class CfnIdentityPropsMixin

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.PinpointEmail.Mixins.CfnIdentityPropsMixin
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awspinpointemail/mixins#CfnIdentityPropsMixin
Java	software.amazon.awscdk.mixins.preview.services.pinpointemail.mixins.CfnIdentityPropsMixin
Python	aws_cdk.mixins_preview.aws_pinpointemail.mixins.CfnIdentityPropsMixin
TypeScript	@aws-cdk/mixins-preview » aws_pinpointemail » mixins » CfnIdentityPropsMixin

Implements IMixin

Extends Mixin

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.

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins } from '@aws-cdk/mixins-preview';
import { mixins as pinpointemail_mixins } from '@aws-cdk/mixins-preview/aws-pinpointemail';
const cfnIdentityPropsMixin = new pinpointemail_mixins.CfnIdentityPropsMixin({
  dkimSigningEnabled: false,
  feedbackForwardingEnabled: false,
  mailFromAttributes: {
    behaviorOnMxFailure: 'behaviorOnMxFailure',
    mailFromDomain: 'mailFromDomain',
  },
  name: 'name',
  tags: [{
    key: 'key',
    value: 'value',
  }],
}, /* all optional props */ {
  strategy: mixins.PropertyMergeStrategy.OVERRIDE,
});

Initializer

new CfnIdentityPropsMixin(props: CfnIdentityMixinProps, options?: CfnPropertyMixinOptions)

Parameters

• props CfnIdentityMixinProps — L1 properties to apply.
• options CfnPropertyMixinOptions — Mixin options.

Create a mixin to apply properties to AWS::PinpointEmail::Identity.

Properties

Name	Type	Description
props	CfnIdentityMixinProps
strategy	PropertyMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnIdentityMixinProps

---

strategy

Type: PropertyMergeStrategy

---

static CFN_PROPERTY_KEYS

Type: string[]

Methods

Name	Description
applyTo(construct)	Apply the mixin properties to the construct.
supports(construct)	Check if this mixin supports the given construct.

---

applyTo(construct)

public applyTo(construct: IConstruct): IConstruct

Parameters

• construct IConstruct

Returns

• IConstruct

Apply the mixin properties to the construct.

---

supports(construct)

public supports(construct: IConstruct): boolean

Parameters

• construct IConstruct

Returns

• boolean

Check if this mixin supports the given construct.