Package software.amazon.awscdk.services.ses

Class CfnEmailIdentity

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.ses.CfnEmailIdentity
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:41.373Z") @Stability(Stable) public class CfnEmailIdentity extends CfnResource implements IInspectable
A CloudFormation AWS::SES::EmailIdentity.

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.services.ses.*;
 CfnEmailIdentity cfnEmailIdentity = CfnEmailIdentity.Builder.create(this, "MyCfnEmailIdentity")
         .emailIdentity("emailIdentity")
         // the properties below are optional
         .configurationSetAttributes(ConfigurationSetAttributesProperty.builder()
                 .configurationSetName("configurationSetName")
                 .build())
         .dkimAttributes(DkimAttributesProperty.builder()
                 .signingEnabled(false)
                 .build())
         .dkimSigningAttributes(DkimSigningAttributesProperty.builder()
                 .domainSigningPrivateKey("domainSigningPrivateKey")
                 .domainSigningSelector("domainSigningSelector")
                 .nextSigningKeyLength("nextSigningKeyLength")
                 .build())
         .feedbackAttributes(FeedbackAttributesProperty.builder()
                 .emailForwardingEnabled(false)
                 .build())
         .mailFromAttributes(MailFromAttributesProperty.builder()
                 .behaviorOnMxFailure("behaviorOnMxFailure")
                 .mailFromDomain("mailFromDomain")
                 .build())
         .build();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnEmailIdentity

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

    • CfnEmailIdentity

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

    • CfnEmailIdentity

      @Stability(Stable) public CfnEmailIdentity(@NotNull Construct scope, @NotNull String id, @NotNull CfnEmailIdentityProps props)
      Create a new AWS::SES::EmailIdentity.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrDkimDnsTokenName1

      @Stability(Stable) @NotNull public String getAttrDkimDnsTokenName1()
      The host name for the first token that you have to add to the DNS configuration for your domain.

    • getAttrDkimDnsTokenName2

      @Stability(Stable) @NotNull public String getAttrDkimDnsTokenName2()
      The host name for the second token that you have to add to the DNS configuration for your domain.

    • getAttrDkimDnsTokenName3

      @Stability(Stable) @NotNull public String getAttrDkimDnsTokenName3()
      The host name for the third token that you have to add to the DNS configuration for your domain.

    • getAttrDkimDnsTokenValue1

      @Stability(Stable) @NotNull public String getAttrDkimDnsTokenValue1()
      The record value for the first token that you have to add to the DNS configuration for your domain.

    • getAttrDkimDnsTokenValue2

      @Stability(Stable) @NotNull public String getAttrDkimDnsTokenValue2()
      The record value for the second token that you have to add to the DNS configuration for your domain.

    • getAttrDkimDnsTokenValue3

      @Stability(Stable) @NotNull public String getAttrDkimDnsTokenValue3()
      The record value for the third token that you have to add to the DNS configuration for your domain.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getEmailIdentity

      @Stability(Stable) @NotNull public String getEmailIdentity()
      The email address or domain to verify.

    • setEmailIdentity

      @Stability(Stable) public void setEmailIdentity(@NotNull String value)
      The email address or domain to verify.

    • getConfigurationSetAttributes

      @Stability(Stable) @Nullable public Object getConfigurationSetAttributes()
      Used to associate a configuration set with an email identity.

    • setConfigurationSetAttributes

      @Stability(Stable) public void setConfigurationSetAttributes(@Nullable IResolvable value)
      Used to associate a configuration set with an email identity.

    • setConfigurationSetAttributes

      @Stability(Stable) public void setConfigurationSetAttributes(@Nullable CfnEmailIdentity.ConfigurationSetAttributesProperty value)
      Used to associate a configuration set with an email identity.

    • getDkimAttributes

      @Stability(Stable) @Nullable public Object getDkimAttributes()
      An object that contains information about the DKIM attributes for the identity.

    • setDkimAttributes

      @Stability(Stable) public void setDkimAttributes(@Nullable IResolvable value)
      An object that contains information about the DKIM attributes for the identity.

    • setDkimAttributes

      @Stability(Stable) public void setDkimAttributes(@Nullable CfnEmailIdentity.DkimAttributesProperty value)
      An object that contains information about the DKIM attributes for the identity.

    • getDkimSigningAttributes

      @Stability(Stable) @Nullable public Object getDkimSigningAttributes()
      If your request includes this object, Amazon SES configures the identity to use Bring Your Own DKIM (BYODKIM) for DKIM authentication purposes, or, configures the key length to be used for Easy DKIM .

    • setDkimSigningAttributes

      @Stability(Stable) public void setDkimSigningAttributes(@Nullable IResolvable value)
      If your request includes this object, Amazon SES configures the identity to use Bring Your Own DKIM (BYODKIM) for DKIM authentication purposes, or, configures the key length to be used for Easy DKIM .

    • setDkimSigningAttributes

      @Stability(Stable) public void setDkimSigningAttributes(@Nullable CfnEmailIdentity.DkimSigningAttributesProperty value)
      If your request includes this object, Amazon SES configures the identity to use Bring Your Own DKIM (BYODKIM) for DKIM authentication purposes, or, configures the key length to be used for Easy DKIM .

    • getFeedbackAttributes

      @Stability(Stable) @Nullable public Object getFeedbackAttributes()
      Used to enable or disable feedback forwarding for an identity.

    • setFeedbackAttributes

      @Stability(Stable) public void setFeedbackAttributes(@Nullable IResolvable value)
      Used to enable or disable feedback forwarding for an identity.

    • setFeedbackAttributes

      @Stability(Stable) public void setFeedbackAttributes(@Nullable CfnEmailIdentity.FeedbackAttributesProperty value)
      Used to enable or disable feedback forwarding for an identity.

    • getMailFromAttributes

      @Stability(Stable) @Nullable public Object getMailFromAttributes()
      Used to enable or disable the custom Mail-From domain configuration for an email identity.

    • setMailFromAttributes

      @Stability(Stable) public void setMailFromAttributes(@Nullable IResolvable value)
      Used to enable or disable the custom Mail-From domain configuration for an email identity.

    • setMailFromAttributes

      @Stability(Stable) public void setMailFromAttributes(@Nullable CfnEmailIdentity.MailFromAttributesProperty value)
      Used to enable or disable the custom Mail-From domain configuration for an email identity.