Skip to content
v2.278.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',
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_pinpoint as pinpoint

cfn_email_channel_props = pinpoint.CfnEmailChannelProps(
    application_id="applicationId",
    from_address="fromAddress",
    identity="identity",

    # the properties below are optional
    configuration_set="configurationSet",
    enabled=False,
    orchestration_sending_role_arn="orchestrationSendingRoleArn",
    role_arn="roleArn"
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.pinpoint.*;

CfnEmailChannelProps cfnEmailChannelProps = CfnEmailChannelProps.builder()
        .applicationId("applicationId")
        .fromAddress("fromAddress")
        .identity("identity")

        // the properties below are optional
        .configurationSet("configurationSet")
        .enabled(false)
        .orchestrationSendingRoleArn("orchestrationSendingRoleArn")
        .roleArn("roleArn")
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Pinpoint;

var cfnEmailChannelProps = new CfnEmailChannelProps {
    ApplicationId = "applicationId",
    FromAddress = "fromAddress",
    Identity = "identity",

    // the properties below are optional
    ConfigurationSet = "configurationSet",
    Enabled = false,
    OrchestrationSendingRoleArn = "orchestrationSendingRoleArn",
    RoleArn = "roleArn"
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

cfnEmailChannelProps := &CfnEmailChannelProps{
	ApplicationId: jsii.String("applicationId"),
	FromAddress: jsii.String("fromAddress"),
	Identity: jsii.String("identity"),

	// the properties below are optional
	ConfigurationSet: jsii.String("configurationSet"),
	Enabled: jsii.Boolean(false),
	OrchestrationSendingRoleArn: jsii.String("orchestrationSendingRoleArn"),
	RoleArn: jsii.String("roleArn"),
}

Properties ​

applicationIdstringapplication_idstrapplicationIdStringApplicationIdstringApplicationId*string required #
The unique identifier for the Amazon Pinpoint application that you're specifying the email channel for.
configurationSetoptionalstringconfiguration_setoptionalstrconfigurationSetoptionalStringConfigurationSetoptionalstringConfigurationSetoptional*string #
The Amazon SES configuration set 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*string required #
The verified email address that you want to send email from when you send email through the channel.
identitystringidentitystridentityStringIdentitystringIdentity*string required #
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.