Package org.apache.beam.sdk.io.aws2.common

Class ClientConfiguration

java.lang.Object

org.apache.beam.sdk.io.aws2.common.ClientConfiguration

All Implemented Interfaces:

Serializable

public abstract class ClientConfiguration
extends Object
implements Serializable

AWS client configuration.

AWS clients for all AWS IOs can be configured using AwsOptions, which provides reasonable defaults based on default providers of the AWS SDK.

ClientConfiguration is meant to override defaults for a specific IO, including RetryConfiguration. Retries are handled by the AWS SDK unless there's partial success. The SDK uses a backoff strategy with equal jitter for computing the delay before the next retry.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ClientConfiguration.Builder

Field Summary

Fields

Modifier and Type	Field	Description
static final ClientConfiguration	EMPTY

Constructor Summary

Constructors

Constructor	Description
ClientConfiguration()

Method Summary

Modifier and Type	Method	Description
static ClientConfiguration.Builder	builder()
static ClientConfiguration	create(AwsCredentialsProvider credentials, Region region, URI endpoint)
AwsCredentialsProvider	credentialsProvider()	Optional AwsCredentialsProvider.
abstract URI	endpoint()	Optional service endpoint to use AWS compatible services instead, e.g.
Region	region()	Optional Region.
abstract RetryConfiguration	retry()	Optional RetryConfiguration for AWS clients.
abstract Boolean	skipCertificateVerification()	Optional flag to skip certificate verification.
abstract ClientConfiguration.Builder	toBuilder()

Methods inherited from class java.lang.Object

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

Field Details

EMPTY

public static final ClientConfiguration EMPTY

Constructor Details

ClientConfiguration

public ClientConfiguration()

Method Details

credentialsProvider

@Memoized
@Nullable
@Pure
public AwsCredentialsProvider credentialsProvider()

Optional AwsCredentialsProvider. If set, this overwrites the default in AwsOptions.getAwsCredentialsProvider().

region

@Memoized
@Nullable
@Pure
public Region region()

Optional Region. If set, this overwrites the default in AwsOptions.getAwsRegion().

skipCertificateVerification

@Nullable
@Pure
public abstract Boolean skipCertificateVerification()

Optional flag to skip certificate verification. Should only be overriden for test scenarios. If set, this overwrites the default in

invalid reference

AwsOptions#skipCertificateVerification()

.

endpoint

@Nullable
@Pure
public abstract URI endpoint()

Optional service endpoint to use AWS compatible services instead, e.g. for testing. If set, this overwrites the default in AwsOptions.getEndpoint().

retry

@Nullable
@Pure
public abstract RetryConfiguration retry()

Optional RetryConfiguration for AWS clients. If unset, retry behavior will be unchanged and use SDK defaults.

toBuilder

public abstract ClientConfiguration.Builder toBuilder()

builder

public static ClientConfiguration.Builder builder()

create

public static ClientConfiguration create(AwsCredentialsProvider credentials,
 Region region,
 @Nullable
 URI endpoint)