Skip to content

Commit 3db0da1

Browse files
Laren-AWSLaren-AWS
authored
Go: Update use of context in all Go examples (#6945)
* Update use of context in all Go examples.
1 parent c319089 commit 3db0da1

File tree

103 files changed

+1097
-955
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

103 files changed

+1097
-955
lines changed

‎gov2/aurora/actions/clusters.go

+30-30
Original file line numberDiff line numberDiff line change
@@ -23,10 +23,10 @@ type DbClusters struct {
2323
// snippet-start:[gov2.aurora.DescribeDBClusterParameterGroups]
2424

2525
// GetParameterGroup gets a DB cluster parameter group by name.
26-
func (clusters *DbClusters) GetParameterGroup(parameterGroupName string) (
26+
func (clusters *DbClusters) GetParameterGroup(ctx context.Context, parameterGroupName string) (
2727
*types.DBClusterParameterGroup, error) {
2828
output, err := clusters.AuroraClient.DescribeDBClusterParameterGroups(
29-
context.TODO(), &rds.DescribeDBClusterParameterGroupsInput{
29+
ctx, &rds.DescribeDBClusterParameterGroupsInput{
3030
DBClusterParameterGroupName: aws.String(parameterGroupName),
3131
})
3232
if err != nil {
@@ -49,10 +49,10 @@ func (clusters *DbClusters) GetParameterGroup(parameterGroupName string) (
4949
// CreateParameterGroup creates a DB cluster parameter group that is based on the specified
5050
// parameter group family.
5151
func (clusters *DbClusters) CreateParameterGroup(
52-
parameterGroupName string, parameterGroupFamily string, description string) (
52+
ctx context.Context, parameterGroupName string, parameterGroupFamily string, description string) (
5353
*types.DBClusterParameterGroup, error) {
5454

55-
output, err := clusters.AuroraClient.CreateDBClusterParameterGroup(context.TODO(),
55+
output, err := clusters.AuroraClient.CreateDBClusterParameterGroup(ctx,
5656
&rds.CreateDBClusterParameterGroupInput{
5757
DBClusterParameterGroupName: aws.String(parameterGroupName),
5858
DBParameterGroupFamily: aws.String(parameterGroupFamily),
@@ -71,8 +71,8 @@ func (clusters *DbClusters) CreateParameterGroup(
7171
// snippet-start:[gov2.aurora.DeleteDBClusterParameterGroup]
7272

7373
// DeleteParameterGroup deletes the named DB cluster parameter group.
74-
func (clusters *DbClusters) DeleteParameterGroup(parameterGroupName string) error {
75-
_, err := clusters.AuroraClient.DeleteDBClusterParameterGroup(context.TODO(),
74+
func (clusters *DbClusters) DeleteParameterGroup(ctx context.Context, parameterGroupName string) error {
75+
_, err := clusters.AuroraClient.DeleteDBClusterParameterGroup(ctx,
7676
&rds.DeleteDBClusterParameterGroupInput{
7777
DBClusterParameterGroupName: aws.String(parameterGroupName),
7878
})
@@ -89,7 +89,7 @@ func (clusters *DbClusters) DeleteParameterGroup(parameterGroupName string) erro
8989
// snippet-start:[gov2.aurora.DescribeDBClusterParameters]
9090

9191
// GetParameters gets the parameters that are contained in a DB cluster parameter group.
92-
func (clusters *DbClusters) GetParameters(parameterGroupName string, source string) (
92+
func (clusters *DbClusters) GetParameters(ctx context.Context, parameterGroupName string, source string) (
9393
[]types.Parameter, error) {
9494

9595
var output *rds.DescribeDBClusterParametersOutput
@@ -101,7 +101,7 @@ func (clusters *DbClusters) GetParameters(parameterGroupName string, source stri
101101
Source: aws.String(source),
102102
})
103103
for parameterPaginator.HasMorePages() {
104-
output, err = parameterPaginator.NextPage(context.TODO())
104+
output, err = parameterPaginator.NextPage(ctx)
105105
if err != nil {
106106
log.Printf("Couldn't get paramaeters for %v: %v\n", parameterGroupName, err)
107107
break
@@ -117,8 +117,8 @@ func (clusters *DbClusters) GetParameters(parameterGroupName string, source stri
117117
// snippet-start:[gov2.aurora.ModifyDBClusterParameterGroup]
118118

119119
// UpdateParameters updates parameters in a named DB cluster parameter group.
120-
func (clusters *DbClusters) UpdateParameters(parameterGroupName string, params []types.Parameter) error {
121-
_, err := clusters.AuroraClient.ModifyDBClusterParameterGroup(context.TODO(),
120+
func (clusters *DbClusters) UpdateParameters(ctx context.Context, parameterGroupName string, params []types.Parameter) error {
121+
_, err := clusters.AuroraClient.ModifyDBClusterParameterGroup(ctx,
122122
&rds.ModifyDBClusterParameterGroupInput{
123123
DBClusterParameterGroupName: aws.String(parameterGroupName),
124124
Parameters: params,
@@ -136,8 +136,8 @@ func (clusters *DbClusters) UpdateParameters(parameterGroupName string, params [
136136
// snippet-start:[gov2.aurora.DescribeDBClusters]
137137

138138
// GetDbCluster gets data about an Aurora DB cluster.
139-
func (clusters *DbClusters) GetDbCluster(clusterName string) (*types.DBCluster, error) {
140-
output, err := clusters.AuroraClient.DescribeDBClusters(context.TODO(),
139+
func (clusters *DbClusters) GetDbCluster(ctx context.Context, clusterName string) (*types.DBCluster, error) {
140+
output, err := clusters.AuroraClient.DescribeDBClusters(ctx,
141141
&rds.DescribeDBClustersInput{
142142
DBClusterIdentifier: aws.String(clusterName),
143143
})
@@ -162,11 +162,11 @@ func (clusters *DbClusters) GetDbCluster(clusterName string) (*types.DBCluster,
162162
// CreateDbCluster creates a DB cluster that is configured to use the specified parameter group.
163163
// The newly created DB cluster contains a database that uses the specified engine and
164164
// engine version.
165-
func (clusters *DbClusters) CreateDbCluster(clusterName string, parameterGroupName string,
165+
func (clusters *DbClusters) CreateDbCluster(ctx context.Context, clusterName string, parameterGroupName string,
166166
dbName string, dbEngine string, dbEngineVersion string, adminName string, adminPassword string) (
167167
*types.DBCluster, error) {
168168

169-
output, err := clusters.AuroraClient.CreateDBCluster(context.TODO(), &rds.CreateDBClusterInput{
169+
output, err := clusters.AuroraClient.CreateDBCluster(ctx, &rds.CreateDBClusterInput{
170170
DBClusterIdentifier: aws.String(clusterName),
171171
Engine: aws.String(dbEngine),
172172
DBClusterParameterGroupName: aws.String(parameterGroupName),
@@ -188,8 +188,8 @@ func (clusters *DbClusters) CreateDbCluster(clusterName string, parameterGroupNa
188188
// snippet-start:[gov2.aurora.DeleteDBCluster]
189189

190190
// DeleteDbCluster deletes a DB cluster without keeping a final snapshot.
191-
func (clusters *DbClusters) DeleteDbCluster(clusterName string) error {
192-
_, err := clusters.AuroraClient.DeleteDBCluster(context.TODO(), &rds.DeleteDBClusterInput{
191+
func (clusters *DbClusters) DeleteDbCluster(ctx context.Context, clusterName string) error {
192+
_, err := clusters.AuroraClient.DeleteDBCluster(ctx, &rds.DeleteDBClusterInput{
193193
DBClusterIdentifier: aws.String(clusterName),
194194
SkipFinalSnapshot: aws.Bool(true),
195195
})
@@ -206,9 +206,9 @@ func (clusters *DbClusters) DeleteDbCluster(clusterName string) error {
206206
// snippet-start:[gov2.aurora.CreateDBClusterSnapshot]
207207

208208
// CreateClusterSnapshot creates a snapshot of a DB cluster.
209-
func (clusters *DbClusters) CreateClusterSnapshot(clusterName string, snapshotName string) (
209+
func (clusters *DbClusters) CreateClusterSnapshot(ctx context.Context, clusterName string, snapshotName string) (
210210
*types.DBClusterSnapshot, error) {
211-
output, err := clusters.AuroraClient.CreateDBClusterSnapshot(context.TODO(), &rds.CreateDBClusterSnapshotInput{
211+
output, err := clusters.AuroraClient.CreateDBClusterSnapshot(ctx, &rds.CreateDBClusterSnapshotInput{
212212
DBClusterIdentifier: aws.String(clusterName),
213213
DBClusterSnapshotIdentifier: aws.String(snapshotName),
214214
})
@@ -225,8 +225,8 @@ func (clusters *DbClusters) CreateClusterSnapshot(clusterName string, snapshotNa
225225
// snippet-start:[gov2.aurora.DescribeDBClusterSnapshots]
226226

227227
// GetClusterSnapshot gets a DB cluster snapshot.
228-
func (clusters *DbClusters) GetClusterSnapshot(snapshotName string) (*types.DBClusterSnapshot, error) {
229-
output, err := clusters.AuroraClient.DescribeDBClusterSnapshots(context.TODO(),
228+
func (clusters *DbClusters) GetClusterSnapshot(ctx context.Context, snapshotName string) (*types.DBClusterSnapshot, error) {
229+
output, err := clusters.AuroraClient.DescribeDBClusterSnapshots(ctx,
230230
&rds.DescribeDBClusterSnapshotsInput{
231231
DBClusterSnapshotIdentifier: aws.String(snapshotName),
232232
})
@@ -244,9 +244,9 @@ func (clusters *DbClusters) GetClusterSnapshot(snapshotName string) (*types.DBCl
244244

245245
// CreateInstanceInCluster creates a database instance in an existing DB cluster. The first database that is
246246
// created defaults to a read-write DB instance.
247-
func (clusters *DbClusters) CreateInstanceInCluster(clusterName string, instanceName string,
247+
func (clusters *DbClusters) CreateInstanceInCluster(ctx context.Context, clusterName string, instanceName string,
248248
dbEngine string, dbInstanceClass string) (*types.DBInstance, error) {
249-
output, err := clusters.AuroraClient.CreateDBInstance(context.TODO(), &rds.CreateDBInstanceInput{
249+
output, err := clusters.AuroraClient.CreateDBInstance(ctx, &rds.CreateDBInstanceInput{
250250
DBInstanceIdentifier: aws.String(instanceName),
251251
DBClusterIdentifier: aws.String(clusterName),
252252
Engine: aws.String(dbEngine),
@@ -265,9 +265,9 @@ func (clusters *DbClusters) CreateInstanceInCluster(clusterName string, instance
265265
// snippet-start:[gov2.aurora.DescribeDBInstances]
266266

267267
// GetInstance gets data about a DB instance.
268-
func (clusters *DbClusters) GetInstance(instanceName string) (
268+
func (clusters *DbClusters) GetInstance(ctx context.Context, instanceName string) (
269269
*types.DBInstance, error) {
270-
output, err := clusters.AuroraClient.DescribeDBInstances(context.TODO(),
270+
output, err := clusters.AuroraClient.DescribeDBInstances(ctx,
271271
&rds.DescribeDBInstancesInput{
272272
DBInstanceIdentifier: aws.String(instanceName),
273273
})
@@ -290,8 +290,8 @@ func (clusters *DbClusters) GetInstance(instanceName string) (
290290
// snippet-start:[gov2.aurora.DeleteDBInstance]
291291

292292
// DeleteInstance deletes a DB instance.
293-
func (clusters *DbClusters) DeleteInstance(instanceName string) error {
294-
_, err := clusters.AuroraClient.DeleteDBInstance(context.TODO(), &rds.DeleteDBInstanceInput{
293+
func (clusters *DbClusters) DeleteInstance(ctx context.Context, instanceName string) error {
294+
_, err := clusters.AuroraClient.DeleteDBInstance(ctx, &rds.DeleteDBInstanceInput{
295295
DBInstanceIdentifier: aws.String(instanceName),
296296
SkipFinalSnapshot: aws.Bool(true),
297297
DeleteAutomatedBackups: aws.Bool(true),
@@ -310,9 +310,9 @@ func (clusters *DbClusters) DeleteInstance(instanceName string) error {
310310

311311
// GetEngineVersions gets database engine versions that are available for the specified engine
312312
// and parameter group family.
313-
func (clusters *DbClusters) GetEngineVersions(engine string, parameterGroupFamily string) (
313+
func (clusters *DbClusters) GetEngineVersions(ctx context.Context, engine string, parameterGroupFamily string) (
314314
[]types.DBEngineVersion, error) {
315-
output, err := clusters.AuroraClient.DescribeDBEngineVersions(context.TODO(),
315+
output, err := clusters.AuroraClient.DescribeDBEngineVersions(ctx,
316316
&rds.DescribeDBEngineVersionsInput{
317317
Engine: aws.String(engine),
318318
DBParameterGroupFamily: aws.String(parameterGroupFamily),
@@ -331,7 +331,7 @@ func (clusters *DbClusters) GetEngineVersions(engine string, parameterGroupFamil
331331

332332
// GetOrderableInstances uses a paginator to get DB instance options that can be used to create DB instances that are
333333
// compatible with a set of specifications.
334-
func (clusters *DbClusters) GetOrderableInstances(engine string, engineVersion string) (
334+
func (clusters *DbClusters) GetOrderableInstances(ctx context.Context, engine string, engineVersion string) (
335335
[]types.OrderableDBInstanceOption, error) {
336336

337337
var output *rds.DescribeOrderableDBInstanceOptionsOutput
@@ -343,7 +343,7 @@ func (clusters *DbClusters) GetOrderableInstances(engine string, engineVersion s
343343
EngineVersion: aws.String(engineVersion),
344344
})
345345
for orderablePaginator.HasMorePages() {
346-
output, err = orderablePaginator.NextPage(context.TODO())
346+
output, err = orderablePaginator.NextPage(ctx)
347347
if err != nil {
348348
log.Printf("Couldn't get orderable DB instances: %v\n", err)
349349
break

‎gov2/aurora/cmd/main.go

+6-5
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ import (
2323
// - `clusters` - Runs the interactive DB clusters scenario that shows you how to use
2424
// Amazon Aurora commands to work with DB clusters and databases.
2525
func main() {
26-
scenarioMap := map[string]func(sdkConfig aws.Config){
26+
scenarioMap := map[string]func(ctx context.Context, sdkConfig aws.Config){
2727
"clusters": runClusterScenario,
2828
}
2929
choices := make([]string, len(scenarioMap))
@@ -41,18 +41,19 @@ func main() {
4141
fmt.Printf("'%v' is not a valid scenario.\n", *scenario)
4242
flag.Usage()
4343
} else {
44-
sdkConfig, err := config.LoadDefaultConfig(context.TODO())
44+
ctx := context.Background()
45+
sdkConfig, err := config.LoadDefaultConfig(ctx)
4546
if err != nil {
4647
log.Fatalf("unable to load SDK config, %v", err)
4748
}
4849

4950
log.SetFlags(0)
50-
runScenario(sdkConfig)
51+
runScenario(ctx, sdkConfig)
5152
}
5253
}
5354

54-
func runClusterScenario(sdkConfig aws.Config) {
55+
func runClusterScenario(ctx context.Context, sdkConfig aws.Config) {
5556
scenario := scenarios.NewGetStartedClusters(sdkConfig, demotools.NewQuestioner(), scenarios.ScenarioHelper{})
56-
scenario.Run("aurora-mysql", "doc-example-cluster-parameter-group", "doc-example-aurora",
57+
scenario.Run(ctx, "aurora-mysql", "doc-example-cluster-parameter-group", "doc-example-aurora",
5758
"docexampledb")
5859
}

‎gov2/aurora/hello/hello.go

+4-3
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,8 @@ import (
1919
// This example uses the default settings specified in your shared credentials
2020
// and config files.
2121
func main() {
22-
sdkConfig, err := config.LoadDefaultConfig(context.TODO())
22+
ctx := context.Background()
23+
sdkConfig, err := config.LoadDefaultConfig(ctx)
2324
if err != nil {
2425
fmt.Println("Couldn't load default configuration. Have you set up your AWS account?")
2526
fmt.Println(err)
@@ -28,8 +29,8 @@ func main() {
2829
auroraClient := rds.NewFromConfig(sdkConfig)
2930
const maxClusters = 20
3031
fmt.Printf("Let's list up to %v DB clusters.\n", maxClusters)
31-
output, err := auroraClient.DescribeDBClusters(context.TODO(),
32-
&rds.DescribeDBClustersInput{MaxRecords: aws.Int32(maxClusters)})
32+
output, err := auroraClient.DescribeDBClusters(
33+
ctx, &rds.DescribeDBClustersInput{MaxRecords: aws.Int32(maxClusters)})
3334
if err != nil {
3435
fmt.Printf("Couldn't list DB clusters: %v\n", err)
3536
return

0 commit comments

Comments
 (0)