Class: AWSCDK::S3Tables::CfnTableBucket::EncryptionConfigurationProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::S3Tables::CfnTableBucket::EncryptionConfigurationProperty

Defined in:

s3_tables/cfn_table_bucket.rb

Overview

Configuration specifying how data should be encrypted.

This structure defines the encryption algorithm and optional KMS key to be used for server-side encryption.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3tables-tablebucket-encryptionconfiguration.html

Instance Attribute Summary

• #kms_key_arn ⇒ String^? readonly

  The Amazon Resource Name (ARN) of the KMS key to use for encryption.

• #sse_algorithm ⇒ String^? readonly

  The server-side encryption algorithm to use.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(kms_key_arn: nil, sse_algorithm: nil) ⇒ EncryptionConfigurationProperty constructor

  A new instance of EncryptionConfigurationProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(kms_key_arn: nil, sse_algorithm: nil) ⇒ EncryptionConfigurationProperty

Returns a new instance of EncryptionConfigurationProperty.

Parameters:

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

  The Amazon Resource Name (ARN) of the KMS key to use for encryption.

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

  The server-side encryption algorithm to use.

# File 's3_tables/cfn_table_bucket.rb', line 610

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

Instance Attribute Details

#kms_key_arn ⇒ String^? (readonly)

The Amazon Resource Name (ARN) of the KMS key to use for encryption.

This field is required only when sse_algorithm is set to aws:kms .

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3tables-tablebucket-encryptionconfiguration.html#cfn-s3tables-tablebucket-encryptionconfiguration-kmskeyarn

# File 's3_tables/cfn_table_bucket.rb', line 623

def kms_key_arn
  @kms_key_arn
end

#sse_algorithm ⇒ String^? (readonly)

The server-side encryption algorithm to use.

Valid values are AES256 for S3-managed encryption keys, or aws:kms for AWS KMS-managed encryption keys. If you choose SSE-KMS encryption you must grant the S3 Tables maintenance principal access to your KMS key. For more information, see Permissions requirements for S3 Tables SSE-KMS encryption .

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3tables-tablebucket-encryptionconfiguration.html#cfn-s3tables-tablebucket-encryptionconfiguration-ssealgorithm

# File 's3_tables/cfn_table_bucket.rb', line 630

def sse_algorithm
  @sse_algorithm
end

Class Method Details

.jsii_properties ⇒ Object

# File 's3_tables/cfn_table_bucket.rb', line 632

def self.jsii_properties
  {
    :kms_key_arn => "kmsKeyArn",
    :sse_algorithm => "sseAlgorithm",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 's3_tables/cfn_table_bucket.rb', line 639

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