CfnEmailIdentityPropsMixin

class aws_cdk.mixins_preview.aws_ses.mixins.CfnEmailIdentityPropsMixin(props, *, strategy=None)

Bases: 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:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-emailidentity.html
CloudformationResource:: AWS::SES::EmailIdentity
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_ses import mixins as ses_mixins

cfn_email_identity_props_mixin = ses_mixins.CfnEmailIdentityPropsMixin(ses_mixins.CfnEmailIdentityMixinProps(
    configuration_set_attributes=ses_mixins.CfnEmailIdentityPropsMixin.ConfigurationSetAttributesProperty(
        configuration_set_name="configurationSetName"
    ),
    dkim_attributes=ses_mixins.CfnEmailIdentityPropsMixin.DkimAttributesProperty(
        signing_enabled=False
    ),
    dkim_signing_attributes=ses_mixins.CfnEmailIdentityPropsMixin.DkimSigningAttributesProperty(
        domain_signing_private_key="domainSigningPrivateKey",
        domain_signing_selector="domainSigningSelector",
        next_signing_key_length="nextSigningKeyLength"
    ),
    email_identity="emailIdentity",
    feedback_attributes=ses_mixins.CfnEmailIdentityPropsMixin.FeedbackAttributesProperty(
        email_forwarding_enabled=False
    ),
    mail_from_attributes=ses_mixins.CfnEmailIdentityPropsMixin.MailFromAttributesProperty(
        behavior_on_mx_failure="behaviorOnMxFailure",
        mail_from_domain="mailFromDomain"
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

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

Parameters:

props (Union[CfnEmailIdentityMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['configurationSetAttributes', 'dkimAttributes', 'dkimSigningAttributes', 'emailIdentity', 'feedbackAttributes', 'mailFromAttributes', 'tags']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

ConfigurationSetAttributesProperty

class CfnEmailIdentityPropsMixin.ConfigurationSetAttributesProperty(*, configuration_set_name=None)

Bases: object

Used to associate a configuration set with an email identity.

Parameters:: configuration_set_name (Optional[str]) – The configuration set to associate with an email identity.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-emailidentity-configurationsetattributes.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_ses import mixins as ses_mixins

configuration_set_attributes_property = ses_mixins.CfnEmailIdentityPropsMixin.ConfigurationSetAttributesProperty(
    configuration_set_name="configurationSetName"
)

Attributes

configuration_set_name

The configuration set to associate with an email identity.

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

DkimAttributesProperty

class CfnEmailIdentityPropsMixin.DkimAttributesProperty(*, signing_enabled=None)

Bases: object

Used to enable or disable DKIM authentication for an email identity.

Parameters:: signing_enabled (Union[bool, IResolvable, None]) – Sets the DKIM signing configuration for the identity. When you set this value true , then the messages that are sent from the identity are signed using DKIM. If you set this value to false , your messages are sent without DKIM signing.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-emailidentity-dkimattributes.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_ses import mixins as ses_mixins

dkim_attributes_property = ses_mixins.CfnEmailIdentityPropsMixin.DkimAttributesProperty(
    signing_enabled=False
)

Attributes

signing_enabled

Sets the DKIM signing configuration for the identity.

When you set this value true , then the messages that are sent from the identity are signed using DKIM. If you set this value to false , your messages are sent without DKIM signing.

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

DkimSigningAttributesProperty

class CfnEmailIdentityPropsMixin.DkimSigningAttributesProperty(*, domain_signing_private_key=None, domain_signing_selector=None, next_signing_key_length=None)

Bases: object

Used to configure or change the DKIM authentication settings for an email domain identity.

You can use this operation to do any of the following:

Update the signing attributes for an identity that uses Bring Your Own DKIM (BYODKIM).
Update the key length that should be used for Easy DKIM.
Change from using no DKIM authentication to using Easy DKIM.
Change from using no DKIM authentication to using BYODKIM.
Change from using Easy DKIM to using BYODKIM.
Change from using BYODKIM to using Easy DKIM.

Parameters:

domain_signing_private_key (Optional[str]) – [Bring Your Own DKIM] A private key that’s used to generate a DKIM signature. The private key must use 1024 or 2048-bit RSA encryption, and must be encoded using base64 encoding. .. epigraph:: Rather than embedding sensitive information directly in your CFN templates, we recommend you use dynamic parameters in the stack template to reference sensitive information that is stored and managed outside of CFN, such as in the AWS Systems Manager Parameter Store or AWS Secrets Manager. For more information, see the Do not embed credentials in your templates best practice.
domain_signing_selector (Optional[str]) – [Bring Your Own DKIM] A string that’s used to identify a public key in the DNS configuration for a domain.
next_signing_key_length (Optional[str]) – [Easy DKIM] The key length of the future DKIM key pair to be generated. This can be changed at most once per day. Valid Values: RSA_1024_BIT | RSA_2048_BIT

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-emailidentity-dkimsigningattributes.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_ses import mixins as ses_mixins

dkim_signing_attributes_property = ses_mixins.CfnEmailIdentityPropsMixin.DkimSigningAttributesProperty(
    domain_signing_private_key="domainSigningPrivateKey",
    domain_signing_selector="domainSigningSelector",
    next_signing_key_length="nextSigningKeyLength"
)

Attributes

domain_signing_private_key

[Bring Your Own DKIM] A private key that’s used to generate a DKIM signature.

The private key must use 1024 or 2048-bit RSA encryption, and must be encoded using base64 encoding. .. epigraph:

Rather than embedding sensitive information directly in your CFN templates, we recommend you use dynamic parameters in the stack template to reference sensitive information that is stored and managed outside of CFN, such as in the AWS Systems Manager Parameter Store or AWS Secrets Manager.

For more information, see the `Do not embed credentials in your templates <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/best-practices.html#creds>`_ best practice.

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

domain_signing_selector

[Bring Your Own DKIM] A string that’s used to identify a public key in the DNS configuration for a domain.

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

next_signing_key_length

[Easy DKIM] The key length of the future DKIM key pair to be generated.

This can be changed at most once per day.

Valid Values: RSA_1024_BIT | RSA_2048_BIT

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

FeedbackAttributesProperty

class CfnEmailIdentityPropsMixin.FeedbackAttributesProperty(*, email_forwarding_enabled=None)

Bases: object

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.

Parameters:: email_forwarding_enabled (Union[bool, IResolvable, None]) – Sets the feedback forwarding configuration for the identity. If the value is true , you receive email notifications when bounce or complaint events occur. These notifications are sent to the address that you specified in the Return-Path header of the original email. 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 (for example, by setting up an event destination), you receive an email notification when these events occur (even if this setting is disabled).
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-emailidentity-feedbackattributes.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_ses import mixins as ses_mixins

feedback_attributes_property = ses_mixins.CfnEmailIdentityPropsMixin.FeedbackAttributesProperty(
    email_forwarding_enabled=False
)

Attributes

email_forwarding_enabled

Sets the feedback forwarding configuration for the identity.

If the value is true , you receive email notifications when bounce or complaint events occur. These notifications are sent to the address that you specified in the Return-Path header of the original email.

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 (for example, by setting up an event destination), you receive an email notification when these events occur (even if this setting is disabled).

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

MailFromAttributesProperty

class CfnEmailIdentityPropsMixin.MailFromAttributesProperty(*, behavior_on_mx_failure=None, mail_from_domain=None)

Bases: object

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

Parameters:

behavior_on_mx_failure (Optional[str]) – The action to take if the required MX record isn’t found when you send an email. When you set this value to USE_DEFAULT_VALUE , the mail is sent using amazonses.com as the MAIL FROM domain. When you set this value to REJECT_MESSAGE , the Amazon SES API v2 returns a MailFromDomainNotVerified error, and doesn’t attempt to deliver the email. These behaviors are taken when the custom MAIL FROM domain configuration is in the Pending , Failed , and TemporaryFailure states. Valid Values: USE_DEFAULT_VALUE | REJECT_MESSAGE
mail_from_domain (Optional[str]) – The custom MAIL FROM domain that you want the verified identity to use. The MAIL FROM domain must meet the following criteria: - It has to be a subdomain of the verified identity. - It can’t be used to receive email. - It can’t be used in a “From” address if the MAIL FROM domain is a destination for feedback forwarding emails.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ses-emailidentity-mailfromattributes.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_ses import mixins as ses_mixins

mail_from_attributes_property = ses_mixins.CfnEmailIdentityPropsMixin.MailFromAttributesProperty(
    behavior_on_mx_failure="behaviorOnMxFailure",
    mail_from_domain="mailFromDomain"
)

Attributes

behavior_on_mx_failure

The action to take if the required MX record isn’t found when you send an email.

When you set this value to USE_DEFAULT_VALUE , the mail is sent using amazonses.com as the MAIL FROM domain. When you set this value to REJECT_MESSAGE , the Amazon SES API v2 returns a MailFromDomainNotVerified error, and doesn’t attempt to deliver the email.

These behaviors are taken when the custom MAIL FROM domain configuration is in the Pending , Failed , and TemporaryFailure states.

Valid Values: USE_DEFAULT_VALUE | REJECT_MESSAGE

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

mail_from_domain

The custom MAIL FROM domain that you want the verified identity to use.

The MAIL FROM domain must meet the following criteria:

It has to be a subdomain of the verified identity.
It can’t be used to receive email.
It can’t be used in a “From” address if the MAIL FROM domain is a destination for feedback forwarding emails.

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