software.amazon.dax

Class Configuration.Builder

java.lang.Object

software.amazon.dax.Configuration.Builder

All Implemented Interfaces:

software.amazon.awssdk.utils.builder.Buildable, software.amazon.awssdk.utils.builder.CopyableBuilder<Configuration.Builder,Configuration>, software.amazon.awssdk.utils.builder.SdkBuilder<Configuration.Builder,Configuration>

Enclosing class:

Configuration

public static class Configuration.Builder
extends Object
implements software.amazon.awssdk.utils.builder.CopyableBuilder<Configuration.Builder,Configuration>

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
Configuration.Builder	addMetricPublisher(software.amazon.awssdk.metrics.MetricPublisher metricPublisher) Add a metric publisher to the existing list of previously set publishers to be used for publishing metrics for this client.
Configuration	build()
Configuration.Builder	clusterUpdateIntervalMillis(int clusterUpdateIntervalMillis) The interval between polling of cluster members for membership changes.
Configuration.Builder	connectionTtlMillis(int connectionTtlMillis) The ttl for connections with the DAX cluster.
Configuration.Builder	connectTimeoutMillis(int connectTimeoutMillis) The timeout for connections establishment with the DAX cluster.
Configuration.Builder	credentialsProvider(software.amazon.awssdk.auth.credentials.AwsCredentialsProvider credentialsProvider) Configure the credentials that should be used to authenticate with AWS.
Configuration.Builder	endpointRefreshTimeoutMillis(int endpointRefreshTimeoutMillis) The endpoint refresh request timeout for the DAX cluster.
Configuration.Builder	eventLoopGroup(io.netty.channel.EventLoopGroup eventLoopGroup) Sets the EventLoopGroup which will be used to create the Netty client.
Configuration.Builder	idleTimeoutMillis(int idleTimeoutMillis) The timeout for idle connections with the DAX cluster.
Configuration.Builder	maxConcurrency(int maxConcurrency) The number of maximal active connections, once this is reached new tries to acquire a connection will be delayed until a connection is returned to the pool again.
Configuration.Builder	maxPendingConnectionAcquires(int maxPendingConnectionAcquires) The maximum number of pending acquires.
Configuration.Builder	readRetries(int readRetries) The number of times to retry reads (not counting the initial try).
Configuration.Builder	region(software.amazon.awssdk.regions.Region region) The AWS region.
Configuration.Builder	requestTimeoutMillis(int requestTimeoutMillis) The request timeout for connections with the DAX cluster.
Configuration.Builder	skipHostNameVerification(boolean skipHostNameVerification) skipHostnameVerification skip hostname verification of TLS connections.
Configuration.Builder	url(String url) Sets the DAX cluster discovery endpoints.
Configuration.Builder	writeRetries(int writeRetries) The number of times to retry writes (not counting the initial try).

Methods inherited from class java.lang.Object

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

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

copy

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

applyMutation

Constructor Detail

Builder

public Builder()

Method Detail

idleTimeoutMillis

public Configuration.Builder idleTimeoutMillis(int idleTimeoutMillis)

The timeout for idle connections with the DAX cluster.

Defaults to ms.

connectionTtlMillis

public Configuration.Builder connectionTtlMillis(int connectionTtlMillis)

The ttl for connections with the DAX cluster. 0 to disable ttl i.e. connection will never be closed due to ttl.

Defaults to ms.

connectTimeoutMillis

public Configuration.Builder connectTimeoutMillis(int connectTimeoutMillis)

The timeout for connections establishment with the DAX cluster.

Defaults to ms.

requestTimeoutMillis

public Configuration.Builder requestTimeoutMillis(int requestTimeoutMillis)

The request timeout for connections with the DAX cluster.

Defaults to ms.

writeRetries

public Configuration.Builder writeRetries(int writeRetries)

The number of times to retry writes (not counting the initial try). Defaults to .

readRetries

public Configuration.Builder readRetries(int readRetries)

The number of times to retry reads (not counting the initial try). Defaults to .

clusterUpdateIntervalMillis

public Configuration.Builder clusterUpdateIntervalMillis(int clusterUpdateIntervalMillis)

The interval between polling of cluster members for membership changes. Defaults to ms.

endpointRefreshTimeoutMillis

public Configuration.Builder endpointRefreshTimeoutMillis(int endpointRefreshTimeoutMillis)

The endpoint refresh request timeout for the DAX cluster.

Defaults to ms.

maxPendingConnectionAcquires

public Configuration.Builder maxPendingConnectionAcquires(int maxPendingConnectionAcquires)

The maximum number of pending acquires. Once this is exceed connection acquire tries will be failed.

Defaults to .

maxConcurrency

public Configuration.Builder maxConcurrency(int maxConcurrency)

The number of maximal active connections, once this is reached new tries to acquire a connection will be delayed until a connection is returned to the pool again.

Defaults to .

eventLoopGroup

public Configuration.Builder eventLoopGroup(io.netty.channel.EventLoopGroup eventLoopGroup)

Sets the EventLoopGroup which will be used to create the Netty client.

skipHostNameVerification

public Configuration.Builder skipHostNameVerification(boolean skipHostNameVerification)

skipHostnameVerification skip hostname verification of TLS connections. This parameter has no impact on unecrypted clusters. The default is to perform hostname verification, setting this to true will skip verification. Be sure you understand the implication of doing so, which is the inability to authenticate the cluster that you are connecting to.

Defaults to false.

credentialsProvider

public Configuration.Builder credentialsProvider(software.amazon.awssdk.auth.credentials.AwsCredentialsProvider credentialsProvider)

Configure the credentials that should be used to authenticate with AWS.

region

public Configuration.Builder region(software.amazon.awssdk.regions.Region region)

The AWS region.

The region is necessary for signing requests.

url

public Configuration.Builder url(String url)

Sets the DAX cluster discovery endpoints.

Cluster discovery endpoints are available from the DynamoDB console or by calling describe-clusters with the AWS CLI or DAX control plane client. For encrypted cluster, only one cluster discovery endpoint may be provided.

Parameters:

url - the cluster discovery endpoints, in the form [scheme://]hostname:port

addMetricPublisher

public Configuration.Builder addMetricPublisher(software.amazon.awssdk.metrics.MetricPublisher metricPublisher)

Add a metric publisher to the existing list of previously set publishers to be used for publishing metrics for this client.

Parameters:

metricPublisher - The metric publisher to add.

build

public Configuration build()

Specified by:

build in interface software.amazon.awssdk.utils.builder.Buildable

Specified by:

build in interface software.amazon.awssdk.utils.builder.SdkBuilder<Configuration.Builder,Configuration>