Class SdkClientOption<T>
java.lang.Object
software.amazon.awssdk.utils.AttributeMap.Key<T>
software.amazon.awssdk.core.client.config.ClientOption<T>
software.amazon.awssdk.core.client.config.SdkClientOption<T>
A set of internal options required by the SDK via
SdkClientConfiguration
.-
Field Summary
Modifier and TypeFieldDescriptionstatic final SdkClientOption
<Map<String, List<String>>> static final SdkClientOption
<Duration> static final SdkClientOption
<Duration> static final SdkClientOption
<SdkAsyncHttpClient> The asynchronous HTTP client implementation to make HTTP requests with.static final SdkClientOption
<AuthSchemeProvider> TheAuthSchemeProvider
configured on the client.static final SdkClientOption
<Map<String, AuthScheme<?>>> TheAuthScheme
s configured on the client.static final SdkClientOption
<AttributeMap> The container for any client contexts parameters set on the client.static final SdkClientOption
<ClientType> The type of client used to make requests.static final SdkClientOption
<String> A user agent prefix that is specific to the client (agnostic of the request).static final SdkClientOption
<CompressionConfiguration> Option used by the rest of the SDK to read theCompressionConfiguration
.static final SdkClientOption
<SdkAsyncHttpClient> An asynchronous HTTP client set by the customer.static final SdkClientOption
<SdkAsyncHttpClient.Builder<?>> An asynchronous HTTP client builder set by the customer.static final SdkClientOption
<CompressionConfiguration> Configuration of the COMPRESSION_CONFIGURATION.static final SdkClientOption
<ScheduledExecutorService> The internal SDK scheduled executor service that is set by the customer.static final SdkClientOption
<SdkHttpClient> An HTTP client set by the customer.static final SdkClientOption
<SdkHttpClient.Builder<?>> An HTTP client builder set by the customer.static final SdkClientOption
<Boolean> Whether to calculate the CRC 32 checksum of a message based on the uncompressed data.static final SdkClientOption
<RetryMode> Option to specify the default retry mode.static final SdkClientOption
<URI> The effective endpoint the client is configured to make requests to.static final SdkClientOption
<Boolean> Whether or not endpoint discovery is enabled for this client.static final SdkClientOption
<Boolean> A flag that when set to true indicates the endpoint stored inENDPOINT
was a customer supplied value and not generated by the client based on Region metadata.static final SdkClientOption
<EndpointProvider> TheEndpointProvider
configured on the client.static final SdkClientOption
<ExecutionAttributes> Option to specify additional execution attributes to each client call.static final SdkClientOption
<List<ExecutionInterceptor>> static final SdkClientOption
<AttributeMap> Configuration that should be used to build theSYNC_HTTP_CLIENT
orASYNC_HTTP_CLIENT
.static final SdkClientOption
<IdentityProviders> The IdentityProviders configured on the client.static final SdkClientOption
<String> Option to specify the internal user agent.static final SdkClientOption
<List<MetricPublisher>> static final SdkClientOption
<ProfileFile> Deprecated.static final SdkClientOption
<Supplier<ProfileFile>> The profile file supplier to use for this client.static final SdkClientOption
<String> The profile name to use for this client.static final SdkClientOption
<RetryPolicy> static final SdkClientOption
<ScheduledExecutorService> The internal SDK scheduled executor service that is used for scheduling tasks such as async retry attempts and timeout task.static final SdkClientOption
<SdkClient> Option to specify a reference to the SDK client in use.static final SdkClientOption
<ServiceConfiguration> Service-specific configuration used by some services, like S3.static final SdkClientOption
<String> Descriptive name for the service.static final SdkClientOption
<Boolean> Option to specify if the default signer has been overridden on the client.static final SdkClientOption
<SdkHttpClient> The HTTP client implementation to make HTTP requests with. -
Method Summary
Methods inherited from class software.amazon.awssdk.utils.AttributeMap.Key
convertValue, toString
-
Field Details
-
ADDITIONAL_HTTP_HEADERS
- See Also:
-
RETRY_POLICY
- See Also:
-
EXECUTION_INTERCEPTORS
- See Also:
-
ENDPOINT
The effective endpoint the client is configured to make requests to. If the client has been configured with an endpoint override then this value will be the provided endpoint value. -
ENDPOINT_OVERRIDDEN
A flag that when set to true indicates the endpoint stored inENDPOINT
was a customer supplied value and not generated by the client based on Region metadata. -
SERVICE_CONFIGURATION
Service-specific configuration used by some services, like S3. -
CRC32_FROM_COMPRESSED_DATA_ENABLED
Whether to calculate the CRC 32 checksum of a message based on the uncompressed data. By default, this is false. -
SCHEDULED_EXECUTOR_SERVICE
The internal SDK scheduled executor service that is used for scheduling tasks such as async retry attempts and timeout task. -
CONFIGURED_SCHEDULED_EXECUTOR_SERVICE
The internal SDK scheduled executor service that is set by the customer. This is likely only useful within configuration classes, and will be converted into aSCHEDULED_EXECUTOR_SERVICE
for the SDK's runtime. -
ASYNC_HTTP_CLIENT
The asynchronous HTTP client implementation to make HTTP requests with. -
CONFIGURED_ASYNC_HTTP_CLIENT
An asynchronous HTTP client set by the customer. This is likely only useful within configuration classes, and will be converted into aASYNC_HTTP_CLIENT
for the SDK's runtime. -
CONFIGURED_ASYNC_HTTP_CLIENT_BUILDER
public static final SdkClientOption<SdkAsyncHttpClient.Builder<?>> CONFIGURED_ASYNC_HTTP_CLIENT_BUILDERAn asynchronous HTTP client builder set by the customer. This is likely only useful within configuration classes, and will be converted into aASYNC_HTTP_CLIENT
for the SDK's runtime. -
SYNC_HTTP_CLIENT
The HTTP client implementation to make HTTP requests with. -
CONFIGURED_SYNC_HTTP_CLIENT
An HTTP client set by the customer. This is likely only useful within configuration classes, and will be converted into aSYNC_HTTP_CLIENT
for the SDK's runtime. -
CONFIGURED_SYNC_HTTP_CLIENT_BUILDER
An HTTP client builder set by the customer. This is likely only useful within configuration classes, and will be converted into aSYNC_HTTP_CLIENT
for the SDK's runtime. -
HTTP_CLIENT_CONFIG
Configuration that should be used to build theSYNC_HTTP_CLIENT
orASYNC_HTTP_CLIENT
. -
CLIENT_TYPE
The type of client used to make requests. -
API_CALL_ATTEMPT_TIMEOUT
- See Also:
-
API_CALL_TIMEOUT
- See Also:
-
SERVICE_NAME
Descriptive name for the service. Used primarily for metrics and also in metadata like AwsErrorDetails. -
ENDPOINT_DISCOVERY_ENABLED
Whether or not endpoint discovery is enabled for this client. -
PROFILE_FILE
Deprecated.This option was used to: - Read configuration options in profile files in aws-core, sdk-core - Build service configuration objects from profile files in codegen, s3control - Build service configuration objects from profile files, set endpoint options in s3 - Set retry mode in dynamodb, kinesis This has been replaced withPROFILE_FILE_SUPPLIER.get()
.The profile file to use for this client. -
PROFILE_FILE_SUPPLIER
The profile file supplier to use for this client. -
PROFILE_NAME
The profile name to use for this client. -
METRIC_PUBLISHERS
-
SIGNER_OVERRIDDEN
Option to specify if the default signer has been overridden on the client. -
EXECUTION_ATTRIBUTES
Option to specify additional execution attributes to each client call. -
INTERNAL_USER_AGENT
Option to specify the internal user agent. -
CLIENT_USER_AGENT
A user agent prefix that is specific to the client (agnostic of the request). -
DEFAULT_RETRY_MODE
Option to specify the default retry mode.- See Also:
-
ENDPOINT_PROVIDER
TheEndpointProvider
configured on the client. -
AUTH_SCHEME_PROVIDER
TheAuthSchemeProvider
configured on the client. -
AUTH_SCHEMES
TheAuthScheme
s configured on the client. -
IDENTITY_PROVIDERS
The IdentityProviders configured on the client. -
CLIENT_CONTEXT_PARAMS
The container for any client contexts parameters set on the client. -
CONFIGURED_COMPRESSION_CONFIGURATION
Configuration of the COMPRESSION_CONFIGURATION. UnlikeCOMPRESSION_CONFIGURATION
, this may contain null values. -
COMPRESSION_CONFIGURATION
Option used by the rest of the SDK to read theCompressionConfiguration
. This will never contain null values. -
SDK_CLIENT
Option to specify a reference to the SDK client in use.
-
PROFILE_FILE_SUPPLIER.get()
.