software.amazon.awscdk.services.pinpointemail

Class CfnIdentity

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.pinpointemail.CfnIdentity

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:41.257Z")
 @Stability(value=Stable)
public class CfnIdentity
extends CfnResource
implements IInspectable

A CloudFormation `AWS::PinpointEmail::Identity`.

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.services.pinpointemail.*;
 CfnIdentity cfnIdentity = CfnIdentity.Builder.create(this, "MyCfnIdentity")
         .name("name")
         // the properties below are optional
         .dkimSigningEnabled(false)
         .feedbackForwardingEnabled(false)
         .mailFromAttributes(MailFromAttributesProperty.builder()
                 .behaviorOnMxFailure("behaviorOnMxFailure")
                 .mailFromDomain("mailFromDomain")
                 .build())
         .tags(List.of(TagsProperty.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnIdentity.Builder A fluent builder for CfnIdentity.
static interface	CfnIdentity.MailFromAttributesProperty A list of attributes that are associated with a MAIL FROM domain.
static interface	CfnIdentity.TagsProperty An object that defines the tags (keys and values) that you want to associate with the identity.

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

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnIdentity(software.constructs.Construct scope, String id, CfnIdentityProps props) Create a new `AWS::PinpointEmail::Identity`.
protected	CfnIdentity(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnIdentity(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrIdentityDnsRecordName1() The host name for the first token that you have to add to the DNS configuration for your domain.
String	getAttrIdentityDnsRecordName2() The host name for the second token that you have to add to the DNS configuration for your domain.
String	getAttrIdentityDnsRecordName3() The host name for the third token that you have to add to the DNS configuration for your domain.
String	getAttrIdentityDnsRecordValue1() The record value for the first token that you have to add to the DNS configuration for your domain.
String	getAttrIdentityDnsRecordValue2() The record value for the second token that you have to add to the DNS configuration for your domain.
String	getAttrIdentityDnsRecordValue3() The record value for the third token that you have to add to the DNS configuration for your domain.
protected Map<String,Object>	getCfnProperties()
Object	getDkimSigningEnabled() For domain identities, this attribute is used to enable or disable DomainKeys Identified Mail (DKIM) signing for the domain.
Object	getFeedbackForwardingEnabled() Used to enable or disable feedback forwarding for an identity.
Object	getMailFromAttributes() Used to enable or disable the custom Mail-From domain configuration for an email identity.
String	getName() The address or domain of the identity, such as *sender@example.com* or *example.co.uk* .
List<CfnIdentity.TagsProperty>	getTags() An object that defines the tags (keys and values) that you want to associate with the email identity.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDkimSigningEnabled(Boolean value) For domain identities, this attribute is used to enable or disable DomainKeys Identified Mail (DKIM) signing for the domain.
void	setDkimSigningEnabled(IResolvable value) For domain identities, this attribute is used to enable or disable DomainKeys Identified Mail (DKIM) signing for the domain.
void	setFeedbackForwardingEnabled(Boolean value) Used to enable or disable feedback forwarding for an identity.
void	setFeedbackForwardingEnabled(IResolvable value) Used to enable or disable feedback forwarding for an identity.
void	setMailFromAttributes(CfnIdentity.MailFromAttributesProperty value) Used to enable or disable the custom Mail-From domain configuration for an email identity.
void	setMailFromAttributes(IResolvable value) Used to enable or disable the custom Mail-From domain configuration for an email identity.
void	setName(String value) The address or domain of the identity, such as *sender@example.com* or *example.co.uk* .
void	setTags(List<CfnIdentity.TagsProperty> value) An object that defines the tags (keys and values) that you want to associate with the email identity.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

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, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnIdentity

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

CfnIdentity

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

CfnIdentity

@Stability(value=Stable)
public CfnIdentity(@NotNull
                                            software.constructs.Construct scope,
                                            @NotNull
                                            String id,
                                            @NotNull
                                            CfnIdentityProps props)

Create a new `AWS::PinpointEmail::Identity`.

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 Detail

inspect

@Stability(value=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(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrIdentityDnsRecordName1

@Stability(value=Stable)
 @NotNull
public String getAttrIdentityDnsRecordName1()

The host name for the first token that you have to add to the DNS configuration for your domain.

For more information, see Verifying a Domain in the Amazon Pinpoint User Guide.

getAttrIdentityDnsRecordName2

@Stability(value=Stable)
 @NotNull
public String getAttrIdentityDnsRecordName2()

The host name for the second token that you have to add to the DNS configuration for your domain.

getAttrIdentityDnsRecordName3

@Stability(value=Stable)
 @NotNull
public String getAttrIdentityDnsRecordName3()

The host name for the third token that you have to add to the DNS configuration for your domain.

getAttrIdentityDnsRecordValue1

@Stability(value=Stable)
 @NotNull
public String getAttrIdentityDnsRecordValue1()

The record value for the first token that you have to add to the DNS configuration for your domain.

getAttrIdentityDnsRecordValue2

@Stability(value=Stable)
 @NotNull
public String getAttrIdentityDnsRecordValue2()

The record value for the second token that you have to add to the DNS configuration for your domain.

getAttrIdentityDnsRecordValue3

@Stability(value=Stable)
 @NotNull
public String getAttrIdentityDnsRecordValue3()

The record value for the third token that you have to add to the DNS configuration for your domain.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getName

@Stability(value=Stable)
 @NotNull
public String getName()

The address or domain of the identity, such as *sender@example.com* or *example.co.uk* .

setName

@Stability(value=Stable)
public void setName(@NotNull
                                             String value)

The address or domain of the identity, such as *sender@example.com* or *example.co.uk* .

getDkimSigningEnabled

@Stability(value=Stable)
 @Nullable
public Object getDkimSigningEnabled()

For domain identities, this attribute is used to enable or disable DomainKeys Identified Mail (DKIM) signing for the domain.

If the value is true , then the messages that you send from the domain are signed using both the DKIM keys for your domain, as well as the keys for the amazonses.com domain. If the value is false , then the messages that you send are only signed using the DKIM keys for the amazonses.com domain.

setDkimSigningEnabled

@Stability(value=Stable)
public void setDkimSigningEnabled(@Nullable
                                                           Boolean value)

For domain identities, this attribute is used to enable or disable DomainKeys Identified Mail (DKIM) signing for the domain.

If the value is true , then the messages that you send from the domain are signed using both the DKIM keys for your domain, as well as the keys for the amazonses.com domain. If the value is false , then the messages that you send are only signed using the DKIM keys for the amazonses.com domain.

setDkimSigningEnabled

@Stability(value=Stable)
public void setDkimSigningEnabled(@Nullable
                                                           IResolvable value)

For domain identities, this attribute is used to enable or disable DomainKeys Identified Mail (DKIM) signing for the domain.

If the value is true , then the messages that you send from the domain are signed using both the DKIM keys for your domain, as well as the keys for the amazonses.com domain. If the value is false , then the messages that you send are only signed using the DKIM keys for the amazonses.com domain.

getFeedbackForwardingEnabled

@Stability(value=Stable)
 @Nullable
public Object getFeedbackForwardingEnabled()

Used to enable or disable feedback forwarding for an identity.

This setting determines what happens when an identity is used to send an email that results in a bounce or complaint event.

When you enable feedback forwarding, Amazon Pinpoint sends you email notifications when bounce or complaint events occur. Amazon Pinpoint sends this notification to the address that you specified in the Return-Path header of the original email.

When you disable feedback forwarding, Amazon Pinpoint sends notifications through other mechanisms, such as by notifying an Amazon SNS topic. You're required to have a method of tracking bounces and complaints. If you haven't set up another mechanism for receiving bounce or complaint notifications, Amazon Pinpoint sends an email notification when these events occur (even if this setting is disabled).

setFeedbackForwardingEnabled

@Stability(value=Stable)
public void setFeedbackForwardingEnabled(@Nullable
                                                                  Boolean value)

Used to enable or disable feedback forwarding for an identity.

This setting determines what happens when an identity is used to send an email that results in a bounce or complaint event.

When you enable feedback forwarding, Amazon Pinpoint sends you email notifications when bounce or complaint events occur. Amazon Pinpoint sends this notification to the address that you specified in the Return-Path header of the original email.

When you disable feedback forwarding, Amazon Pinpoint sends notifications through other mechanisms, such as by notifying an Amazon SNS topic. You're required to have a method of tracking bounces and complaints. If you haven't set up another mechanism for receiving bounce or complaint notifications, Amazon Pinpoint sends an email notification when these events occur (even if this setting is disabled).

setFeedbackForwardingEnabled

@Stability(value=Stable)
public void setFeedbackForwardingEnabled(@Nullable
                                                                  IResolvable value)

Used to enable or disable feedback forwarding for an identity.

This setting determines what happens when an identity is used to send an email that results in a bounce or complaint event.

When you enable feedback forwarding, Amazon Pinpoint sends you email notifications when bounce or complaint events occur. Amazon Pinpoint sends this notification to the address that you specified in the Return-Path header of the original email.

When you disable feedback forwarding, Amazon Pinpoint sends notifications through other mechanisms, such as by notifying an Amazon SNS topic. You're required to have a method of tracking bounces and complaints. If you haven't set up another mechanism for receiving bounce or complaint notifications, Amazon Pinpoint sends an email notification when these events occur (even if this setting is disabled).

getMailFromAttributes

@Stability(value=Stable)
 @Nullable
public Object getMailFromAttributes()

Used to enable or disable the custom Mail-From domain configuration for an email identity.

setMailFromAttributes

@Stability(value=Stable)
public void setMailFromAttributes(@Nullable
                                                           CfnIdentity.MailFromAttributesProperty value)

Used to enable or disable the custom Mail-From domain configuration for an email identity.

setMailFromAttributes

@Stability(value=Stable)
public void setMailFromAttributes(@Nullable
                                                           IResolvable value)

Used to enable or disable the custom Mail-From domain configuration for an email identity.

getTags

@Stability(value=Stable)
 @Nullable
public List<CfnIdentity.TagsProperty> getTags()

An object that defines the tags (keys and values) that you want to associate with the email identity.

setTags

@Stability(value=Stable)
public void setTags(@Nullable
                                             List<CfnIdentity.TagsProperty> value)

An object that defines the tags (keys and values) that you want to associate with the email identity.