1.204.0

interface CfnEmailChannelProps

LanguageType name
.NETAmazon.CDK.AWS.Pinpoint.CfnEmailChannelProps
Javasoftware.amazon.awscdk.services.pinpoint.CfnEmailChannelProps
Pythonaws_cdk.aws_pinpoint.CfnEmailChannelProps
TypeScript @aws-cdk/aws-pinpoint » CfnEmailChannelProps

Properties for defining a CfnEmailChannel.

Example

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

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

Properties

NameTypeDescription
applicationIdstringThe unique identifier for the Amazon Pinpoint application that you're specifying the email channel for.
fromAddressstringThe verified email address that you want to send email from when you send email through the channel.
identitystringThe 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.
configurationSet?stringThe Amazon SES configuration set that you want to apply to messages that you send through the channel.
enabled?boolean | IResolvableSpecifies whether to enable the email channel for the application.
roleArn?stringThe 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.

applicationId

Type: string

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

fromAddress

Type: string

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

identity

Type: 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.

configurationSet?

Type: string (optional)

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

enabled?

Type: boolean | IResolvable (optional)

Specifies whether to enable the email channel for the application.

roleArn?

Type: string (optional)

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.

← PreviousNext →