Class: AWSCDK::SES::CfnMailManagerArchiveProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
ses/cfn_mail_manager_archive_props.rb

Overview

Properties for defining a CfnMailManagerArchive.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(archive_name: nil, kms_key_arn: nil, retention: nil, tags: nil) ⇒ CfnMailManagerArchiveProps

Returns a new instance of CfnMailManagerArchiveProps.

Parameters:

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

    A unique name for the new archive.

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

    The Amazon Resource Name (ARN) of the KMS key for encrypting emails in the archive.

  • retention (AWSCDK::IResolvable, AWSCDK::SES::CfnMailManagerArchive::ArchiveRetentionProperty, nil) (defaults to: nil) —

    The period for retaining emails in the archive before automatic deletion.

  • tags (Array<AWSCDK::CfnTag>, nil) (defaults to: nil) —

    The tags used to organize, track, or control access for the resource.



13
14
15
16
17
18
19
20
21
22
 
# File 'ses/cfn_mail_manager_archive_props.rb', line 13

def initialize(archive_name: nil, kms_key_arn: nil, retention: nil, tags: nil)
  @archive_name = archive_name
  Jsii::Type.check_type(@archive_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "archiveName") unless @archive_name.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?
  @retention = retention.is_a?(Hash) ? ::AWSCDK::SES::CfnMailManagerArchive::ArchiveRetentionProperty.new(**retention.transform_keys(&:to_sym)) : retention
  Jsii::Type.check_type(@retention, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zZXMuQ2ZuTWFpbE1hbmFnZXJBcmNoaXZlLkFyY2hpdmVSZXRlbnRpb25Qcm9wZXJ0eSJ9XX19")), "retention") unless @retention.nil?
  @tags = tags.is_a?(Array) ? tags.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless @tags.nil?
end

Instance Attribute Details

#archive_name ⇒ String? (readonly)

A unique name for the new archive.

Returns:

  • (String, nil)

See Also:



28
29
30
 
# File 'ses/cfn_mail_manager_archive_props.rb', line 28

def archive_name
  @archive_name
end

#kms_key_arn ⇒ String? (readonly)

The Amazon Resource Name (ARN) of the KMS key for encrypting emails in the archive.

Returns:

  • (String, nil)

See Also:



33
34
35
 
# File 'ses/cfn_mail_manager_archive_props.rb', line 33

def kms_key_arn
  @kms_key_arn
end

#retention ⇒ AWSCDK::IResolvable, ... (readonly)

The period for retaining emails in the archive before automatic deletion.

Returns:

See Also:



38
39
40
 
# File 'ses/cfn_mail_manager_archive_props.rb', line 38

def retention
  @retention
end

#tags ⇒ Array<AWSCDK::CfnTag>? (readonly)

The tags used to organize, track, or control access for the resource.

For example, { "tags": "key2":"value2" }.

Returns:

See Also:



45
46
47
 
# File 'ses/cfn_mail_manager_archive_props.rb', line 45

def tags
  @tags
end

Class Method Details

.jsii_properties ⇒ Object 



47
48
49
50
51
52
53
54
 
# File 'ses/cfn_mail_manager_archive_props.rb', line 47

def self.jsii_properties
  {
    :archive_name => "archiveName",
    :kms_key_arn => "kmsKeyArn",
    :retention => "retention",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



56
57
58
59
60
61
62
63
64
65
 
# File 'ses/cfn_mail_manager_archive_props.rb', line 56

def to_jsii
  result = {}
  result.merge!({
    "archiveName" => @archive_name,
    "kmsKeyArn" => @kms_key_arn,
    "retention" => @retention,
    "tags" => @tags,
  })
  result.compact
end