AwsSystemSetting (AWS SDK for Java

java.lang.Object
- java.lang.Enum<AwsSystemSetting>
- - software.amazon.awssdk.core.AwsSystemSetting

All Implemented Interfaces:

Serializable, Comparable<AwsSystemSetting>, SystemSetting
```
public enum AwsSystemSetting
extends Enum<AwsSystemSetting>
implements SystemSetting
```
The system properties and environment variables supported by the AWS SDK.

See Also:

JavaSystemSetting

Enum Constant Summary

Enum Constants
Enum Constant and Description
`AWS_ACCESS_KEY_ID` Configure the AWS access key ID used in the `EnvironmentVariableCredentialsProvider` and `SystemPropertyCredentialsProvider`.
`AWS_BINARY_ION_ENABLED` Whether binary ION representation optimization should automatically be used if the service supports ION.
`AWS_CBOR_ENABLED` Whether CBOR optimization should automatically be used if its support is found on the classpath and the service supports CBOR-formatted JSON.
`AWS_CONFIG_FILE` Configure the default configuration file used in the `ProfileFile.defaultProfileFile()`.
`AWS_CONTAINER_AUTHORIZATION_TOKEN` An authorization token to pass to a container metatdata service, only used when `AWS_CONTAINER_CREDENTIALS_FULL_URI` is specified.
`AWS_CONTAINER_CREDENTIALS_FULL_URI` The full URI path to a localhost metadata service to be used by `ContainerCredentialsProvider` when loading credentials.
`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.
`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.
`AWS_EC2_METADATA_SERVICE_ENDPOINT` The EC2 instance metadata service endpoint that should be called by the `InstanceProfileCredentialsProvider` and `InstanceProfileRegionProvider` when loading data from the EC2 instance metadata service.
`AWS_EXECUTION_ENV` The execution environment of the SDK user.
`AWS_IN_REGION_OPTIMIZATION_ENABLED` Whether the default configuration applied to AWS clients should be optimized for services within the same region.
`AWS_PROFILE` Configure the default profile that should be loaded from the `AWS_CONFIG_FILE` and `AWS_SHARED_CREDENTIALS_FILE` when using configuration files for configuring the SDK.
`AWS_REGION` Configure the default region used in the `SystemSettingsRegionProvider`.
`AWS_SECRET_ACCESS_KEY` Configure the AWS secret access key used in the `EnvironmentVariableCredentialsProvider` and `SystemPropertyCredentialsProvider`.
`AWS_SESSION_TOKEN` Configure the AWS session token used in the `EnvironmentVariableCredentialsProvider` and `SystemPropertyCredentialsProvider`.
`AWS_SHARED_CREDENTIALS_FILE` Configure the default credentials file used in the `ProfileFile.defaultProfileFile()`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`defaultValue()` The default value of the setting (or empty if there is no default).
`String`	`environmentVariable()` The environment variable of the setting (or null if there is no environment variable for this setting).
`String`	`property()` The system property of the setting (or null if there is no property for this setting).
`static AwsSystemSetting`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static AwsSystemSetting[]`	`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 class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.SystemSetting
getBooleanValue, getBooleanValueOrThrow, getStringValue, getStringValueOrThrow

- Enum Constant Detail
  - AWS_ACCESS_KEY_ID
```
public static final AwsSystemSetting AWS_ACCESS_KEY_ID
```
    Configure the AWS access key ID used in the EnvironmentVariableCredentialsProvider and SystemPropertyCredentialsProvider. This value is checked by the DefaultCredentialsProvider, which is used when clients are created with no credential provider specified via ClientBuilder.credentialsProvider(AwsCredentialsProvider). This value will not be ignored if the AWS_SECRET_ACCESS_KEY is not specified.
    
    See Also:
    
    AwsCredentials
  - AWS_SECRET_ACCESS_KEY
```
public static final AwsSystemSetting AWS_SECRET_ACCESS_KEY
```
    Configure the AWS secret access key used in the EnvironmentVariableCredentialsProvider and SystemPropertyCredentialsProvider. This value is checked by the DefaultCredentialsProvider, which is used when clients are created with no credential provider specified via ClientBuilder.credentialsProvider(AwsCredentialsProvider). This value will not be ignored if the AWS_ACCESS_KEY_ID is not specified.
    
    See Also:
    
    AwsCredentials
  - AWS_SESSION_TOKEN
```
public static final AwsSystemSetting AWS_SESSION_TOKEN
```
    Configure the AWS session token used in the EnvironmentVariableCredentialsProvider and SystemPropertyCredentialsProvider. This value is checked by the DefaultCredentialsProvider, which is used when clients are created with no credential provider specified via ClientBuilder.credentialsProvider(AwsCredentialsProvider). This value will not be ignored if the AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY are not specified.
    
    See Also:
    
    AwsSessionCredentials
  - AWS_REGION
```
public static final AwsSystemSetting AWS_REGION
```
    Configure the default region used in the SystemSettingsRegionProvider. This value is checked by the ClientBuilder when no region is specified via ClientBuilder.region(Region).
    
    See Also:
    
    Region
  - AWS_CONFIG_FILE
```
public static final AwsSystemSetting AWS_CONFIG_FILE
```
    Configure the default configuration file used in the ProfileFile.defaultProfileFile(). When not explicitly overridden in a client (eg. by specifying the region or credentials provider), this will be the location used when an AWS client is created. See http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html for more information on configuring the SDK via a configuration file.
    
    See Also:
    
    ProfileCredentialsProvider
  - AWS_SHARED_CREDENTIALS_FILE
```
public static final AwsSystemSetting AWS_SHARED_CREDENTIALS_FILE
```
    Configure the default credentials file used in the ProfileFile.defaultProfileFile(). When not explicitly overridden in a client (eg. by specifying the region or credentials provider), this will be the location used when an AWS client is created. See http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html for more information on configuring the SDK via a credentials file.
    
    See Also:
    
    ProfileCredentialsProvider
  - AWS_PROFILE
```
public static final AwsSystemSetting AWS_PROFILE
```
    Configure the default profile that should be loaded from the AWS_CONFIG_FILE and AWS_SHARED_CREDENTIALS_FILE when using configuration files for configuring the SDK.
    
    See Also:
    
    AWS_CONFIG_FILE
  - AWS_IN_REGION_OPTIMIZATION_ENABLED
```
public static final AwsSystemSetting AWS_IN_REGION_OPTIMIZATION_ENABLED
```
    Whether the default configuration applied to AWS clients should be optimized for services within the same region. This will usually include lower request timeouts because requests do not need to travel outside of the AWS network.
  - AWS_EXECUTION_ENV
```
public static final AwsSystemSetting 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_EC2_METADATA_SERVICE_ENDPOINT
```
public static final AwsSystemSetting AWS_EC2_METADATA_SERVICE_ENDPOINT
```
    The EC2 instance metadata service endpoint that should be called by the InstanceProfileCredentialsProvider and InstanceProfileRegionProvider when loading data from the EC2 instance metadata service. This allows a service running in EC2 to automatically load its credentials and region without needing to configure them in the ClientBuilder.
  - AWS_CONTAINER_SERVICE_ENDPOINT
```
public static final AwsSystemSetting 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 ClientBuilder. This is not used if the AWS_CONTAINER_CREDENTIALS_RELATIVE_URI is not specified.
  - AWS_CONTAINER_CREDENTIALS_RELATIVE_URI
```
public static final AwsSystemSetting 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_SERVICE_ENDPOINT
  - AWS_CONTAINER_CREDENTIALS_FULL_URI
```
public static final AwsSystemSetting AWS_CONTAINER_CREDENTIALS_FULL_URI
```
    The full URI path to a localhost metadata service to be used by ContainerCredentialsProvider when loading credentials. If this is not specified, credentials will not be automatically loaded from the container.
  - AWS_CONTAINER_AUTHORIZATION_TOKEN
```
public static final AwsSystemSetting AWS_CONTAINER_AUTHORIZATION_TOKEN
```
    An authorization token to pass to a container metatdata service, only used when AWS_CONTAINER_CREDENTIALS_FULL_URI is specified.
    
    See Also:
    
    AWS_CONTAINER_CREDENTIALS_FULL_URI
  - AWS_CBOR_ENABLED
```
public static final AwsSystemSetting AWS_CBOR_ENABLED
```
    Whether CBOR optimization should automatically be used if its support is found on the classpath and the service supports CBOR-formatted JSON.
  - AWS_BINARY_ION_ENABLED
```
public static final AwsSystemSetting AWS_BINARY_ION_ENABLED
```
    Whether binary ION representation optimization should automatically be used if the service supports ION.
- Method Detail
  - values
```
public static AwsSystemSetting[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (AwsSystemSetting c : AwsSystemSetting.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static AwsSystemSetting valueOf(String name)
```
    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 name
    
    NullPointerException - if the argument is null
  - property
```
public String 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 interface SystemSetting
  - environmentVariable
```
public String 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 interface SystemSetting
  - defaultValue
```
public String 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 interface SystemSetting

Enum AwsSystemSetting

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.SystemSetting

Enum Constant Detail

AWS_ACCESS_KEY_ID

AWS_SECRET_ACCESS_KEY

AWS_SESSION_TOKEN

AWS_REGION

AWS_CONFIG_FILE

AWS_SHARED_CREDENTIALS_FILE

AWS_PROFILE

AWS_IN_REGION_OPTIMIZATION_ENABLED

AWS_EXECUTION_ENV

AWS_EC2_METADATA_SERVICE_ENDPOINT

AWS_CONTAINER_SERVICE_ENDPOINT

AWS_CONTAINER_CREDENTIALS_RELATIVE_URI

AWS_CONTAINER_CREDENTIALS_FULL_URI

AWS_CONTAINER_AUTHORIZATION_TOKEN

AWS_CBOR_ENABLED

AWS_BINARY_ION_ENABLED

Method Detail

values

valueOf

property

environmentVariable

defaultValue