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.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:42.203Z")
 @Stability(value=Stable)
public abstract class Identity
extends software.amazon.jsii.JsiiObject

Identity.

Example:

 // Example automatically generated from non-compiling source. May contain errors.
 IPublicHostedZone myHostedZone;
 EmailIdentity identity = EmailIdentity.Builder.create(stack, "Identity")
         .identity(Identity.publicHostedZone(myHostedZone))
         .mailFromDomain("mail.cdk.dev")
         .build();
 

Nested Class Summary

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

software.amazon.jsii.JsiiObject.InitializationMode

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and 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 Detail

Identity

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

Identity

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

Identity

@Stability(value=Stable)
protected Identity()

Method Detail

domain

@Stability(value=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(value=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(value=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(value=Stable)
 @NotNull
public abstract String getValue()

The value of the identity.

getHostedZone

@Stability(value=Stable)
 @Nullable
public abstract IPublicHostedZone getHostedZone()

The hosted zone associated with this identity.

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