AWS::SES::ConfigurationSet - AWS CloudFormation
SyntaxPropertiesReturn valuesExamples

AWS::SES::ConfigurationSet

Configuration sets let you create groups of rules that you can apply to the emails you send using Amazon SES. For more information about using configuration sets, see Using Amazon SES Configuration Sets in the Amazon SES Developer Guide.

Note

Required permissions:

To apply any of the resource options, you will need to have the corresponding AWS Identity and Access Management (IAM) SES API v2 permissions:

  • ses:GetConfigurationSet

    • (This permission is replacing the v1 ses:DescribeConfigurationSet permission which will not work with these v2 resource options.)

  • ses:PutConfigurationSetDeliveryOptions

  • ses:PutConfigurationSetReputationOptions

  • ses:PutConfigurationSetSendingOptions

  • ses:PutConfigurationSetSuppressionOptions

  • ses:PutConfigurationSetTrackingOptions

Syntax

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

Properties

DeliveryOptions

Specifies the name of the dedicated IP pool to associate with the configuration set and whether messages that use the configuration set are required to use Transport Layer Security (TLS).

Required: No

Type: DeliveryOptions

Update requires: No interruption

Name

The name of the configuration set. The name must meet the following requirements:

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

  • Contain 64 characters or fewer.

Required: No

Type: String

Pattern: ^[a-zA-Z0-9_-]{1,64}$

Update requires: Replacement

ReputationOptions

An object that defines whether or not Amazon SES collects reputation metrics for the emails that you send that use the configuration set.

Required: No

Type: ReputationOptions

Update requires: No interruption

SendingOptions

An object that defines whether or not Amazon SES can send email that you send using the configuration set.

Required: No

Type: SendingOptions

Update requires: No interruption

SuppressionOptions

An object that contains information about the suppression list preferences for your account.

Required: No

Type: SuppressionOptions

Update requires: No interruption

TrackingOptions

An object that defines the open and click tracking options for emails that you send using the configuration set.

Required: No

Type: TrackingOptions

Update requires: No interruption

VdmOptions

The Virtual Deliverability Manager (VDM) options that apply to the configuration set.

Required: No

Type: VdmOptions

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the resource name.

For more information about using the Ref function, see Ref.

Examples

Specifies a configuration set.

JSON

{
    "AWSTemplateFormatVersion": "2010-09-09",
    "Description": "AWS SES ConfigurationSet Sample Template",
    "Parameters": {
        "ConfigSetName": {
            "Type": "String"
        }
    },
    "Resources": {
        "ConfigSet": {
            "Type": "AWS::SES::ConfigurationSet",
            "Properties": {
                "Name": {
                    "Ref": "ConfigSetName"
                }
            }
        }
    }
}

YAML

AWSTemplateFormatVersion: 2010-09-09
Description: AWS SES ConfigurationSet Sample Template
Parameters:
  ConfigSetName:
    Type: String
Resources:
  ConfigSet:
    Type: 'AWS::SES::ConfigurationSet'
    Properties:
      Name: !Ref ConfigSetName