Class EmailIdentity

An email identity.

Inheritance

object

Resource

EmailIdentity

Implements

IEmailIdentity

IResource

IConstruct

IDependable

Inherited Members

Resource.IsOwnedResource(IConstruct)

Resource.IsResource(IConstruct)

Resource.ApplyRemovalPolicy(RemovalPolicy)

Resource.GeneratePhysicalName()

Resource.GetResourceArnAttribute(string, IArnComponents)

Resource.GetResourceNameAttribute(string)

Resource.Env

Resource.PhysicalName

Resource.Stack

Namespace: Amazon.CDK.AWS.SES

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class EmailIdentity : Resource, IEmailIdentity, IResource, IConstruct, IDependable

Syntax (vb)

Public Class EmailIdentity Inherits Resource Implements IEmailIdentity, IResource, IConstruct, IDependable

Remarks

ExampleMetadata: infused

Examples

using Amazon.CDK.AWS.IAM;
            User user;


            var identity = new EmailIdentity(this, "Identity", new EmailIdentityProps {
                Identity = Identity.Domain("cdk.dev")
            });

            identity.GrantSendEmail(user);

Synopsis

Constructors

EmailIdentity(Construct, string, IEmailIdentityProps)

An email identity.

Properties

DkimDnsTokenName1	The host name for the first token that you have to add to the DNS configurationfor your domain.
DkimDnsTokenName2	The host name for the second token that you have to add to the DNS configuration for your domain.
DkimDnsTokenName3	The host name for the third token that you have to add to the DNS configuration for your domain.
DkimDnsTokenValue1	The record value for the first token that you have to add to the DNS configuration for your domain.
DkimDnsTokenValue2	The record value for the second token that you have to add to the DNS configuration for your domain.
DkimDnsTokenValue3	The record value for the third token that you have to add to the DNS configuration for your domain.
DkimRecords	DKIM records for this identity.
EmailIdentityArn	The ARN of the email identity.
EmailIdentityName	The name of the email identity.
PROPERTY_INJECTION_ID	Uniquely identifies this class.

Methods

FromEmailIdentityArn(Construct, string, string)	Import an email identity by ARN.
FromEmailIdentityName(Construct, string, string)	Use an existing email identity.
Grant(IGrantable, params string[])	Adds an IAM policy statement associated with this email identity to an IAM principal's policy.
GrantSendEmail(IGrantable)	Permits an IAM principal the send email action.

Constructors

EmailIdentity(Construct, string, IEmailIdentityProps)

An email identity.

public EmailIdentity(Construct scope, string id, IEmailIdentityProps props)

Parameters

scope Construct
id string
props IEmailIdentityProps

Remarks

ExampleMetadata: infused

Examples

using Amazon.CDK.AWS.IAM;
            User user;


            var identity = new EmailIdentity(this, "Identity", new EmailIdentityProps {
                Identity = Identity.Domain("cdk.dev")
            });

            identity.GrantSendEmail(user);

Properties

DkimDnsTokenName1

The host name for the first token that you have to add to the DNS configurationfor your domain.

public virtual string DkimDnsTokenName1 { get; }

Property Value

string

Remarks

Attribute: true

DkimDnsTokenName2

The host name for the second token that you have to add to the DNS configuration for your domain.

public virtual string DkimDnsTokenName2 { get; }

Property Value

string

Remarks

Attribute: true

DkimDnsTokenName3

The host name for the third token that you have to add to the DNS configuration for your domain.

public virtual string DkimDnsTokenName3 { get; }

Property Value

string

Remarks

Attribute: true

DkimDnsTokenValue1

The record value for the first token that you have to add to the DNS configuration for your domain.

public virtual string DkimDnsTokenValue1 { get; }

Property Value

string

Remarks

Attribute: true

DkimDnsTokenValue2

The record value for the second token that you have to add to the DNS configuration for your domain.

public virtual string DkimDnsTokenValue2 { get; }

Property Value

string

Remarks

Attribute: true

DkimDnsTokenValue3

The record value for the third token that you have to add to the DNS configuration for your domain.

public virtual string DkimDnsTokenValue3 { get; }

Property Value

string

Remarks

Attribute: true

DkimRecords

DKIM records for this identity.

public virtual IDkimRecord[] DkimRecords { get; }

Property Value

IDkimRecord[]

Remarks

ExampleMetadata: infused

EmailIdentityArn

The ARN of the email identity.

public virtual string EmailIdentityArn { get; }

Property Value

string

Remarks

ExampleMetadata: infused

EmailIdentityName

The name of the email identity.

public virtual string EmailIdentityName { get; }

Property Value

string

Remarks

ExampleMetadata: infused

PROPERTY_INJECTION_ID

Uniquely identifies this class.

public static string PROPERTY_INJECTION_ID { get; }

Property Value

string

Remarks

ExampleMetadata: infused

Methods

FromEmailIdentityArn(Construct, string, string)

Import an email identity by ARN.

public static IEmailIdentity FromEmailIdentityArn(Construct scope, string id, string emailIdentityArn)

Parameters

scope Construct
id string
emailIdentityArn string

Returns

IEmailIdentity

Remarks

ExampleMetadata: infused

FromEmailIdentityName(Construct, string, string)

Use an existing email identity.

public static IEmailIdentity FromEmailIdentityName(Construct scope, string id, string emailIdentityName)

Parameters

scope Construct
id string
emailIdentityName string

Returns

IEmailIdentity

Remarks

ExampleMetadata: infused

Grant(IGrantable, params string[])

Adds an IAM policy statement associated with this email identity to an IAM principal's policy.

public virtual Grant Grant(IGrantable grantee, params string[] actions)

Parameters

grantee IGrantable: the principal (no-op if undefined).
actions string[]: the set of actions to allow.

Returns

Grant

Remarks

ExampleMetadata: infused

GrantSendEmail(IGrantable)

Permits an IAM principal the send email action.

public virtual Grant GrantSendEmail(IGrantable grantee)

Parameters

grantee IGrantable: the principal to grant access to.

Returns

Grant

Remarks

Actions: SendEmail, SendRawEmail.

Implements

IEmailIdentity

IResource

Constructs.IConstruct

Constructs.IDependable