class CfnEmailIdentityPropsMixin

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.SES.Mixins.CfnEmailIdentityPropsMixin
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsses/mixins#CfnEmailIdentityPropsMixin
Java	software.amazon.awscdk.mixins.preview.services.ses.mixins.CfnEmailIdentityPropsMixin
Python	aws_cdk.mixins_preview.aws_ses.mixins.CfnEmailIdentityPropsMixin
TypeScript	@aws-cdk/mixins-preview » aws_ses » mixins » CfnEmailIdentityPropsMixin

Implements IMixin

Extends Mixin

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 { mixins } from '@aws-cdk/mixins-preview';
import { mixins as ses_mixins } from '@aws-cdk/mixins-preview/aws-ses';
const cfnEmailIdentityPropsMixin = new ses_mixins.CfnEmailIdentityPropsMixin({
  configurationSetAttributes: {
    configurationSetName: 'configurationSetName',
  },
  dkimAttributes: {
    signingEnabled: false,
  },
  dkimSigningAttributes: {
    domainSigningPrivateKey: 'domainSigningPrivateKey',
    domainSigningSelector: 'domainSigningSelector',
    nextSigningKeyLength: 'nextSigningKeyLength',
  },
  emailIdentity: 'emailIdentity',
  feedbackAttributes: {
    emailForwardingEnabled: false,
  },
  mailFromAttributes: {
    behaviorOnMxFailure: 'behaviorOnMxFailure',
    mailFromDomain: 'mailFromDomain',
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
}, /* all optional props */ {
  strategy: mixins.PropertyMergeStrategy.OVERRIDE,
});

Initializer

new CfnEmailIdentityPropsMixin(props: CfnEmailIdentityMixinProps, options?: CfnPropertyMixinOptions)

Parameters

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

Create a mixin to apply properties to AWS::SES::EmailIdentity.

Properties

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

---

props

Type: CfnEmailIdentityMixinProps

---

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.