public enum AwsSystemSetting extends Enum<AwsSystemSetting> implements SystemSetting
JavaSystemSetting
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() . |
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.
|
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
getBooleanValue, getBooleanValueOrThrow, getStringValue, getStringValueOrThrow
public static final AwsSystemSetting AWS_ACCESS_KEY_ID
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.AwsCredentials
public static final AwsSystemSetting AWS_SECRET_ACCESS_KEY
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.AwsCredentials
public static final AwsSystemSetting AWS_SESSION_TOKEN
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.AwsSessionCredentials
public static final AwsSystemSetting AWS_REGION
SystemSettingsRegionProvider
. This value is checked by the
ClientBuilder
when no region is specified via ClientBuilder.region(Region)
.Region
public static final AwsSystemSetting AWS_CONFIG_FILE
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.ProfileCredentialsProvider
public static final AwsSystemSetting AWS_SHARED_CREDENTIALS_FILE
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.ProfileCredentialsProvider
public static final AwsSystemSetting AWS_PROFILE
AWS_CONFIG_FILE
and
AWS_SHARED_CREDENTIALS_FILE
when using configuration files for configuring the SDK.AWS_CONFIG_FILE
public static final AwsSystemSetting AWS_IN_REGION_OPTIMIZATION_ENABLED
public static final AwsSystemSetting AWS_EXECUTION_ENV
public static final AwsSystemSetting AWS_EC2_METADATA_SERVICE_ENDPOINT
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
.public static final AwsSystemSetting AWS_CONTAINER_SERVICE_ENDPOINT
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.public static final AwsSystemSetting AWS_CONTAINER_CREDENTIALS_RELATIVE_URI
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.AWS_CONTAINER_SERVICE_ENDPOINT
public static final AwsSystemSetting AWS_CONTAINER_CREDENTIALS_FULL_URI
ContainerCredentialsProvider
when
loading credentials. If this is not specified, credentials will not be automatically loaded from the container.public static final AwsSystemSetting AWS_CONTAINER_AUTHORIZATION_TOKEN
AWS_CONTAINER_CREDENTIALS_FULL_URI
is specified.AWS_CONTAINER_CREDENTIALS_FULL_URI
public static final AwsSystemSetting AWS_CBOR_ENABLED
public static final AwsSystemSetting AWS_BINARY_ION_ENABLED
public static AwsSystemSetting[] values()
for (AwsSystemSetting c : AwsSystemSetting.values()) System.out.println(c);
public static AwsSystemSetting valueOf(String name)
name
- the name of the enum constant to be returned.IllegalArgumentException
- if this enum type has no constant with the specified nameNullPointerException
- if the argument is nullpublic String property()
SystemSetting
property
in interface SystemSetting
public String environmentVariable()
SystemSetting
environmentVariable
in interface SystemSetting
public String defaultValue()
SystemSetting
defaultValue
in interface SystemSetting
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.