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 viaSdkClientConfiguration.Builder.option(ClientOption, Object)
and checked viaoption(ClientOption)
. This configuration can be merged with other configuration usingmerge(software.amazon.awssdk.core.client.config.SdkClientConfiguration)
. This configuration object can beclose()
d to release all closeable resources configured within it.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
SdkClientConfiguration.Builder
-
Method Summary
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
builder
public static SdkClientConfiguration.Builder builder()
Create a builder for aSdkClientConfiguration
.
-
fromOverrideConfiguration
public static SdkClientConfiguration fromOverrideConfiguration(ClientOverrideConfiguration configuration)
Create aSdkClientConfiguration
from the providedClientOverrideConfiguration
. This copies the properties out of the configuration and ensures that _OVERRIDDEN properties are properly set, likeSdkClientOption.SIGNER_OVERRIDDEN
.
-
option
public <T> T option(ClientOption<T> option)
Retrieve the value of a specific option.
-
asOverrideConfiguration
public ClientOverrideConfiguration asOverrideConfiguration()
Create aClientOverrideConfiguration
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)
-
toBuilder
public SdkClientConfiguration.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<SdkClientConfiguration.Builder,SdkClientConfiguration>
-
close
public void close()
Close this configuration, which closes all closeable attributes.- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceSdkAutoCloseable
-
-