org.apache.nifi.processors.aws.s3

Interface AmazonS3EncryptionService

All Superinterfaces:

ConfigurableComponent, ControllerService

public interface AmazonS3EncryptionService
extends ControllerService

This interface defines how clients interact with an S3 encryption service.

Field Summary

Fields

Modifier and Type	Field and Description
static String	STRATEGY_NAME_CSE_C
static String	STRATEGY_NAME_CSE_KMS
static String	STRATEGY_NAME_NONE
static String	STRATEGY_NAME_SSE_C
static String	STRATEGY_NAME_SSE_KMS
static String	STRATEGY_NAME_SSE_S3

Method Summary

Modifier and Type	Method and Description
void	configureGetObjectRequest(com.amazonaws.services.s3.model.GetObjectRequest request, com.amazonaws.services.s3.model.ObjectMetadata objectMetadata) Configure a GetObjectRequest for encryption.
void	configureInitiateMultipartUploadRequest(com.amazonaws.services.s3.model.InitiateMultipartUploadRequest request, com.amazonaws.services.s3.model.ObjectMetadata objectMetadata) Configure an InitiateMultipartUploadRequest for encryption.
void	configurePutObjectRequest(com.amazonaws.services.s3.model.PutObjectRequest request, com.amazonaws.services.s3.model.ObjectMetadata objectMetadata) Configure a PutObjectRequest for encryption.
void	configureUploadPartRequest(com.amazonaws.services.s3.model.UploadPartRequest request, com.amazonaws.services.s3.model.ObjectMetadata objectMetadata) Configure an UploadPartRequest for encryption.
com.amazonaws.services.s3.AmazonS3Client	createEncryptionClient(com.amazonaws.auth.AWSCredentialsProvider credentialsProvider, com.amazonaws.ClientConfiguration clientConfiguration) Create an S3 encryption client.
String	getKmsRegion()
String	getStrategyDisplayName()
String	getStrategyName()

Methods inherited from interface org.apache.nifi.controller.ControllerService

initialize

Methods inherited from interface org.apache.nifi.components.ConfigurableComponent

getIdentifier, getPropertyDescriptor, getPropertyDescriptors, onPropertyModified, validate

Field Detail

STRATEGY_NAME_NONE

static final String STRATEGY_NAME_NONE

See Also:

Constant Field Values

STRATEGY_NAME_SSE_S3

static final String STRATEGY_NAME_SSE_S3

See Also:

Constant Field Values

STRATEGY_NAME_SSE_KMS

static final String STRATEGY_NAME_SSE_KMS

See Also:

Constant Field Values

STRATEGY_NAME_SSE_C

static final String STRATEGY_NAME_SSE_C

See Also:

Constant Field Values

STRATEGY_NAME_CSE_KMS

static final String STRATEGY_NAME_CSE_KMS

See Also:

Constant Field Values

STRATEGY_NAME_CSE_C

static final String STRATEGY_NAME_CSE_C

See Also:

Constant Field Values

Method Detail

configurePutObjectRequest

void configurePutObjectRequest(com.amazonaws.services.s3.model.PutObjectRequest request,
                               com.amazonaws.services.s3.model.ObjectMetadata objectMetadata)

Configure a PutObjectRequest for encryption.

Parameters:

request - the request to configure.

objectMetadata - the request metadata to configure.

configureInitiateMultipartUploadRequest

void configureInitiateMultipartUploadRequest(com.amazonaws.services.s3.model.InitiateMultipartUploadRequest request,
                                             com.amazonaws.services.s3.model.ObjectMetadata objectMetadata)

Configure an InitiateMultipartUploadRequest for encryption.

Parameters:

request - the request to configure.

objectMetadata - the request metadata to configure.

configureGetObjectRequest

void configureGetObjectRequest(com.amazonaws.services.s3.model.GetObjectRequest request,
                               com.amazonaws.services.s3.model.ObjectMetadata objectMetadata)

Configure a GetObjectRequest for encryption.

Parameters:

request - the request to configure.

objectMetadata - the request metadata to configure.

configureUploadPartRequest

void configureUploadPartRequest(com.amazonaws.services.s3.model.UploadPartRequest request,
                                com.amazonaws.services.s3.model.ObjectMetadata objectMetadata)

Configure an UploadPartRequest for encryption.

Parameters:

request - the request to configure.

objectMetadata - the request metadata to configure.

createEncryptionClient

com.amazonaws.services.s3.AmazonS3Client createEncryptionClient(com.amazonaws.auth.AWSCredentialsProvider credentialsProvider,
                                                                com.amazonaws.ClientConfiguration clientConfiguration)

Create an S3 encryption client.

Parameters:

credentialsProvider - AWS credentials provider.

clientConfiguration - Client configuration.

Returns:

AmazonS3Client, perhaps an AmazonS3EncryptionClient

getKmsRegion

String getKmsRegion()

Returns:

The KMS region associated with the service, as a String.

getStrategyName

String getStrategyName()

Returns:

The name of the encryption strategy associated with the service.

getStrategyDisplayName

String getStrategyDisplayName()

Returns:

The display name of the encryption strategy associated with the service.