JavaScript is disabled on your browser.
Skip navigation links

AWS SDK for Java 1.x API Reference - 1.12.793

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.
com.amazonaws

Class SDKGlobalConfiguration



  • public class SDKGlobalConfiguration
    extends Object 
    SDKGlobalConfiguration is to configure any global settings
    • 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
      • AWS_ACCOUNT_ID_SYSTEM_PROPERTY

        public static final String AWS_ACCOUNT_ID_SYSTEM_PROPERTY
        System property name for the AWS account ID
        See Also:
        Constant Field Values
      • SESSION_TOKEN_SYSTEM_PROPERTY

        public static final String SESSION_TOKEN_SYSTEM_PROPERTY
        System property name for the AWS session token
        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
      • EC2_METADATA_SERVICE_OVERRIDE_ENV_VAR

        public static final String EC2_METADATA_SERVICE_OVERRIDE_ENV_VAR
        Environment variable for overriding the Amazon EC2 Instance Metadata Service endpoint.
        See Also:
        Constant Field Values
      • AWS_METADATA_SERVICE_TIMEOUT_ENV_VAR

        public static final String AWS_METADATA_SERVICE_TIMEOUT_ENV_VAR
        The number of seconds (either as an integer or double) before a connection to the instance metadata service should time out. This is used for both the socket connect and read timeouts.
        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 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.

        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.
        Like 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.
        See Also:
        Constant Field Values
      • DISABLE_S3_IMPLICIT_GLOBAL_CLIENTS_SYSTEM_PROPERTY

        public static final String DISABLE_S3_IMPLICIT_GLOBAL_CLIENTS_SYSTEM_PROPERTY
        By default, the S3 client constructor does not set a region.

        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.

        See Also:
        Constant Field Values
      • ENABLE_IN_REGION_OPTIMIZED_MODE

        public static final 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. Timeouts in in-region optimized configurations are generally set much lower than the client standard configuration.
        See Also:
        Constant Field Values
      • DEFAULT_AWS_CSM_HOST

        public static final String DEFAULT_AWS_CSM_HOST
        The default host used by client side monitoring.
        See Also:
        Constant Field Values
      • DEFAULT_AWS_CSM_PORT

        public static final int DEFAULT_AWS_CSM_PORT
        The default port used by client side monitoring.
        See Also:
        Constant Field Values
      • DEFAULT_AWS_CSM_CLIENT_ID

        public static final String DEFAULT_AWS_CSM_CLIENT_ID
        The default client Id used by client side monitoring.
        See Also:
        Constant Field Values
      • AWS_CSM_ENABLED_SYSTEM_PROPERTY

        public static final String AWS_CSM_ENABLED_SYSTEM_PROPERTY
        System property to enable/disable client side monitoring.
        See Also:
        Constant Field Values
      • AWS_CSM_HOST_SYSTEM_PROPERTY

        public static final String AWS_CSM_HOST_SYSTEM_PROPERTY
        System property to set the host that will receive the client side monitoring events.
        See Also:
        Constant Field Values
      • AWS_CSM_PORT_SYSTEM_PROPERTY

        public static final String AWS_CSM_PORT_SYSTEM_PROPERTY
        System property to set the port of the out of process client side monitoring agent.
        See Also:
        Constant Field Values
      • AWS_CSM_CLIENT_ID_SYSTEM_PROPERTY

        public static final String AWS_CSM_CLIENT_ID_SYSTEM_PROPERTY
        System property to set the client ID to use for client side monitoring events.
        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_ACCOUNT_ID_ENV_VAR

        public static final String AWS_ACCOUNT_ID_ENV_VAR
        Environment variable name for the AWS account ID
        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_WEB_IDENTITY_ENV_VAR

        public static final String AWS_WEB_IDENTITY_ENV_VAR
        Environment variable name for the AWS Web Identity Token File Path
        See Also:
        Constant Field Values
      • AWS_ROLE_ARN_ENV_VAR

        public static final String AWS_ROLE_ARN_ENV_VAR
        Environment variable name for the AWS role arn
        See Also:
        Constant Field Values
      • AWS_ROLE_SESSION_NAME_ENV_VAR

        public static final String AWS_ROLE_SESSION_NAME_ENV_VAR
        Environment variable name for the AWS role arn
        See Also:
        Constant Field Values
      • AWS_REGION_ENV_VAR

        public static final String AWS_REGION_ENV_VAR
        Environment variable containing region used to configure clients.
        See Also:
        Constant Field Values
      • AWS_CONFIG_FILE_ENV_VAR

        public static final String AWS_CONFIG_FILE_ENV_VAR
        Environment variable to set an alternate path to the shared config file (default path is ~/.aws/config).
        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
      • AWS_ION_BINARY_DISABLE_ENV_VAR

        public static final String AWS_ION_BINARY_DISABLE_ENV_VAR
        Environment variable to disable Ion binary protocol. This forces the request to be sent over the wire as Ion text.
        See Also:
        Constant Field Values
      • AWS_ION_BINARY_DISABLE_SYSTEM_PROPERTY

        public static final String AWS_ION_BINARY_DISABLE_SYSTEM_PROPERTY
        System property to disable Ion binary protocol. This forces the request to be sent over the wire as Ion text
        See Also:
        Constant Field Values
      • AWS_EC2_METADATA_DISABLED_ENV_VAR

        public static final String AWS_EC2_METADATA_DISABLED_ENV_VAR
        Environment variable to disable loading credentials or regions from EC2 Metadata instance service.
        See Also:
        Constant Field Values
      • AWS_EC2_METADATA_DISABLED_SYSTEM_PROPERTY

        public static final String AWS_EC2_METADATA_DISABLED_SYSTEM_PROPERTY
        System property to disable loading credentials or regions from EC2 Metadata instance service.
        See Also:
        Constant Field Values
      • AWS_EC2_METADATA_V1_DISABLED_ENV_VAR

        public static final String AWS_EC2_METADATA_V1_DISABLED_ENV_VAR
        Environment variable to disable fallback to IMDS v1.
        See Also:
        Constant Field Values
      • AWS_EC2_METADATA_V1_DISABLED_SYSTEM_PROPERTY

        public static final String AWS_EC2_METADATA_V1_DISABLED_SYSTEM_PROPERTY
        System property to disable fallback to IMDS v1.
        See Also:
        Constant Field Values
      • AWS_EC2_METADATA_V1_DISABLED_PROFILE_PROPERTY

        public static final String AWS_EC2_METADATA_V1_DISABLED_PROFILE_PROPERTY
        Profile file property to disable fallback to IMDS v1.
        See Also:
        Constant Field Values
      • AWS_CSM_ENABLED_ENV_VAR

        public static final String AWS_CSM_ENABLED_ENV_VAR
        Environment variable to enable/disable client side monitoring.
        See Also:
        Constant Field Values
      • AWS_CSM_HOST_ENV_VAR

        public static final String AWS_CSM_HOST_ENV_VAR
        Environment variable to set the host to send client side monitor events to.
        See Also:
        Constant Field Values
      • AWS_CSM_PORT_ENV_VAR

        public static final String AWS_CSM_PORT_ENV_VAR
        Environment varaible to set the port of the out of process client side monitoring agent.
        See Also:
        Constant Field Values
      • AWS_CSM_CLIENT_ID_ENV_VAR

        public static final String AWS_CSM_CLIENT_ID_ENV_VAR
        Environment variable to set the client ID to use for client side monitoring events.
        See Also:
        Constant Field Values
      • AWS_RETRY_MODE_SYSTEM_PROPERTY

        public static final String AWS_RETRY_MODE_SYSTEM_PROPERTY
        System properties to set the retry mode to use. See RetryMode for available values
        See Also:
        Constant Field Values
      • AWS_RETRY_MODE_ENV_VAR

        public static final String AWS_RETRY_MODE_ENV_VAR
        Environment variable to set the retry mode to use. See RetryMode for available values
        See Also:
        Constant Field Values
      • AWS_ACCOUNT_ID_ENDPOINT_MODE_SYSTEM_PROPERTY

        public static final String AWS_ACCOUNT_ID_ENDPOINT_MODE_SYSTEM_PROPERTY
        System properties to set the account id endpoint mode to use. See AccountIdEndpointMode for available values
        See Also:
        Constant Field Values
      • AWS_ACCOUNT_ID_ENDPOINT_MODE_ENV_VAR

        public static final String AWS_ACCOUNT_ID_ENDPOINT_MODE_ENV_VAR
        Environment variable to set the account id endpoint mode to use. See AccountIdEndpointMode for available values
        See Also:
        Constant Field Values
      • AWS_MAX_ATTEMPTS_SYSTEM_PROPERTY

        public static final String AWS_MAX_ATTEMPTS_SYSTEM_PROPERTY
        System properties to set the retry max attempts
        See Also:
        Constant Field Values
      • AWS_MAX_ATTEMPTS_ENV_VAR

        public static final String AWS_MAX_ATTEMPTS_ENV_VAR
        Environment variable to set the retry max attempts
        See Also:
        Constant Field Values
    • Constructor Detail

      • SDKGlobalConfiguration

        public SDKGlobalConfiguration()
    • Method Detail

      • isInRegionOptimizedModeEnabled

        public static boolean isInRegionOptimizedModeEnabled()
      • isCertCheckingDisabled

        public static boolean isCertCheckingDisabled()
      • isCborDisabled

        public static boolean isCborDisabled()
      • isIonBinaryDisabled

        public static boolean isIonBinaryDisabled()
      • isEc2MetadataDisabled

        public static boolean isEc2MetadataDisabled()
      • isEc2MetadataV1Disabled

        public static boolean isEc2MetadataV1Disabled()
Skip navigation links

AltStyle によって変換されたページ (->オリジナル) /