public class SDKGlobalConfiguration extends Object
Modifier and Type | Field and Description |
---|---|
static String |
ACCESS_KEY_ENV_VAR
Environment variable name for the AWS access key ID
|
static String |
ACCESS_KEY_SYSTEM_PROPERTY
System property name for the AWS access key ID
|
static String |
ALTERNATE_ACCESS_KEY_ENV_VAR
Alternate environment variable name for the AWS access key ID
|
static String |
ALTERNATE_SECRET_KEY_ENV_VAR
Alternate environment variable name for the AWS secret key
|
static String |
AWS_CBOR_DISABLE_ENV_VAR
Environment variable to disable CBOR protocol.
|
static String |
AWS_CBOR_DISABLE_SYSTEM_PROPERTY
System property to disable CBOR protocol.
|
static String |
AWS_CONFIG_FILE_ENV_VAR
Environment variable to set an alternate path to the shared config file (default path is
~/.aws/config).
|
static String |
AWS_CSM_CLIENT_ID_ENV_VAR
Environment variable to set the client ID to use for client side
monitoring events.
|
static String |
AWS_CSM_CLIENT_ID_SYSTEM_PROPERTY
System property to set the client ID to use for client side monitoring
events.
|
static String |
AWS_CSM_ENABLED_ENV_VAR |
static String |
AWS_CSM_ENABLED_SYSTEM_PROPERTY
System property to enable/disable client side monitoring.
|
static String |
AWS_CSM_PORT_ENV_VAR
Environment varaible to set the port of the out of process client side
monitoring agent.
|
static String |
AWS_CSM_PORT_SYSTEM_PROPERTY
System property to set the port of the out of process client side
monitoring agent.
|
static String |
AWS_EC2_METADATA_DISABLED_ENV_VAR
Environment variable to disable loading credentials or regions from EC2 Metadata instance service.
|
static String |
AWS_EC2_METADATA_DISABLED_SYSTEM_PROPERTY
System property to disable loading credentials or regions from EC2 Metadata instance service.
|
static String |
AWS_ION_BINARY_DISABLE_ENV_VAR
Environment variable to disable Ion binary protocol.
|
static String |
AWS_ION_BINARY_DISABLE_SYSTEM_PROPERTY
System property to disable Ion binary protocol.
|
static String |
AWS_REGION_ENV_VAR
Environment variable containing region used to configure clients.
|
static String |
AWS_REGION_SYSTEM_PROPERTY
System property for the AWS region to use when creating clients.
|
static String |
AWS_SESSION_TOKEN_ENV_VAR
Environment variable name for the AWS session token
|
static String |
DEFAULT_AWS_CSM_CLIENT_ID
The default client Id used by client side monitoring.
|
static int |
DEFAULT_AWS_CSM_PORT
The default port used by client side monitoring.
|
static String |
DEFAULT_METRICS_SYSTEM_PROPERTY
System property used when starting up the JVM to enable the default
metrics collected by the AWS SDK, which uploads the derived statistics
to Amazon CloudWatch.
|
static String |
DEFAULT_S3_STREAM_BUFFER_SIZE
Deprecated.
with
AmazonWebServiceRequest.getRequestClientOptions()
and RequestClientOptions.setReadLimit(int) .
The default size of the buffer when uploading data from a stream. A buffer of this size will be created and filled with the first bytes from a stream being uploaded so that any transmit errors that occur in that section of the data can be automatically retried without the caller's intervention. If not set, the default value of 128 KB will be used. |
static String |
DISABLE_CERT_CHECKING_SYSTEM_PROPERTY
Disable validation of server certificates when using the HTTPS protocol.
|
static String |
DISABLE_REMOTE_REGIONS_FILE_SYSTEM_PROPERTY
By default, the SDK will attempt to download an up-to-date set of
region metadata from Amazon CloudFront when first required.
|
static String |
DISABLE_S3_IMPLICIT_GLOBAL_CLIENTS_SYSTEM_PROPERTY
By default, the S3 client constructor does not set a region.
|
static String |
EC2_METADATA_SERVICE_OVERRIDE_SYSTEM_PROPERTY
System property for overriding the Amazon EC2 Instance Metadata Service
endpoint.
|
static String |
ENABLE_IN_REGION_OPTIMIZED_MODE
Overrides the client default
ClientConfiguration to use
configuration with values tailored towards clients operating in the
same AWS region as the service endpoint they call. |
static String |
ENABLE_S3_SIGV4_SYSTEM_PROPERTY
Deprecated.
|
static String |
ENFORCE_S3_SIGV4_SYSTEM_PROPERTY
Deprecated.
|
static String |
PROFILING_SYSTEM_PROPERTY
Deprecated.
by
DEFAULT_METRICS_SYSTEM_PROPERTY .
Internal system property to enable timing info collection. |
static String |
REGIONS_FILE_OVERRIDE_SYSTEM_PROPERTY
Path to an override file for the region metadata loaded by the SDK
that maps service/region pairs to endpoints and vice versa.
|
static String |
RETRY_THROTTLING_SYSTEM_PROPERTY
System property for enabling retry throttling.
|
static String |
SECRET_KEY_ENV_VAR
Environment variable name for the AWS secret key
|
static String |
SECRET_KEY_SYSTEM_PROPERTY
System property name for the AWS secret key
|
static String |
SESSION_TOKEN_SYSTEM_PROPERTY
System property name for the AWS session token
|
Constructor and Description |
---|
SDKGlobalConfiguration() |
Modifier and Type | Method and Description |
---|---|
static int |
getGlobalTimeOffset()
Deprecated.
|
static boolean |
isCborDisabled() |
static boolean |
isCertCheckingDisabled() |
static boolean |
isEc2MetadataDisabled() |
static boolean |
isInRegionOptimizedModeEnabled() |
static boolean |
isIonBinaryDisabled() |
static void |
setGlobalTimeOffset(int timeOffset)
Deprecated.
|
public static final String DISABLE_CERT_CHECKING_SYSTEM_PROPERTY
public static final String DEFAULT_METRICS_SYSTEM_PROPERTY
Example: -Dcom.amazonaws.sdk.enableDefaultMetrics
public static final String ACCESS_KEY_SYSTEM_PROPERTY
public static final String SECRET_KEY_SYSTEM_PROPERTY
public static final String SESSION_TOKEN_SYSTEM_PROPERTY
public static final String AWS_REGION_SYSTEM_PROPERTY
DefaultAwsRegionProviderChain
.public static final String EC2_METADATA_SERVICE_OVERRIDE_SYSTEM_PROPERTY
public static final String RETRY_THROTTLING_SYSTEM_PROPERTY
Retry throttling is a feature which intelligently throttles retry attempts when a large percentage of requests are failing and retries are unsuccessful, particularly in scenarios of degraded service health. In these situations the client will drain its internal retry capacity and slowly roll off from retry attempts until requests begin to succeed again. At that point the retry capacity pool will begin to refill and retries will once again be permitted
In situations where retries have been throttled this feature will effectively result in fail-fast behavior from the client. Because retries are circumvented exceptions will be immediately returned to the caller if the initial request is unsuccessful. This will result in a greater number of exceptions being returned up front but prevents requests being tied up attempting subsequent retries which are also likely to fail.
public static final String REGIONS_FILE_OVERRIDE_SYSTEM_PROPERTY
public static final String DISABLE_REMOTE_REGIONS_FILE_SYSTEM_PROPERTY
If the SDK cannot download region metadata from Amazon CloudFront, it will fall back to loading the region metadata bundled with the SDK when it was released, which may be out of date.
Setting this system property to anything other than null
will
disable this remote fetching, and will only load region
metadata that was bundled with the SDK. This gives you control over
when new region metadata will be picked up by your application, and
isolates you from potential issues if your application depends on being
able to load metadata about a region which is not included in your
version of the SDK and therefore may not be available in the event of
network outages.
@Deprecated public static final String ENABLE_S3_SIGV4_SYSTEM_PROPERTY
Signature Version 4 is more secure than the legacy S3Signer, but requires calculating a SHA-256 hash of the entire request body which can be expensive for large upload requests.
@Deprecated public static final String ENFORCE_S3_SIGV4_SYSTEM_PROPERTY
ENABLE_S3_SIGV4_SYSTEM_PROPERTY
, but causes the client to
always use Signature Version 4, assuming a region of
"us-east-1" if no explicit region has been configured. This
guarantees that the more secure authentication protocol will be used,
but will cause authentication failures in code that accesses buckets in
regions other than US Standard without explicitly configuring a region.public static final String DISABLE_S3_IMPLICIT_GLOBAL_CLIENTS_SYSTEM_PROPERTY
If the client is not configured with an explicit region, bucket operations
(eg. listObjects
) will attempt to determine the bucket's region the first
time that bucket is seen. This may result in a cross-region call.
Setting this system property to anything other than null
or
false
will disable this implicit fixed-region invocation,
and any attempt to use a regionless client will fail with an IllegalStateException.
This allows SDK users to force all S3 clients to be created with a region defined,
so that calls to unintended regions are avoided.
Note: Even with this option enabled, SDK users can still create clients not
attached to fixed regions using specific opt-in methods on the S3 client builder.
For instance, the enableGlobalBucketAccess
option explicitly allows
creation of a client that will automatically identify the location of a bucket via
a call to a single, fixed region.
public static final String ENABLE_IN_REGION_OPTIMIZED_MODE
ClientConfiguration
to use
configuration with values tailored towards clients operating in the
same AWS region as the service endpoint they call. Timeouts in
in-region optimized configurations are generally set much lower than
the client standard configuration.@Deprecated public static final String DEFAULT_S3_STREAM_BUFFER_SIZE
AmazonWebServiceRequest.getRequestClientOptions()
and RequestClientOptions.setReadLimit(int)
.
The default size of the buffer when uploading data from a stream. A buffer of this size will be created and filled with the first bytes from a stream being uploaded so that any transmit errors that occur in that section of the data can be automatically retried without the caller's intervention.
If not set, the default value of 128 KB will be used.
@Deprecated public static final String PROFILING_SYSTEM_PROPERTY
DEFAULT_METRICS_SYSTEM_PROPERTY
.
Internal system property to enable timing info collection.public static final int DEFAULT_AWS_CSM_PORT
public static final String DEFAULT_AWS_CSM_CLIENT_ID
public static final String AWS_CSM_ENABLED_SYSTEM_PROPERTY
public static final String AWS_CSM_PORT_SYSTEM_PROPERTY
public static final String AWS_CSM_CLIENT_ID_SYSTEM_PROPERTY
public static final String ACCESS_KEY_ENV_VAR
public static final String ALTERNATE_ACCESS_KEY_ENV_VAR
public static final String SECRET_KEY_ENV_VAR
public static final String ALTERNATE_SECRET_KEY_ENV_VAR
public static final String AWS_SESSION_TOKEN_ENV_VAR
public static final String AWS_REGION_ENV_VAR
public static final String AWS_CONFIG_FILE_ENV_VAR
public static final String AWS_CBOR_DISABLE_ENV_VAR
public static final String AWS_CBOR_DISABLE_SYSTEM_PROPERTY
public static final String AWS_ION_BINARY_DISABLE_ENV_VAR
public static final String AWS_ION_BINARY_DISABLE_SYSTEM_PROPERTY
public static final String AWS_EC2_METADATA_DISABLED_ENV_VAR
public static final String AWS_EC2_METADATA_DISABLED_SYSTEM_PROPERTY
public static final String AWS_CSM_ENABLED_ENV_VAR
public static final String AWS_CSM_PORT_ENV_VAR
public static final String AWS_CSM_CLIENT_ID_ENV_VAR
@Deprecated public static void setGlobalTimeOffset(int timeOffset)
SDKGlobalTime.setGlobalTimeOffset(int)
@Deprecated public static int getGlobalTimeOffset()
SDKGlobalTime.getGlobalTimeOffset()
public static boolean isInRegionOptimizedModeEnabled()
public static boolean isCertCheckingDisabled()
public static boolean isCborDisabled()
public static boolean isIonBinaryDisabled()
public static boolean isEc2MetadataDisabled()
Copyright © 2019. All rights reserved.