Class SdkClientConfiguration

java.lang.Object

software.amazon.awssdk.core.client.config.SdkClientConfiguration

All Implemented Interfaces:

AutoCloseable, ToCopyableBuilder<SdkClientConfiguration.Builder,SdkClientConfiguration>, SdkAutoCloseable

public final class SdkClientConfiguration
extends Object
implements ToCopyableBuilder<SdkClientConfiguration.Builder,SdkClientConfiguration>, SdkAutoCloseable

A collection of configuration that is required by an AWS client in order to operate. Configuration can be set via SdkClientConfiguration.Builder.option(ClientOption, Object) and checked via option(ClientOption). This configuration can be merged with other configuration using merge(software.amazon.awssdk.core.client.config.SdkClientConfiguration). This configuration object can be close()d to release all closeable resources configured within it.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	SdkClientConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
ClientOverrideConfiguration	asOverrideConfiguration()	Create a ClientOverrideConfiguration using the values currently in this configuration.
static SdkClientConfiguration.Builder	builder()	Create a builder for a SdkClientConfiguration.
void	close()	Close this configuration, which closes all closeable attributes.
boolean	equals(Object o)
static SdkClientConfiguration	fromOverrideConfiguration(ClientOverrideConfiguration configuration)	Create a SdkClientConfiguration from the provided ClientOverrideConfiguration.
int	hashCode()
SdkClientConfiguration	merge(Consumer<SdkClientConfiguration.Builder> configuration)
SdkClientConfiguration	merge(SdkClientConfiguration configuration)	Merge this configuration with another configuration, where this configuration's values take precedence.
<T> T	option(ClientOption<T> option)	Retrieve the value of a specific option.
SdkClientConfiguration.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Details

builder

public static SdkClientConfiguration.Builder builder()

Create a builder for a SdkClientConfiguration.

fromOverrideConfiguration

public static SdkClientConfiguration fromOverrideConfiguration(ClientOverrideConfiguration configuration)

Create a SdkClientConfiguration from the provided ClientOverrideConfiguration. This copies the properties out of the configuration and ensures that _OVERRIDDEN properties are properly set, like SdkClientOption.SIGNER_OVERRIDDEN.

option

public <T> T option(ClientOption<T> option)

Retrieve the value of a specific option.

asOverrideConfiguration

public ClientOverrideConfiguration asOverrideConfiguration()

Create a ClientOverrideConfiguration using the values currently in this configuration.

merge

public SdkClientConfiguration merge(SdkClientConfiguration configuration)

Merge this configuration with another configuration, where this configuration's values take precedence.

merge

public SdkClientConfiguration merge(Consumer<SdkClientConfiguration.Builder> configuration)

toString

public String toString()

Overrides:

toString in class Object

toBuilder

public SdkClientConfiguration.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<SdkClientConfiguration.Builder,SdkClientConfiguration>

Returns:

a builder for type T

close

public void close()

Close this configuration, which closes all closeable attributes.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface SdkAutoCloseable

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object