software.amazon.awscdk.services.pinpoint

Class CfnEmailChannel

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.pinpoint.CfnEmailChannel

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:41.219Z")
 @Stability(value=Stable)
public class CfnEmailChannel
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Pinpoint::EmailChannel`.

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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnEmailChannel.Builder A fluent builder for CfnEmailChannel.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnEmailChannel(software.constructs.Construct scope, 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)

Method Summary

Modifier and Type	Method and Description
String	getApplicationId() The unique identifier for the Amazon Pinpoint application that you're specifying the email channel for.
protected Map<String,Object>	getCfnProperties()
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.
Object	getEnabled() Specifies whether to enable the email channel for the application.
String	getFromAddress() The verified email address that you want to send email from when you send email through the channel.
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.
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 Map<String,Object>	renderProperties(Map<String,Object> props)
void	setApplicationId(String value) The unique identifier for the Amazon Pinpoint application that you're specifying the email channel for.
void	setConfigurationSet(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(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(String value) The verified email address that you want to send email from when you send email through the channel.
void	setIdentity(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(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.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnEmailChannel

protected CfnEmailChannel(software.amazon.jsii.JsiiObjectRef objRef)

CfnEmailChannel

protected CfnEmailChannel(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnEmailChannel

@Stability(value=Stable)
public CfnEmailChannel(@NotNull
                                                software.constructs.Construct scope,
                                                @NotNull
                                                String id,
                                                @NotNull
                                                CfnEmailChannelProps props)

Create a new `AWS::Pinpoint::EmailChannel`.

Parameters:

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.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getApplicationId

@Stability(value=Stable)
 @NotNull
public String getApplicationId()

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

setApplicationId

@Stability(value=Stable)
public void setApplicationId(@NotNull
                                                      String value)

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

getFromAddress

@Stability(value=Stable)
 @NotNull
public String getFromAddress()

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

setFromAddress

@Stability(value=Stable)
public void setFromAddress(@NotNull
                                                    String value)

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

getIdentity

@Stability(value=Stable)
 @NotNull
public 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.

setIdentity

@Stability(value=Stable)
public void setIdentity(@NotNull
                                                 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.

getConfigurationSet

@Stability(value=Stable)
 @Nullable
public 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.

setConfigurationSet

@Stability(value=Stable)
public void setConfigurationSet(@Nullable
                                                         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.

getEnabled

@Stability(value=Stable)
 @Nullable
public Object getEnabled()

Specifies whether to enable the email channel for the application.

setEnabled

@Stability(value=Stable)
public void setEnabled(@Nullable
                                                Boolean value)

Specifies whether to enable the email channel for the application.

setEnabled

@Stability(value=Stable)
public void setEnabled(@Nullable
                                                IResolvable value)

Specifies whether to enable the email channel for the application.

getRoleArn

@Stability(value=Stable)
 @Nullable
public 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.

setRoleArn

@Stability(value=Stable)
public void setRoleArn(@Nullable
                                                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.