Class DkimIdentity

The identity to use for DKIM.

Inheritance

object

DkimIdentity

Namespace: Amazon.CDK.AWS.SES

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public abstract class DkimIdentity : DeputyBase

Syntax (vb)

Public MustInherit Class DkimIdentity Inherits DeputyBase

Remarks

ExampleMetadata: infused

Examples

IPublicHostedZone myHostedZone;


            new EmailIdentity(this, "Identity", new EmailIdentityProps {
                Identity = Identity.PublicHostedZone(myHostedZone),
                DkimIdentity = DkimIdentity.ByoDkim(new ByoDkimOptions {
                    PrivateKey = SecretValue.SecretsManager("dkim-private-key"),
                    PublicKey = "...base64-encoded-public-key...",
                    Selector = "selector"
                })
            });

Synopsis

Constructors

DkimIdentity()

The identity to use for DKIM.

Methods

Bind(EmailIdentity, IPublicHostedZone?)	Binds this DKIM identity to the email identity.
ByoDkim(IByoDkimOptions)	Bring Your Own DKIM.
EasyDkim(EasyDkimSigningKeyLength?)	Easy DKIM.

Constructors

DkimIdentity()

The identity to use for DKIM.

protected DkimIdentity()

Remarks

ExampleMetadata: infused

Examples

IPublicHostedZone myHostedZone;


            new EmailIdentity(this, "Identity", new EmailIdentityProps {
                Identity = Identity.PublicHostedZone(myHostedZone),
                DkimIdentity = DkimIdentity.ByoDkim(new ByoDkimOptions {
                    PrivateKey = SecretValue.SecretsManager("dkim-private-key"),
                    PublicKey = "...base64-encoded-public-key...",
                    Selector = "selector"
                })
            });

Methods

Bind(EmailIdentity, IPublicHostedZone?)

Binds this DKIM identity to the email identity.

public abstract IDkimIdentityConfig? Bind(EmailIdentity emailIdentity, IPublicHostedZone? hostedZone = null)

Parameters

emailIdentity EmailIdentity

hostedZone IPublicHostedZone

Returns

IDkimIdentityConfig

Remarks

ExampleMetadata: infused

ByoDkim(IByoDkimOptions)

Bring Your Own DKIM.

public static DkimIdentity ByoDkim(IByoDkimOptions options)

Parameters

options IByoDkimOptions

Options for BYO DKIM.

Returns

DkimIdentity

Remarks

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

EasyDkim(EasyDkimSigningKeyLength?)

Easy DKIM.

public static DkimIdentity EasyDkim(EasyDkimSigningKeyLength? signingKeyLength = null)

Parameters

signingKeyLength EasyDkimSigningKeyLength?

The length of the signing key.

Returns

DkimIdentity

Remarks

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