Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/serverless-framework-configuration/_shared/latest--aws-ses-emailidentity.json
Parent schema serverless-framework-configuration
Type: object

Resource Type definition for AWS::SES::EmailIdentity. Source:- https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-ses.git

Properties

EmailIdentity string | Aws_CF_FunctionString required

The email address or domain to verify.

ConfigurationSetAttributes object

Used to associate a configuration set with an email identity.

1 nested properties
ConfigurationSetName string | Aws_CF_FunctionString

The configuration set to use by default when sending from this identity. Note that any configuration set defined in the email sending request takes precedence.

DkimSigningAttributes object

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.

3 nested properties
DomainSigningSelector string | Aws_CF_FunctionString

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

DomainSigningPrivateKey string | Aws_CF_FunctionString

[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.

NextSigningKeyLength string | Aws_CF_FunctionString

[Easy DKIM] The key length of the future DKIM key pair to be generated. This can be changed at most once per day.

DkimAttributes object

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

1 nested properties
SigningEnabled boolean

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.

MailFromAttributes object

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

2 nested properties
MailFromDomain string | Aws_CF_FunctionString

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

BehaviorOnMxFailure string | Aws_CF_FunctionString

The action to take if the required MX record isn't found when you send an email. When you set this value to UseDefaultValue , the mail is sent using amazonses.com as the MAIL FROM domain. When you set this value to RejectMessage , the Amazon SES API v2 returns a MailFromDomainNotVerified error, and doesn't attempt to deliver the email.

FeedbackAttributes object

Used to enable or disable feedback forwarding for an identity.

1 nested properties
EmailForwardingEnabled boolean

If the value is true, you receive email notifications when bounce or complaint events occur

Definitions

DkimSigningAttributes object

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.

DomainSigningSelector string | Aws_CF_FunctionString

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

DomainSigningPrivateKey string | Aws_CF_FunctionString

[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.

NextSigningKeyLength string | Aws_CF_FunctionString

[Easy DKIM] The key length of the future DKIM key pair to be generated. This can be changed at most once per day.

ConfigurationSetAttributes object

Used to associate a configuration set with an email identity.

ConfigurationSetName string | Aws_CF_FunctionString

The configuration set to use by default when sending from this identity. Note that any configuration set defined in the email sending request takes precedence.

DkimAttributes object

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

SigningEnabled boolean

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.

MailFromAttributes object

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

MailFromDomain string | Aws_CF_FunctionString

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

BehaviorOnMxFailure string | Aws_CF_FunctionString

The action to take if the required MX record isn't found when you send an email. When you set this value to UseDefaultValue , the mail is sent using amazonses.com as the MAIL FROM domain. When you set this value to RejectMessage , the Amazon SES API v2 returns a MailFromDomainNotVerified error, and doesn't attempt to deliver the email.

FeedbackAttributes object

Used to enable or disable feedback forwarding for an identity.

EmailForwardingEnabled boolean

If the value is true, you receive email notifications when bounce or complaint events occur