SdkSystemSetting (AWS SDK for Java

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

All Implemented Interfaces:

Serializable, Comparable<SdkSystemSetting>, SystemSetting
```
public enum SdkSystemSetting
extends Enum<SdkSystemSetting>
implements SystemSetting
```
System properties to configure the SDK runtime.

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ASYNC_HTTP_SERVICE_IMPL` Explicitly identify the default Async HTTP implementation the SDK will use.
`AWS_ACCESS_KEY_ID` Configure the AWS access key ID.
`AWS_CONFIG_FILE` Configure the default configuration file used in the ProfileFile.
`AWS_CONTAINER_AUTHORIZATION_TOKEN` An authorization token to pass to a container metadata 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.
`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_DISABLED` Whether to load information such as credentials, regions from EC2 Metadata instance service.
`AWS_EC2_METADATA_SERVICE_ENDPOINT` The EC2 instance metadata service endpoint.
`AWS_EXECUTION_ENV` The execution environment of the SDK user.
`AWS_PROFILE` Configure the default profile that should be loaded from the `AWS_CONFIG_FILE`
`AWS_REGION` Configure the default region.
`AWS_SECRET_ACCESS_KEY` Configure the AWS secret access key.
`AWS_SESSION_TOKEN` Configure the AWS session token.
`AWS_SHARED_CREDENTIALS_FILE` Configure the default credentials file used in the ProfileFile.
`BINARY_ION_ENABLED` Whether binary ION representation optimization should automatically be used if the service supports ION.
`CBOR_ENABLED` Whether CBOR optimization should automatically be used if its support is found on the classpath and the service supports CBOR-formatted JSON.
`SYNC_HTTP_SERVICE_IMPL` Explicitly identify the default synchronous HTTP implementation the SDK will use.

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 SdkSystemSetting`	`valueOf(String name)` 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 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_CONFIG_FILE
```
public static final SdkSystemSetting AWS_CONFIG_FILE
```
    Configure the default configuration file used in the ProfileFile. 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.
  - AWS_PROFILE
```
public static final SdkSystemSetting AWS_PROFILE
```
    Configure the default profile that should be loaded from the AWS_CONFIG_FILE
    
    See Also:
    
    AWS_CONFIG_FILE
  - AWS_SHARED_CREDENTIALS_FILE
```
public static final SdkSystemSetting AWS_SHARED_CREDENTIALS_FILE
```
    Configure the default credentials file used in the ProfileFile. 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.
  - AWS_ACCESS_KEY_ID
```
public static final SdkSystemSetting AWS_ACCESS_KEY_ID
```
    Configure the AWS access key ID. This value will not be ignored if the AWS_SECRET_ACCESS_KEY is not specified.
  - AWS_SECRET_ACCESS_KEY
```
public static final SdkSystemSetting AWS_SECRET_ACCESS_KEY
```
    Configure the AWS secret access key. This value will not be ignored if the AWS_ACCESS_KEY_ID is not specified.
  - AWS_SESSION_TOKEN
```
public static final SdkSystemSetting AWS_SESSION_TOKEN
```
    Configure the AWS session token.
  - AWS_REGION
```
public static final SdkSystemSetting AWS_REGION
```
    Configure the default region.
  - AWS_EC2_METADATA_DISABLED
```
public static final SdkSystemSetting AWS_EC2_METADATA_DISABLED
```
    Whether to load information such as credentials, regions from EC2 Metadata instance service.
  - AWS_EC2_METADATA_SERVICE_ENDPOINT
```
public static final SdkSystemSetting 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_CONTAINER_SERVICE_ENDPOINT
```
public static final SdkSystemSetting 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 the AWS_CONTAINER_CREDENTIALS_RELATIVE_URI is not specified.
  - AWS_CONTAINER_CREDENTIALS_RELATIVE_URI
```
public static final SdkSystemSetting 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 SdkSystemSetting AWS_CONTAINER_CREDENTIALS_FULL_URI
```
    The full URI path to a localhost metadata service to be used.
  - AWS_CONTAINER_AUTHORIZATION_TOKEN
```
public static final SdkSystemSetting AWS_CONTAINER_AUTHORIZATION_TOKEN
```
    An authorization token to pass to a container metadata service, only used when AWS_CONTAINER_CREDENTIALS_FULL_URI is specified.
    
    See Also:
    
    AWS_CONTAINER_CREDENTIALS_FULL_URI
  - SYNC_HTTP_SERVICE_IMPL
```
public static final SdkSystemSetting 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
```
public static final SdkSystemSetting 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
```
public static final SdkSystemSetting 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
```
public static final SdkSystemSetting BINARY_ION_ENABLED
```
    Whether binary ION representation optimization should automatically be used if the service supports ION.
  - AWS_EXECUTION_ENV
```
public static final SdkSystemSetting 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.
- Method Detail
  - values
```
public static SdkSystemSetting[] 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 (SdkSystemSetting c : SdkSystemSetting.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static SdkSystemSetting 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 SdkSystemSetting

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_CONFIG_FILE

AWS_PROFILE

AWS_SHARED_CREDENTIALS_FILE

AWS_ACCESS_KEY_ID

AWS_SECRET_ACCESS_KEY

AWS_SESSION_TOKEN

AWS_REGION

AWS_EC2_METADATA_DISABLED

AWS_EC2_METADATA_SERVICE_ENDPOINT

AWS_CONTAINER_SERVICE_ENDPOINT

AWS_CONTAINER_CREDENTIALS_RELATIVE_URI

AWS_CONTAINER_CREDENTIALS_FULL_URI

AWS_CONTAINER_AUTHORIZATION_TOKEN

SYNC_HTTP_SERVICE_IMPL

ASYNC_HTTP_SERVICE_IMPL

CBOR_ENABLED

BINARY_ION_ENABLED

AWS_EXECUTION_ENV

Method Detail

values

valueOf

property

environmentVariable

defaultValue