L1 ConstructAWS::PinpointEmail::Identity

CfnIdentity

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.

Import

import { CfnIdentity } from 'aws-cdk-lib/aws-pinpointemail';

Or use the module namespace:

import * as pinpointemail from 'aws-cdk-lib/aws-pinpointemail';
// pinpointemail.CfnIdentity

Properties

Configuration passed to the constructor as CfnIdentityProps.

nameRequired

string

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

dkimSigningEnabledOptional

boolean | IResolvable

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.

feedbackForwardingEnabledOptional

boolean | IResolvable

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

mailFromAttributesOptional

IResolvable | MailFromAttributesProperty

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

tagsOptional

CfnTag[]

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