Package software.amazon.awscdk.services.pinpoint

Interface CfnEmailChannelProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnEmailChannelProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:00.823Z")
@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)
         .roleArn("roleArn")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnEmailChannelProps.Builder	A builder for CfnEmailChannelProps
static final class	CfnEmailChannelProps.Jsii$Proxy	An implementation for CfnEmailChannelProps

Method Summary

Modifier and Type	Method	Description
static CfnEmailChannelProps.Builder	builder()
String	getApplicationId()	The unique identifier for the Amazon Pinpoint application that you're specifying the email channel for.
default String	getConfigurationSet()	The Amazon SES configuration set that you want to apply to messages that you send through the channel.
default 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.
default 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.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getApplicationId

@Stability(Stable)
@NotNull
String getApplicationId()

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

getFromAddress

@Stability(Stable)
@NotNull
String getFromAddress()

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

getIdentity

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

getConfigurationSet

@Stability(Stable)
@Nullable
default String getConfigurationSet()

The Amazon SES configuration set that you want to apply to messages that you send through the channel.

getEnabled

@Stability(Stable)
@Nullable
default Object getEnabled()

Specifies whether to enable the email channel for the application.

getRoleArn

@Stability(Stable)
@Nullable
default 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.

builder

@Stability(Stable)
static CfnEmailChannelProps.Builder builder()

Returns:

a CfnEmailChannelProps.Builder of CfnEmailChannelProps