AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::Pinpoint::EmailChannel

CfnEmailChannel

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

Import

import { CfnEmailChannel } from 'aws-cdk-lib/aws-pinpoint';

Or use the module namespace:

import * as pinpoint from 'aws-cdk-lib/aws-pinpoint';
// pinpoint.CfnEmailChannel

Properties

Configuration passed to the constructor as CfnEmailChannelProps.

applicationIdRequired
string

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

fromAddressRequired
string

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

identityRequired
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.

configurationSetOptional
string

The [Amazon SES configuration set](https://docs.aws.amazon.com/ses/latest/APIReference/API_ConfigurationSet.html) that you want to apply to messages that you send through the channel.

enabledOptional
boolean | IResolvable

Specifies whether to enable the email channel for the application.

orchestrationSendingRoleArnOptional
string

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

roleArnOptional
string

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.

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

AWS::Pinpoint::EmailChannelView in CloudFormation Explorer

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

LevelL1 (CloudFormation)
Moduleaws-pinpoint
CFN TypeAWS::Pinpoint::EmailChannel
Properties7

Related Constructs

Explore This Service

External Links