org.apache.beam.sdk.io.aws2.options

Interface AwsOptions

All Superinterfaces:

HasDisplayData, PipelineOptions

@Experimental(value=SOURCE_SINK)
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.

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
software.amazon.awssdk.auth.credentials.AwsCredentialsProvider	getAwsCredentialsProvider() The credential instance that should be used to authenticate against AWS services.
java.lang.String	getEndpoint() The AWS service endpoint used by the AWS client.
software.amazon.awssdk.http.apache.ProxyConfiguration	getProxyConfiguration() The client configuration instance that should be used to configure AWS service clients.
java.lang.String	getRegion() AWS region used by the AWS client.
void	setAwsCredentialsProvider(software.amazon.awssdk.auth.credentials.AwsCredentialsProvider value)
void	setEndpoint(java.lang.String value)
void	setProxyConfiguration(software.amazon.awssdk.http.apache.ProxyConfiguration value)
void	setRegion(java.lang.String value)

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

getRegion

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

AWS region used by the AWS client.

setRegion

void setRegion(java.lang.String value)

getEndpoint

java.lang.String getEndpoint()

The AWS service endpoint used by the AWS client.

setEndpoint

void setEndpoint(java.lang.String value)

getAwsCredentialsProvider

@Default.InstanceFactory(value=AwsOptions.AwsUserCredentialsFactory.class)
software.amazon.awssdk.auth.credentials.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 DefaultCredentialsProvider 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(software.amazon.awssdk.auth.credentials.AwsCredentialsProvider value)

getProxyConfiguration

software.amazon.awssdk.http.apache.ProxyConfiguration getProxyConfiguration()

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.

For example, to specify the proxy endpoint, username and password, specify the following: --proxyConfiguration={ "endpoint": "http://hostname:port", "username": "username", "password": "password" }

setProxyConfiguration

void setProxyConfiguration(software.amazon.awssdk.http.apache.ProxyConfiguration value)