Package software.amazon.awscdk.services.ses

Class Identity

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.ses.Identity
All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable
@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)", date="2024-05-08T21:35:14.068Z") @Stability(Stable) public abstract class Identity extends software.amazon.jsii.JsiiObject
Identity.

Example: 

 import software.amazon.awscdk.services.iam.*;
 User user;
 EmailIdentity identity = EmailIdentity.Builder.create(this, "Identity")
         .identity(Identity.domain("cdk.dev"))
         .build();
 identity.grantSendEmail(user);

  • Nested Class Summary

    Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

    software.amazon.jsii.JsiiObject.InitializationMode

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    Identity()
     
    protected
    Identity(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
     
    protected
    Identity(software.amazon.jsii.JsiiObjectRef objRef)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static Identity
    domain(String domain)
    Verify a domain name.
    static Identity
    email(String email)
    Verify an email address.
    abstract IPublicHostedZone
    getHostedZone()
    The hosted zone associated with this identity.
    abstract String
    getValue()
    The value of the identity.
    static Identity
    publicHostedZone(IPublicHostedZone hostedZone)
    Verify a public hosted zone.

    Methods inherited from class software.amazon.jsii.JsiiObject

    jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson

  • Constructor Details

    • Identity

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

    • Identity

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

    • Identity

      @Stability(Stable) protected Identity()

  • Method Details

    • domain

      @Stability(Stable) @NotNull public static Identity domain(@NotNull String domain)
      Verify a domain name.

      DKIM records will have to be added manually to complete the verification process

      Parameters:
      domain - This parameter is required.

    • email

      @Stability(Stable) @NotNull public static Identity email(@NotNull String email)
      Verify an email address.

      To complete the verification process look for an email from no-reply-aws@amazon.com, open it and click the link.

      Parameters:
      email - This parameter is required.

    • publicHostedZone

      @Stability(Stable) @NotNull public static Identity publicHostedZone(@NotNull IPublicHostedZone hostedZone)
      Verify a public hosted zone.

      DKIM and MAIL FROM records will be added automatically to the hosted zone

      Parameters:
      hostedZone - This parameter is required.

    • getValue

      @Stability(Stable) @NotNull public abstract String getValue()
      The value of the identity.

    • getHostedZone

      @Stability(Stable) @Nullable public abstract IPublicHostedZone getHostedZone()
      The hosted zone associated with this identity.

      Default: - no hosted zone is associated and no records are created