Skip to content

Commit c214cb6

Browse files
authored
DefaultsMode Documentation Fixes (#1599)
Regenerates API clients to refer to correct DefaultMode constants.
1 parent 07719a1 commit c214cb6

File tree

312 files changed

+617
-617
lines changed

Some content is hidden

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

312 files changed

+617
-617
lines changed

aws/config.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ type Config struct {
115115
DefaultsMode DefaultsMode
116116

117117
// The RuntimeEnvironment configuration, only populated if the DefaultsMode
118-
// is set to AutoDefaultsMode and is initialized by
118+
// is set to DefaultsModeAuto and is initialized by
119119
// `config.LoadDefaultConfig`. You should not populate this structure
120120
// programmatically, or rely on the values here within your applications.
121121
RuntimeEnvironment RuntimeEnvironment

aws/defaults/auto.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ var getGOOS = func() string {
1111
}
1212

1313
// ResolveDefaultsModeAuto is used to determine the effective aws.DefaultsMode when the mode
14-
// is set to aws.AutoDefaultsMode.
14+
// is set to aws.DefaultsModeAuto.
1515
func ResolveDefaultsModeAuto(region string, environment aws.RuntimeEnvironment) aws.DefaultsMode {
1616
goos := getGOOS()
1717
if goos == "android" || goos == "ios" {

codegen/smithy-aws-go-codegen/src/main/java/software/amazon/smithy/aws/go/codegen/AddAwsConfigFields.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ public class AddAwsConfigFields implements GoIntegration {
8888
.type(getAwsCoreSymbol("RuntimeEnvironment"))
8989
.documentation("""
9090
The RuntimeEnvironment configuration, only populated if the DefaultsMode is set to
91-
AutoDefaultsMode and is initialized using `config.LoadDefaultConfig`. You should not
91+
DefaultsModeAuto and is initialized using `config.LoadDefaultConfig`. You should not
9292
populate this structure programmatically, or rely on the values here within your
9393
applications.
9494
""")

codegen/smithy-aws-go-codegen/src/main/java/software/amazon/smithy/aws/go/codegen/ClientResolvedDefaultsMode.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ public class ClientResolvedDefaultsMode implements GoIntegration {
4343
.build())
4444
.documentation("""
4545
The initial DefaultsMode used when the client options were constructed. If the
46-
DefaultsMode was set to aws.AutoDefaultsMode this will store what the resolved value
46+
DefaultsMode was set to aws.DefaultsModeAuto this will store what the resolved value
4747
was at that point in time.
4848
4949
Currently does not support per operation call overrides, may in the future.

config/config.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ var defaultAWSConfigResolvers = []awsConfigResolver{
5656
resolveAPIOptions,
5757

5858
// Resolves the DefaultsMode that should be used by SDK clients. If this
59-
// mode is set to AutoDefaultsMode.
59+
// mode is set to DefaultsModeAuto.
6060
//
6161
// Comes after HTTPClient and CustomCABundle to ensure the HTTP client is
6262
// configured if provided before invoking IMDS if mode is auto. Comes

config/defaultsmode.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ type DefaultsModeOptions struct {
1818
Mode aws.DefaultsMode
1919

2020
// The EC2 Instance Metadata Client that should be used when performing environment
21-
// discovery when aws.AutoDefaultsMode is set.
21+
// discovery when aws.DefaultsModeAuto is set.
2222
//
2323
// If not specified the SDK will construct a client if the instance metadata service has not been disabled by
2424
// the AWS_EC2_METADATA_DISABLED environment variable.

config/load_options.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -911,7 +911,7 @@ func (o LoadOptions) GetUseFIPSEndpoint(ctx context.Context) (value aws.FIPSEndp
911911
// WithDefaultsMode sets the SDK defaults configuration mode to the value provided.
912912
//
913913
// Zero or more functional options can be provided to provide configuration options for performing
914-
// environment discovery when using aws.AutoDefaultsMode.
914+
// environment discovery when using aws.DefaultsModeAuto.
915915
func WithDefaultsMode(mode aws.DefaultsMode, optFns ...func(options *DefaultsModeOptions)) LoadOptionsFunc {
916916
do := DefaultsModeOptions{
917917
Mode: mode,

internal/protocoltest/awsrestjson/api_client.go

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

internal/protocoltest/ec2query/api_client.go

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

internal/protocoltest/jsonrpc/api_client.go

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)