Class CfnEmailChannel
A channel is a type of platform that you can deliver messages to.
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.Pinpoint
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnEmailChannel : CfnResource, IInspectable
Syntax (vb)
Public Class CfnEmailChannel
Inherits CfnResource
Implements IInspectable
Remarks
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
CloudformationResource: AWS::Pinpoint::EmailChannel
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Pinpoint;
var cfnEmailChannel = new CfnEmailChannel(this, "MyCfnEmailChannel", new CfnEmailChannelProps {
ApplicationId = "applicationId",
FromAddress = "fromAddress",
Identity = "identity",
// the properties below are optional
ConfigurationSet = "configurationSet",
Enabled = false,
OrchestrationSendingRoleArn = "orchestrationSendingRoleArn",
RoleArn = "roleArn"
});
Synopsis
Constructors
CfnEmailChannel(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnEmailChannel(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnEmailChannel(Construct, String, ICfnEmailChannelProps) |
Properties
ApplicationId | The unique identifier for the Amazon Pinpoint application that you're specifying the email channel for. |
AttrId | (Deprecated) An identifier for the email channel. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
ConfigurationSet | The Amazon SES configuration set that you want to apply to messages that you send through the channel. |
Enabled | Specifies whether to enable the email channel for the application. |
FromAddress | The verified email address that you want to send email from when you send email through the channel. |
Identity | 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. |
OrchestrationSendingRoleArn | |
RoleArn | 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
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnEmailChannel(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnEmailChannel(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnEmailChannel(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnEmailChannel(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnEmailChannel(Construct, String, ICfnEmailChannelProps)
public CfnEmailChannel(Construct scope, string id, ICfnEmailChannelProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnEmailChannelProps
Resource properties.
Properties
ApplicationId
The unique identifier for the Amazon Pinpoint application that you're specifying the email channel for.
public virtual string ApplicationId { get; set; }
Property Value
System.String
AttrId
(Deprecated) An identifier for the email channel.
public virtual string AttrId { get; }
Property Value
System.String
Remarks
This property is retained only for backward compatibility.
CloudformationAttribute: Id
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
ConfigurationSet
The Amazon SES configuration set that you want to apply to messages that you send through the channel.
public virtual string ConfigurationSet { get; set; }
Property Value
System.String
Enabled
Specifies whether to enable the email channel for the application.
public virtual object Enabled { get; set; }
Property Value
System.Object
FromAddress
The verified email address that you want to send email from when you send email through the channel.
public virtual string FromAddress { get; set; }
Property Value
System.String
Identity
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.
public virtual string Identity { get; set; }
Property Value
System.String
OrchestrationSendingRoleArn
public virtual string OrchestrationSendingRoleArn { get; set; }
Property Value
System.String
RoleArn
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.
public virtual string RoleArn { get; set; }
Property Value
System.String
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>