aws-cdk-lib.aws_ses.Identity

class Identity

LanguageType name
.NETAmazon.CDK.AWS.SES.Identity
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsses#Identity
Javasoftware.amazon.awscdk.services.ses.Identity
Pythonaws_cdk.aws_ses.Identity
TypeScript (source)aws-cdk-lib » aws_ses » Identity

Identity.

Example

declare const myHostedZone: route53.IPublicHostedZone;

const identity = new ses.EmailIdentity(this, 'Identity', {
  identity: ses.Identity.publicHostedZone(myHostedZone),
  mailFromDomain: 'mail.cdk.dev',
});

Initializer

new Identity()

Properties

NameTypeDescription
valuestringThe value of the identity.
hostedZone?IPublicHostedZoneThe hosted zone associated with this identity.

value

Type: string

The value of the identity.


hostedZone?

Type: IPublicHostedZone (optional, default: no hosted zone is associated and no records are created)

The hosted zone associated with this identity.

Methods

NameDescription
static domain(domain)Verify a domain name.
static email(email)Verify an email address.
static publicHostedZone(hostedZone)Verify a public hosted zone.

static domain(domain)

public static domain(domain: string): Identity

Parameters

  • domain string

Returns

  • Identity

Verify a domain name.

DKIM records will have to be added manually to complete the verification process


static email(email)

public static email(email: string): Identity

Parameters

  • email string

Returns

  • Identity

Verify an email address.

To complete the verification process look for an email from no-reply-aws@amazon.com, open it and click the link.


static publicHostedZone(hostedZone)

public static publicHostedZone(hostedZone: IPublicHostedZone): Identity

Parameters

  • hostedZone IPublicHostedZone

Returns

  • Identity

Verify a public hosted zone.

DKIM and MAIL FROM records will be added automatically to the hosted zone