Class EmailIdentity

An email identity.

Inheritance

System.Object

Resource

EmailIdentity

Implements

IEmailIdentity

IResource

Constructs.IConstruct

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

Syntax (vb)

Public Class EmailIdentity
    Inherits Resource
    Implements IEmailIdentity, IResource

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(ByRefValue)	Used by jsii to construct an instance of this class from a Javascript-owned object reference
EmailIdentity(DeputyBase.DeputyProps)	Used by jsii to construct an instance of this class from DeputyProps
EmailIdentity(Construct, String, IEmailIdentityProps)

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.

Methods

FromEmailIdentityName(Construct, String, String)	Use an existing email identity.
Grant(IGrantable, 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(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected EmailIdentity(ByRefValue reference)

Parameters

reference Amazon.JSII.Runtime.Deputy.ByRefValue: The Javascript-owned object reference

EmailIdentity(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected EmailIdentity(DeputyBase.DeputyProps props)

Parameters

props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps: The deputy props

EmailIdentity(Construct, String, IEmailIdentityProps)

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

Parameters

scope Constructs.Construct
id System.String
props IEmailIdentityProps

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

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

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

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

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

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

System.String

Remarks

Attribute: true

DkimRecords

DKIM records for this identity.

public virtual IDkimRecord[] DkimRecords { get; }

Property Value

IDkimRecord[]

EmailIdentityArn

The ARN of the email identity.

public virtual string EmailIdentityArn { get; }

Property Value

System.String

EmailIdentityName

The name of the email identity.

public virtual string EmailIdentityName { get; }

Property Value

System.String

Methods

FromEmailIdentityName(Construct, String, String)

Use an existing email identity.

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

Parameters

scope Constructs.Construct
id System.String
emailIdentityName System.String

Returns

IEmailIdentity

Grant(IGrantable, 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 System.String[]: the set of actions to allow.

Returns

Grant

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