@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-03-22T19:35:39.213Z") public class CfnEmailChannel extends CfnResource implements IInspectable
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
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.*; CfnEmailChannel cfnEmailChannel = CfnEmailChannel.Builder.create(this, "MyCfnEmailChannel") .applicationId("applicationId") .fromAddress("fromAddress") .identity("identity") // the properties below are optional .configurationSet("configurationSet") .enabled(false) .roleArn("roleArn") .build();
Modifier and Type | Class and Description |
---|---|
static class |
CfnEmailChannel.Builder
A fluent builder for
CfnEmailChannel . |
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
Modifier | Constructor and Description |
---|---|
|
CfnEmailChannel(Construct scope,
java.lang.String id,
CfnEmailChannelProps props)
Create a new `AWS::Pinpoint::EmailChannel`.
|
protected |
CfnEmailChannel(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
CfnEmailChannel(software.amazon.jsii.JsiiObjectRef objRef) |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getApplicationId()
The unique identifier for the Amazon Pinpoint application that you're specifying the email channel for.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.lang.String |
getConfigurationSet()
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.
|
java.lang.Object |
getEnabled()
Specifies whether to enable the email channel for the application.
|
java.lang.String |
getFromAddress()
The verified email address that you want to send email from when you send email through the channel.
|
java.lang.String |
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.
|
java.lang.String |
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.
|
void |
inspect(TreeInspector inspector)
Examines the CloudFormation resource and discloses attributes.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
renderProperties(java.util.Map<java.lang.String,java.lang.Object> props) |
void |
setApplicationId(java.lang.String value)
The unique identifier for the Amazon Pinpoint application that you're specifying the email channel for.
|
void |
setConfigurationSet(java.lang.String value)
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.
|
void |
setEnabled(java.lang.Boolean value)
Specifies whether to enable the email channel for the application.
|
void |
setEnabled(IResolvable value)
Specifies whether to enable the email channel for the application.
|
void |
setFromAddress(java.lang.String value)
The verified email address that you want to send email from when you send email through the channel.
|
void |
setIdentity(java.lang.String value)
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.
|
void |
setRoleArn(java.lang.String value)
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.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnEmailChannel(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnEmailChannel(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnEmailChannel(Construct scope, java.lang.String id, CfnEmailChannelProps props)
scope
- - scope in which this resource is defined. This parameter is required.id
- - scoped id of the resource. This parameter is required.props
- - resource properties. This parameter is required.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public java.lang.String getApplicationId()
public void setApplicationId(java.lang.String value)
public java.lang.String getFromAddress()
public void setFromAddress(java.lang.String value)
public java.lang.String getIdentity()
public void setIdentity(java.lang.String value)
public java.lang.String getConfigurationSet()
public void setConfigurationSet(java.lang.String value)
public java.lang.Object getEnabled()
public void setEnabled(java.lang.Boolean value)
public void setEnabled(IResolvable value)
public java.lang.String getRoleArn()
public void setRoleArn(java.lang.String value)