Package software.amazon.awscdk.services.ses

Class EmailIdentity

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.ses.EmailIdentity

All Implemented Interfaces:

IResource, IEmailIdentity, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-22T02:24:09.804Z")
@Stability(Stable)
public class EmailIdentity
extends Resource
implements IEmailIdentity

An email identity.

Example:

 import software.amazon.awscdk.services.iam.*;
 User user;
 EmailIdentity identity = EmailIdentity.Builder.create(this, "Identity")
         .identity(Identity.domain("cdk.dev"))
         .build();
 identity.grantSendEmail(user);
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	EmailIdentity.Builder	A fluent builder for EmailIdentity.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.ses.IEmailIdentity

IEmailIdentity.Jsii$Default, IEmailIdentity.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource

IResource.Jsii$Default

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	EmailIdentity(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	EmailIdentity(software.amazon.jsii.JsiiObjectRef objRef)
	EmailIdentity(software.constructs.Construct scope, String id, EmailIdentityProps props)

Method Summary

Modifier and Type	Method	Description
static IEmailIdentity	fromEmailIdentityName(software.constructs.Construct scope, String id, String emailIdentityName)	Use an existing email identity.
String	getDkimDnsTokenName1()	The host name for the first token that you have to add to the DNS configurationfor your domain.
String	getDkimDnsTokenName2()	The host name for the second token that you have to add to the DNS configuration for your domain.
String	getDkimDnsTokenName3()	The host name for the third token that you have to add to the DNS configuration for your domain.
String	getDkimDnsTokenValue1()	The record value for the first token that you have to add to the DNS configuration for your domain.
String	getDkimDnsTokenValue2()	The record value for the second token that you have to add to the DNS configuration for your domain.
String	getDkimDnsTokenValue3()	The record value for the third token that you have to add to the DNS configuration for your domain.
List<DkimRecord>	getDkimRecords()	DKIM records for this identity.
String	getEmailIdentityArn()	The ARN of the email identity.
String	getEmailIdentityName()	The name of the email identity.
Grant	grant(IGrantable grantee, @NotNull String... actions)	Adds an IAM policy statement associated with this email identity to an IAM principal's policy.
Grant	grantSendEmail(IGrantable grantee)	Permits an IAM principal the send email action.

Methods inherited from class software.amazon.awscdk.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResource

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

EmailIdentity

protected EmailIdentity(software.amazon.jsii.JsiiObjectRef objRef)

EmailIdentity

protected EmailIdentity(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

EmailIdentity

@Stability(Stable)
public EmailIdentity(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 EmailIdentityProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Details

fromEmailIdentityName

@Stability(Stable)
@NotNull
public static IEmailIdentity fromEmailIdentityName(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 String emailIdentityName)

Use an existing email identity.

Parameters:

scope - This parameter is required.

id - This parameter is required.

emailIdentityName - This parameter is required.

grant

@Stability(Stable)
@NotNull
public Grant grant(@NotNull
 IGrantable grantee,
 @NotNull
 @NotNull String... actions)

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

Specified by:

grant in interface IEmailIdentity

Parameters:

grantee - the principal (no-op if undefined). This parameter is required.

actions - the set of actions to allow. This parameter is required.

grantSendEmail

@Stability(Stable)
@NotNull
public Grant grantSendEmail(@NotNull
 IGrantable grantee)

Permits an IAM principal the send email action.

Actions: SendEmail, SendRawEmail.

Specified by:

grantSendEmail in interface IEmailIdentity

Parameters:

grantee - the principal to grant access to. This parameter is required.

getDkimDnsTokenName1

@Stability(Stable)
@NotNull
public String getDkimDnsTokenName1()

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

getDkimDnsTokenName2

@Stability(Stable)
@NotNull
public String getDkimDnsTokenName2()

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

getDkimDnsTokenName3

@Stability(Stable)
@NotNull
public String getDkimDnsTokenName3()

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

getDkimDnsTokenValue1

@Stability(Stable)
@NotNull
public String getDkimDnsTokenValue1()

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

getDkimDnsTokenValue2

@Stability(Stable)
@NotNull
public String getDkimDnsTokenValue2()

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

getDkimDnsTokenValue3

@Stability(Stable)
@NotNull
public String getDkimDnsTokenValue3()

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

getDkimRecords

@Stability(Stable)
@NotNull
public List<DkimRecord> getDkimRecords()

DKIM records for this identity.

getEmailIdentityArn

@Stability(Stable)
@NotNull
public String getEmailIdentityArn()

The ARN of the email identity.

Specified by:

getEmailIdentityArn in interface IEmailIdentity

getEmailIdentityName

@Stability(Stable)
@NotNull
public String getEmailIdentityName()

The name of the email identity.

Specified by:

getEmailIdentityName in interface IEmailIdentity