Class: AWSCDK::SES::EmailIdentityProps

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

Overview

Properties for an email identity.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(identity:, configuration_set: nil, dkim_identity: nil, dkim_signing: nil, feedback_forwarding: nil, mail_from_behavior_on_mx_failure: nil, mail_from_domain: nil) ⇒ EmailIdentityProps

Returns a new instance of EmailIdentityProps.

Parameters:

  • identity (AWSCDK::SES::Identity) —

    The email address or domain to verify.

  • configuration_set (AWSCDK::Interfaces::AWSSES::IConfigurationSetRef, nil) (defaults to: nil) —

    The configuration set to associate with the email identity.

  • dkim_identity (AWSCDK::SES::DkimIdentity, nil) (defaults to: nil) —

    The type of DKIM identity to use.

  • dkim_signing (Boolean, nil) (defaults to: nil) —

    Whether the messages that are sent from the identity are signed using DKIM.

  • feedback_forwarding (Boolean, nil) (defaults to: nil) —

    Whether to receive email notifications when bounce or complaint events occur.

  • mail_from_behavior_on_mx_failure (AWSCDK::SES::MailFromBehaviorOnMxFailure, nil) (defaults to: nil) —

    The action to take if the required MX record for the MAIL FROM domain isn't found when you send an email.

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

    The custom MAIL FROM domain that you want the verified identity to use.



14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
 
# File 'ses/email_identity_props.rb', line 14

def initialize(identity:, configuration_set: nil, dkim_identity: nil, dkim_signing: nil, feedback_forwarding: nil, mail_from_behavior_on_mx_failure: nil, mail_from_domain: nil)
  @identity = identity
  Jsii::Type.check_type(@identity, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc2VzLklkZW50aXR5In0=")), "identity")
  @configuration_set = configuration_set
  Jsii::Type.check_type(@configuration_set, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19zZXMuSUNvbmZpZ3VyYXRpb25TZXRSZWYifQ==")), "configurationSet") unless @configuration_set.nil?
  @dkim_identity = dkim_identity
  Jsii::Type.check_type(@dkim_identity, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc2VzLkRraW1JZGVudGl0eSJ9")), "dkimIdentity") unless @dkim_identity.nil?
  @dkim_signing = dkim_signing
  Jsii::Type.check_type(@dkim_signing, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "dkimSigning") unless @dkim_signing.nil?
  @feedback_forwarding = feedback_forwarding
  Jsii::Type.check_type(@feedback_forwarding, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "feedbackForwarding") unless @feedback_forwarding.nil?
  @mail_from_behavior_on_mx_failure = mail_from_behavior_on_mx_failure
  Jsii::Type.check_type(@mail_from_behavior_on_mx_failure, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc2VzLk1haWxGcm9tQmVoYXZpb3JPbk14RmFpbHVyZSJ9")), "mailFromBehaviorOnMxFailure") unless @mail_from_behavior_on_mx_failure.nil?
  @mail_from_domain = mail_from_domain
  Jsii::Type.check_type(@mail_from_domain, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "mailFromDomain") unless @mail_from_domain.nil?
end

Instance Attribute Details

#configuration_set ⇒ AWSCDK::Interfaces::AWSSES::IConfigurationSetRef? (readonly)

Note:

Default: - do not use a specific configuration set

The configuration set to associate with the email identity.

Returns:



39
40
41
 
# File 'ses/email_identity_props.rb', line 39

def configuration_set
  @configuration_set
end

#dkim_identity ⇒ AWSCDK::SES::DkimIdentity? (readonly)

Note:

Default: - Easy DKIM with a key length of 2048-bit

The type of DKIM identity to use.

Returns:



44
45
46
 
# File 'ses/email_identity_props.rb', line 44

def dkim_identity
  @dkim_identity
end

#dkim_signing ⇒ Boolean? (readonly)

Note:

Default: true

Whether the messages that are sent from the identity are signed using DKIM.

Returns:

  • (Boolean, nil) 


49
50
51
 
# File 'ses/email_identity_props.rb', line 49

def dkim_signing
  @dkim_signing
end

#feedback_forwarding ⇒ Boolean? (readonly)

Note:

Default: true

Whether to receive email notifications when bounce or complaint events occur.

These notifications are sent to the address that you specified in the Return-Path header of the original email.

You're required to have a method of tracking bounces and complaints. If you haven't set up another mechanism for receiving bounce or complaint notifications (for example, by setting up an event destination), you receive an email notification when these events occur (even if this setting is disabled).

Returns:

  • (Boolean, nil) 


62
63
64
 
# File 'ses/email_identity_props.rb', line 62

def feedback_forwarding
  @feedback_forwarding
end

#identity ⇒ AWSCDK::SES::Identity (readonly)

The email address or domain to verify.

Returns:



34
35
36
 
# File 'ses/email_identity_props.rb', line 34

def identity
  @identity
end

#mail_from_behavior_on_mx_failure ⇒ AWSCDK::SES::MailFromBehaviorOnMxFailure? (readonly)

Note:

Default: MailFromBehaviorOnMxFailure.USE_DEFAULT_VALUE

The action to take if the required MX record for the MAIL FROM domain isn't found when you send an email.

Returns:



67
68
69
 
# File 'ses/email_identity_props.rb', line 67

def mail_from_behavior_on_mx_failure
  @mail_from_behavior_on_mx_failure
end

#mail_from_domain ⇒ String? (readonly)

Note:

Default: - use amazonses.com

The custom MAIL FROM domain that you want the verified identity to use.

The MAIL FROM domain must meet the following criteria:

  • It has to be a subdomain of the verified identity
  • It can't be used to receive email
  • It can't be used in a "From" address if the MAIL FROM domain is a destination for feedback forwarding emails

Returns:

  • (String, nil) 


80
81
82
 
# File 'ses/email_identity_props.rb', line 80

def mail_from_domain
  @mail_from_domain
end

Class Method Details

.jsii_properties ⇒ Object 



82
83
84
85
86
87
88
89
90
91
92
 
# File 'ses/email_identity_props.rb', line 82

def self.jsii_properties
  {
    :identity => "identity",
    :configuration_set => "configurationSet",
    :dkim_identity => "dkimIdentity",
    :dkim_signing => "dkimSigning",
    :feedback_forwarding => "feedbackForwarding",
    :mail_from_behavior_on_mx_failure => "mailFromBehaviorOnMxFailure",
    :mail_from_domain => "mailFromDomain",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'ses/email_identity_props.rb', line 94

def to_jsii
  result = {}
  result.merge!({
    "identity" => @identity,
    "configurationSet" => @configuration_set,
    "dkimIdentity" => @dkim_identity,
    "dkimSigning" => @dkim_signing,
    "feedbackForwarding" => @feedback_forwarding,
    "mailFromBehaviorOnMxFailure" => @mail_from_behavior_on_mx_failure,
    "mailFromDomain" => @mail_from_domain,
  })
  result.compact
end