com.amazonaws.services.s3

Class AmazonS3EncryptionClientV2Builder

java.lang.Object

com.amazonaws.client.builder.AwsClientBuilder<Subclass,TypeToBuild>

com.amazonaws.client.builder.AwsSyncClientBuilder<Subclass,TypeToBuild>

com.amazonaws.services.s3.AmazonS3Builder<AmazonS3EncryptionClientV2Builder,AmazonS3EncryptionV2>

com.amazonaws.services.s3.AmazonS3EncryptionClientV2Builder

public final class AmazonS3EncryptionClientV2Builder
extends AmazonS3Builder<AmazonS3EncryptionClientV2Builder,AmazonS3EncryptionV2>

Nested Class Summary

Nested classes/interfaces inherited from class com.amazonaws.client.builder.AwsClientBuilder

AwsClientBuilder.EndpointConfiguration, AwsClientBuilder.SyncBuilderParams

Field Summary

Fields inherited from class com.amazonaws.services.s3.AmazonS3Builder

clientFactory

Constructor Summary

Constructors

Constructor and Description
AmazonS3EncryptionClientV2Builder()

Method Summary

Modifier and Type	Method and Description
protected AmazonS3EncryptionV2	build(AwsSyncClientParams clientParams) Construct a synchronous implementation of AmazonS3Encryption using the current builder configuration.
void	setCryptoConfiguration(CryptoConfigurationV2 cryptoConfig) Sets the crypto configuration whose parameters will be used to encrypt and decrypt data.
void	setEncryptionMaterialsProvider(EncryptionMaterialsProvider encryptionMaterialsProvider) Sets the encryption materials to be used to encrypt and decrypt data
void	setKmsClient(AWSKMS kmsClient) Sets the KMS implementation to be used throughout the crypto process.
static AmazonS3EncryptionClientV2Builder	standard()
AmazonS3EncryptionClientV2Builder	withCryptoConfiguration(CryptoConfigurationV2 cryptoConfig) Sets the crypto configuration whose parameters will be used to encrypt and decrypt data.
AmazonS3EncryptionClientV2Builder	withEncryptionMaterialsProvider(EncryptionMaterialsProvider encryptionMaterialsProvider) Sets the encryption materials to be used to encrypt and decrypt data.
AmazonS3EncryptionClientV2Builder	withKmsClient(AWSKMS kmsClient) Sets the KMS implementation to be used throughout the crypto process

Methods inherited from class com.amazonaws.services.s3.AmazonS3Builder

disableChunkedEncoding, enableAccelerateMode, enableDualstack, enableForceGlobalBucketAccess, enablePathStyleAccess, enablePayloadSigning, enableRegionalUsEast1Endpoint, enableUseArnRegion, isAccelerateModeEnabled, isChunkedEncodingDisabled, isDualstackEnabled, isForceGlobalBucketAccessEnabled, isPathStyleAccessEnabled, isPayloadSigningEnabled, isRegionalUsEast1EndpointEnabled, isUseArnRegionEnabled, resolveS3ClientOptions, setAccelerateModeEnabled, setChunkedEncodingDisabled, setDualstackEnabled, setForceGlobalBucketAccessEnabled, setPathStyleAccessEnabled, setPayloadSigningEnabled, setRegionalUsEast1EndpointEnabled, withAccelerateModeEnabled, withChunkedEncodingDisabled, withDualstackEnabled, withForceGlobalBucketAccessEnabled, withPathStyleAccessEnabled, withPayloadSigningEnabled, withRegionalUsEast1EndpointEnabled

Methods inherited from class com.amazonaws.client.builder.AwsSyncClientBuilder

build

Methods inherited from class com.amazonaws.client.builder.AwsClientBuilder

getAdvancedConfig, getAdvancedConfig, getClientConfiguration, getClientSideMonitoringConfigurationProvider, getCredentials, getEndpoint, getMetricsCollector, getMonitoringListener, getRegion, getRequestHandlers, getSubclass, getSyncClientParams, putAdvancedConfig, setClientConfiguration, setClientSideMonitoringConfigurationProvider, setCredentials, setEndpointConfiguration, setMetricsCollector, setMonitoringListener, setRegion, setRequestHandlers, withClientConfiguration, withClientSideMonitoringConfigurationProvider, withCredentials, withEndpointConfiguration, withMetricsCollector, withMonitoringListener, withRegion, withRegion, withRequestHandlers

Methods inherited from class java.lang.Object

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

Constructor Detail

AmazonS3EncryptionClientV2Builder

public AmazonS3EncryptionClientV2Builder()

Method Detail

standard

public static AmazonS3EncryptionClientV2Builder standard()

Returns:

Create new instance of builder with all defaults set.

setEncryptionMaterialsProvider

public void setEncryptionMaterialsProvider(EncryptionMaterialsProvider encryptionMaterialsProvider)

Sets the encryption materials to be used to encrypt and decrypt data

Note: If a non-KMS encryption materials provider is used, an internal KMS client will still be created by default. See setKmsClient(AWSKMS) for more information.

Parameters:

encryptionMaterialsProvider - a provider for the encryption materials

withEncryptionMaterialsProvider

public AmazonS3EncryptionClientV2Builder withEncryptionMaterialsProvider(EncryptionMaterialsProvider encryptionMaterialsProvider)

Sets the encryption materials to be used to encrypt and decrypt data.

Note: If a non-KMS encryption materials provider is used, an internal KMS client will still be created by default. See withKmsClient(AWSKMS) for more information.

Parameters:

encryptionMaterialsProvider - A provider for the encryption materials to be used to encrypt and decrypt data.

Returns:

this object for method chaining

setCryptoConfiguration

public void setCryptoConfiguration(CryptoConfigurationV2 cryptoConfig)

Sets the crypto configuration whose parameters will be used to encrypt and decrypt data.

Parameters:

cryptoConfig - crypto configuration

withCryptoConfiguration

public AmazonS3EncryptionClientV2Builder withCryptoConfiguration(CryptoConfigurationV2 cryptoConfig)

Sets the crypto configuration whose parameters will be used to encrypt and decrypt data.

Parameters:

cryptoConfig - crypto configuration

Returns:

this object for method chaining

setKmsClient

public void setKmsClient(AWSKMS kmsClient)

Sets the KMS implementation to be used throughout the crypto process.

If a KMS client isn't specified here, the encryption client creates a default internal KMS client.
Note: An internal KMS client is created even if the user supply their own encryption materials. If the KMS client fails to find a region when it's instantiated, supply a client through this method or set the KMS region through CryptoConfigurationV2.withAwsKmsRegion(Region).

Parameters:

kmsClient - an AWSKMS implementation (e.g. AWSKMSClient)

withKmsClient

public AmazonS3EncryptionClientV2Builder withKmsClient(AWSKMS kmsClient)

Sets the KMS implementation to be used throughout the crypto process

If a KMS client isn't specified here, the encryption client creates a default internal KMS client.
Note: An internal KMS client is created even if the user supply their own encryption materials. If the KMS client fails to find a region when it's instantiated, supply a client through this method or set the KMS region through CryptoConfigurationV2.withAwsKmsRegion(Region).

Parameters:

kmsClient - an AWSKMS implementation (e.g. AWSKMSClient)

Returns:

this object for method chaining

build

protected AmazonS3EncryptionV2 build(AwsSyncClientParams clientParams)

Construct a synchronous implementation of AmazonS3Encryption using the current builder configuration.

Specified by:

build in class AwsSyncClientBuilder<AmazonS3EncryptionClientV2Builder,AmazonS3EncryptionV2>

Returns:

Fully configured implementation of AmazonS3EncryptionV2.