Class SdkAdvancedClientOption<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.SdkAdvancedClientOption<T>

Type Parameters:

T - The type of value associated with the option.

Direct Known Subclasses:

AwsAdvancedClientOption, SdkInternalTestAdvancedClientOption

@SdkPublicApi
public class SdkAdvancedClientOption<T>
extends ClientOption<T>

A collection of advanced options that can be configured on an AWS client via ClientOverrideConfiguration.Builder.putAdvancedOption(SdkAdvancedClientOption, Object).

These options are usually not required outside of testing or advanced libraries, so most users should not need to configure them.

Field Summary

Fields

Modifier and Type	Field	Description
static final SdkAdvancedClientOption<Boolean>	DISABLE_HOST_PREFIX_INJECTION	SDK uses endpoint trait and hostPrefix trait specified in service model to modify the endpoint host that the API request is sent to.
static final SdkAdvancedClientOption<Signer>	SIGNER	Deprecated. Replaced by HttpSigner.
static final SdkAdvancedClientOption<Signer>	TOKEN_SIGNER	Deprecated. Replaced by HttpSigner.
static final SdkAdvancedClientOption<String>	USER_AGENT_PREFIX	Set the prefix of the user agent that is sent with each request to AWS.
static final SdkAdvancedClientOption<String>	USER_AGENT_SUFFIX	Set the suffix of the user agent that is sent with each request to AWS.

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

USER_AGENT_PREFIX

public static final SdkAdvancedClientOption<String> USER_AGENT_PREFIX

Set the prefix of the user agent that is sent with each request to AWS.

USER_AGENT_SUFFIX

public static final SdkAdvancedClientOption<String> USER_AGENT_SUFFIX

Set the suffix of the user agent that is sent with each request to AWS.

SIGNER

@Deprecated
public static final SdkAdvancedClientOption<Signer> SIGNER

Deprecated.

Replaced by HttpSigner.

Migration options:

• To customize signing logic: Configure via SdkClientBuilder.putAuthScheme(AuthScheme). See Signer for examples.
• To override signing properties only: Use custom AuthSchemeProvider. See AuthSchemeProvider for examples.

Define the signer that should be used when authenticating with AWS.

TOKEN_SIGNER

public static final SdkAdvancedClientOption<Signer> TOKEN_SIGNER

Deprecated.

Replaced by HttpSigner.

Migration options:

• To customize signing logic: Configure via SdkClientBuilder.putAuthScheme(AuthScheme). See Signer for examples.
• To override signing properties only: Use custom AuthSchemeProvider. See AuthSchemeProvider for examples.

Define the signer that should be used for token-based authentication with AWS.

DISABLE_HOST_PREFIX_INJECTION

public static final SdkAdvancedClientOption<Boolean> DISABLE_HOST_PREFIX_INJECTION

SDK uses endpoint trait and hostPrefix trait specified in service model to modify the endpoint host that the API request is sent to. Customers can set this value to True to disable the behavior.