Class: AWSCDK::Pinpoint::CfnEmailChannelProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
pinpoint/cfn_email_channel_props.rb

Overview

Properties for defining a CfnEmailChannel.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(application_id:, from_address:, identity:, configuration_set: nil, enabled: nil, orchestration_sending_role_arn: nil, role_arn: nil) ⇒ CfnEmailChannelProps

Returns a new instance of CfnEmailChannelProps.

Parameters:

  • application_id (String) —

    The unique identifier for the Amazon Pinpoint application that you're specifying the email channel for.

  • from_address (String) —

    The verified email address that you want to send email from when you send email through the channel.

  • identity (String) —

    The Amazon Resource Name (ARN) of the identity, verified with Amazon Simple Email Service (Amazon SES), that you want to use when you send email through the channel.

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

    The Amazon SES configuration set that you want to apply to messages that you send through the channel.

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

    Specifies whether to enable the email channel for the application.

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

    The ARN of an IAM role for Amazon Pinpoint to use to send email from your campaigns or journeys through Amazon SES .

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

    The ARN of the AWS Identity and Access Management (IAM) role that you want Amazon Pinpoint to use when it submits email-related event data for the channel.



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

def initialize(application_id:, from_address:, identity:, configuration_set: nil, enabled: nil, orchestration_sending_role_arn: nil, role_arn: nil)
  @application_id = application_id
  Jsii::Type.check_type(@application_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "applicationId")
  @from_address = from_address
  Jsii::Type.check_type(@from_address, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "fromAddress")
  @identity = identity
  Jsii::Type.check_type(@identity, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "identity")
  @configuration_set = configuration_set
  Jsii::Type.check_type(@configuration_set, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "configurationSet") unless @configuration_set.nil?
  @enabled = enabled
  Jsii::Type.check_type(@enabled, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "enabled") unless @enabled.nil?
  @orchestration_sending_role_arn = orchestration_sending_role_arn
  Jsii::Type.check_type(@orchestration_sending_role_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "orchestrationSendingRoleArn") unless @orchestration_sending_role_arn.nil?
  @role_arn = role_arn
  Jsii::Type.check_type(@role_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "roleArn") unless @role_arn.nil?
end

Instance Attribute Details

#application_id ⇒ String (readonly)

The unique identifier for the Amazon Pinpoint application that you're specifying the email channel for.

Returns:

  • (String)

See Also:



37
38
39
 
# File 'pinpoint/cfn_email_channel_props.rb', line 37

def application_id
  @application_id
end

#configuration_set ⇒ String? (readonly)

The Amazon SES configuration set that you want to apply to messages that you send through the channel.

Returns:

  • (String, nil)

See Also:



52
53
54
 
# File 'pinpoint/cfn_email_channel_props.rb', line 52

def configuration_set
  @configuration_set
end

#enabled ⇒ Boolean, ... (readonly)

Specifies whether to enable the email channel for the application.

Returns:

See Also:



57
58
59
 
# File 'pinpoint/cfn_email_channel_props.rb', line 57

def enabled
  @enabled
end

#from_address ⇒ String (readonly)

The verified email address that you want to send email from when you send email through the channel.

Returns:

  • (String)

See Also:



42
43
44
 
# File 'pinpoint/cfn_email_channel_props.rb', line 42

def from_address
  @from_address
end

#identity ⇒ String (readonly)

The Amazon Resource Name (ARN) of the identity, verified with Amazon Simple Email Service (Amazon SES), that you want to use when you send email through the channel.

Returns:

  • (String)

See Also:



47
48
49
 
# File 'pinpoint/cfn_email_channel_props.rb', line 47

def identity
  @identity
end

#orchestration_sending_role_arn ⇒ String? (readonly)

The ARN of an IAM role for Amazon Pinpoint to use to send email from your campaigns or journeys through Amazon SES .

Returns:

  • (String, nil)

See Also:



62
63
64
 
# File 'pinpoint/cfn_email_channel_props.rb', line 62

def orchestration_sending_role_arn
  @orchestration_sending_role_arn
end

#role_arn ⇒ String? (readonly)

The ARN of the AWS Identity and Access Management (IAM) role that you want Amazon Pinpoint to use when it submits email-related event data for the channel.

Returns:

  • (String, nil)

See Also:



67
68
69
 
# File 'pinpoint/cfn_email_channel_props.rb', line 67

def role_arn
  @role_arn
end

Class Method Details

.jsii_properties ⇒ Object 



69
70
71
72
73
74
75
76
77
78
79
 
# File 'pinpoint/cfn_email_channel_props.rb', line 69

def self.jsii_properties
  {
    :application_id => "applicationId",
    :from_address => "fromAddress",
    :identity => "identity",
    :configuration_set => "configurationSet",
    :enabled => "enabled",
    :orchestration_sending_role_arn => "orchestrationSendingRoleArn",
    :role_arn => "roleArn",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'pinpoint/cfn_email_channel_props.rb', line 81

def to_jsii
  result = {}
  result.merge!({
    "applicationId" => @application_id,
    "fromAddress" => @from_address,
    "identity" => @identity,
    "configurationSet" => @configuration_set,
    "enabled" => @enabled,
    "orchestrationSendingRoleArn" => @orchestration_sending_role_arn,
    "roleArn" => @role_arn,
  })
  result.compact
end