Package software.amazon.awscdk.services.ses

Interface ByoDkimOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ByoDkimOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)",
           date="2025-12-18T18:20:18.073Z")
@Stability(Stable)
public interface ByoDkimOptions
extends software.amazon.jsii.JsiiSerializable

Options for BYO 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

Modifier and Type	Interface	Description
static final class	ByoDkimOptions.Builder	A builder for ByoDkimOptions
static final class	ByoDkimOptions.Jsii$Proxy	An implementation for ByoDkimOptions

Method Summary

Modifier and Type	Method	Description
static ByoDkimOptions.Builder	builder()
SecretValue	getPrivateKey()	The private key that's used to generate a DKIM signature.
default String	getPublicKey()	The public key.
String	getSelector()	A string that's used to identify a public key in the DNS configuration for a domain.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getPrivateKey

@Stability(Stable)
@NotNull
SecretValue getPrivateKey()

The private key that's used to generate a DKIM signature.

getSelector

@Stability(Stable)
@NotNull
String getSelector()

A string that's used to identify a public key in the DNS configuration for a domain.

getPublicKey

@Stability(Stable)
@Nullable
default String getPublicKey()

The public key.

If specified, a TXT record with the public key is created.

Default: - the validation TXT record with the public key is not created

builder

@Stability(Stable)
static ByoDkimOptions.Builder builder()

Returns:

a ByoDkimOptions.Builder of ByoDkimOptions