Package software.amazon.awscdk.services.s3

Interface CfnBucket.ServerSideEncryptionByDefaultProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnBucket.ServerSideEncryptionByDefaultProperty.Jsii$Proxy

Enclosing class:

CfnBucket

@Stability(Stable)
public static interface CfnBucket.ServerSideEncryptionByDefaultProperty
extends software.amazon.jsii.JsiiSerializable

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 AWS KMS key in your AWS 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 .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.s3.*;
 ServerSideEncryptionByDefaultProperty serverSideEncryptionByDefaultProperty = ServerSideEncryptionByDefaultProperty.builder()
         .sseAlgorithm("sseAlgorithm")
         // the properties below are optional
         .kmsMasterKeyId("kmsMasterKeyId")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-serversideencryptionbydefault.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnBucket.ServerSideEncryptionByDefaultProperty.Builder	A builder for CfnBucket.ServerSideEncryptionByDefaultProperty
static final class	CfnBucket.ServerSideEncryptionByDefaultProperty.Jsii$Proxy	An implementation for CfnBucket.ServerSideEncryptionByDefaultProperty

Method Summary

Modifier and Type	Method	Description
static CfnBucket.ServerSideEncryptionByDefaultProperty.Builder	builder()
default String	getKmsMasterKeyId()	AWS Key Management Service (KMS) customer AWS KMS key ID to use for the default encryption.
String	getSseAlgorithm()	Server-side encryption algorithm to use for the default encryption.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getSseAlgorithm

@Stability(Stable)
@NotNull
String getSseAlgorithm()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-serversideencryptionbydefault.html#cfn-s3-bucket-serversideencryptionbydefault-ssealgorithm

getKmsMasterKeyId

@Stability(Stable)
@Nullable
default String getKmsMasterKeyId()

AWS Key Management Service (KMS) customer AWS KMS key ID to use for the default encryption.

This parameter is allowed if and only if SSEAlgorithm is set to aws:kms or aws:kms:dsse .

You can specify the key ID, key alias, or the Amazon Resource Name (ARN) of the KMS key.

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

If you use a key ID, you can run into a LogDestination undeliverable error when creating a VPC flow log.

If you are using encryption with cross-account or AWS service operations you must use a fully qualified KMS key ARN. For more information, see Using encryption for cross-account operations .

Amazon S3 only supports symmetric encryption KMS keys. For more information, see Asymmetric keys in AWS KMS in the AWS Key Management Service Developer Guide .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-serversideencryptionbydefault.html#cfn-s3-bucket-serversideencryptionbydefault-kmsmasterkeyid

builder

@Stability(Stable)
static CfnBucket.ServerSideEncryptionByDefaultProperty.Builder builder()

Returns:

a CfnBucket.ServerSideEncryptionByDefaultProperty.Builder of CfnBucket.ServerSideEncryptionByDefaultProperty