org.apache.beam.sdk.io.aws.options

Interface AwsOptions

All Superinterfaces:

HasDisplayData, PipelineOptions

All Known Subinterfaces:

S3Options

public interface AwsOptions
extends PipelineOptions

Options used to configure Amazon Web Services specific options such as credentials and region.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	AwsOptions.AwsUserCredentialsFactory Attempts to load AWS credentials.
static class	AwsOptions.ClientConfigurationFactory Default AWS client configuration.

Nested classes/interfaces inherited from interface org.apache.beam.sdk.options.PipelineOptions

PipelineOptions.AtomicLongFactory, PipelineOptions.CheckEnabled, PipelineOptions.DirectRunner, PipelineOptions.JobNameFactory, PipelineOptions.UserAgentFactory

Method Summary

Modifier and Type	Method and Description
AWSCredentialsProvider	getAwsCredentialsProvider() The credential instance that should be used to authenticate against AWS services.
ClientConfiguration	getAwsHttpClientConfiguration() The client configuration instance that should be used to configure AWS service clients.
java.lang.String	getAwsRegion() AWS region used by the AWS client.
java.lang.String	getAwsServiceEndpoint() The AWS service endpoint used by the AWS client.
ClientConfiguration	getClientConfiguration() The client configuration instance that should be used to configure AWS service clients.
void	setAwsCredentialsProvider(AWSCredentialsProvider value)
void	setAwsHttpClientConfiguration(ClientConfiguration clientConfiguration)
void	setAwsRegion(java.lang.String value)
void	setAwsServiceEndpoint(java.lang.String value)
void	setClientConfiguration(ClientConfiguration clientConfiguration)

Methods inherited from interface org.apache.beam.sdk.options.PipelineOptions

as, getJobName, getOptionsId, getRunner, getStableUniqueNames, getTempLocation, getUserAgent, outputRuntimeOptions, setJobName, setOptionsId, setRunner, setStableUniqueNames, setTempLocation, setUserAgent

Methods inherited from interface org.apache.beam.sdk.transforms.display.HasDisplayData

populateDisplayData

Method Detail

getAwsRegion

@Validation.Required
java.lang.String getAwsRegion()

AWS region used by the AWS client.

setAwsRegion

void setAwsRegion(java.lang.String value)

getAwsServiceEndpoint

java.lang.String getAwsServiceEndpoint()

The AWS service endpoint used by the AWS client.

setAwsServiceEndpoint

void setAwsServiceEndpoint(java.lang.String value)

getAwsCredentialsProvider

@Default.InstanceFactory(value=AwsOptions.AwsUserCredentialsFactory.class)
AWSCredentialsProvider getAwsCredentialsProvider()

The credential instance that should be used to authenticate against AWS services. The option value must contain a "@type" field and an AWS Credentials Provider class as the field value. Refer to DefaultAWSCredentialsProviderChain Javadoc for usage help.

For example, to specify the AWS key ID and secret, specify the following: {"@type" : "AWSStaticCredentialsProvider", "awsAccessKeyId" : "key_id_value", "awsSecretKey" : "secret_value"}

setAwsCredentialsProvider

void setAwsCredentialsProvider(AWSCredentialsProvider value)

getClientConfiguration

@Default.InstanceFactory(value=AwsOptions.ClientConfigurationFactory.class)
ClientConfiguration getClientConfiguration()

The client configuration instance that should be used to configure AWS service clients. Please note that the configuration deserialization only allows one to specify proxy settings. Please use AwsHttpClientConfiguration's client configuration to set a wider range of options.

For example, to specify the proxy host, port, username and password, specify the following: --clientConfiguration={ "proxyHost":"hostname", "proxyPort":1234, "proxyUsername":"username", "proxyPassword":"password" }

Returns:

setClientConfiguration

void setClientConfiguration(ClientConfiguration clientConfiguration)

getAwsHttpClientConfiguration

@Default.InstanceFactory(value=AwsOptions.ClientConfigurationFactory.class)
ClientConfiguration getAwsHttpClientConfiguration()

The client configuration instance that should be used to configure AWS service clients. Please note that the configuration deserialization allows aws http client configuration settings.

For example, to set different timeout for aws client service : Note that all the below fields are optional, so only add those configurations that need to be set. --clientConfiguration={ "clientExecutionTimeout":1000, "connectionMaxIdleTime":3000, "connectionTimeout":10000, "requestTimeout":30, "socketTimeout":600, "maxConnections":10, "socketTimeout":5000 }

Returns:

setAwsHttpClientConfiguration

void setAwsHttpClientConfiguration(ClientConfiguration clientConfiguration)