Interface AmazonS3EncryptionService
- All Superinterfaces:
org.apache.nifi.components.ConfigurableComponent,org.apache.nifi.controller.ControllerService
public interface AmazonS3EncryptionService
extends org.apache.nifi.controller.ControllerService
This interface defines how clients interact with an S3 encryption service.
-
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionvoidconfigureGetObjectRequest(com.amazonaws.services.s3.model.GetObjectRequest request, com.amazonaws.services.s3.model.ObjectMetadata objectMetadata) Configure aGetObjectRequestfor encryption.voidconfigureInitiateMultipartUploadRequest(com.amazonaws.services.s3.model.InitiateMultipartUploadRequest request, com.amazonaws.services.s3.model.ObjectMetadata objectMetadata) Configure anInitiateMultipartUploadRequestfor encryption.voidconfigurePutObjectRequest(com.amazonaws.services.s3.model.PutObjectRequest request, com.amazonaws.services.s3.model.ObjectMetadata objectMetadata) Configure aPutObjectRequestfor encryption.voidconfigureUploadPartRequest(com.amazonaws.services.s3.model.UploadPartRequest request, com.amazonaws.services.s3.model.ObjectMetadata objectMetadata) Configure anUploadPartRequestfor encryption.com.amazonaws.services.s3.AmazonS3createEncryptionClient(Consumer<com.amazonaws.services.s3.AmazonS3Builder<?, ?>> clientBuilder) Create an S3 encryption client.Methods inherited from interface org.apache.nifi.components.ConfigurableComponent
getIdentifier, getPropertyDescriptor, getPropertyDescriptors, onPropertyModified, validateMethods inherited from interface org.apache.nifi.controller.ControllerService
initialize, isStateful, migrateProperties
-
Field Details
-
STRATEGY_NAME_NONE
- See Also:
-
STRATEGY_NAME_SSE_S3
- See Also:
-
STRATEGY_NAME_SSE_KMS
- See Also:
-
STRATEGY_NAME_SSE_C
- See Also:
-
STRATEGY_NAME_CSE_KMS
- See Also:
-
STRATEGY_NAME_CSE_C
- See Also:
-
-
Method Details
-
configurePutObjectRequest
void configurePutObjectRequest(com.amazonaws.services.s3.model.PutObjectRequest request, com.amazonaws.services.s3.model.ObjectMetadata objectMetadata) Configure aPutObjectRequestfor 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 anInitiateMultipartUploadRequestfor 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 aGetObjectRequestfor 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 anUploadPartRequestfor encryption.- Parameters:
request- the request to configure.objectMetadata- the request metadata to configure.
-
createEncryptionClient
com.amazonaws.services.s3.AmazonS3 createEncryptionClient(Consumer<com.amazonaws.services.s3.AmazonS3Builder<?, ?>> clientBuilder) Create an S3 encryption client.- Parameters:
clientBuilder- a Consumer that is responsible for configuring the client builder
-
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.
-