CryptoConfigurationV2 (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.s3.model.CryptoConfigurationV2

All Implemented Interfaces:

Serializable, Cloneable
```
public class CryptoConfigurationV2
extends Object
implements Cloneable, Serializable
```
Stores configuration parameters that will be used during encryption and decryption by the Amazon S3 Encryption Client V2 AmazonS3EncryptionClientV2.
Note: The withAwsKmsRegion(Region) parameter only affects the internally instantiated KMS client that is created by default, not an external client added through AmazonS3EncryptionClientV2Builder.withKmsClient(AWSKMS). The internal KMS client is instantiated even if the user supply their own encryption materials and do not call KMS.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description
`CryptoConfigurationV2()` Creates a new CryptoConfiguration object with default crypto mode, `CryptoMode.StrictAuthenticatedEncryption`.
`CryptoConfigurationV2(CryptoMode cryptoMode)` Creates a new CryptoConfiguration object with default storage mode and crypto provider settings.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CryptoConfigurationV2`	`clone()`
`boolean`	`getAlwaysUseCryptoProvider()` Returns true if the specified crypto provider should be used in all cases.
`Region`	`getAwsKmsRegion()` Returns the the KMS region explicitly specified for the Amazon Web Services KMS client when such client is internally instantiated; or null if no explicit KMS region is specified.
`CryptoMode`	`getCryptoMode()` Returns the optionally specified crypto mode applicable only to the S3 encryption client; or null.
`Provider`	`getCryptoProvider()` Returns the crypto provider whose encryption implementation will be used to encrypt and decrypt data.
`CryptoRangeGetMode`	`getRangeGetMode()`
`SecureRandom`	`getSecureRandom()` Returns the SecureRandom instance that will be used to generate cryptographic parameters.
`CryptoStorageMode`	`getStorageMode()` Returns the current storage mode of a CryptoConfiguration object.
`boolean`	`isReadOnly()`
`boolean`	`isUnsafeUndecryptableObjectPassthrough()` Returns true to pass through (download) an encrypted object without decrypting it during a GET operation, if no encryption metadata is found for the object; false otherwise.
`CryptoConfigurationV2`	`readOnly()` Returns a read-only copy of this configuration.
`void`	`setAlwaysUseCryptoProvider(boolean value)` Sets whether the specified crypto provider should be used in all cases.
`void`	`setAwsKmsRegion(Region awsKmsRegion)` Sets the KMS region for the Amazon Web Services KMS client when such client is internally instantiated instead of externally passed in by users; or null if no explicit KMS region is explicitly configured.This KMS region parameter is ignored when the Amazon Web Services KMS client of the S3 encryption client is explicitly passed in by the users, instead of being implicitly created.
`void`	`setCryptoMode(CryptoMode cryptoMode)` Sets the crypto mode; applicable only to the S3 encryption client.
`void`	`setCryptoProvider(Provider cryptoProvider)` Sets the crypto provider to the specified provider.
`void`	`setRangeGetMode(CryptoRangeGetMode rangeGetMode)` An optional parameter specifying the behavior of the client when a GetObjectRequest is made that includes a range or part number.
`void`	`setSecureRandom(SecureRandom secureRandom)` Sets the secure random instance to use for generating cryptographic parameters.
`void`	`setStorageMode(CryptoStorageMode storageMode)` Sets the storage mode to the specified mode.
`void`	`setUnsafeUndecryptableObjectPassthrough(boolean unsafeUndecryptableObjectPassthrough)` Set the property to to pass through (download) an encrypted object without decrypting it during a GET operation, if no encryption metadata is found for the object.
`CryptoConfigurationV2`	`withAlwaysUseCryptoProvider(boolean value)` Sets whether the specified crypto provider should be used in all cases.
`CryptoConfigurationV2`	`withAwsKmsRegion(Region awsKmsRegion)` Fluent API for setting the KMS region for the Amazon Web Services KMS client when such client is internally instantiated instead of externally passed in by users; or null if no explicit KMS region is explicitly configured.This KMS region parameter is ignored when the Amazon Web Services KMS client of the S3 encryption client is explicitly passed in by the users, instead of being implicitly created.
`CryptoConfigurationV2`	`withCryptoMode(CryptoMode cryptoMode)` Fluent API to set the crypto mode; applicable only to the S3 encryption client.
`CryptoConfigurationV2`	`withCryptoProvider(Provider cryptoProvider)` Sets the crypto provider to the specified provider, and returns the updated CryptoConfiguration object.
`CryptoConfigurationV2`	`withRangeGetMode(CryptoRangeGetMode rangeGetMode)` An optional parameter specifying the behavior of the client a GetObjectRequest is made for only part of an object.
`CryptoConfigurationV2`	`withSecureRandom(SecureRandom secureRandom)` Sets the secure random instance to use for generating cryptographic parameters, and returns this object.
`CryptoConfigurationV2`	`withStorageMode(CryptoStorageMode storageMode)` Sets the storage mode to the specified mode, and returns the updated CryptoConfiguration object.
`CryptoConfigurationV2`	`withUnsafeUndecryptableObjectPassthrough(boolean unsafeUndecryptableObjectPassthrough)` Fluent API to set the property to to pass through (download) an encrypted object without decrypting it during a GET operation, if no encryption metadata is found for the object.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - CryptoConfigurationV2
```
public CryptoConfigurationV2()
```
    Creates a new CryptoConfiguration object with default crypto mode, CryptoMode.StrictAuthenticatedEncryption.
  - CryptoConfigurationV2
```
public CryptoConfigurationV2(CryptoMode cryptoMode)
```
    Creates a new CryptoConfiguration object with default storage mode and crypto provider settings. The default storage mode is the Object Metadata storage mode, and the default crypto provider is the JCE provider. Note that the V2 configuration and encryption client does not support CryptoMode.EncryptionOnly. Attempts to use that mode will result in an exception.
    
    Parameters:
    
    cryptoMode - cryptographic mode to be used
    
    Throws:
    
    UnsupportedOperationException - if the necessary security provider cannot be found, the necessary cryptographic operations are not supported for the specified crypto mode or an unsupported crypto mode is supplied
- Method Detail
  - setStorageMode
```
public void setStorageMode(CryptoStorageMode storageMode)
```
    Sets the storage mode to the specified mode.
    
    Parameters:
    
    storageMode - The storage mode to be used for storing encryption information.
  - withStorageMode
```
public CryptoConfigurationV2 withStorageMode(CryptoStorageMode storageMode)
```
    Sets the storage mode to the specified mode, and returns the updated CryptoConfiguration object.
    
    Parameters:
    
    storageMode - The storage mode to be used for storing encryption information.
    
    Returns:
    
    The updated CryptoConfiguration object.
  - getStorageMode
```
public CryptoStorageMode getStorageMode()
```
    Returns the current storage mode of a CryptoConfiguration object.
    
    Returns:
    
    The storage mode to be used for storing encryption information.
  - setCryptoProvider
```
public void setCryptoProvider(Provider cryptoProvider)
```
    Sets the crypto provider to the specified provider.
    
    Parameters:
    
    cryptoProvider - The crypto provider whose encryption implementation will be used to encrypt and decrypt data.
  - withCryptoProvider
```
public CryptoConfigurationV2 withCryptoProvider(Provider cryptoProvider)
```
    Sets the crypto provider to the specified provider, and returns the updated CryptoConfiguration object.
    
    Parameters:
    
    cryptoProvider - The crypto provider whose encryption implementation will be used to encrypt and decrypt data.
    
    Returns:
    
    The updated CryptoConfiguration object.
  - getCryptoProvider
```
public Provider getCryptoProvider()
```
    Returns the crypto provider whose encryption implementation will be used to encrypt and decrypt data.
    
    Returns:
    
    the crypto provider whose encryption implementation will be used to encrypt and decrypt data.
  - setAlwaysUseCryptoProvider
```
public void setAlwaysUseCryptoProvider(boolean value)
```
    Sets whether the specified crypto provider should be used in all cases. For backwards compatibility, it will be ignored if CryptoMode specified authenticated encryption.
  - withAlwaysUseCryptoProvider
```
public CryptoConfigurationV2 withAlwaysUseCryptoProvider(boolean value)
```
    Sets whether the specified crypto provider should be used in all cases. For backwards compatibility, it will be ignored if CryptoMode specified authenticated encryption.
  - getAlwaysUseCryptoProvider
```
public boolean getAlwaysUseCryptoProvider()
```
    Returns true if the specified crypto provider should be used in all cases. For backwards compatibility, it will be ignored if CryptoMode specifies authenticated encryption.
    
    Returns:
    
    true if the crypto provider should always be used
  - getSecureRandom
```
public SecureRandom getSecureRandom()
```
    Returns the SecureRandom instance that will be used to generate cryptographic parameters.
  - setSecureRandom
```
public void setSecureRandom(SecureRandom secureRandom)
```
    Sets the secure random instance to use for generating cryptographic parameters.
  - withSecureRandom
```
public CryptoConfigurationV2 withSecureRandom(SecureRandom secureRandom)
```
    Sets the secure random instance to use for generating cryptographic parameters, and returns this object.
  - getCryptoMode
```
public CryptoMode getCryptoMode()
```
    Returns the optionally specified crypto mode applicable only to the S3 encryption client; or null. This attribute is ignored if the S3 encryption client is not in use.
  - setCryptoMode
```
public void setCryptoMode(CryptoMode cryptoMode)
                   throws UnsupportedOperationException
```
    Sets the crypto mode; applicable only to the S3 encryption client.
    
    Throws:
    
    UnsupportedOperationException - if the necessary security provider cannot be found, the necessary cryptographic operations are not supported for the specified crypto mode or an unsupported crypto mode is supplied.
  - withCryptoMode
```
public CryptoConfigurationV2 withCryptoMode(CryptoMode cryptoMode)
                                     throws UnsupportedOperationException
```
    Fluent API to set the crypto mode; applicable only to the S3 encryption client. Note that the V2 configuration and encryption client does not support CryptoMode.EncryptionOnly. Attempts to use that mode will result in an exception.
    
    Throws:
    
    UnsupportedOperationException - if the necessary security provider cannot be found, the necessary cryptographic operations are not supported for the specified crypto mode or an unsupported crypto mode is supplied.
  - isUnsafeUndecryptableObjectPassthrough
```
public boolean isUnsafeUndecryptableObjectPassthrough()
```
    Returns true to pass through (download) an encrypted object without decrypting it during a GET operation, if no encryption metadata is found for the object; false otherwise. Default is false.
  - setUnsafeUndecryptableObjectPassthrough
```
public void setUnsafeUndecryptableObjectPassthrough(boolean unsafeUndecryptableObjectPassthrough)
```
    Set the property to to pass through (download) an encrypted object without decrypting it during a GET operation, if no encryption metadata is found for the object. Default is false. An exception will be thrown if it's enabled with CryptoMode.StrictAuthenticatedEncryption crypto mode configured.
    
    Parameters:
    
    unsafeUndecryptableObjectPassthrough - unsafeUndecryptableObjectPassthrough to set
  - withUnsafeUndecryptableObjectPassthrough
```
public CryptoConfigurationV2 withUnsafeUndecryptableObjectPassthrough(boolean unsafeUndecryptableObjectPassthrough)
```
    Fluent API to set the property to to pass through (download) an encrypted object without decrypting it during a GET operation, if no encryption metadata is found for the object. Default is false. An exception will be thrown if it's enabled with CryptoMode.StrictAuthenticatedEncryption crypto mode configured.
  - getAwsKmsRegion
```
public Region getAwsKmsRegion()
```
    Returns the the KMS region explicitly specified for the Amazon Web Services KMS client when such client is internally instantiated; or null if no explicit KMS region is specified. This KMS region parameter is ignored when the Amazon Web Services KMS client of the S3 encryption client is explicitly passed in by the users, instead of being implicitly created.
  - setAwsKmsRegion
```
public void setAwsKmsRegion(Region awsKmsRegion)
```
    Sets the KMS region for the Amazon Web Services KMS client when such client is internally instantiated instead of externally passed in by users; or null if no explicit KMS region is explicitly configured.This KMS region parameter is ignored when the Amazon Web Services KMS client of the S3 encryption client is explicitly passed in by the users, instead of being implicitly created. Note: An internal KMS client is created even if the user supply their own encryption materials.
    
    See Also:
    
    AmazonS3EncryptionClientV2Builder.setKmsClient(AWSKMS)
  - withAwsKmsRegion
```
public CryptoConfigurationV2 withAwsKmsRegion(Region awsKmsRegion)
```
    Fluent API for setting the KMS region for the Amazon Web Services KMS client when such client is internally instantiated instead of externally passed in by users; or null if no explicit KMS region is explicitly configured.This KMS region parameter is ignored when the Amazon Web Services KMS client of the S3 encryption client is explicitly passed in by the users, instead of being implicitly created. Note: An internal KMS client is created even if the user supply their own encryption materials.
    
    See Also:
    
    AmazonS3EncryptionClientV2Builder.setKmsClient(AWSKMS)
  - withRangeGetMode
```
public CryptoConfigurationV2 withRangeGetMode(CryptoRangeGetMode rangeGetMode)
```
    An optional parameter specifying the behavior of the client a GetObjectRequest is made for only part of an object.
    Range gets do not provide authenticated encryption properties even when used with an authenticated mode (AES-GCM).
    By default, range gets are disabled.
    
    Parameters:
    
    rangeGetMode - The range get mode.
  - setRangeGetMode
```
public void setRangeGetMode(CryptoRangeGetMode rangeGetMode)
```
    An optional parameter specifying the behavior of the client when a GetObjectRequest is made that includes a range or part number.
    Range gets do not provide authenticated encryption properties even when used with an authenticated mode (AES-GCM).
    By default, range gets are disabled.
    
    Parameters:
    
    rangeGetMode - The range get mode.
  - getRangeGetMode
```
public CryptoRangeGetMode getRangeGetMode()
```
  - isReadOnly
```
public boolean isReadOnly()
```
  - readOnly
```
public CryptoConfigurationV2 readOnly()
```
    Returns a read-only copy of this configuration.
  - clone
```
public CryptoConfigurationV2 clone()
```
    Overrides:
    
    clone in class Object

AWS SDK for Java 1.x API Reference - 1.12.777

Class CryptoConfigurationV2

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CryptoConfigurationV2

CryptoConfigurationV2

Method Detail

setStorageMode

withStorageMode

getStorageMode

setCryptoProvider

withCryptoProvider

getCryptoProvider

setAlwaysUseCryptoProvider

withAlwaysUseCryptoProvider

getAlwaysUseCryptoProvider

getSecureRandom

setSecureRandom

withSecureRandom

getCryptoMode

setCryptoMode

withCryptoMode

isUnsafeUndecryptableObjectPassthrough

setUnsafeUndecryptableObjectPassthrough

withUnsafeUndecryptableObjectPassthrough

getAwsKmsRegion

setAwsKmsRegion

withAwsKmsRegion

withRangeGetMode

setRangeGetMode

getRangeGetMode

isReadOnly

readOnly

clone