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.

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
com.amazonaws.auth.AWSCredentialsProvider	getAwsCredentialsProvider() The credential instance that should be used to authenticate against AWS services.
java.lang.String	getAwsRegion() AWS region used by the AWS client.
void	setAwsCredentialsProvider(com.amazonaws.auth.AWSCredentialsProvider value)
void	setAwsRegion(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

getAwsRegion

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

AWS region used by the AWS client.

setAwsRegion

void setAwsRegion(java.lang.String value)

getAwsCredentialsProvider

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

The credential instance that should be used to authenticate against AWS services. Refer to DefaultAWSCredentialsProviderChain Javadoc for usage help.

setAwsCredentialsProvider

void setAwsCredentialsProvider(com.amazonaws.auth.AWSCredentialsProvider value)