Package software.amazon.awscdk.cfnpropertymixins.services.ses

Class CfnEmailIdentityPropsMixin

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.Mixin
software.amazon.awscdk.cfnpropertymixins.services.ses.CfnEmailIdentityPropsMixin
All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable, software.constructs.IMixin
@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)", date="2026-03-11T13:20:05.522Z") @Stability(Stable) public class CfnEmailIdentityPropsMixin extends Mixin implements software.constructs.IMixin
Specifies an identity for using within SES.

An identity is an email address or domain that you use when you send email. Before you can use an identity to send email, you first have to verify it. By verifying an identity, you demonstrate that you're the owner of the identity, and that you've given Amazon SES API v2 permission to send email from the identity.

When you verify an email address, SES sends an email to the address. Your email address is verified as soon as you follow the link in the verification email. When you verify a domain without specifying the DkimSigningAttributes properties, OR only the NextSigningKeyLength property of DkimSigningAttributes , this resource provides a set of CNAME token names and values ( DkimDNSTokenName1 , DkimDNSTokenValue1 , DkimDNSTokenName2 , DkimDNSTokenValue2 , DkimDNSTokenName3 , DkimDNSTokenValue3 ) as outputs. You can then add these to the DNS configuration for your domain. Your domain is verified when Amazon SES detects these records in the DNS configuration for your domain. This verification method is known as Easy DKIM.

Alternatively, you can perform the verification process by providing your own public-private key pair. This verification method is known as Bring Your Own DKIM (BYODKIM). To use BYODKIM, your resource must include DkimSigningAttributes properties DomainSigningSelector and DomainSigningPrivateKey . When you specify this object, you provide a selector ( DomainSigningSelector ) (a component of the DNS record name that identifies the public key to use for DKIM authentication) and a private key ( DomainSigningPrivateKey ).

Additionally, you can associate an existing configuration set with the email identity that you're verifying.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.ses.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 CfnEmailIdentityPropsMixin cfnEmailIdentityPropsMixin = CfnEmailIdentityPropsMixin.Builder.create(CfnEmailIdentityMixinProps.builder()
         .configurationSetAttributes(ConfigurationSetAttributesProperty.builder()
                 .configurationSetName("configurationSetName")
                 .build())
         .dkimAttributes(DkimAttributesProperty.builder()
                 .signingEnabled(false)
                 .build())
         .dkimSigningAttributes(DkimSigningAttributesProperty.builder()
                 .domainSigningPrivateKey("domainSigningPrivateKey")
                 .domainSigningSelector("domainSigningSelector")
                 .nextSigningKeyLength("nextSigningKeyLength")
                 .build())
         .emailIdentity("emailIdentity")
         .feedbackAttributes(FeedbackAttributesProperty.builder()
                 .emailForwardingEnabled(false)
                 .build())
         .mailFromAttributes(MailFromAttributesProperty.builder()
                 .behaviorOnMxFailure("behaviorOnMxFailure")
                 .mailFromDomain("mailFromDomain")
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build())
 .strategy(mergeStrategy)
 .build();

See Also:

  • Field Details

    • CFN_PROPERTY_KEYS

      @Stability(Stable) protected static final List<String> CFN_PROPERTY_KEYS

  • Constructor Details

    • CfnEmailIdentityPropsMixin

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

    • CfnEmailIdentityPropsMixin

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

    • CfnEmailIdentityPropsMixin

      @Stability(Stable) public CfnEmailIdentityPropsMixin(@NotNull CfnEmailIdentityMixinProps props, @Nullable CfnPropertyMixinOptions options)
      Create a mixin to apply properties to AWS::SES::EmailIdentity.

      Parameters:
      props - L1 properties to apply. This parameter is required.
      options - Mixin options.

    • CfnEmailIdentityPropsMixin

      @Stability(Stable) public CfnEmailIdentityPropsMixin(@NotNull CfnEmailIdentityMixinProps props)
      Create a mixin to apply properties to AWS::SES::EmailIdentity.

      Parameters:
      props - L1 properties to apply. This parameter is required.

  • Method Details

    • applyTo

      @Stability(Stable) public void applyTo(@NotNull software.constructs.IConstruct construct)
      Apply the mixin properties to the construct.

      Specified by:
      applyTo in interface software.constructs.IMixin
      Specified by:
      applyTo in class Mixin
      Parameters:
      construct - This parameter is required.

    • supports

      @Stability(Stable) @NotNull public Boolean supports(@NotNull software.constructs.IConstruct construct)
      Check if this mixin supports the given construct.

      Specified by:
      supports in interface software.constructs.IMixin
      Overrides:
      supports in class Mixin
      Parameters:
      construct - This parameter is required.

    • getProps

      @Stability(Stable) @NotNull protected CfnEmailIdentityMixinProps getProps()

    • getStrategy

      @Stability(Stable) @NotNull protected IMergeStrategy getStrategy()