Skip to content

Commit

Permalink
Go: Update use of context in all Go examples (#6945)
Browse files Browse the repository at this point in the history 
* Update use of context in all Go examples.
  • Loading branch information
@Laren-AWS
Laren-AWS authored Oct 2, 2024
1 parent c319089 commit 3db0da1
Show file tree
Hide file tree
Showing 103 changed files with 1,097 additions and 955 deletions.
60 changes: 30 additions & 30 deletions gov2/aurora/actions/clusters.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,10 @@ type DbClusters struct {
// snippet-start:[gov2.aurora.DescribeDBClusterParameterGroups]

// GetParameterGroup gets a DB cluster parameter group by name.
func (clusters *DbClusters) GetParameterGroup(parameterGroupName string) (
func (clusters *DbClusters) GetParameterGroup(ctx context.Context, parameterGroupName string) (
*types.DBClusterParameterGroup, error) {
output, err := clusters.AuroraClient.DescribeDBClusterParameterGroups(
context.TODO(), &rds.DescribeDBClusterParameterGroupsInput{
ctx, &rds.DescribeDBClusterParameterGroupsInput{
DBClusterParameterGroupName: aws.String(parameterGroupName),
})
if err != nil {
Expand All @@ -49,10 +49,10 @@ func (clusters *DbClusters) GetParameterGroup(parameterGroupName string) (
// CreateParameterGroup creates a DB cluster parameter group that is based on the specified
// parameter group family.
func (clusters *DbClusters) CreateParameterGroup(
parameterGroupName string, parameterGroupFamily string, description string) (
ctx context.Context, parameterGroupName string, parameterGroupFamily string, description string) (
*types.DBClusterParameterGroup, error) {

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

var output *rds.DescribeOrderableDBInstanceOptionsOutput
Expand All @@ -343,7 +343,7 @@ func (clusters *DbClusters) GetOrderableInstances(engine string, engineVersion s
EngineVersion: aws.String(engineVersion),
})
for orderablePaginator.HasMorePages() {
output, err = orderablePaginator.NextPage(context.TODO())
output, err = orderablePaginator.NextPage(ctx)
if err != nil {
log.Printf("Couldn't get orderable DB instances: %v\n", err)
break
Expand Down
11 changes: 6 additions & 5 deletions gov2/aurora/cmd/main.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ import (
// - `clusters` - Runs the interactive DB clusters scenario that shows you how to use
// Amazon Aurora commands to work with DB clusters and databases.
func main() {
scenarioMap := map[string]func(sdkConfig aws.Config){
scenarioMap := map[string]func(ctx context.Context, sdkConfig aws.Config){
"clusters": runClusterScenario,
}
choices := make([]string, len(scenarioMap))
Expand All @@ -41,18 +41,19 @@ func main() {
fmt.Printf("'%v' is not a valid scenario.\n", *scenario)
flag.Usage()
} else {
sdkConfig, err := config.LoadDefaultConfig(context.TODO())
ctx := context.Background()
sdkConfig, err := config.LoadDefaultConfig(ctx)
if err != nil {
log.Fatalf("unable to load SDK config, %v", err)
}

log.SetFlags(0)
runScenario(sdkConfig)
runScenario(ctx, sdkConfig)
}
}

func runClusterScenario(sdkConfig aws.Config) {
func runClusterScenario(ctx context.Context, sdkConfig aws.Config) {
scenario := scenarios.NewGetStartedClusters(sdkConfig, demotools.NewQuestioner(), scenarios.ScenarioHelper{})
scenario.Run("aurora-mysql", "doc-example-cluster-parameter-group", "doc-example-aurora",
scenario.Run(ctx, "aurora-mysql", "doc-example-cluster-parameter-group", "doc-example-aurora",
"docexampledb")
}
7 changes: 4 additions & 3 deletions gov2/aurora/hello/hello.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,8 @@ import (
// This example uses the default settings specified in your shared credentials
// and config files.
func main() {
sdkConfig, err := config.LoadDefaultConfig(context.TODO())
ctx := context.Background()
sdkConfig, err := config.LoadDefaultConfig(ctx)
if err != nil {
fmt.Println("Couldn't load default configuration. Have you set up your AWS account?")
fmt.Println(err)
Expand All @@ -28,8 +29,8 @@ func main() {
auroraClient := rds.NewFromConfig(sdkConfig)
const maxClusters = 20
fmt.Printf("Let's list up to %v DB clusters.\n", maxClusters)
output, err := auroraClient.DescribeDBClusters(context.TODO(),
&rds.DescribeDBClustersInput{MaxRecords: aws.Int32(maxClusters)})
output, err := auroraClient.DescribeDBClusters(
ctx, &rds.DescribeDBClustersInput{MaxRecords: aws.Int32(maxClusters)})
if err != nil {
fmt.Printf("Couldn't list DB clusters: %v\n", err)
return
Expand Down
Loading

0 comments on commit 3db0da1

Please sign in to comment.