Interface CfnEmailChannelProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnEmailChannelProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.102.0 (build e354887)",
date="2024-08-23T05:56:20.322Z")
@Stability(Stable)
public interface CfnEmailChannelProps
extends software.amazon.jsii.JsiiSerializable
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 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();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnEmailChannelProps
static final class
An implementation forCfnEmailChannelProps
-
Method Summary
Modifier and TypeMethodDescriptionstatic CfnEmailChannelProps.Builder
builder()
The unique identifier for the Amazon Pinpoint application that you're specifying the email channel for.default String
The Amazon SES configuration set that you want to apply to messages that you send through the channel.default Object
Specifies whether to enable the email channel for the application.The verified email address that you want to send email from when you send email through the channel.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.default String
The ARN of an IAM role for Amazon Pinpoint to use to send email from your campaigns or journeys through Amazon SES .default 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.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getApplicationId
The unique identifier for the Amazon Pinpoint application that you're specifying the email channel for.- See Also:
-
getFromAddress
The verified email address that you want to send email from when you send email through the channel.- See Also:
-
getIdentity
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.- See Also:
-
getConfigurationSet
The Amazon SES configuration set that you want to apply to messages that you send through the channel.- See Also:
-
getEnabled
Specifies whether to enable the email channel for the application.- See Also:
-
getOrchestrationSendingRoleArn
The ARN of an IAM role for Amazon Pinpoint to use to send email from your campaigns or journeys through Amazon SES .- See Also:
-
getRoleArn
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.- See Also:
-
builder
- Returns:
- a
CfnEmailChannelProps.Builder
ofCfnEmailChannelProps
-