AWS::Pinpoint::EmailChannel - AWS CloudFormation
SyntaxPropertiesReturn values

AWS::Pinpoint::EmailChannel

A channel is a type of platform that you can deliver messages to. You can use the email channel to send email to users. Before you can use Amazon Pinpoint to send email, you must enable the email channel for an Amazon Pinpoint application.

The EmailChannel resource represents the status, identity, and other settings of the email channel for an application

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

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

YAML

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

Properties

ApplicationId

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

Required: Yes

Type: String

Update requires: Replacement

ConfigurationSet

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

Required: No

Type: String

Update requires: No interruption

Enabled

Specifies whether to enable the email channel for the application.

Required: No

Type: Boolean

Update requires: No interruption

FromAddress

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

Required: Yes

Type: String

Update requires: No interruption

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.

Required: Yes

Type: String

Update requires: No interruption

OrchestrationSendingRoleArn

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

Required: No

Type: String

Update requires: No interruption

RoleArn

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.

Required: No

Type: String

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the unique identifier (ApplicationId) for the Amazon Pinpoint application that the channel is associated with.

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

Fn::GetAtt

Id

(Deprecated) An identifier for the email channel. This property is retained only for backward compatibility.