Package software.amazon.awscdk.cfnpropertymixins.services.s3express

Interface CfnDirectoryBucketPropsMixin.ServerSideEncryptionByDefaultProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDirectoryBucketPropsMixin.ServerSideEncryptionByDefaultProperty.Jsii$Proxy

Enclosing class:

CfnDirectoryBucketPropsMixin

@Stability(Stable)
public static interface CfnDirectoryBucketPropsMixin.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. For more information, see PutBucketEncryption 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.cfnpropertymixins.services.s3express.*;
 ServerSideEncryptionByDefaultProperty serverSideEncryptionByDefaultProperty = ServerSideEncryptionByDefaultProperty.builder()
         .kmsMasterKeyId("kmsMasterKeyId")
         .sseAlgorithm("sseAlgorithm")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getKmsMasterKeyId

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

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

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

You can specify this parameter with the key ID or the Amazon Resource Name (ARN) of the KMS key. You can’t use the key alias 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

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 .

Your SSE-KMS configuration can only support 1 customer managed key per directory bucket for the lifetime of the bucket. AWS managed key ( aws/s3 ) isn't supported. Also, after you specify a customer managed key for SSE-KMS and upload objects with this configuration, you can't override the customer managed key for your SSE-KMS configuration. To use a new customer manager key for your data, we recommend copying your existing objects to a new directory bucket with a new customer managed key. > 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 .

Returns union: either String or IKeyRef

See Also:

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

getSseAlgorithm

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

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

For directory buckets, there are only two supported values for server-side encryption: AES256 and aws:kms .

See Also:

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

builder

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

Returns:

a CfnDirectoryBucketPropsMixin.ServerSideEncryptionByDefaultProperty.Builder of CfnDirectoryBucketPropsMixin.ServerSideEncryptionByDefaultProperty