Package software.amazon.awscdk.services.ses

Class DkimIdentity

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.ses.DkimIdentity

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-22T02:24:09.802Z")
@Stability(Stable)
public abstract class DkimIdentity
extends software.amazon.jsii.JsiiObject

The identity to use for DKIM.

Example:

 IPublicHostedZone myHostedZone;
 EmailIdentity.Builder.create(this, "Identity")
         .identity(Identity.publicHostedZone(myHostedZone))
         .dkimIdentity(DkimIdentity.byoDkim(ByoDkimOptions.builder()
                 .privateKey(SecretValue.secretsManager("dkim-private-key"))
                 .publicKey("...base64-encoded-public-key...")
                 .selector("selector")
                 .build()))
         .build();
 

Nested Class Summary

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

software.amazon.jsii.JsiiObject.InitializationMode

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DkimIdentity()
protected	DkimIdentity(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	DkimIdentity(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
abstract DkimIdentityConfig	bind(EmailIdentity emailIdentity)	Binds this DKIM identity to the email identity.
abstract DkimIdentityConfig	bind(EmailIdentity emailIdentity, IPublicHostedZone hostedZone)	Binds this DKIM identity to the email identity.
static DkimIdentity	byoDkim(ByoDkimOptions options)	Bring Your Own DKIM.
static DkimIdentity	easyDkim()	Easy DKIM.
static DkimIdentity	easyDkim(EasyDkimSigningKeyLength signingKeyLength)	Easy DKIM.

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, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

DkimIdentity

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

DkimIdentity

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

DkimIdentity

@Stability(Stable)
protected DkimIdentity()

Method Details

byoDkim

@Stability(Stable)
@NotNull
public static DkimIdentity byoDkim(@NotNull
 ByoDkimOptions options)

Bring Your Own DKIM.

Parameters:

options - Options for BYO DKIM. This parameter is required.

See Also:

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

easyDkim

@Stability(Stable)
@NotNull
public static DkimIdentity easyDkim(@Nullable
 EasyDkimSigningKeyLength signingKeyLength)

Easy DKIM.

Parameters:

signingKeyLength - The length of the signing key.

See Also:

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

easyDkim

@Stability(Stable)
@NotNull
public static DkimIdentity easyDkim()

Easy DKIM.

See Also:

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

bind

@Stability(Stable)
@Nullable
public abstract DkimIdentityConfig bind(@NotNull
 EmailIdentity emailIdentity,
 @Nullable
 IPublicHostedZone hostedZone)

Binds this DKIM identity to the email identity.

Parameters:

emailIdentity - This parameter is required.

hostedZone -

bind

@Stability(Stable)
@Nullable
public abstract DkimIdentityConfig bind(@NotNull
 EmailIdentity emailIdentity)

Binds this DKIM identity to the email identity.

Parameters:

emailIdentity - This parameter is required.