Skip to content
v2.275.0

CfnEmailChannelProps Struct ​

Properties for defining a CfnEmailChannel.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_pinpoint as pinpoint } from 'aws-cdk-lib';
const cfnEmailChannelProps: pinpoint.CfnEmailChannelProps = {
  applicationId: 'applicationId',
  fromAddress: 'fromAddress',
  identity: 'identity',

  // the properties below are optional
  configurationSet: 'configurationSet',
  enabled: false,
  orchestrationSendingRoleArn: 'orchestrationSendingRoleArn',
  roleArn: 'roleArn',
};

Properties ​

applicationIdstringapplication_idstrapplicationIdStringApplicationIdstringApplicationId*stringrequired#
The unique identifier for the Amazon Pinpoint application that you're specifying the email channel for.
configurationSetoptionalstringconfiguration_setoptionalstrconfigurationSetoptionalStringConfigurationSetoptionalstringConfigurationSetoptional*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.
enabledoptionalboolean | IResolvableenabledoptionaltyping.Union[bool, IResolvable]enabledoptionalBooleanEnabledoptionalboolEnabledoptionalinterface{}#
Specifies whether to enable the email channel for the application.
fromAddressstringfrom_addressstrfromAddressStringFromAddressstringFromAddress*stringrequired#
The verified email address that you want to send email from when you send email through the channel.
identitystringidentitystridentityStringIdentitystringIdentity*stringrequired#
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.
orchestrationSendingRoleArnoptionalstringorchestration_sending_role_arnoptionalstrorchestrationSendingRoleArnoptionalStringOrchestrationSendingRoleArnoptionalstringOrchestrationSendingRoleArnoptional*string#
The ARN of an IAM role for Amazon Pinpoint to use to send email from your campaigns or journeys through Amazon SES .
roleArnoptionalstringrole_arnoptionalstrroleArnoptionalStringRoleArnoptionalstringRoleArnoptional*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.