Package software.amazon.awssdk.core
Enum SdkSystemSetting
- All Implemented Interfaces:
Serializable
,Comparable<SdkSystemSetting>
,SystemSetting
System properties to configure the SDK runtime.
-
Enum Constant Summary
Enum ConstantDescriptionExplicitly identify the default Async HTTP implementation the SDK will use.Configure the AWS access key ID.Configure the AWS account id associated with credentials supplied through system properties.WhichAccountIdEndpointMode
to use, case insensitiveAn authorization token to pass to a container metadata service, only used whenAWS_CONTAINER_CREDENTIALS_FULL_URI
is specified.The absolute file path containing the authorization token in plain text to pass to a container metadata service, only used whenAWS_CONTAINER_CREDENTIALS_FULL_URI
is specified.The full URI path to a localhost metadata service to be used.The elastic container metadata service path that should be called by the ContainerCredentialsProvider when loading credentials form the container metadata service.The elastic container metadata service endpoint that should be called by the ContainerCredentialsProvider when loading data from the container metadata service.WhichDefaultsMode
to use, case insensitiveWhether request compression is disabled for operations marked with the RequestCompression trait.Whether to load information such as credentials, regions from EC2 Metadata instance service.The EC2 instance metadata service endpoint.Whether to disable fallback to insecure EC2 Metadata instance service v1 on errors or timeouts.Whether endpoint discovery should be enabled.The execution environment of the SDK user.Defines the default value forRetryPolicy.Builder.numRetries(Integer)
, if the retry count is not overridden in the retry policy configured viaClientOverrideConfiguration.Builder.retryPolicy(RetryPolicy)
.Configure the default region.Defines the minimum compression size in bytes, inclusive, for a request to be compressed.WhichRetryMode
to use for the defaultRetryPolicy
, when one is not specified at the client level.Configure the AWS role arn.Configure the session name for a role.The S3 regional endpoint setting for theus-east-1
region.Configure the AWS secret access key.Configure the AWS session token.Defines whether dualstack endpoints should be resolved during default endpoint resolution instead of non-dualstack endpoints.Defines whether fips endpoints should be resolved during default endpoint resolution instead of non-fips endpoints.Configure the AWS web identity token file path.Whether binary ION representation optimization should automatically be used if the service supports ION.Whether CBOR optimization should automatically be used if its support is found on the classpath and the service supports CBOR-formatted JSON.Explicitly identify the default synchronous HTTP implementation the SDK will use. -
Method Summary
Modifier and TypeMethodDescriptionThe default value of the setting (or empty if there is no default).The environment variable of the setting (or null if there is no environment variable for this setting).property()
The system property of the setting (or null if there is no property for this setting).static SdkSystemSetting
Returns the enum constant of this type with the specified name.static SdkSystemSetting[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.Methods inherited from class java.lang.Enum
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
Methods inherited from interface software.amazon.awssdk.utils.SystemSetting
getBooleanValue, getBooleanValueOrThrow, getIntegerValue, getIntegerValueOrThrow, getNonDefaultStringValue, getStringValue, getStringValueOrThrow
-
Enum Constant Details
-
AWS_ACCESS_KEY_ID
Configure the AWS access key ID. This value will not be ignored if theAWS_SECRET_ACCESS_KEY
is not specified. -
AWS_SECRET_ACCESS_KEY
Configure the AWS secret access key. This value will not be ignored if theAWS_ACCESS_KEY_ID
is not specified. -
AWS_SESSION_TOKEN
Configure the AWS session token. -
AWS_ACCOUNT_ID
Configure the AWS account id associated with credentials supplied through system properties. -
AWS_WEB_IDENTITY_TOKEN_FILE
Configure the AWS web identity token file path. -
AWS_ROLE_ARN
Configure the AWS role arn. -
AWS_ROLE_SESSION_NAME
Configure the session name for a role. -
AWS_REGION
Configure the default region. -
AWS_EC2_METADATA_DISABLED
Whether to load information such as credentials, regions from EC2 Metadata instance service. -
AWS_EC2_METADATA_V1_DISABLED
Whether to disable fallback to insecure EC2 Metadata instance service v1 on errors or timeouts. -
AWS_EC2_METADATA_SERVICE_ENDPOINT
The EC2 instance metadata service endpoint. This allows a service running in EC2 to automatically load its credentials and region without needing to configure them in the SdkClientBuilder. -
AWS_EC2_METADATA_SERVICE_ENDPOINT_MODE
-
AWS_CONTAINER_SERVICE_ENDPOINT
The elastic container metadata service endpoint that should be called by the ContainerCredentialsProvider when loading data from the container metadata service. This allows a service running in an elastic container to automatically load its credentials without needing to configure them in the SdkClientBuilder. This is not used if theAWS_CONTAINER_CREDENTIALS_RELATIVE_URI
is not specified. -
AWS_CONTAINER_CREDENTIALS_RELATIVE_URI
The elastic container metadata service path that should be called by the ContainerCredentialsProvider when loading credentials form the container metadata service. If this is not specified, credentials will not be automatically loaded from the container metadata service.- See Also:
-
AWS_CONTAINER_CREDENTIALS_FULL_URI
The full URI path to a localhost metadata service to be used. -
AWS_CONTAINER_AUTHORIZATION_TOKEN
An authorization token to pass to a container metadata service, only used whenAWS_CONTAINER_CREDENTIALS_FULL_URI
is specified.- See Also:
-
AWS_CONTAINER_AUTHORIZATION_TOKEN_FILE
The absolute file path containing the authorization token in plain text to pass to a container metadata service, only used whenAWS_CONTAINER_CREDENTIALS_FULL_URI
is specified.- See Also:
-
SYNC_HTTP_SERVICE_IMPL
Explicitly identify the default synchronous HTTP implementation the SDK will use. Useful when there are multiple implementations on the classpath or as a performance optimization since implementation discovery requires classpath scanning. -
ASYNC_HTTP_SERVICE_IMPL
Explicitly identify the default Async HTTP implementation the SDK will use. Useful when there are multiple implementations on the classpath or as a performance optimization since implementation discovery requires classpath scanning. -
CBOR_ENABLED
Whether CBOR optimization should automatically be used if its support is found on the classpath and the service supports CBOR-formatted JSON. -
BINARY_ION_ENABLED
Whether binary ION representation optimization should automatically be used if the service supports ION. -
AWS_EXECUTION_ENV
The execution environment of the SDK user. This is automatically set in certain environments by the underlying AWS service. For example, AWS Lambda will automatically specify a runtime indicating that the SDK is being used within Lambda. -
AWS_ENDPOINT_DISCOVERY_ENABLED
Whether endpoint discovery should be enabled. -
AWS_S3_US_EAST_1_REGIONAL_ENDPOINT
The S3 regional endpoint setting for theus-east-1
region. Setting the value toregional
causes the SDK to use thes3.us-east-1.amazonaws.com
endpoint when using theUS_EAST_1
region instead of the globals3.amazonaws.com
. Using the regional endpoint is disabled by default. -
AWS_S3_DISABLE_EXPRESS_SESSION_AUTH
-
AWS_RETRY_MODE
WhichRetryMode
to use for the defaultRetryPolicy
, when one is not specified at the client level. -
AWS_MAX_ATTEMPTS
Defines the default value forRetryPolicy.Builder.numRetries(Integer)
, if the retry count is not overridden in the retry policy configured viaClientOverrideConfiguration.Builder.retryPolicy(RetryPolicy)
. This is one more than the number of retries, so aws.maxAttempts = 1 is 0 retries. -
AWS_DEFAULTS_MODE
WhichDefaultsMode
to use, case insensitive -
AWS_ACCOUNT_ID_ENDPOINT_MODE
WhichAccountIdEndpointMode
to use, case insensitive -
AWS_USE_DUALSTACK_ENDPOINT
Defines whether dualstack endpoints should be resolved during default endpoint resolution instead of non-dualstack endpoints. -
AWS_USE_FIPS_ENDPOINT
Defines whether fips endpoints should be resolved during default endpoint resolution instead of non-fips endpoints. -
AWS_DISABLE_REQUEST_COMPRESSION
Whether request compression is disabled for operations marked with the RequestCompression trait. The default value is false, i.e., request compression is enabled. -
AWS_REQUEST_MIN_COMPRESSION_SIZE_BYTES
Defines the minimum compression size in bytes, inclusive, for a request to be compressed. The default value is 10_240. The value must be non-negative and no greater than 10_485_760.
-
-
Method Details
-
values
Returns an array containing the constants of this enum type, in the order they are declared.- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)- Parameters:
name
- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException
- if this enum type has no constant with the specified nameNullPointerException
- if the argument is null
-
property
Description copied from interface:SystemSetting
The system property of the setting (or null if there is no property for this setting).- Specified by:
property
in interfaceSystemSetting
-
environmentVariable
Description copied from interface:SystemSetting
The environment variable of the setting (or null if there is no environment variable for this setting).- Specified by:
environmentVariable
in interfaceSystemSetting
-
defaultValue
Description copied from interface:SystemSetting
The default value of the setting (or empty if there is no default). This value will be applied if the customer did not specify a setting.- Specified by:
defaultValue
in interfaceSystemSetting
-