Package software.amazon.awscdk.cfnpropertymixins.services.pinpointemail

Class CfnIdentityPropsMixin

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.Mixin
software.amazon.awscdk.cfnpropertymixins.services.pinpointemail.CfnIdentityPropsMixin
All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable, software.constructs.IMixin
@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)", date="2026-03-11T13:20:02.353Z") @Stability(Stable) public class CfnIdentityPropsMixin extends Mixin implements software.constructs.IMixin
Specifies an identity to use for sending email through Amazon Pinpoint.

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

When you verify an email address, Amazon Pinpoint 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, this operation provides a set of DKIM tokens, which you can convert into CNAME tokens. You add these CNAME tokens to the DNS configuration for your domain. Your domain is verified when Amazon Pinpoint detects these records in the DNS configuration for your domain. It usually takes around 72 hours to complete the domain verification process.

When you use CloudFormation to specify an identity, CloudFormation might indicate that the identity was created successfully. However, you have to verify the identity before you can use it to send email.

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.pinpointemail.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 CfnIdentityPropsMixin cfnIdentityPropsMixin = CfnIdentityPropsMixin.Builder.create(CfnIdentityMixinProps.builder()
         .dkimSigningEnabled(false)
         .feedbackForwardingEnabled(false)
         .mailFromAttributes(MailFromAttributesProperty.builder()
                 .behaviorOnMxFailure("behaviorOnMxFailure")
                 .mailFromDomain("mailFromDomain")
                 .build())
         .name("name")
         .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

    • CfnIdentityPropsMixin

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

    • CfnIdentityPropsMixin

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

    • CfnIdentityPropsMixin

      @Stability(Stable) public CfnIdentityPropsMixin(@NotNull CfnIdentityMixinProps props, @Nullable CfnPropertyMixinOptions options)
      Create a mixin to apply properties to AWS::PinpointEmail::Identity.

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

    • CfnIdentityPropsMixin

      @Stability(Stable) public CfnIdentityPropsMixin(@NotNull CfnIdentityMixinProps props)
      Create a mixin to apply properties to AWS::PinpointEmail::Identity.

      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 CfnIdentityMixinProps getProps()

    • getStrategy

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