software.amazon.awscdk.services.pinpointemail

Class CfnIdentity

java.lang.Object

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.pinpointemail.CfnIdentity

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-14T16:25:24.920Z")
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 interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnIdentity(Construct scope, java.lang.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
java.lang.String	getAttrIdentityDnsRecordName1() The host name for the first token that you have to add to the DNS configuration for your domain.
java.lang.String	getAttrIdentityDnsRecordName2() The host name for the second token that you have to add to the DNS configuration for your domain.
java.lang.String	getAttrIdentityDnsRecordName3() The host name for the third token that you have to add to the DNS configuration for your domain.
java.lang.String	getAttrIdentityDnsRecordValue1() The record value for the first token that you have to add to the DNS configuration for your domain.
java.lang.String	getAttrIdentityDnsRecordValue2() The record value for the second token that you have to add to the DNS configuration for your domain.
java.lang.String	getAttrIdentityDnsRecordValue3() The record value for the third token that you have to add to the DNS configuration for your domain.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.Object	getDkimSigningEnabled() For domain identities, this attribute is used to enable or disable DomainKeys Identified Mail (DKIM) signing for the domain.
java.lang.Object	getFeedbackForwardingEnabled() Used to enable or disable feedback forwarding for an identity.
java.lang.Object	getMailFromAttributes() Used to enable or disable the custom Mail-From domain configuration for an email identity.
java.lang.String	getName() The address or domain of the identity, such as *sender@example.com* or *example.co.uk* .
java.util.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 java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setDkimSigningEnabled(java.lang.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(java.lang.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(java.lang.String value) The address or domain of the identity, such as *sender@example.com* or *example.co.uk* .
void	setTags(java.util.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.core.CfnResource

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

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

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

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.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

public CfnIdentity(Construct scope,
                   java.lang.String id,
                   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

public void inspect(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

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrIdentityDnsRecordName1

public java.lang.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

public java.lang.String getAttrIdentityDnsRecordName2()

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

getAttrIdentityDnsRecordName3

public java.lang.String getAttrIdentityDnsRecordName3()

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

getAttrIdentityDnsRecordValue1

public java.lang.String getAttrIdentityDnsRecordValue1()

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

getAttrIdentityDnsRecordValue2

public java.lang.String getAttrIdentityDnsRecordValue2()

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

getAttrIdentityDnsRecordValue3

public java.lang.String getAttrIdentityDnsRecordValue3()

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

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getName

public java.lang.String getName()

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

setName

public void setName(java.lang.String value)

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

getDkimSigningEnabled

public java.lang.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

public void setDkimSigningEnabled(java.lang.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

public void setDkimSigningEnabled(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

public java.lang.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

public void setFeedbackForwardingEnabled(java.lang.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

public void setFeedbackForwardingEnabled(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

public java.lang.Object getMailFromAttributes()

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

setMailFromAttributes

public void setMailFromAttributes(IResolvable value)

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

setMailFromAttributes

public void setMailFromAttributes(CfnIdentity.MailFromAttributesProperty value)

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

getTags

public java.util.List<CfnIdentity.TagsProperty> getTags()

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

setTags

public void setTags(java.util.List<CfnIdentity.TagsProperty> value)

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