aws-cdk-lib.aws_ses.DkimIdentity

class DkimIdentity

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

The identity to use for DKIM.

Example

declare const myHostedZone: route53.IPublicHostedZone;

new ses.EmailIdentity(this, 'Identity', {
  identity: ses.Identity.publicHostedZone(myHostedZone),
  dkimIdentity: ses.DkimIdentity.byoDkim({
    privateKey: SecretValue.secretsManager('dkim-private-key'),
    publicKey: '...base64-encoded-public-key...',
    selector: 'selector',
  }),
});

Initializer

new DkimIdentity()

Methods

NameDescription
bind(emailIdentity, hostedZone?)Binds this DKIM identity to the email identity.
static byoDkim(options)Bring Your Own DKIM.
static easyDkim(signingKeyLength?)Easy DKIM.

bind(emailIdentity, hostedZone?)

public bind(emailIdentity: EmailIdentity, hostedZone?: IPublicHostedZone): DkimIdentityConfig

Parameters

  • emailIdentity EmailIdentity
  • hostedZone IPublicHostedZone

Returns

  • DkimIdentityConfig

Binds this DKIM identity to the email identity.


static byoDkim(options)

public static byoDkim(options: ByoDkimOptions): DkimIdentity

Parameters

  • options ByoDkimOptions — Options for BYO DKIM.

Returns

  • DkimIdentity

Bring Your Own DKIM.

See also: https://docs.aws.amazon.com/ses/latest/dg/send-email-authentication-dkim-bring-your-own.html


static easyDkim(signingKeyLength?)

public static easyDkim(signingKeyLength?: EasyDkimSigningKeyLength): DkimIdentity

Parameters

  • signingKeyLength EasyDkimSigningKeyLength — The length of the signing key.

Returns

  • DkimIdentity

Easy DKIM.

See also: https://docs.aws.amazon.com/ses/latest/dg/send-email-authentication-dkim-easy.html