software.amazon.awscdk.services.pinpoint

Class CfnEmailChannel

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.pinpoint.CfnEmailChannel

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:39.213Z")
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 interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

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)

Method Summary

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.

Methods inherited from class software.amazon.awscdk.core.CfnResource

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

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

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

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.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

public CfnEmailChannel(Construct scope,
                       java.lang.String id,
                       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

public void inspect(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

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getApplicationId

public java.lang.String getApplicationId()

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

setApplicationId

public void setApplicationId(java.lang.String value)

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

getFromAddress

public java.lang.String getFromAddress()

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

setFromAddress

public void setFromAddress(java.lang.String value)

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

getIdentity

public 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.

setIdentity

public 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.

getConfigurationSet

public 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.

setConfigurationSet

public 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.

getEnabled

public java.lang.Object getEnabled()

Specifies whether to enable the email channel for the application.

setEnabled

public void setEnabled(java.lang.Boolean value)

Specifies whether to enable the email channel for the application.

setEnabled

public void setEnabled(IResolvable value)

Specifies whether to enable the email channel for the application.

getRoleArn

public 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.

setRoleArn

public 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.