Class: AWSCDK::SES::CfnEmailIdentityProps

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

Overview

Properties for defining a CfnEmailIdentity.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(email_identity:, configuration_set_attributes: nil, dkim_attributes: nil, dkim_signing_attributes: nil, feedback_attributes: nil, mail_from_attributes: nil, tags: nil) ⇒ CfnEmailIdentityProps

Returns a new instance of CfnEmailIdentityProps.

Parameters:



16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
 
# File 'ses/cfn_email_identity_props.rb', line 16

def initialize(email_identity:, configuration_set_attributes: nil, dkim_attributes: nil, dkim_signing_attributes: nil, feedback_attributes: nil, mail_from_attributes: nil, tags: nil)
  @email_identity = email_identity
  Jsii::Type.check_type(@email_identity, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "emailIdentity")
  @configuration_set_attributes = configuration_set_attributes.is_a?(Hash) ? ::AWSCDK::SES::CfnEmailIdentity::ConfigurationSetAttributesProperty.new(**configuration_set_attributes.transform_keys(&:to_sym)) : configuration_set_attributes
  Jsii::Type.check_type(@configuration_set_attributes, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zZXMuQ2ZuRW1haWxJZGVudGl0eS5Db25maWd1cmF0aW9uU2V0QXR0cmlidXRlc1Byb3BlcnR5In1dfX0=")), "configurationSetAttributes") unless @configuration_set_attributes.nil?
  @dkim_attributes = dkim_attributes.is_a?(Hash) ? ::AWSCDK::SES::CfnEmailIdentity::DkimAttributesProperty.new(**dkim_attributes.transform_keys(&:to_sym)) : dkim_attributes
  Jsii::Type.check_type(@dkim_attributes, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zZXMuQ2ZuRW1haWxJZGVudGl0eS5Ea2ltQXR0cmlidXRlc1Byb3BlcnR5In1dfX0=")), "dkimAttributes") unless @dkim_attributes.nil?
  @dkim_signing_attributes = dkim_signing_attributes.is_a?(Hash) ? ::AWSCDK::SES::CfnEmailIdentity::DkimSigningAttributesProperty.new(**dkim_signing_attributes.transform_keys(&:to_sym)) : dkim_signing_attributes
  Jsii::Type.check_type(@dkim_signing_attributes, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zZXMuQ2ZuRW1haWxJZGVudGl0eS5Ea2ltU2lnbmluZ0F0dHJpYnV0ZXNQcm9wZXJ0eSJ9XX19")), "dkimSigningAttributes") unless @dkim_signing_attributes.nil?
  @feedback_attributes = feedback_attributes.is_a?(Hash) ? ::AWSCDK::SES::CfnEmailIdentity::FeedbackAttributesProperty.new(**feedback_attributes.transform_keys(&:to_sym)) : feedback_attributes
  Jsii::Type.check_type(@feedback_attributes, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zZXMuQ2ZuRW1haWxJZGVudGl0eS5GZWVkYmFja0F0dHJpYnV0ZXNQcm9wZXJ0eSJ9XX19")), "feedbackAttributes") unless @feedback_attributes.nil?
  @mail_from_attributes = mail_from_attributes.is_a?(Hash) ? ::AWSCDK::SES::CfnEmailIdentity::MailFromAttributesProperty.new(**mail_from_attributes.transform_keys(&:to_sym)) : mail_from_attributes
  Jsii::Type.check_type(@mail_from_attributes, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zZXMuQ2ZuRW1haWxJZGVudGl0eS5NYWlsRnJvbUF0dHJpYnV0ZXNQcm9wZXJ0eSJ9XX19")), "mailFromAttributes") unless @mail_from_attributes.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

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

Used to associate a configuration set with an email identity.

Returns:

See Also:



42
43
44
 
# File 'ses/cfn_email_identity_props.rb', line 42

def configuration_set_attributes
  @configuration_set_attributes
end

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

An object that contains information about the DKIM attributes for the identity.

Returns:

See Also:



47
48
49
 
# File 'ses/cfn_email_identity_props.rb', line 47

def dkim_attributes
  @dkim_attributes
end

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

If your request includes this object, Amazon SES configures the identity to use Bring Your Own DKIM (BYODKIM) for DKIM authentication purposes, or, configures the key length to be used for Easy DKIM .

You can only specify this object if the email identity is a domain, as opposed to an address.

Returns:

See Also:



54
55
56
 
# File 'ses/cfn_email_identity_props.rb', line 54

def dkim_signing_attributes
  @dkim_signing_attributes
end

#email_identity ⇒ String (readonly)

The email address or domain to verify.

Returns:

  • (String)

See Also:



37
38
39
 
# File 'ses/cfn_email_identity_props.rb', line 37

def email_identity
  @email_identity
end

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

Used to enable or disable feedback forwarding for an identity.

Returns:

See Also:



59
60
61
 
# File 'ses/cfn_email_identity_props.rb', line 59

def feedback_attributes
  @feedback_attributes
end

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

Used to enable or disable the custom Mail-From domain configuration for an email identity.

Returns:

See Also:



64
65
66
 
# File 'ses/cfn_email_identity_props.rb', line 64

def mail_from_attributes
  @mail_from_attributes
end

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

An array of objects that define the tags (keys and values) to associate with the email identity.

Returns:

See Also:



69
70
71
 
# File 'ses/cfn_email_identity_props.rb', line 69

def tags
  @tags
end

Class Method Details

.jsii_properties ⇒ Object 



71
72
73
74
75
76
77
78
79
80
81
 
# File 'ses/cfn_email_identity_props.rb', line 71

def self.jsii_properties
  {
    :email_identity => "emailIdentity",
    :configuration_set_attributes => "configurationSetAttributes",
    :dkim_attributes => "dkimAttributes",
    :dkim_signing_attributes => "dkimSigningAttributes",
    :feedback_attributes => "feedbackAttributes",
    :mail_from_attributes => "mailFromAttributes",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'ses/cfn_email_identity_props.rb', line 83

def to_jsii
  result = {}
  result.merge!({
    "emailIdentity" => @email_identity,
    "configurationSetAttributes" => @configuration_set_attributes,
    "dkimAttributes" => @dkim_attributes,
    "dkimSigningAttributes" => @dkim_signing_attributes,
    "feedbackAttributes" => @feedback_attributes,
    "mailFromAttributes" => @mail_from_attributes,
    "tags" => @tags,
  })
  result.compact
end