CfnIdentityPropsMixin

class aws_cdk.mixins_preview.aws_pinpointemail.mixins.CfnIdentityPropsMixin(props, *, strategy=None)

Bases: 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. .. epigraph:

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:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpointemail-identity.html
CloudformationResource:: AWS::PinpointEmail::Identity
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_pinpointemail import mixins as pinpointemail_mixins

cfn_identity_props_mixin = pinpointemail_mixins.CfnIdentityPropsMixin(pinpointemail_mixins.CfnIdentityMixinProps(
    dkim_signing_enabled=False,
    feedback_forwarding_enabled=False,
    mail_from_attributes=pinpointemail_mixins.CfnIdentityPropsMixin.MailFromAttributesProperty(
        behavior_on_mx_failure="behaviorOnMxFailure",
        mail_from_domain="mailFromDomain"
    ),
    name="name",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

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

Parameters:

props (Union[CfnIdentityMixinProps, 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 = ['dkimSigningEnabled', 'feedbackForwardingEnabled', 'mailFromAttributes', 'name', '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

MailFromAttributesProperty

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

Bases: object

A list of attributes that are associated with a MAIL FROM domain.

Parameters:

behavior_on_mx_failure (Optional[str]) – The action that Amazon Pinpoint to takes if it can’t read the required MX record for a custom MAIL FROM domain. When you set this value to UseDefaultValue , Amazon Pinpoint uses amazonses.com as the MAIL FROM domain. When you set this value to RejectMessage , Amazon Pinpoint 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.
mail_from_domain (Optional[str]) – The name of a domain that an email identity uses as a custom MAIL FROM domain.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpointemail-identity-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_pinpointemail import mixins as pinpointemail_mixins

mail_from_attributes_property = pinpointemail_mixins.CfnIdentityPropsMixin.MailFromAttributesProperty(
    behavior_on_mx_failure="behaviorOnMxFailure",
    mail_from_domain="mailFromDomain"
)

Attributes

behavior_on_mx_failure

The action that Amazon Pinpoint to takes if it can’t read the required MX record for a custom MAIL FROM domain.

When you set this value to UseDefaultValue , Amazon Pinpoint uses amazonses.com as the MAIL FROM domain. When you set this value to RejectMessage , Amazon Pinpoint 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.

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

mail_from_domain

The name of a domain that an email identity uses as a custom MAIL FROM domain.

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