Class: AWSCDK::S3::CfnBucket::ServerSideEncryptionByDefaultProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::S3::CfnBucket::ServerSideEncryptionByDefaultProperty

Defined in:

s3/cfn_bucket.rb

Overview

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 .

• General purpose buckets - If you don't specify a customer managed key at configuration, Amazon S3 automatically creates an AWS KMS key ( aws/s3 ) 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.
• Directory buckets - Your SSE-KMS configuration can only support 1 customer managed key per directory bucket's lifetime. The AWS managed key ( aws/s3 ) isn't supported.
• Directory buckets - For directory buckets, there are only two supported options for server-side encryption: SSE-S3 and SSE-KMS.

See Also:

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

Instance Attribute Summary

• #kms_master_key_id ⇒ String^? readonly

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

• #sse_algorithm ⇒ String readonly

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

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(sse_algorithm:, kms_master_key_id: nil) ⇒ ServerSideEncryptionByDefaultProperty constructor

  A new instance of ServerSideEncryptionByDefaultProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(sse_algorithm:, kms_master_key_id: nil) ⇒ ServerSideEncryptionByDefaultProperty

Returns a new instance of ServerSideEncryptionByDefaultProperty.

Parameters:

• sse_algorithm (String) —

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

• kms_master_key_id (String, nil) (defaults to: nil) —

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

# File 's3/cfn_bucket.rb', line 4239

def initialize(sse_algorithm:, kms_master_key_id: nil)
  @sse_algorithm = sse_algorithm
  Jsii::Type.check_type(@sse_algorithm, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "sseAlgorithm")
  @kms_master_key_id = kms_master_key_id
  Jsii::Type.check_type(@kms_master_key_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "kmsMasterKeyId") unless @kms_master_key_id.nil?
end

Instance Attribute Details

#kms_master_key_id ⇒ String^? (readonly)

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

• General purpose buckets - This parameter is allowed if and only if SSEAlgorithm is set to aws:kms or aws:kms:dsse .
• Directory buckets - This parameter is allowed if and only if SSEAlgorithm is set to aws:kms .

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 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 .

• General purpose buckets - If you're specifying a customer managed KMS key, we recommend using a fully qualified KMS key ARN. If you use a KMS key alias instead, then AWS resolves the key within the requester’s account. This behavior can result in data that's encrypted with a KMS key that belongs to the requester, and not the bucket owner. Also, if you use a key ID, you can run into a LogDestination undeliverable error when creating a VPC flow log.
• Directory buckets - When you specify an AWS customer managed key for encryption in your directory bucket, only use the key ID or key ARN. The key alias format of the KMS key isn't supported. > 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:

• (String, nil)

See Also:

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

# File 's3/cfn_bucket.rb', line 4271

def kms_master_key_id
  @kms_master_key_id
end

#sse_algorithm ⇒ String (readonly)

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 .

Returns:

• (String)

See Also:

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

# File 's3/cfn_bucket.rb', line 4252

def sse_algorithm
  @sse_algorithm
end

Class Method Details

.jsii_properties ⇒ Object

# File 's3/cfn_bucket.rb', line 4273

def self.jsii_properties
  {
    :sse_algorithm => "sseAlgorithm",
    :kms_master_key_id => "kmsMasterKeyId",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 's3/cfn_bucket.rb', line 4280

def to_jsii
  result = {}
  result.merge!({
    "sseAlgorithm" => @sse_algorithm,
    "kmsMasterKeyId" => @kms_master_key_id,
  })
  result.compact
end