com.amazonaws.services.s3.model

Class ServerSideEncryptionByDefault

java.lang.Object

com.amazonaws.services.s3.model.ServerSideEncryptionByDefault

All Implemented Interfaces:

Serializable, Cloneable

public class ServerSideEncryptionByDefault
extends Object
implements Serializable, Cloneable

Describes the default server-side encryption to apply to new objects in the bucket. If a PUT Object request doesn't specify any server-side encryption, this default encryption will be applied. If you don't specify a customer managed key at configuration, Amazon S3 automatically creates an Amazon Web Services KMS key in your Amazon Web Services account the first time that you add an object encrypted with SSE-KMS to a bucket. By default, Amazon S3 uses this KMS key for SSE-KMS. For more information, see PUT Bucket encryption in the Amazon S3 API Reference.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ServerSideEncryptionByDefault()

Method Summary

Modifier and Type	Method and Description
ServerSideEncryptionByDefault	clone()
boolean	equals(Object obj)
String	getKMSMasterKeyID() Amazon Web Services Key Management Service (KMS) customer Amazon Web Services KMS key ID to use for the default encryption.
String	getSSEAlgorithm()
int	hashCode()
void	setKMSMasterKeyID(String kmsMasterKeyID) Amazon Web Services Key Management Service (KMS) customer Amazon Web Services KMS key ID to use for the default encryption.
void	setSSEAlgorithm(String sseAlgorithm) Sets the server-side encryption algorithm to use for the default encryption.
String	toString() Returns a string representation of this object; useful for testing and debugging.
ServerSideEncryptionByDefault	withKMSMasterKeyID(String kmsMasterKeyID) Amazon Web Services Key Management Service (KMS) customer Amazon Web Services KMS key ID to use for the default encryption.
ServerSideEncryptionByDefault	withSSEAlgorithm(SSEAlgorithm sseAlgorithm) Sets the server-side encryption algorithm to use for the default encryption.
ServerSideEncryptionByDefault	withSSEAlgorithm(String sseAlgorithm) Sets the server-side encryption algorithm to use for the default encryption.

Methods inherited from class java.lang.Object

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

Constructor Detail

ServerSideEncryptionByDefault

public ServerSideEncryptionByDefault()

Method Detail

getSSEAlgorithm

public String getSSEAlgorithm()

Returns:

Server-side encryption algorithm to use for the default encryption.

setSSEAlgorithm

public void setSSEAlgorithm(String sseAlgorithm)

Sets the server-side encryption algorithm to use for the default encryption.

Parameters:

sseAlgorithm - SSE algorithm to use.

withSSEAlgorithm

public ServerSideEncryptionByDefault withSSEAlgorithm(String sseAlgorithm)

Sets the server-side encryption algorithm to use for the default encryption.

Parameters:

sseAlgorithm - SSE algorithm to use.

Returns:

This object for method chaining.

withSSEAlgorithm

public ServerSideEncryptionByDefault withSSEAlgorithm(SSEAlgorithm sseAlgorithm)

Sets the server-side encryption algorithm to use for the default encryption.

Parameters:

sseAlgorithm - SSE algorithm to use.

Returns:

This object for method chaining.

getKMSMasterKeyID

public String getKMSMasterKeyID()

Amazon Web Services Key Management Service (KMS) customer Amazon Web Services KMS key ID to use for the default encryption. This parameter is allowed if and only if SSEAlgorithm is set to aws:kms.

You can specify the key ID or the Amazon Resource Name (ARN) of the KMS key. However, if you are using encryption with cross-account or Amazon Web Services service operations you must use a fully qualified KMS key ARN. For more information, see Using encryption for cross-account operations.

For example:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

• Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

Amazon S3 only supports symmetric KMS keys and not asymmetric KMS keys. For more information, see Using symmetric and asymmetric keys in the Amazon Web Services Key Management Service Developer Guide.

Returns:

Amazon Web Services Key Management Service (KMS) customer Amazon Web Services KMS key ID to use for the default encryption. This parameter is allowed if and only if SSEAlgorithm is set to aws:kms.

You can specify the key ID or the Amazon Resource Name (ARN) of the KMS key. However, if you are using encryption with cross-account or Amazon Web Services service operations you must use a fully qualified KMS key ARN. For more information, see Using encryption for cross-account operations.

For example:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

• Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

Amazon S3 only supports symmetric KMS keys and not asymmetric KMS keys. For more information, see Using symmetric and asymmetric keys in the Amazon Web Services Key Management Service Developer Guide.

setKMSMasterKeyID

public void setKMSMasterKeyID(String kmsMasterKeyID)

Amazon Web Services Key Management Service (KMS) customer Amazon Web Services KMS key ID to use for the default encryption. This parameter is allowed if and only if SSEAlgorithm is set to aws:kms.

You can specify the key ID or the Amazon Resource Name (ARN) of the KMS key. However, if you are using encryption with cross-account or Amazon Web Services service operations you must use a fully qualified KMS key ARN. For more information, see Using encryption for cross-account operations.

For example:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

• Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

Amazon S3 only supports symmetric KMS keys and not asymmetric KMS keys. For more information, see Using symmetric and asymmetric keys in the Amazon Web Services Key Management Service Developer Guide.

Parameters:

kmsMasterKeyID - Amazon Web Services Key Management Service (KMS) customer Amazon Web Services KMS key ID to use for the default encryption. This parameter is allowed if and only if SSEAlgorithm is set to aws:kms.

You can specify the key ID or the Amazon Resource Name (ARN) of the KMS key. However, if you are using encryption with cross-account or Amazon Web Services service operations you must use a fully qualified KMS key ARN. For more information, see Using encryption for cross-account operations.

For example:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

• Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

Amazon S3 only supports symmetric KMS keys and not asymmetric KMS keys. For more information, see Using symmetric and asymmetric keys in the Amazon Web Services Key Management Service Developer Guide.

withKMSMasterKeyID

public ServerSideEncryptionByDefault withKMSMasterKeyID(String kmsMasterKeyID)

Amazon Web Services Key Management Service (KMS) customer Amazon Web Services KMS key ID to use for the default encryption. This parameter is allowed if and only if SSEAlgorithm is set to aws:kms.

You can specify the key ID or the Amazon Resource Name (ARN) of the KMS key. However, if you are using encryption with cross-account or Amazon Web Services service operations you must use a fully qualified KMS key ARN. For more information, see Using encryption for cross-account operations.

For example:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

• Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

Amazon S3 only supports symmetric KMS keys and not asymmetric KMS keys. For more information, see Using symmetric and asymmetric keys in the Amazon Web Services Key Management Service Developer Guide.

Parameters:

kmsMasterKeyID - Amazon Web Services Key Management Service (KMS) customer Amazon Web Services KMS key ID to use for the default encryption. This parameter is allowed if and only if SSEAlgorithm is set to aws:kms.

You can specify the key ID or the Amazon Resource Name (ARN) of the KMS key. However, if you are using encryption with cross-account or Amazon Web Services service operations you must use a fully qualified KMS key ARN. For more information, see Using encryption for cross-account operations.

For example:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

• Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

Amazon S3 only supports symmetric KMS keys and not asymmetric KMS keys. For more information, see Using symmetric and asymmetric keys in the Amazon Web Services Key Management Service Developer Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public ServerSideEncryptionByDefault clone()

Overrides:

clone in class Object