software.amazon.awssdk.core.config

Class AdvancedClientOption<T>

java.lang.Object

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

software.amazon.awssdk.core.config.AdvancedClientOption<T>

Type Parameters:

T - The type of value associated with the option.

Direct Known Subclasses:

InternalAdvancedClientOption

public class AdvancedClientOption<T>
extends AttributeMap.Key<T>

A collection of advanced options that can be configured on an AWS client via ClientOverrideConfiguration.Builder.advancedOption(AdvancedClientOption, 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 and Description
static AdvancedClientOption<Region>	AWS_REGION AWS Region the client was configured with.
static AdvancedClientOption<Boolean>	ENABLE_DEFAULT_REGION_DETECTION Whether region detection should be enabled.
static AdvancedClientOption<SignerProvider>	SIGNER_PROVIDER Configure the signer factory that should be used when generating signers in communication with AWS.
static AdvancedClientOption<String>	USER_AGENT_PREFIX Set the prefix of the user agent that is sent with each request to AWS.
static AdvancedClientOption<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 java.lang.Object

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

Field Detail

USER_AGENT_PREFIX

public static final AdvancedClientOption<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 AdvancedClientOption<String> USER_AGENT_SUFFIX

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

SIGNER_PROVIDER

public static final AdvancedClientOption<SignerProvider> SIGNER_PROVIDER

Configure the signer factory that should be used when generating signers in communication with AWS.

AWS_REGION

public static final AdvancedClientOption<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.

ENABLE_DEFAULT_REGION_DETECTION

public static final AdvancedClientOption<Boolean> ENABLE_DEFAULT_REGION_DETECTION

Whether region detection should be enabled. Region detection is used when the ClientBuilder#region(Region) is not specified. This is enabled by default.