com.ibm.cos.v2.core

Enum SdkSystemSetting

java.lang.Object

java.lang.Enum<SdkSystemSetting>

com.ibm.cos.v2.core.SdkSystemSetting

All Implemented Interfaces:

SystemSetting, Serializable, Comparable<SdkSystemSetting>

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_ACCOUNT_ID Configure the AWS account id associated with credentials supplied through system properties.
AWS_ACCOUNT_ID_ENDPOINT_MODE Which AccountIdEndpointMode to use, case insensitive
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_AUTHORIZATION_TOKEN_FILE The absolute file path containing the authorization token in plain text 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_DEFAULTS_MODE Which DefaultsMode to use, case insensitive
AWS_DISABLE_REQUEST_COMPRESSION Whether request compression is disabled for operations marked with the RequestCompression trait.
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_EC2_METADATA_SERVICE_ENDPOINT_MODE
AWS_EC2_METADATA_V1_DISABLED Whether to disable fallback to insecure EC2 Metadata instance service v1 on errors or timeouts.
AWS_ENDPOINT_DISCOVERY_ENABLED Whether endpoint discovery should be enabled.
AWS_EXECUTION_ENV The execution environment of the SDK user.
AWS_MAX_ATTEMPTS Defines the default value for RetryPolicy.Builder#numRetries(Integer), if the retry count is not overridden in the retry policy configured via ClientOverrideConfiguration.Builder#retryPolicy(RetryPolicy).
AWS_METADATA_SERVICE_TIMEOUT The number of seconds (either as an integer or double) before a connection to the instance metadata service should time out.
AWS_PARTITIONS_FILE Defines a file path from which partition metadata should be loaded.
AWS_REGION Configure the default region.
AWS_REQUEST_CHECKSUM_CALCULATION The request checksum calculation setting.
AWS_REQUEST_MIN_COMPRESSION_SIZE_BYTES Defines the minimum compression size in bytes, inclusive, for a request to be compressed.
AWS_RESPONSE_CHECKSUM_VALIDATION The response checksum validation setting.
AWS_RETRY_MODE Which RetryMode to use for the default RetryPolicy, when one is not specified at the client level.
AWS_ROLE_ARN Configure the AWS role arn.
AWS_ROLE_SESSION_NAME Configure the session name for a role.
AWS_S3_DISABLE_EXPRESS_SESSION_AUTH
AWS_S3_US_EAST_1_REGIONAL_ENDPOINT The S3 regional endpoint setting for the us-east-1 region.
AWS_SDK_UA_APP_ID Configure an optional identification value to be appended to the user agent header.
AWS_SECRET_ACCESS_KEY Configure the AWS secret access key.
AWS_SESSION_TOKEN Configure the AWS session token.
AWS_SIGV4A_SIGNING_REGION_SET Configure the SIGV4A signing region set.
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_WEB_IDENTITY_TOKEN_FILE Configure the AWS web identity token file path.
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.
IBM_API_KEY_ID Global System Property variable name for ibm api key
IBM_SERVICE_INSTANCE_ID Global System Property variable name for ibm service instance id
SYNC_HTTP_SERVICE_IMPL Explicitly identify the default synchronous HTTP implementation the SDK will use.

Method Summary

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

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.ibm.cos.v2.utils.SystemSetting

getBooleanValue, getBooleanValueOrThrow, getIntegerValue, getIntegerValueOrThrow, getNonDefaultStringValue, getStringValue, getStringValueFromEnvironmentVariable, getStringValueOrThrow

Enum Constant Detail

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_ACCOUNT_ID

public static final SdkSystemSetting AWS_ACCOUNT_ID

Configure the AWS account id associated with credentials supplied through system properties.

AWS_WEB_IDENTITY_TOKEN_FILE

public static final SdkSystemSetting AWS_WEB_IDENTITY_TOKEN_FILE

Configure the AWS web identity token file path.

AWS_ROLE_ARN

public static final SdkSystemSetting AWS_ROLE_ARN

Configure the AWS role arn.

AWS_ROLE_SESSION_NAME

public static final SdkSystemSetting AWS_ROLE_SESSION_NAME

Configure the session name for a role.

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_V1_DISABLED

public static final SdkSystemSetting 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

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_EC2_METADATA_SERVICE_ENDPOINT_MODE

public static final SdkSystemSetting AWS_EC2_METADATA_SERVICE_ENDPOINT_MODE

AWS_METADATA_SERVICE_TIMEOUT

public static final SdkSystemSetting AWS_METADATA_SERVICE_TIMEOUT

The number of seconds (either as an integer or double) before a connection to the instance metadata service should time out. This value is applied to both the socket connect and read timeouts. The timeout can be configured using the system property "aws.ec2MetadataServiceTimeout". If not set, a default timeout is used. This setting is crucial for ensuring timely responses from the instance metadata service in environments with varying network conditions.

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

AWS_CONTAINER_AUTHORIZATION_TOKEN_FILE

public static final SdkSystemSetting 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 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.

AWS_ENDPOINT_DISCOVERY_ENABLED

public static final SdkSystemSetting AWS_ENDPOINT_DISCOVERY_ENABLED

Whether endpoint discovery should be enabled.

AWS_S3_US_EAST_1_REGIONAL_ENDPOINT

public static final SdkSystemSetting AWS_S3_US_EAST_1_REGIONAL_ENDPOINT

The S3 regional endpoint setting for the us-east-1 region. Setting the value to regional causes the SDK to use the s3.us-east-1.amazonaws.com endpoint when using the US_EAST_1 region instead of the global s3.amazonaws.com. Using the regional endpoint is disabled by default.

AWS_S3_DISABLE_EXPRESS_SESSION_AUTH

public static final SdkSystemSetting AWS_S3_DISABLE_EXPRESS_SESSION_AUTH

AWS_RETRY_MODE

public static final SdkSystemSetting AWS_RETRY_MODE

Which RetryMode to use for the default RetryPolicy, when one is not specified at the client level.

AWS_MAX_ATTEMPTS

public static final SdkSystemSetting AWS_MAX_ATTEMPTS

Defines the default value for RetryPolicy.Builder#numRetries(Integer), if the retry count is not overridden in the retry policy configured via ClientOverrideConfiguration.Builder#retryPolicy(RetryPolicy). This is one more than the number of retries, so aws.maxAttempts = 1 is 0 retries.

AWS_DEFAULTS_MODE

public static final SdkSystemSetting AWS_DEFAULTS_MODE

Which DefaultsMode to use, case insensitive

AWS_ACCOUNT_ID_ENDPOINT_MODE

public static final SdkSystemSetting AWS_ACCOUNT_ID_ENDPOINT_MODE

Which AccountIdEndpointMode to use, case insensitive

AWS_USE_DUALSTACK_ENDPOINT

public static final SdkSystemSetting AWS_USE_DUALSTACK_ENDPOINT

Defines whether dualstack endpoints should be resolved during default endpoint resolution instead of non-dualstack endpoints.

AWS_USE_FIPS_ENDPOINT

public static final SdkSystemSetting AWS_USE_FIPS_ENDPOINT

Defines whether fips endpoints should be resolved during default endpoint resolution instead of non-fips endpoints.

AWS_DISABLE_REQUEST_COMPRESSION

public static final SdkSystemSetting 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

public static final SdkSystemSetting 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.

AWS_PARTITIONS_FILE

public static final SdkSystemSetting AWS_PARTITIONS_FILE

Defines a file path from which partition metadata should be loaded. If this isn't specified, the partition metadata deployed with the SDK client will be used instead.

AWS_REQUEST_CHECKSUM_CALCULATION

public static final SdkSystemSetting AWS_REQUEST_CHECKSUM_CALCULATION

The request checksum calculation setting. The default value is WHEN_SUPPORTED.

AWS_RESPONSE_CHECKSUM_VALIDATION

public static final SdkSystemSetting AWS_RESPONSE_CHECKSUM_VALIDATION

The response checksum validation setting. The default value is WHEN_SUPPORTED.

AWS_SDK_UA_APP_ID

public static final SdkSystemSetting AWS_SDK_UA_APP_ID

Configure an optional identification value to be appended to the user agent header. The value should be less than 50 characters in length and is null by default.

AWS_SIGV4A_SIGNING_REGION_SET

public static final SdkSystemSetting AWS_SIGV4A_SIGNING_REGION_SET

Configure the SIGV4A signing region set. This is a non-empty, comma-delimited list of AWS region names used during signing.

IBM_API_KEY_ID

public static final SdkSystemSetting IBM_API_KEY_ID

Global System Property variable name for ibm api key

IBM_SERVICE_INSTANCE_ID

public static final SdkSystemSetting IBM_SERVICE_INSTANCE_ID

Global System Property variable name for ibm service instance id

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