Modifier and Type | Field and Description |
---|---|
protected ClientConfiguration |
AmazonWebServiceClient.clientConfiguration
The client configuration
|
Modifier and Type | Method and Description |
---|---|
static ClientConfiguration |
PredefinedClientConfigurations.defaultConfig()
Factory method for default
ClientConfiguration for all services unless otherwise
specified |
static ClientConfiguration |
PredefinedClientConfigurations.dynamoDefault()
Factory method for DynamoDB's default
ClientConfiguration |
ClientConfiguration |
AmazonWebServiceClient.getClientConfiguration() |
ClientConfiguration |
ClientConfigurationFactory.getConfig()
Builds a
ClientConfiguration instance with the default configuration
for the current client. |
protected ClientConfiguration |
ClientConfigurationFactory.getDefaultConfig()
Builds a
ClientConfiguration instance with default configuration
values suitable for most use cases. |
protected ClientConfiguration |
ClientConfigurationFactory.getInRegionOptimizedConfig()
Builds a
ClientConfiguration instance with configuration values
tailored towards clients operating in the same AWS region as the service
endpoint they call. |
static ClientConfiguration |
PredefinedClientConfigurations.swfDefault()
Factory method for Simple Workflow's default
ClientConfiguration |
ClientConfiguration |
ClientConfiguration.withCacheResponseMetadata(boolean shouldCache)
Sets whether or not to cache response metadata.
|
ClientConfiguration |
ClientConfiguration.withClientExecutionTimeout(int clientExecutionTimeout)
Sets the amount of time (in milliseconds) to allow the client to complete the execution of
an API call.
|
ClientConfiguration |
ClientConfiguration.withConnectionMaxIdleMillis(long connectionMaxIdleMillis)
Sets the maximum amount of time that an idle connection may sit in the connection pool and
still be eligible for reuse.
|
ClientConfiguration |
ClientConfiguration.withConnectionTimeout(int connectionTimeout)
Sets the amount of time to wait (in milliseconds) when initially establishing a connection
before giving up and timing out, and returns the updated ClientConfiguration object so that
additional method calls may be chained together.
|
ClientConfiguration |
ClientConfiguration.withConnectionTTL(long connectionTTL)
Sets the expiration time (in milliseconds) for a connection in the connection pool.
|
ClientConfiguration |
ClientConfiguration.withDisableHostPrefixInjection(boolean disableHostPrefixInjection)
Sets the configuration option to disable the host prefix injection.
|
ClientConfiguration |
ClientConfiguration.withDisableSocketProxy(boolean disableSocketProxy)
Set whether to disable proxies at the socket level.
|
ClientConfiguration |
ClientConfiguration.withDnsResolver(DnsResolver resolver)
Sets the DNS Resolver that should be used to for resolving AWS IP addresses.
|
ClientConfiguration |
ClientConfiguration.withGzip(boolean use)
Sets whether gzip decompression should be used when receiving HTTP responses.
|
ClientConfiguration |
ClientConfiguration.withHeader(String name,
String value)
Adds a header to be added on all requests and returns the
ClientConfiguration object |
ClientConfiguration |
ClientConfiguration.withLocalAddress(InetAddress localAddress)
Sets the optional local address the client will bind to and returns the updated
ClientConfiguration object.
|
ClientConfiguration |
ClientConfiguration.withMaxConnections(int maxConnections)
Sets the maximum number of allowed open HTTP connections and returns the updated
ClientConfiguration object.
|
ClientConfiguration |
ClientConfiguration.withMaxConsecutiveRetriesBeforeThrottling(int maxConsecutiveRetriesBeforeThrottling)
Set the maximum number of consecutive failed retries that the client will permit before
throttling all subsequent retries of failed requests.
|
ClientConfiguration |
ClientConfiguration.withMaxErrorRetry(int maxErrorRetry)
Sets the maximum number of retry attempts for failed retryable requests (ex: 5xx error
responses from services), and returns the updated ClientConfiguration object.
|
ClientConfiguration |
ClientConfiguration.withNonProxyHosts(String nonProxyHosts)
Set the optional hosts the client will access without going
through the proxy.
|
ClientConfiguration |
ClientConfiguration.withPreemptiveBasicProxyAuth(boolean preemptiveBasicProxyAuth)
Sets whether to attempt to authenticate preemptively against proxy servers using basic
authentication, and returns the updated ClientConfiguration object so that additional method
calls may be chained together.
|
ClientConfiguration |
ClientConfiguration.withProtocol(Protocol protocol)
Sets the protocol (i.e.
|
ClientConfiguration |
ClientConfiguration.withProxyAuthenticationMethods(List<ProxyAuthenticationMethod> proxyAuthenticationMethods)
Configure the list of authentication methods that should be used when authenticating against an HTTP proxy, in the order
they should be attempted.
|
ClientConfiguration |
ClientConfiguration.withProxyDomain(String proxyDomain)
Sets the optional Windows domain name for configuration an NTLM proxy and returns a reference
to this updated ClientConfiguration object so that additional method calls can be chained
together.
|
ClientConfiguration |
ClientConfiguration.withProxyHost(String proxyHost)
Sets the optional proxy host the client will connect through and returns the updated
ClientConfiguration object.
|
ClientConfiguration |
ClientConfiguration.withProxyPassword(String proxyPassword)
Sets the optional proxy password to use when connecting through a proxy, and returns the
updated ClientConfiguration object.
|
ClientConfiguration |
ClientConfiguration.withProxyPort(int proxyPort)
Sets the optional proxy port the client will connect through and returns the updated
ClientConfiguration object.
|
ClientConfiguration |
ClientConfiguration.withProxyProtocol(Protocol proxyProtocol)
Set the
Protocol to use for connecting to the proxy. |
ClientConfiguration |
ClientConfiguration.withProxyUsername(String proxyUsername)
Sets the optional proxy user name and returns the updated ClientConfiguration object.
|
ClientConfiguration |
ClientConfiguration.withProxyWorkstation(String proxyWorkstation)
Sets the optional Windows workstation name for configuring NTLM proxy support, and returns
the updated ClientConfiguration object so that additional method calls can be chained
together.
|
ClientConfiguration |
ClientConfiguration.withReaper(boolean use)
Sets whether the
IdleConnectionReaper is to be started as a daemon thread |
ClientConfiguration |
ClientConfiguration.withRequestTimeout(int requestTimeout)
Sets the amount of time to wait (in milliseconds) for the request to complete before giving
up and timing out.
|
ClientConfiguration |
ClientConfiguration.withResponseMetadataCacheSize(int responseMetadataCacheSize)
Sets the response metadata cache size.
|
ClientConfiguration |
ClientConfiguration.withRetryMode(RetryMode retryMode)
Sets the RetryMode to use
|
ClientConfiguration |
ClientConfiguration.withRetryPolicy(RetryPolicy retryPolicy)
Sets the retry policy upon failed requests, and returns the updated ClientConfiguration
object.
|
ClientConfiguration |
ClientConfiguration.withSecureRandom(SecureRandom secureRandom)
Fluent API for
setSecureRandom(SecureRandom) . |
ClientConfiguration |
ClientConfiguration.withSignerOverride(String value)
Sets the name of the signature algorithm to use for signing requests made by this client.
|
ClientConfiguration |
ClientConfiguration.withSocketBufferSizeHints(int socketSendBufferSizeHint,
int socketReceiveBufferSizeHint)
Sets the optional size hints (in bytes) for the low level TCP send and receive buffers, and
returns the updated ClientConfiguration object so that additional method calls may be chained
together.
|
ClientConfiguration |
ClientConfiguration.withSocketTimeout(int socketTimeout)
Sets the amount of time to wait (in milliseconds) for data to be transferred over an
established, open connection before the connection times out and is closed, and returns the
updated ClientConfiguration object so that additional method calls may be chained together.
|
ClientConfiguration |
ClientConfiguration.withTcpKeepAlive(boolean use)
Sets whether or not to enable TCP KeepAlive support at the socket level.
|
ClientConfiguration |
ClientConfiguration.withThrottledRetries(boolean use)
Sets whether throttled retries should be used
|
ClientConfiguration |
ClientConfiguration.withTlsKeyManagersProvider(TlsKeyManagersProvider tlsKeyManagersProvider)
Sets
TlsKeyManagersProvider that will provide the KeyManager s to use when
constructing the client's SSL context. |
ClientConfiguration |
ClientConfiguration.withUseExpectContinue(boolean useExpectContinue)
Sets if use expect continue should be enabled.
|
ClientConfiguration |
ClientConfiguration.withUserAgent(String userAgent)
Deprecated.
Replaced by
withUserAgentPrefix(String) and withUserAgentSuffix(String) |
ClientConfiguration |
ClientConfiguration.withUserAgentPrefix(String prefix)
Sets the HTTP user agent prefix header used in requests and returns the updated ClientConfiguration
object.
|
ClientConfiguration |
ClientConfiguration.withUserAgentSuffix(String suffix)
Sets the HTTP user agent suffix header used in requests and returns the updated ClientConfiguration
object.
|
ClientConfiguration |
ClientConfiguration.withValidateAfterInactivityMillis(int validateAfterInactivityMillis)
Sets the amount of time (in milliseconds) that a connection can be idle in the connection pool before it must be validated
to ensure it's still open.
|
Constructor and Description |
---|
AmazonWebServiceClient(ClientConfiguration clientConfiguration)
Constructs a new AmazonWebServiceClient object using the specified
configuration.
|
AmazonWebServiceClient(ClientConfiguration clientConfiguration,
RequestMetricCollector requestMetricCollector)
Constructs a new AmazonWebServiceClient object using the specified
configuration and request metric collector.
|
AmazonWebServiceClient(ClientConfiguration clientConfiguration,
RequestMetricCollector requestMetricCollector,
boolean disableStrictHostNameVerification) |
ClientConfiguration(ClientConfiguration other) |
Modifier and Type | Method and Description |
---|---|
abstract ClientConfiguration |
AwsSyncClientParams.getClientConfiguration() |
Modifier and Type | Method and Description |
---|---|
ClientConfiguration |
AwsClientBuilder.getClientConfiguration()
Gets the ClientConfiguration currently configured in the builder
|
ClientConfiguration |
AwsClientBuilder.SyncBuilderParams.getClientConfiguration() |
Modifier and Type | Method and Description |
---|---|
void |
AwsClientBuilder.setClientConfiguration(ClientConfiguration config)
Sets the ClientConfiguration to be used by the client.
|
Subclass |
AwsClientBuilder.withClientConfiguration(ClientConfiguration config)
Sets the ClientConfiguration to be used by the client.
|
Modifier and Type | Method and Description |
---|---|
AmazonHttpClient.Builder |
AmazonHttpClient.Builder.clientConfiguration(ClientConfiguration clientConfig) |
Constructor and Description |
---|
AmazonHttpClient(ClientConfiguration config)
Constructs a new AWS client using the specified client configuration options (ex: max retry
attempts, proxy httpClientSettings, etc).
|
AmazonHttpClient(ClientConfiguration clientConfig,
ConnectionManagerAwareHttpClient httpClient,
RequestMetricCollector requestMetricCollector,
TokenBucket tokenBucket)
Package-protected constructor for unit test purposes.
|
AmazonHttpClient(ClientConfiguration config,
RequestMetricCollector requestMetricCollector)
Constructs a new AWS client using the specified client configuration options (ex: max retry
attempts, proxy httpClientSettings, etc), and request metric collector.
|
AmazonHttpClient(ClientConfiguration config,
RequestMetricCollector requestMetricCollector,
boolean useBrowserCompatibleHostNameVerifier)
Constructs a new AWS client using the specified client configuration options (ex: max retry
attempts, proxy httpClientSettings, etc), and request metric collector.
|
AmazonHttpClient(ClientConfiguration config,
RequestMetricCollector requestMetricCollector,
boolean useBrowserCompatibleHostNameVerifier,
boolean calculateCRC32FromCompressedData)
Constructs a new AWS client using the specified client configuration options (ex: max retry
attempts, proxy httpClientSettings, etc), and request metric collector.
|
Modifier and Type | Method and Description |
---|---|
static HttpClientSettings |
HttpClientSettings.adapt(ClientConfiguration config) |
static HttpClientSettings |
HttpClientSettings.adapt(ClientConfiguration config,
boolean useBrowserCompatibleHostNameVerifier) |
static HttpClientSettings |
HttpClientSettings.adapt(ClientConfiguration config,
boolean useBrowserCompatibleHostNameVerifier,
boolean calculateCRC32FromCompressedData) |
Constructor and Description |
---|
SdkRequestRetryHeaderProvider(ClientConfiguration config,
RetryPolicy retryPolicy,
ClockSkewAdjuster clockSkewAdjuster) |
Modifier and Type | Method and Description |
---|---|
<T extends AmazonWebServiceClient> |
Region.createClient(Class<T> serviceClass,
AWSCredentialsProvider credentials,
ClientConfiguration config)
Deprecated.
use appropriate
AwsClientBuilder implementation
for the service being constructed. For example:
AmazonSNSClientBuilder.standard().withRegion(region).build(); |
static void |
RegionUtils.initializeFromURI(URI uri,
ClientConfiguration config)
Deprecated.
|
static RegionMetadata |
LegacyRegionXmlLoadUtils.load(URI uri,
ClientConfiguration config)
Deprecated.
Loads a set of region metadata by downloading an XML file from the
given URI and parsing it.
|
static RegionMetadata |
RegionUtils.loadMetadataFromURI(URI uri,
ClientConfiguration config)
Deprecated.
|
Constructor and Description |
---|
RetryPolicyAdapter(RetryPolicy legacyRetryPolicy,
ClientConfiguration clientConfiguration) |
Modifier and Type | Method and Description |
---|---|
static InputStream |
RuntimeHttpUtils.fetchFile(URI uri,
ClientConfiguration config)
Fetches a file from the URI given and returns an input stream to it.
|
static String |
RuntimeHttpUtils.getUserAgent(ClientConfiguration config,
String userAgentMarker) |
static URI |
RuntimeHttpUtils.toUri(String endpoint,
ClientConfiguration config)
Returns an URI for the given endpoint.
|
Copyright © 2022. All rights reserved.