View a markdown version of this page

AWS::SES::Tenant TenantSuppressionAttributes - AWS CloudFormation
SyntaxProperties

This is the new CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::SES::Tenant TenantSuppressionAttributes

An object that contains the suppression list preferences for a tenant.

Syntax

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

JSON

{
  "SuppressedReasons" : [ String, ... ],
  "SuppressionScope" : String
}

YAML

  SuppressedReasons: 
    - String
  SuppressionScope: String

Properties

SuppressedReasons

A list that contains the reasons that email addresses are automatically added to the suppression list for the tenant. This list can contain any or all of the following:

  • COMPLAINT – Amazon SES adds an email address to the suppression list when a message sent to that address results in a complaint.

  • BOUNCE – Amazon SES adds an email address to the suppression list when a message sent to that address results in a hard bounce.

Required: Yes

Type: Array of String

Allowed values: BOUNCE | COMPLAINT

Update requires: No interruption

SuppressionScope

The suppression scope for the tenant. Can be one of the following:

  • TENANT – The tenant uses its own suppression list.

  • ACCOUNT – The tenant uses the account-level suppression list.

Note

If you don't specify a suppression scope, the tenant defaults to ACCOUNT scope and uses the account-level suppression list.

Required: Yes

Type: String

Allowed values: ACCOUNT | TENANT

Update requires: No interruption