class CfnEmailIdentity (construct)

Language	Type name
.NET	Amazon.CDK.AWS.SES.CfnEmailIdentity
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsses#CfnEmailIdentity
Java	software.amazon.awscdk.services.ses.CfnEmailIdentity
Python	aws_cdk.aws_ses.CfnEmailIdentity
TypeScript	aws-cdk-lib » aws_ses » CfnEmailIdentity

Implements IConstruct, IDependable, IInspectable

Specifies an identity for using within SES.

An identity is an email address or domain that you use when you send email. Before you can use an identity to send email, you first have to verify it. By verifying an identity, you demonstrate that you're the owner of the identity, and that you've given Amazon SES API v2 permission to send email from the identity.

When you verify an email address, SES 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 without specifying the DkimSigningAttributes properties, OR only the NextSigningKeyLength property of DkimSigningAttributes , this resource provides a set of CNAME token names and values ( DkimDNSTokenName1 , DkimDNSTokenValue1 , DkimDNSTokenName2 , DkimDNSTokenValue2 , DkimDNSTokenName3 , DkimDNSTokenValue3 ) as outputs. You can then add these to the DNS configuration for your domain. Your domain is verified when Amazon SES detects these records in the DNS configuration for your domain. This verification method is known as Easy DKIM.

Alternatively, you can perform the verification process by providing your own public-private key pair. This verification method is known as Bring Your Own DKIM (BYODKIM). To use BYODKIM, your resource must include DkimSigningAttributes properties DomainSigningSelector and DomainSigningPrivateKey . When you specify this object, you provide a selector ( DomainSigningSelector ) (a component of the DNS record name that identifies the public key to use for DKIM authentication) and a private key ( DomainSigningPrivateKey ).

Additionally, you can associate an existing configuration set with the email identity that you're verifying.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-emailidentity.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_ses as ses } from 'aws-cdk-lib';
const cfnEmailIdentity = new ses.CfnEmailIdentity(this, 'MyCfnEmailIdentity', {
  emailIdentity: 'emailIdentity',

  // the properties below are optional
  configurationSetAttributes: {
    configurationSetName: 'configurationSetName',
  },
  dkimAttributes: {
    signingEnabled: false,
  },
  dkimSigningAttributes: {
    domainSigningPrivateKey: 'domainSigningPrivateKey',
    domainSigningSelector: 'domainSigningSelector',
    nextSigningKeyLength: 'nextSigningKeyLength',
  },
  feedbackAttributes: {
    emailForwardingEnabled: false,
  },
  mailFromAttributes: {
    behaviorOnMxFailure: 'behaviorOnMxFailure',
    mailFromDomain: 'mailFromDomain',
  },
});

Initializer

new CfnEmailIdentity(scope: Construct, id: string, props: CfnEmailIdentityProps)

Parameters

• scope Construct — Scope in which this resource is defined.
• id string — Construct identifier for this resource (unique in its scope).
• props CfnEmailIdentityProps — Resource properties.

Construct Props

Name	Type	Description
emailIdentity	string	The email address or domain to verify.
configurationSetAttributes?	IResolvable | ConfigurationSetAttributesProperty	Used to associate a configuration set with an email identity.
dkimAttributes?	IResolvable | DkimAttributesProperty	An object that contains information about the DKIM attributes for the identity.
dkimSigningAttributes?	IResolvable | DkimSigningAttributesProperty	If your request includes this object, Amazon SES configures the identity to use Bring Your Own DKIM (BYODKIM) for DKIM authentication purposes, or, configures the key length to be used for Easy DKIM .
feedbackAttributes?	IResolvable | FeedbackAttributesProperty	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.

---

emailIdentity

Type: string

The email address or domain to verify.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-emailidentity.html#cfn-ses-emailidentity-emailidentity

---

configurationSetAttributes?

Type: IResolvable | ConfigurationSetAttributesProperty (optional)

Used to associate a configuration set with an email identity.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-emailidentity.html#cfn-ses-emailidentity-configurationsetattributes

---

dkimAttributes?

Type: IResolvable | DkimAttributesProperty (optional)

An object that contains information about the DKIM attributes for the identity.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-emailidentity.html#cfn-ses-emailidentity-dkimattributes

---

dkimSigningAttributes?

Type: IResolvable | DkimSigningAttributesProperty (optional)

If your request includes this object, Amazon SES configures the identity to use Bring Your Own DKIM (BYODKIM) for DKIM authentication purposes, or, configures the key length to be used for Easy DKIM .

You can only specify this object if the email identity is a domain, as opposed to an address.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-emailidentity.html#cfn-ses-emailidentity-dkimsigningattributes

---

feedbackAttributes?

Type: IResolvable | FeedbackAttributesProperty (optional)

Used to enable or disable feedback forwarding for an identity.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-emailidentity.html#cfn-ses-emailidentity-feedbackattributes

---

mailFromAttributes?

Type: IResolvable | MailFromAttributesProperty (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-emailidentity.html#cfn-ses-emailidentity-mailfromattributes

Properties

Name	Type	Description
attrDkimDnsTokenName1	string	The host name for the first token that you have to add to the DNS configuration for your domain.
attrDkimDnsTokenName2	string	The host name for the second token that you have to add to the DNS configuration for your domain.
attrDkimDnsTokenName3	string	The host name for the third token that you have to add to the DNS configuration for your domain.
attrDkimDnsTokenValue1	string	The record value for the first token that you have to add to the DNS configuration for your domain.
attrDkimDnsTokenValue2	string	The record value for the second token that you have to add to the DNS configuration for your domain.
attrDkimDnsTokenValue3	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[]
emailIdentity	string	The email address or domain to verify.
logicalId	string	The logical ID for this CloudFormation stack element.
node	Node	The tree node.
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.
configurationSetAttributes?	IResolvable | ConfigurationSetAttributesProperty	Used to associate a configuration set with an email identity.
dkimAttributes?	IResolvable | DkimAttributesProperty	An object that contains information about the DKIM attributes for the identity.
dkimSigningAttributes?	IResolvable | DkimSigningAttributesProperty	If your request includes this object, Amazon SES configures the identity to use Bring Your Own DKIM (BYODKIM) for DKIM authentication purposes, or, configures the key length to be used for Easy DKIM .
feedbackAttributes?	IResolvable | FeedbackAttributesProperty	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.
static CFN_RESOURCE_TYPE_NAME	string	The CloudFormation resource type name for this resource class.

---

attrDkimDnsTokenName1

Type: string

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

---

attrDkimDnsTokenName2

Type: string

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

---

attrDkimDnsTokenName3

Type: string

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

---

attrDkimDnsTokenValue1

Type: string

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

---

attrDkimDnsTokenValue2

Type: string

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

---

attrDkimDnsTokenValue3

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[]

---

emailIdentity

Type: string

The email address or domain to verify.

---

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

---

node

Type: Node

The tree node.

---

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

---

configurationSetAttributes?

Type: IResolvable | ConfigurationSetAttributesProperty (optional)

Used to associate a configuration set with an email identity.

---

dkimAttributes?

Type: IResolvable | DkimAttributesProperty (optional)

An object that contains information about the DKIM attributes for the identity.

---

dkimSigningAttributes?

Type: IResolvable | DkimSigningAttributesProperty (optional)

If your request includes this object, Amazon SES configures the identity to use Bring Your Own DKIM (BYODKIM) for DKIM authentication purposes, or, configures the key length to be used for Easy DKIM .

---

feedbackAttributes?

Type: IResolvable | FeedbackAttributesProperty (optional)

Used to enable or disable feedback forwarding for an identity.

---

mailFromAttributes?

Type: IResolvable | MailFromAttributesProperty (optional)

Used to enable or disable the custom Mail-From domain configuration for an 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).
addDependency(target)	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
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, typeHint?)	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.
obtainDependencies()	Retrieves an array of resources this resource depends on.
obtainResourceDependencies()	Get a shallow copy of dependencies between this resource and other resources in the same stack.
overrideLogicalId(newLogicalId)	Overrides the auto-generated logical ID with a specific ID.
removeDependency(target)	Indicates that this resource no longer depends on another resource.
replaceDependency(target, newTarget)	Replaces one dependency with another.
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).

---

addDependency(target)

public addDependency(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.

---

addDependsOn(target)⚠️

public addDependsOn(target: CfnResource): void

⚠️ Deprecated: use addDependency

Parameters

• target CfnResource

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

---

addMetadata(key, value)

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

Parameters

• key string
• value any

Add a value to the CloudFormation Resource Metadata.

See also: [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.](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). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

See also: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

---

getAtt(attributeName, typeHint?)

public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference

Parameters

• attributeName string — The name of the attribute.
• typeHint ResolutionTypeHint

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.

See also: [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.](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.)

---

inspect(inspector)

public inspect(inspector: TreeInspector): void

Parameters

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

Examines the CloudFormation resource and discloses attributes.

---

obtainDependencies()

public obtainDependencies(): Stack | CfnResource[]

Returns

• Stack | CfnResource[]

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

---

obtainResourceDependencies()

public obtainResourceDependencies(): CfnResource[]

Returns

• CfnResource[]

Get a shallow copy of dependencies between this resource and other resources in the same stack.

---

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.

---

removeDependency(target)

public removeDependency(target: CfnResource): void

Parameters

• target CfnResource

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

---

replaceDependency(target, newTarget)

public replaceDependency(target: CfnResource, newTarget: CfnResource): void

Parameters

• target CfnResource — The dependency to replace.
• newTarget CfnResource — The new dependency to add.

Replaces one dependency with another.

---

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 }