Class: AWSCDK::PinpointEmail::CfnIdentityProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
pinpoint_email/cfn_identity_props.rb

Overview

Properties for defining a CfnIdentity.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name:, dkim_signing_enabled: nil, feedback_forwarding_enabled: nil, mail_from_attributes: nil, tags: nil) ⇒ CfnIdentityProps

Returns a new instance of CfnIdentityProps.

Parameters:

  • name (String) —

    The address or domain of the identity, such as sender@example.com or example.co.uk .

  • dkim_signing_enabled (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    For domain identities, this attribute is used to enable or disable DomainKeys Identified Mail (DKIM) signing for the domain.

  • feedback_forwarding_enabled (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    Used to enable or disable feedback forwarding for an identity.

  • mail_from_attributes (AWSCDK::IResolvable, AWSCDK::PinpointEmail::CfnIdentity::MailFromAttributesProperty, nil) (defaults to: nil) —

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

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

    An object that defines the tags (keys and values) that you want to associate with the email identity.



14
15
16
17
18
19
20
21
22
23
24
25
 
# File 'pinpoint_email/cfn_identity_props.rb', line 14

def initialize(name:, dkim_signing_enabled: nil, feedback_forwarding_enabled: nil, mail_from_attributes: nil, tags: nil)
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  @dkim_signing_enabled = dkim_signing_enabled
  Jsii::Type.check_type(@dkim_signing_enabled, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "dkimSigningEnabled") unless @dkim_signing_enabled.nil?
  @feedback_forwarding_enabled = feedback_forwarding_enabled
  Jsii::Type.check_type(@feedback_forwarding_enabled, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "feedbackForwardingEnabled") unless @feedback_forwarding_enabled.nil?
  @mail_from_attributes = mail_from_attributes.is_a?(Hash) ? ::AWSCDK::PinpointEmail::CfnIdentity::MailFromAttributesProperty.new(**mail_from_attributes.transform_keys(&:to_sym)) : mail_from_attributes
  Jsii::Type.check_type(@mail_from_attributes, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19waW5wb2ludGVtYWlsLkNmbklkZW50aXR5Lk1haWxGcm9tQXR0cmlidXRlc1Byb3BlcnR5In1dfX0=")), "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

#dkim_signing_enabled ⇒ Boolean, ... (readonly)

For domain identities, this attribute is used to enable or disable DomainKeys Identified Mail (DKIM) signing for the domain.

If the value is true , then the messages that you send from the domain are signed using both the DKIM keys for your domain, as well as the keys for the amazonses.com domain. If the value is false , then the messages that you send are only signed using the DKIM keys for the amazonses.com domain.

Returns:

See Also:



38
39
40
 
# File 'pinpoint_email/cfn_identity_props.rb', line 38

def dkim_signing_enabled
  @dkim_signing_enabled
end

#feedback_forwarding_enabled ⇒ Boolean, ... (readonly)

Used to enable or disable feedback forwarding for an identity.

This setting determines what happens when an identity is used to send an email that results in a bounce or complaint event.

When you enable feedback forwarding, Amazon Pinpoint sends you email notifications when bounce or complaint events occur. Amazon Pinpoint sends this notification to the address that you specified in the Return-Path header of the original email.

When you disable feedback forwarding, Amazon Pinpoint sends notifications through other mechanisms, such as by notifying an Amazon SNS topic. 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, Amazon Pinpoint sends an email notification when these events occur (even if this setting is disabled).

Returns:

See Also:



49
50
51
 
# File 'pinpoint_email/cfn_identity_props.rb', line 49

def feedback_forwarding_enabled
  @feedback_forwarding_enabled
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:



54
55
56
 
# File 'pinpoint_email/cfn_identity_props.rb', line 54

def mail_from_attributes
  @mail_from_attributes
end

#name ⇒ String (readonly)

The address or domain of the identity, such as sender@example.com or example.co.uk .

Returns:

  • (String)

See Also:



31
32
33
 
# File 'pinpoint_email/cfn_identity_props.rb', line 31

def name
  @name
end

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

An object that defines the tags (keys and values) that you want to associate with the email identity.

Returns:

See Also:



59
60
61
 
# File 'pinpoint_email/cfn_identity_props.rb', line 59

def tags
  @tags
end

Class Method Details

.jsii_properties ⇒ Object 



61
62
63
64
65
66
67
68
69
 
# File 'pinpoint_email/cfn_identity_props.rb', line 61

def self.jsii_properties
  {
    :name => "name",
    :dkim_signing_enabled => "dkimSigningEnabled",
    :feedback_forwarding_enabled => "feedbackForwardingEnabled",
    :mail_from_attributes => "mailFromAttributes",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



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

def to_jsii
  result = {}
  result.merge!({
    "name" => @name,
    "dkimSigningEnabled" => @dkim_signing_enabled,
    "feedbackForwardingEnabled" => @feedback_forwarding_enabled,
    "mailFromAttributes" => @mail_from_attributes,
    "tags" => @tags,
  })
  result.compact
end