Class AwsClientOption<T>

java.lang.Object

software.amazon.awssdk.utils.AttributeMap.Key<T>

software.amazon.awssdk.core.client.config.ClientOption<T>

software.amazon.awssdk.awscore.client.config.AwsClientOption<T>

@SdkProtectedApi
public final class AwsClientOption<T>
extends ClientOption<T>

Field Summary

Fields

Modifier and Type	Field	Description
static final AwsClientOption<AccountIdEndpointMode>	ACCOUNT_ID_ENDPOINT_MODE	Option used by the rest of the SDK to read the DefaultsMode.
static final AwsClientOption<Region>	AWS_REGION	AWS Region the client was configured with.
static final AwsClientOption<Set<String>>	AWS_SIGV4A_SIGNING_REGION_SET	AWS Sigv4a signing region set used for computing multi-region request signatures.
static final AwsClientOption<DefaultsMode>	CONFIGURED_DEFAULTS_MODE	Configuration of the DEFAULTS_MODE.
static final AwsClientOption<IdentityProvider<? extends AwsCredentialsIdentity>>	CREDENTIALS_IDENTITY_PROVIDER
static final AwsClientOption<AwsCredentialsProvider>	CREDENTIALS_PROVIDER	Deprecated.
static final AwsClientOption<DefaultsMode>	DEFAULTS_MODE	Option used by the rest of the SDK to read the DefaultsMode.
static final AwsClientOption<Boolean>	DUALSTACK_ENDPOINT_ENABLED	Whether the SDK should resolve dualstack endpoints instead of default endpoints.
static final AwsClientOption<String>	ENDPOINT_PREFIX	The first part of the URL in the DNS name for the service.
static final ClientOption<Boolean>	FIPS_ENDPOINT_ENABLED	Whether the SDK should resolve fips endpoints instead of default endpoints.
static final AwsClientOption<String>	SERVICE_SIGNING_NAME	Scope name to use during signing of a request.
static final AwsClientOption<Region>	SIGNING_REGION	AWS Region to be used for signing the request.
static final AwsClientOption<IdentityProvider<? extends TokenIdentity>>	TOKEN_IDENTITY_PROVIDER	Option to specific the SdkTokenProvider to use for bearer token authorization.
static final AwsClientOption<SdkTokenProvider>	TOKEN_PROVIDER	Deprecated.
static final AwsClientOption<Boolean>	USE_GLOBAL_ENDPOINT	Option to specify whether global endpoint should be used.

Method Summary

Methods inherited from class software.amazon.awssdk.utils.AttributeMap.Key

convertValue, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

CREDENTIALS_PROVIDER

@Deprecated
public static final AwsClientOption<AwsCredentialsProvider> CREDENTIALS_PROVIDER

Deprecated.

This option is deprecated in favor of CREDENTIALS_IDENTITY_PROVIDER.

See Also:

• AwsClientBuilder.credentialsProvider(AwsCredentialsProvider)

CREDENTIALS_IDENTITY_PROVIDER

public static final AwsClientOption<IdentityProvider<? extends AwsCredentialsIdentity>> CREDENTIALS_IDENTITY_PROVIDER

See Also:

• AwsClientBuilder.credentialsProvider(IdentityProvider)

AWS_REGION

public static final AwsClientOption<Region> AWS_REGION

AWS Region the client was configured with. Note that this is not always the signing region in the case of global services like IAM.

SIGNING_REGION

public static final AwsClientOption<Region> SIGNING_REGION

AWS Region to be used for signing the request. This is not always same as AWS_REGION in case of global services.

DUALSTACK_ENDPOINT_ENABLED

public static final AwsClientOption<Boolean> DUALSTACK_ENDPOINT_ENABLED

Whether the SDK should resolve dualstack endpoints instead of default endpoints. See AwsClientBuilder.dualstackEnabled(Boolean).

AWS_SIGV4A_SIGNING_REGION_SET

public static final AwsClientOption<Set<String>> AWS_SIGV4A_SIGNING_REGION_SET

AWS Sigv4a signing region set used for computing multi-region request signatures.

FIPS_ENDPOINT_ENABLED

public static final ClientOption<Boolean> FIPS_ENDPOINT_ENABLED

Whether the SDK should resolve fips endpoints instead of default endpoints. See AwsClientBuilder.fipsEnabled(Boolean).

SERVICE_SIGNING_NAME

public static final AwsClientOption<String> SERVICE_SIGNING_NAME

Scope name to use during signing of a request.

ENDPOINT_PREFIX

public static final AwsClientOption<String> ENDPOINT_PREFIX

The first part of the URL in the DNS name for the service. Eg. in the endpoint "dynamodb.amazonaws.com", this is the "dynamodb". For standard services, this should match the "endpointPrefix" field in the AWS model.

CONFIGURED_DEFAULTS_MODE

public static final AwsClientOption<DefaultsMode> CONFIGURED_DEFAULTS_MODE

Configuration of the DEFAULTS_MODE. Unlike DEFAULTS_MODE, this may be DefaultsMode.AUTO.

DEFAULTS_MODE

public static final AwsClientOption<DefaultsMode> DEFAULTS_MODE

Option used by the rest of the SDK to read the DefaultsMode. This will never be DefaultsMode.AUTO.

ACCOUNT_ID_ENDPOINT_MODE

public static final AwsClientOption<AccountIdEndpointMode> ACCOUNT_ID_ENDPOINT_MODE

Option used by the rest of the SDK to read the DefaultsMode. This will never be DefaultsMode.AUTO.

USE_GLOBAL_ENDPOINT

public static final AwsClientOption<Boolean> USE_GLOBAL_ENDPOINT

Option to specify whether global endpoint should be used.

TOKEN_PROVIDER

@Deprecated
public static final AwsClientOption<SdkTokenProvider> TOKEN_PROVIDER

Deprecated.

Option to specific the SdkTokenProvider to use for bearer token authorization. This option is deprecated in favor or TOKEN_IDENTITY_PROVIDER

TOKEN_IDENTITY_PROVIDER

public static final AwsClientOption<IdentityProvider<? extends TokenIdentity>> TOKEN_IDENTITY_PROVIDER

Option to specific the SdkTokenProvider to use for bearer token authorization.