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. For more information, see PUT Bucket encryption in the Amazon S3 API Reference.
Constructor and Description |
---|
ServerSideEncryptionByDefault() |
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.
|
public String getSSEAlgorithm()
public void setSSEAlgorithm(String sseAlgorithm)
sseAlgorithm
- SSE algorithm to use.public ServerSideEncryptionByDefault withSSEAlgorithm(String sseAlgorithm)
sseAlgorithm
- SSE algorithm to use.public ServerSideEncryptionByDefault withSSEAlgorithm(SSEAlgorithm sseAlgorithm)
sseAlgorithm
- SSE algorithm to use.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 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.
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 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.
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 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.
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 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.
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 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.
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 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.
public String toString()
toString
in class Object
Object.toString()
public ServerSideEncryptionByDefault clone()
Copyright © 2021. All rights reserved.