class CfnIdentity (construct)

Language	Type name
.NET	`Amazon.CDK.AWS.PinpointEmail.CfnIdentity`
Java	`software.amazon.awscdk.services.pinpointemail.CfnIdentity`
Python	`aws_cdk.aws_pinpointemail.CfnIdentity`
TypeScript	`@aws-cdk/aws-pinpointemail` » `CfnIdentity`

Implements IConstruct, IConstruct, IDependable, 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 * as pinpointemail from '@aws-cdk/aws-pinpointemail';
const cfnIdentity = new pinpointemail.CfnIdentity(this, 'MyCfnIdentity', {
  name: 'name',

  // the properties below are optional
  dkimSigningEnabled: false,
  feedbackForwardingEnabled: false,
  mailFromAttributes: {
    behaviorOnMxFailure: 'behaviorOnMxFailure',
    mailFromDomain: 'mailFromDomain',
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
});

Initializer

new CfnIdentity(scope: Construct, id: string, props: CfnIdentityProps)

Parameters

scope Construct — - scope in which this resource is defined.
id string — - scoped id of the resource.
props CfnIdentityProps — - resource properties.

Create a new AWS::PinpointEmail::Identity.

Construct Props

Name	Type	Description
name	`string`	The address or domain of the identity, such as sender@example.com or example.co.uk .
dkimSigningEnabled?	`boolean \|` `IResolvable`	For domain identities, this attribute is used to enable or disable DomainKeys Identified Mail (DKIM) signing for the domain.
feedbackForwardingEnabled?	`boolean \|` `IResolvable`	Used to enable or disable feedback forwarding for an identity.
mailFromAttributes?	`IResolvable` `\|` `MailFromAttributesProperty`	Used to enable or disable the custom Mail-From domain configuration for an email identity.
tags?	`TagsProperty[]`	An object that defines the tags (keys and values) that you want to associate with the email identity.

name

Type: string

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

dkimSigningEnabled?

Type: boolean | IResolvable (optional)

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.

feedbackForwardingEnabled?

Type: boolean | IResolvable (optional)

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

mailFromAttributes?

Type: IResolvable | MailFromAttributesProperty (optional)

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

tags?

Type: TagsProperty[] (optional)

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

Properties

Name	Type	Description
attrIdentityDnsRecordName1	`string`	The host name for the first token that you have to add to the DNS configuration for your domain.
attrIdentityDnsRecordName2	`string`	The host name for the second token that you have to add to the DNS configuration for your domain.
attrIdentityDnsRecordName3	`string`	The host name for the third token that you have to add to the DNS configuration for your domain.
attrIdentityDnsRecordValue1	`string`	The record value for the first token that you have to add to the DNS configuration for your domain.
attrIdentityDnsRecordValue2	`string`	The record value for the second token that you have to add to the DNS configuration for your domain.
attrIdentityDnsRecordValue3	`string`	The record value for the third token that you have to add to the DNS configuration for your domain.
cfnOptions	`ICfnResourceOptions`	Options for this resource, such as condition, update policy etc.
cfnProperties	`{ [string]: any }`
cfnResourceType	`string`	AWS resource type.
creationStack	`string[]`
logicalId	`string`	The logical ID for this CloudFormation stack element.
name	`string`	The address or domain of the identity, such as sender@example.com or example.co.uk .
node	`ConstructNode`	The construct tree node associated with this construct.
ref	`string`	Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
stack	`Stack`	The stack in which this element is defined.
dkimSigningEnabled?	`boolean \|` `IResolvable`	For domain identities, this attribute is used to enable or disable DomainKeys Identified Mail (DKIM) signing for the domain.
feedbackForwardingEnabled?	`boolean \|` `IResolvable`	Used to enable or disable feedback forwarding for an identity.
mailFromAttributes?	`IResolvable` `\|` `MailFromAttributesProperty`	Used to enable or disable the custom Mail-From domain configuration for an email identity.
tags?	`TagsProperty[]`	An object that defines the tags (keys and values) that you want to associate with the email identity.
static CFN_RESOURCE_TYPE_NAME	`string`	The CloudFormation resource type name for this resource class.

attrIdentityDnsRecordName1

Type: string

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.

attrIdentityDnsRecordName2

Type: string

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

attrIdentityDnsRecordName3

Type: string

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

attrIdentityDnsRecordValue1

Type: string

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

attrIdentityDnsRecordValue2

Type: string

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

attrIdentityDnsRecordValue3

Type: string

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

cfnOptions

Type: ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

cfnProperties

Type: { [string]: any }

cfnResourceType

Type: string

AWS resource type.

creationStack

Type: string[]

logicalId

Type: string

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

name

Type: string

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

node

Type: ConstructNode

The construct tree node associated with this construct.

ref

Type: string

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

stack

Type: Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

dkimSigningEnabled?

Type: boolean | IResolvable (optional)

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

feedbackForwardingEnabled?

Type: boolean | IResolvable (optional)

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.

mailFromAttributes?

Type: IResolvable | MailFromAttributesProperty (optional)

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

tags?

Type: TagsProperty[] (optional)

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

static CFN_RESOURCE_TYPE_NAME

Type: string

The CloudFormation resource type name for this resource class.

Methods

Name	Description
addDeletionOverride(path)	Syntactic sugar for `addOverride(path, undefined)`.
addDependsOn(target)	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)	Add a value to the CloudFormation Resource Metadata.
addOverride(path, value)	Adds an override to the synthesized CloudFormation resource.
addPropertyDeletionOverride(propertyPath)	Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)	Adds an override to a resource property.
applyRemovalPolicy(policy?, options?)	Sets the deletion policy of the resource based on the removal policy specified.
getAtt(attributeName)	Returns a token for an runtime attribute of this resource.
getMetadata(key)	Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector)	Examines the CloudFormation resource and discloses attributes.
overrideLogicalId(newLogicalId)	Overrides the auto-generated logical ID with a specific ID.
toString()	Returns a string representation of this construct.
protected renderProperties(props)

addDeletionOverride(path)

public addDeletionOverride(path: string): void

Parameters

path string — The path of the value to delete.

Syntactic sugar for addOverride(path, undefined).

addDependsOn(target)

public addDependsOn(target: CfnResource): void

Parameters

target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

addMetadata(key, value)

public addMetadata(key: string, value: any): void

Parameters

key string
value any

Add a value to the CloudFormation Resource Metadata.

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

addOverride(path, value)

public addOverride(path: string, value: any): void

Parameters

path string — - The path of the property, you can use dot notation to override values in complex types.
value any — - The value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

addPropertyDeletionOverride(propertyPath)

public addPropertyDeletionOverride(propertyPath: string): void

Parameters

propertyPath string — The path to the property.

Adds an override that deletes the value of a property from the resource definition.

addPropertyOverride(propertyPath, value)

public addPropertyOverride(propertyPath: string, value: any): void

Parameters

propertyPath string — The path of the property.
value any — The value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

applyRemovalPolicy(policy?, options?)

public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void

Parameters

policy RemovalPolicy
options RemovalPolicyOptions

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

getAtt(attributeName)

public getAtt(attributeName: string): Reference

Parameters

attributeName string — The name of the attribute.

Returns

Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

getMetadata(key)

public getMetadata(key: string): any

Parameters

key string

Returns

any

Retrieve a value value from the CloudFormation Resource Metadata.

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

inspect(inspector)

public inspect(inspector: TreeInspector): void

Parameters

inspector TreeInspector — - tree inspector to collect and process attributes.

Examines the CloudFormation resource and discloses attributes.

overrideLogicalId(newLogicalId)

public overrideLogicalId(newLogicalId: string): void

Parameters

newLogicalId string — The new logical ID to use for this stack element.

Overrides the auto-generated logical ID with a specific ID.

toString()

public toString(): string

Returns

string

Returns a string representation of this construct.

protected renderProperties(props)

protected renderProperties(props: { [string]: any }): { [string]: any }

Parameters

props { [string]: any }

Returns

{ [string]: any }