CfnEmailIdentity

class aws_cdk.aws_ses.CfnEmailIdentity(scope, id, *, email_identity, configuration_set_attributes=None, dkim_attributes=None, dkim_signing_attributes=None, feedback_attributes=None, mail_from_attributes=None)

Bases: CfnResource

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
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 = ses.CfnEmailIdentity(self, "MyCfnEmailIdentity",
    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"
    )
)

Parameters:

scope (Construct) – Scope in which this resource is defined.
id (str) – Construct identifier for this resource (unique in its scope).
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.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:: path (str) – The path of the value to delete.
Return type:: None

add_dependency(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

add_depends_on(target)

(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:

target (CfnResource) –

Deprecated:

use addDependency

Stability:

deprecated

Return type:

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

key (str) –
value (Any) –

See:

Return type:

None

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

path (str) –
- The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.
value (Any) –
- The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters:: property_path (str) – The path to the property.
Return type:: None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

property_path (str) – The path of the property.
value (Any) – The value.

Return type:

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

policy (Optional[RemovalPolicy]) –
apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true
default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type:

None

get_att(attribute_name, type_hint=None)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

attribute_name (str) – The name of the attribute.
type_hint (Optional[ResolutionTypeHint]) –

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

key (str) –

See:

Return type:

Any

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:: inspector (TreeInspector) – tree inspector to collect and process attributes.
Return type:: None

obtain_dependencies()

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Return type:: List[Union[Stack, CfnResource]]

obtain_resource_dependencies()

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Return type:: List[CfnResource]

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters:: new_logical_id (str) – The new logical ID to use for this stack element.
Return type:: None

remove_dependency(target)

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:

target (CfnResource) – The dependency to replace.
new_target (CfnResource) – The new dependency to add.

Return type:

None

to_string()

Returns a string representation of this construct.

Return type:: str
Returns:: a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::SES::EmailIdentity'

attr_dkim_dns_token_name1

The host name for the first token that you have to add to the DNS configuration for your domain.

CloudformationAttribute:: DkimDNSTokenName1

attr_dkim_dns_token_name2

The host name for the second token that you have to add to the DNS configuration for your domain.

CloudformationAttribute:: DkimDNSTokenName2

attr_dkim_dns_token_name3

The host name for the third token that you have to add to the DNS configuration for your domain.

CloudformationAttribute:: DkimDNSTokenName3

attr_dkim_dns_token_value1

The record value for the first token that you have to add to the DNS configuration for your domain.

CloudformationAttribute:: DkimDNSTokenValue1

attr_dkim_dns_token_value2

The record value for the second token that you have to add to the DNS configuration for your domain.

CloudformationAttribute:: DkimDNSTokenValue2

attr_dkim_dns_token_value3

The record value for the third token that you have to add to the DNS configuration for your domain.

CloudformationAttribute:: DkimDNSTokenValue3

cfn_options: Options for this resource, such as condition, update policy etc.

cfn_resource_type: AWS resource type.

configuration_set_attributes: Used to associate a configuration set with an email identity.

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

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

dkim_signing_attributes

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

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.

feedback_attributes: Used to enable or disable feedback forwarding for an identity.

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Returns:

the logical ID as a stringified token. This value will only get resolved during synthesis.

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

node: The tree node.

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters:

x (Any) –

Return type:

bool

Returns:

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(x)

Check whether the given object is a CfnResource.

Parameters:

x (Any) –

Return type:

bool

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

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

ConfigurationSetAttributesProperty

class CfnEmailIdentity.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 import aws_ses as ses

configuration_set_attributes_property = ses.CfnEmailIdentity.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 CfnEmailIdentity.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 import aws_ses as ses

dkim_attributes_property = ses.CfnEmailIdentity.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 CfnEmailIdentity.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 import aws_ses as ses

dkim_signing_attributes_property = ses.CfnEmailIdentity.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 CfnEmailIdentity.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 import aws_ses as ses

feedback_attributes_property = ses.CfnEmailIdentity.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 CfnEmailIdentity.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 import aws_ses as ses

mail_from_attributes_property = ses.CfnEmailIdentity.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