CfnEmailChannelProps

class aws_cdk.aws_pinpoint.CfnEmailChannelProps(*, application_id, from_address, identity, configuration_set=None, enabled=None, role_arn=None)

Bases: object

Properties for defining a CfnEmailChannel.

Parameters
  • application_id (str) – The unique identifier for the Amazon Pinpoint application that you’re specifying the email channel for.

  • from_address (str) – The verified email address that you want to send email from when you send email through the channel.

  • identity (str) – 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 (Optional[str]) – The Amazon SES configuration set that you want to apply to messages that you send through the channel.

  • enabled (Union[bool, IResolvable, None]) – Specifies whether to enable the email channel for the application.

  • role_arn (Optional[str]) – 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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-emailchannel.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_pinpoint as pinpoint

cfn_email_channel_props = pinpoint.CfnEmailChannelProps(
    application_id="applicationId",
    from_address="fromAddress",
    identity="identity",

    # the properties below are optional
    configuration_set="configurationSet",
    enabled=False,
    role_arn="roleArn"
)

Attributes

application_id

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

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-emailchannel.html#cfn-pinpoint-emailchannel-applicationid

Return type

str

configuration_set

//docs.aws.amazon.com/ses/latest/APIReference/API_ConfigurationSet.html>`_ that you want to apply to messages that you send through the channel.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-emailchannel.html#cfn-pinpoint-emailchannel-configurationset

Type

The `Amazon SES configuration set <https

Return type

Optional[str]

enabled

Specifies whether to enable the email channel for the application.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-emailchannel.html#cfn-pinpoint-emailchannel-enabled

Return type

Union[bool, IResolvable, None]

from_address

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

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-emailchannel.html#cfn-pinpoint-emailchannel-fromaddress

Return type

str

identity

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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-emailchannel.html#cfn-pinpoint-emailchannel-identity

Return type

str

role_arn

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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-emailchannel.html#cfn-pinpoint-emailchannel-rolearn

Return type

Optional[str]