Class: AWSCDK::Synthetics::CfnCanary::S3EncryptionProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::Synthetics::CfnCanary::S3EncryptionProperty

Defined in:

synthetics/cfn_canary.rb

Overview

A structure that contains the configuration of the encryption-at-rest settings for artifacts that the canary uploads to Amazon S3 .

Artifact encryption functionality is available only for canaries that use Synthetics runtime version syn-nodejs-puppeteer-3.3 or later. For more information, see Encrypting canary artifacts .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-synthetics-canary-s3encryption.html

Instance Attribute Summary

• #encryption_mode ⇒ String^? readonly

  The encryption method to use for artifacts created by this canary.

• #kms_key_arn ⇒ String^? readonly

  The ARN of the customer-managed AWS key to use, if you specify SSE-KMS for EncryptionMode.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(encryption_mode: nil, kms_key_arn: nil) ⇒ S3EncryptionProperty constructor

  A new instance of S3EncryptionProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(encryption_mode: nil, kms_key_arn: nil) ⇒ S3EncryptionProperty

Returns a new instance of S3EncryptionProperty.

Parameters:

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

  The encryption method to use for artifacts created by this canary.

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

  The ARN of the customer-managed AWS key to use, if you specify SSE-KMS for EncryptionMode.

# File 'synthetics/cfn_canary.rb', line 1221

def initialize(encryption_mode: nil, kms_key_arn: nil)
  @encryption_mode = encryption_mode
  Jsii::Type.check_type(@encryption_mode, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "encryptionMode") unless @encryption_mode.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?
end

Instance Attribute Details

#encryption_mode ⇒ String^? (readonly)

The encryption method to use for artifacts created by this canary.

Specify SSE_S3 to use server-side encryption (SSE) with an Amazon S3-managed key. Specify SSE-KMS to use server-side encryption with a customer-managed AWS key.

If you omit this parameter, an AWS -managed AWS key is used.

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-synthetics-canary-s3encryption.html#cfn-synthetics-canary-s3encryption-encryptionmode

# File 'synthetics/cfn_canary.rb', line 1236

def encryption_mode
  @encryption_mode
end

#kms_key_arn ⇒ String^? (readonly)

The ARN of the customer-managed AWS key to use, if you specify SSE-KMS for EncryptionMode.

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-synthetics-canary-s3encryption.html#cfn-synthetics-canary-s3encryption-kmskeyarn

# File 'synthetics/cfn_canary.rb', line 1241

def kms_key_arn
  @kms_key_arn
end

Class Method Details

.jsii_properties ⇒ Object

# File 'synthetics/cfn_canary.rb', line 1243

def self.jsii_properties
  {
    :encryption_mode => "encryptionMode",
    :kms_key_arn => "kmsKeyArn",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'synthetics/cfn_canary.rb', line 1250

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