org.apache.beam.sdk.io.aws.s3

Class S3FileSystemConfiguration

java.lang.Object

org.apache.beam.sdk.io.aws.s3.S3FileSystemConfiguration

@Experimental(value=FILESYSTEM)
public abstract class S3FileSystemConfiguration
extends java.lang.Object

Object used to configure S3FileSystem.

See Also:

S3Options, S3FileSystemSchemeRegistrar

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	S3FileSystemConfiguration.Builder

Field Summary

Fields

Modifier and Type	Field and Description
static int	MINIMUM_UPLOAD_BUFFER_SIZE_BYTES

Constructor Summary

Constructors

Constructor and Description
S3FileSystemConfiguration()

Method Summary

Modifier and Type	Method and Description
static S3FileSystemConfiguration.Builder	builder() Creates a new uninitialized S3FileSystemConfiguration.Builder.
static S3FileSystemConfiguration.Builder	fromS3Options(S3Options s3Options) Creates a new S3FileSystemConfiguration.Builder with values initialized by the properties of s3Options.
abstract boolean	getBucketKeyEnabled() Whether to ose an S3 Bucket Key for object encryption with server-side encryption using AWS KMS (SSE-KMS) or not.
static AmazonS3ClientBuilder	getBuilder(S3Options s3Options) Creates a new AmazonS3ClientBuilder as specified by s3Options.
abstract AmazonS3ClientBuilder	getS3ClientBuilder() Builder used to create the AmazonS3Client.
abstract java.lang.String	getS3StorageClass() The AWS S3 storage class used for creating S3 objects.
abstract int	getS3ThreadPoolSize() Thread pool size, limiting the max concurrent S3 operations.
abstract int	getS3UploadBufferSizeBytes() Size of S3 upload chunks.
abstract java.lang.String	getScheme() The uri scheme used by resources on this filesystem.
abstract java.lang.String	getSSEAlgorithm() Algorithm for SSE-S3 encryption, e.g.
abstract SSEAwsKeyManagementParams	getSSEAwsKeyManagementParams() KMS key id for SSE-KMS encryption, e.g.
abstract SSECustomerKey	getSSECustomerKey() SSE key for SSE-C encryption, e.g.
abstract S3FileSystemConfiguration.Builder	toBuilder() Creates a new S3FileSystemConfiguration.Builder with values initialized by this instance's properties.

Methods inherited from class java.lang.Object

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

Field Detail

MINIMUM_UPLOAD_BUFFER_SIZE_BYTES

public static final int MINIMUM_UPLOAD_BUFFER_SIZE_BYTES

See Also:

Constant Field Values

Constructor Detail

S3FileSystemConfiguration

public S3FileSystemConfiguration()

Method Detail

getScheme

public abstract java.lang.String getScheme()

The uri scheme used by resources on this filesystem.

getS3StorageClass

public abstract java.lang.String getS3StorageClass()

The AWS S3 storage class used for creating S3 objects.

getS3UploadBufferSizeBytes

public abstract int getS3UploadBufferSizeBytes()

Size of S3 upload chunks.

getS3ThreadPoolSize

public abstract int getS3ThreadPoolSize()

Thread pool size, limiting the max concurrent S3 operations.

getSSEAlgorithm

@Nullable
public abstract java.lang.String getSSEAlgorithm()

Algorithm for SSE-S3 encryption, e.g. AES256.

getSSECustomerKey

@Nullable
public abstract SSECustomerKey getSSECustomerKey()

SSE key for SSE-C encryption, e.g. a base64 encoded key and the algorithm.

getSSEAwsKeyManagementParams

@Nullable
public abstract SSEAwsKeyManagementParams getSSEAwsKeyManagementParams()

KMS key id for SSE-KMS encryption, e.g. "arn:aws:kms:...".

getBucketKeyEnabled

public abstract boolean getBucketKeyEnabled()

Whether to ose an S3 Bucket Key for object encryption with server-side encryption using AWS KMS (SSE-KMS) or not.

getS3ClientBuilder

public abstract AmazonS3ClientBuilder getS3ClientBuilder()

Builder used to create the AmazonS3Client.

builder

public static S3FileSystemConfiguration.Builder builder()

Creates a new uninitialized S3FileSystemConfiguration.Builder.

toBuilder

public abstract S3FileSystemConfiguration.Builder toBuilder()

Creates a new S3FileSystemConfiguration.Builder with values initialized by this instance's properties.

fromS3Options

public static S3FileSystemConfiguration.Builder fromS3Options(S3Options s3Options)

Creates a new S3FileSystemConfiguration.Builder with values initialized by the properties of s3Options.

getBuilder

public static AmazonS3ClientBuilder getBuilder(S3Options s3Options)

Creates a new AmazonS3ClientBuilder as specified by s3Options.