CfnEmailIdentityProps

class aws_cdk.aws_ses.CfnEmailIdentityProps(*, email_identity, configuration_set_attributes=None, dkim_attributes=None, dkim_signing_attributes=None, feedback_attributes=None, mail_from_attributes=None)

Bases: object

Properties for defining a CfnEmailIdentity.

Parameters:
  • email_identity (str) – The email address or domain to verify.

  • configuration_set_attributes (Union[IResolvable, ConfigurationSetAttributesProperty, Dict[str, Any], None]) – Used to associate a configuration set with an email identity.

  • dkim_attributes (Union[IResolvable, DkimAttributesProperty, Dict[str, Any], None]) – An object that contains information about the DKIM attributes for the identity.

  • dkim_signing_attributes (Union[IResolvable, DkimSigningAttributesProperty, Dict[str, Any], None]) – 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.

  • feedback_attributes (Union[IResolvable, FeedbackAttributesProperty, Dict[str, Any], None]) – Used to enable or disable feedback forwarding for an identity.

  • mail_from_attributes (Union[IResolvable, MailFromAttributesProperty, Dict[str, Any], None]) – Used to enable or disable the custom Mail-From domain configuration for an email identity.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ses-emailidentity.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 import aws_ses as ses

cfn_email_identity_props = ses.CfnEmailIdentityProps(
    email_identity="emailIdentity",

    # the properties below are optional
    configuration_set_attributes=ses.CfnEmailIdentity.ConfigurationSetAttributesProperty(
        configuration_set_name="configurationSetName"
    ),
    dkim_attributes=ses.CfnEmailIdentity.DkimAttributesProperty(
        signing_enabled=False
    ),
    dkim_signing_attributes=ses.CfnEmailIdentity.DkimSigningAttributesProperty(
        domain_signing_private_key="domainSigningPrivateKey",
        domain_signing_selector="domainSigningSelector",
        next_signing_key_length="nextSigningKeyLength"
    ),
    feedback_attributes=ses.CfnEmailIdentity.FeedbackAttributesProperty(
        email_forwarding_enabled=False
    ),
    mail_from_attributes=ses.CfnEmailIdentity.MailFromAttributesProperty(
        behavior_on_mx_failure="behaviorOnMxFailure",
        mail_from_domain="mailFromDomain"
    )
)

Attributes

configuration_set_attributes

Used to associate a configuration set with an email identity.

See:

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

dkim_attributes

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

See:

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

dkim_signing_attributes

//docs.aws.amazon.com/ses/latest/DeveloperGuide/easy-dkim.html>`_ .

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

See:

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

Type:

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 <https

email_identity

The email address or domain to verify.

See:

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

feedback_attributes

Used to enable or disable feedback forwarding for an identity.

See:

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

mail_from_attributes

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

See:

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