Sign In to the Console
AWS CloudFormation
User Guide (API Version 2010-05-15)

AWS Documentation » AWS CloudFormation » User Guide » Template Reference » AWS Resource and Property Types Reference » Amazon Simple Email Service Resource Types Reference » AWS::SES::ReceiptRule » Amazon Simple Email Service ReceiptRule Rule

Amazon Simple Email Service ReceiptRule Rule

The Rule property type specifies which actions Amazon SES should take when it receives mail on behalf of one or more email addresses or domains that you own.

Each receipt rule defines a set of email addresses or domains that it applies to. If the email addresses or domains match at least one recipient address of the message, Amazon SES executes all of the receipt rule's actions on the message.

For more information, see Creating Receipt Rules for Amazon SES Email Receiving in the Amazon Simple Email Service Developer Guide.

Rule is a property of the AWS::SES::ReceiptRule resource.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "ScanEnabled" : Boolean,
  "Recipients" : [ String, ... ],
  "Actions" : [ Action, ... ],
  "Enabled" : Boolean,
  "Name" : String,
  "TlsPolicy" : String
}

YAML


ScanEnabled: Boolean
Recipients: 
  - String
Actions: 
  - Action
Enabled: Boolean
Name: String
TlsPolicy: String

Properties

Actions

An ordered list of actions to perform on messages that match at least one of the recipient email addresses or domains specified in the receipt rule.

Required: No

Type: List of Action

Update requires: No interruption

Enabled

If true, the receipt rule is active. The default value is false.

Required: No

Type: Boolean

Update requires: No interruption

Name

The name of the receipt rule. The name must:

  • Contain only ASCII letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-).

  • Start and end with a letter or number.

  • Contain less than 64 characters.

Required: No

Type: String

Update requires: Replacement

Recipients

The recipient domains and email addresses that the receipt rule applies to. If this field is not specified, this rule will match all recipients under all verified domains.

Required: No

Type: List of String values

Update requires: No interruption

ScanEnabled

If true, then messages that this receipt rule applies to are scanned for spam and viruses. The default value is false.

Required: No

Type: Boolean

Update requires: No interruption

TlsPolicy

Specifies whether Amazon SES should require that incoming email is delivered over a connection encrypted with Transport Layer Security (TLS). If this parameter is set to Require, Amazon SES will bounce emails that are not received over TLS. The default is Optional.

Valid values include Optional and Require.

Required: No

Type: String

Update requires: No interruption

See Also

On this page: