AWS::Pinpoint::EmailChannel - AWS CloudFormation
AWS 文档中描述的 AWS 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 AWS 服务入门

AWS::Pinpoint::EmailChannel

通道 是一种可以向其传递消息的平台。您可以使用电子邮件通道向用户发送电子邮件。您必须先为 Amazon Pinpoint 应用程序启用电子邮件通道,然后才能使用 Amazon Pinpoint 发送电子邮件。

AWS::Pinpoint::EmailChannel 资源定义应用程序的电子邮件通道的状态、身份和其他设置。

语法

要在 AWS CloudFormation 模板中声明此实体,请使用以下语法:

JSON

{ "Type" : "AWS::Pinpoint::EmailChannel", "Properties" : { "ApplicationId" : String, "ConfigurationSet" : String, "Enabled" : Boolean, "FromAddress" : String, "Identity" : String, "RoleArn" : String } }

YAML

Type: AWS::Pinpoint::EmailChannel Properties: ApplicationId: String ConfigurationSet: String Enabled: Boolean FromAddress: String Identity: String RoleArn: String

属性

ApplicationId

电子邮件通道适用的应用程序的唯一标识符。

必需:是

类型:字符串

Update requires: Replacement

ConfigurationSet

要应用于使用 Amazon Pinpoint Email API 通过通道发送的电子邮件的配置集。

必需:否

类型:字符串

Update requires: No interruption

Enabled

指定是否为应用程序启用电子邮件通道。

必需:否

类型:布尔值

Update requires: No interruption

FromAddress

当您通过该通道发送电子邮件时,要从其发送电子邮件的经过验证的电子邮件地址。

必需:是

类型:字符串

Update requires: No interruption

Identity

在通过该通道发送电子邮件时要使用的身份的 Amazon 资源名称 (ARN)(已通过 Amazon Simple Email Service (Amazon SES) 验证)。

必需:是

类型:字符串

Update requires: No interruption

RoleArn

希望 Amazon Pinpoint 在提交通道的电子邮件相关的事件数据时使用的 AWS Identity and Access Management (IAM) 角色的 ARN。

必需:否

类型:字符串

Update requires: No interruption

返回值

Ref

在将此资源的逻辑 ID 传递给内部 Ref 函数时,Ref 返回与通道关联的 Amazon Pinpoint 应用程序的唯一标识符 (ApplicationId)。

For more information about using the Ref function, see Ref.