Interface ByoDkimOptions

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
ByoDkimOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.99.0 (build 8f757e4)", date="2024-06-13T18:49:25.885Z") @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();
 
  • 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