AWS::PinpointEmail::Identity - AWS CloudFormation
SyntaxPropertiesReturn valuesSee also

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.

Important

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.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::PinpointEmail::Identity",
  "Properties" : {
      "DkimSigningEnabled" : Boolean,
      "FeedbackForwardingEnabled" : Boolean,
      "MailFromAttributes" : MailFromAttributes,
      "Name" : String,
      "Tags" : [ Tags, ... ]
    }
}

YAML

Type: AWS::PinpointEmail::Identity
Properties:
  DkimSigningEnabled: Boolean
  FeedbackForwardingEnabled: Boolean
  MailFromAttributes: 
    MailFromAttributes
  Name: String
  Tags: 
    - Tags

Properties

DkimSigningEnabled

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.

Required: No

Type: Boolean

Update requires: No interruption

FeedbackForwardingEnabled

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).

Required: No

Type: Boolean

Update requires: No interruption

MailFromAttributes

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

Required: No

Type: MailFromAttributes

Update requires: No interruption

Name

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

Required: Yes

Type: String

Update requires: Replacement

Tags

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

Required: No

Type: Array of Tags

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the resource name. For example:

{ "Ref": "myEmailIdentity" }

For the Amazon Pinpoint identity myEmailIdentity, Ref returns the name of the identity (the email address or domain name).

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

IdentityDNSRecordName1

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.

IdentityDNSRecordName2

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

IdentityDNSRecordName3

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

IdentityDNSRecordValue1

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

IdentityDNSRecordValue2

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

IdentityDNSRecordValue3

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

See also