Class SDKGlobalConfiguration
- java.lang.Object
-
- com.amazonaws.SDKGlobalConfiguration
-
public class SDKGlobalConfiguration extends Object
SDKGlobalConfiguration is to configure any global settings
-
-
Field Summary
Fields Modifier and Type Field Description static StringACCESS_KEY_ENV_VAREnvironment variable name for the AWS access key IDstatic StringACCESS_KEY_SYSTEM_PROPERTYSystem property name for the AWS access key IDstatic StringALTERNATE_ACCESS_KEY_ENV_VARAlternate environment variable name for the AWS access key IDstatic StringALTERNATE_SECRET_KEY_ENV_VARAlternate environment variable name for the AWS secret keystatic StringAWS_CBOR_DISABLE_ENV_VAREnvironment variable to disable CBOR protocol.static StringAWS_CBOR_DISABLE_SYSTEM_PROPERTYSystem property to disable CBOR protocol.static StringAWS_SESSION_TOKEN_ENV_VAREnvironment variable name for the AWS session tokenstatic StringDEFAULT_METRICS_SYSTEM_PROPERTYSystem 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 StringDEFAULT_S3_STREAM_BUFFER_SIZEDeprecated.static StringDISABLE_CERT_CHECKING_SYSTEM_PROPERTYDisable validation of server certificates when using the HTTPS protocol.static StringDISABLE_REMOTE_REGIONS_FILE_SYSTEM_PROPERTYBy default, the SDK will attempt to download an up-to-date set of region metadata from Amazon CloudFront when first required.static StringEC2_METADATA_SERVICE_OVERRIDE_SYSTEM_PROPERTYSystem property for overriding the Amazon EC2 Instance Metadata Service endpoint.static StringENABLE_IN_REGION_OPTIMIZED_MODEOverrides the client defaultClientConfigurationto use configuration with values tailored towards clients operating in the same AWS region as the service endpoint they call.static StringENABLE_S3_SIGV4_SYSTEM_PROPERTYDeprecated.static StringENFORCE_S3_SIGV4_SYSTEM_PROPERTYDeprecated.static StringPROFILING_SYSTEM_PROPERTYDeprecated.static StringREGIONS_FILE_OVERRIDE_SYSTEM_PROPERTYPath to an override file for the region metadata loaded by the SDK that maps service/region pairs to endpoints and vice versa.static StringRETRY_THROTTLING_SYSTEM_PROPERTYSystem property for enabling retry throttling.static StringSECRET_KEY_ENV_VAREnvironment variable name for the AWS secret keystatic StringSECRET_KEY_SYSTEM_PROPERTYSystem property name for the AWS secret key
-
Constructor Summary
Constructors Constructor Description SDKGlobalConfiguration()
-
Method Summary
All Methods Static Methods Concrete Methods Deprecated Methods Modifier and Type Method Description static intgetGlobalTimeOffset()Deprecated.static booleanisCborDisabled()static booleanisCertCheckingDisabled()static booleanisInRegionOptimizedModeEnabled()static voidsetGlobalTimeOffset(int timeOffset)Deprecated.
-
-
-
Field Detail
-
DISABLE_CERT_CHECKING_SYSTEM_PROPERTY
public static final String DISABLE_CERT_CHECKING_SYSTEM_PROPERTY
Disable validation of server certificates when using the HTTPS protocol. This should ONLY be used to do quick smoke tests against endpoints which don't yet have valid certificates; it should NEVER be used in production. This property is meant to be used as a flag (i.e. -Dcom.amazonaws.sdk.disableCertChecking) rather then taking a value (-Dcom.amazonaws.sdk.disableCertChecking=true). This property is treated as false by default (i.e. check certificates by default)- See Also:
- Constant Field Values
-
DEFAULT_METRICS_SYSTEM_PROPERTY
public static final 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.Example: -Dcom.amazonaws.sdk.enableDefaultMetrics
- See Also:
- Constant Field Values
-
ACCESS_KEY_SYSTEM_PROPERTY
public static final String ACCESS_KEY_SYSTEM_PROPERTY
System property name for the AWS access key ID- See Also:
- Constant Field Values
-
SECRET_KEY_SYSTEM_PROPERTY
public static final String SECRET_KEY_SYSTEM_PROPERTY
System property name for the AWS secret key- See Also:
- Constant Field Values
-
EC2_METADATA_SERVICE_OVERRIDE_SYSTEM_PROPERTY
public static final String EC2_METADATA_SERVICE_OVERRIDE_SYSTEM_PROPERTY
System property for overriding the Amazon EC2 Instance Metadata Service endpoint.- See Also:
- Constant Field Values
-
RETRY_THROTTLING_SYSTEM_PROPERTY
public static final String RETRY_THROTTLING_SYSTEM_PROPERTY
System property for enabling retry throttling.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.
- See Also:
- Constant Field Values
-
REGIONS_FILE_OVERRIDE_SYSTEM_PROPERTY
public static final 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.- See Also:
- Constant Field Values
-
DISABLE_REMOTE_REGIONS_FILE_SYSTEM_PROPERTY
public static final 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. This allows you to look up information about new regions and services without having to download a new version of the SDK every time.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
nullwill 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.- See Also:
- Constant Field Values
-
ENABLE_S3_SIGV4_SYSTEM_PROPERTY
@Deprecated public static final String ENABLE_S3_SIGV4_SYSTEM_PROPERTY
Deprecated.By default, the AmazonS3Client will continue to use the legacy S3Signer to authenticate requests it makes to S3 in regions that support the older protocol. Setting this property to anything other than null will cause the client to upgrade to Signature Version 4 whenever it has been configured with an explicit region (which is a required parameter for Signature Version 4). The client will continue to use the older signature protocol when not configured with a region to avoid breaking existing applications.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.
- See Also:
- Constant Field Values
-
ENFORCE_S3_SIGV4_SYSTEM_PROPERTY
@Deprecated public static final String ENFORCE_S3_SIGV4_SYSTEM_PROPERTY
Deprecated.LikeENABLE_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.- See Also:
- Constant Field Values
-
ENABLE_IN_REGION_OPTIMIZED_MODE
public static final String ENABLE_IN_REGION_OPTIMIZED_MODE
Overrides the client defaultClientConfigurationto 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.- See Also:
- Constant Field Values
-
DEFAULT_S3_STREAM_BUFFER_SIZE
@Deprecated public static final String DEFAULT_S3_STREAM_BUFFER_SIZE
Deprecated.withAmazonWebServiceRequest.getRequestClientOptions()andRequestClientOptions.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.
- See Also:
- Constant Field Values
-
PROFILING_SYSTEM_PROPERTY
@Deprecated public static final String PROFILING_SYSTEM_PROPERTY
Deprecated.byDEFAULT_METRICS_SYSTEM_PROPERTY. Internal system property to enable timing info collection.- See Also:
- Constant Field Values
-
ACCESS_KEY_ENV_VAR
public static final String ACCESS_KEY_ENV_VAR
Environment variable name for the AWS access key ID- See Also:
- Constant Field Values
-
ALTERNATE_ACCESS_KEY_ENV_VAR
public static final String ALTERNATE_ACCESS_KEY_ENV_VAR
Alternate environment variable name for the AWS access key ID- See Also:
- Constant Field Values
-
SECRET_KEY_ENV_VAR
public static final String SECRET_KEY_ENV_VAR
Environment variable name for the AWS secret key- See Also:
- Constant Field Values
-
ALTERNATE_SECRET_KEY_ENV_VAR
public static final String ALTERNATE_SECRET_KEY_ENV_VAR
Alternate environment variable name for the AWS secret key- See Also:
- Constant Field Values
-
AWS_SESSION_TOKEN_ENV_VAR
public static final String AWS_SESSION_TOKEN_ENV_VAR
Environment variable name for the AWS session token- See Also:
- Constant Field Values
-
AWS_CBOR_DISABLE_ENV_VAR
public static final String AWS_CBOR_DISABLE_ENV_VAR
Environment variable to disable CBOR protocol. This forces the request to be sent over the wire as a AWS JSON.- See Also:
- Constant Field Values
-
AWS_CBOR_DISABLE_SYSTEM_PROPERTY
public static final String AWS_CBOR_DISABLE_SYSTEM_PROPERTY
System property to disable CBOR protocol. This forces the request to be sent over the wire as a AWS JSON- See Also:
- Constant Field Values
-
-
Method Detail
-
setGlobalTimeOffset
@Deprecated public static void setGlobalTimeOffset(int timeOffset)
Deprecated.
-
getGlobalTimeOffset
@Deprecated public static int getGlobalTimeOffset()
Deprecated.
-
isInRegionOptimizedModeEnabled
public static boolean isInRegionOptimizedModeEnabled()
-
isCertCheckingDisabled
public static boolean isCertCheckingDisabled()
-
isCborDisabled
public static boolean isCborDisabled()
-
-