com.amazonaws.services.s3.model

Class Encryption

java.lang.Object

com.amazonaws.services.s3.model.Encryption

All Implemented Interfaces:

Serializable, Cloneable

public class Encryption
extends Object
implements Serializable, Cloneable

Describes the server-side encryption that will be applied to the restore results.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Encryption()

Method Summary

Modifier and Type	Method and Description
Encryption	clone()
boolean	equals(Object obj)
String	getEncryptionType()
String	getKmsContext()
String	getKmsKeyId() If the encryption type is aws:kms, this optional value specifies the ID of the symmetric customer managed Amazon Web Services KMS CMK to use for encryption of job results.
int	hashCode()
void	setEncryptionType(String encryptionType) Sets the server-side encryption algorithm used when storing job results in Amazon S3 (e.g., AES256, aws:kms).
void	setKmsContext(String kmsContext) Sets the optional value used to specify the encryption context for the restore results if the encryption type is aws:kms.
void	setKmsKeyId(String kmsKeyId) If the encryption type is aws:kms, this optional value specifies the ID of the symmetric customer managed Amazon Web Services KMS CMK to use for encryption of job results.
String	toString()
Encryption	withEncryptionType(SSEAlgorithm encryptionType) Sets the encryptionType
Encryption	withEncryptionType(String encryptionType) Sets the encryptionType
Encryption	withKmsContext(String kmsContext) Sets the optional value used to specify the encryption context for the restore results if the encryption type is aws:kms.
Encryption	withKmsKeyId(String kmsKeyId) If the encryption type is aws:kms, this optional value specifies the ID of the symmetric customer managed Amazon Web Services KMS CMK to use for encryption of job results.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Encryption

public Encryption()

Method Detail

getEncryptionType

public String getEncryptionType()

Returns:

The server-side encryption algorithm used when storing job results in Amazon S3 (e.g., AES256, aws:kms).

setEncryptionType

public void setEncryptionType(String encryptionType)

Sets the server-side encryption algorithm used when storing job results in Amazon S3 (e.g., AES256, aws:kms).

Parameters:

encryptionType - The new encryptionType value.

withEncryptionType

public Encryption withEncryptionType(String encryptionType)

Sets the encryptionType

Parameters:

encryptionType - The new encryptionType value.

Returns:

This object for method chaining.

withEncryptionType

public Encryption withEncryptionType(SSEAlgorithm encryptionType)

Sets the encryptionType

Parameters:

encryptionType - The new encryptionType value.

Returns:

This object for method chaining.

getKmsKeyId

public String getKmsKeyId()

If the encryption type is aws:kms, this optional value specifies the ID of the symmetric customer managed Amazon Web Services KMS CMK to use for encryption of job results. Amazon S3 only supports symmetric CMKs. For more information, see Using symmetric and asymmetric keys in the Amazon Web Services Key Management Service Developer Guide.

Returns:

If the encryption type is aws:kms, this optional value specifies the ID of the symmetric customer managed Amazon Web Services KMS CMK to use for encryption of job results. Amazon S3 only supports symmetric CMKs. For more information, see Using symmetric and asymmetric keys in the Amazon Web Services Key Management Service Developer Guide.

setKmsKeyId

public void setKmsKeyId(String kmsKeyId)

If the encryption type is aws:kms, this optional value specifies the ID of the symmetric customer managed Amazon Web Services KMS CMK to use for encryption of job results. Amazon S3 only supports symmetric CMKs. For more information, see Using symmetric and asymmetric keys in the Amazon Web Services Key Management Service Developer Guide.

Parameters:

kmsKeyId - If the encryption type is aws:kms, this optional value specifies the ID of the symmetric customer managed Amazon Web Services KMS CMK to use for encryption of job results. Amazon S3 only supports symmetric CMKs. For more information, see Using symmetric and asymmetric keys in the Amazon Web Services Key Management Service Developer Guide.

withKmsKeyId

public Encryption withKmsKeyId(String kmsKeyId)

If the encryption type is aws:kms, this optional value specifies the ID of the symmetric customer managed Amazon Web Services KMS CMK to use for encryption of job results. Amazon S3 only supports symmetric CMKs. For more information, see Using symmetric and asymmetric keys in the Amazon Web Services Key Management Service Developer Guide.

Parameters:

kmsKeyId - If the encryption type is aws:kms, this optional value specifies the ID of the symmetric customer managed Amazon Web Services KMS CMK to use for encryption of job results. Amazon S3 only supports symmetric CMKs. For more information, see Using symmetric and asymmetric keys in the Amazon Web Services Key Management Service Developer Guide.

Returns:

This object for method chaining.

getKmsContext

public String getKmsContext()

Returns:

encryption context for the restore results.

setKmsContext

public void setKmsContext(String kmsContext)

Sets the optional value used to specify the encryption context for the restore results if the encryption type is aws:kms.

Parameters:

kmsContext - The new kmsContext value.

withKmsContext

public Encryption withKmsContext(String kmsContext)

Sets the optional value used to specify the encryption context for the restore results if the encryption type is aws:kms.

Parameters:

kmsContext - The new kmsContext value.

Returns:

This object for method chaining.

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

clone

public Encryption clone()

Overrides:

clone in class Object