AWS::PinpointEmail::ConfigurationSet

Create a configuration set. Configuration sets are groups of rules that you can apply to the emails you send using Amazon Pinpoint. You apply a configuration set to an email by including a reference to the configuration set in the headers of the email. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.

Syntax

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

JSON

{
  "Type" : "AWS::PinpointEmail::ConfigurationSet",
  "Properties" : {
      "DeliveryOptions" : DeliveryOptions,
      "Name" : String,
      "ReputationOptions" : ReputationOptions,
      "SendingOptions" : SendingOptions,
      "Tags" : [ Tags, ... ],
      "TrackingOptions" : TrackingOptions
    }
}

YAML

Type: AWS::PinpointEmail::ConfigurationSet
Properties:
  DeliveryOptions: 
    DeliveryOptions
  Name: String
  ReputationOptions: 
    ReputationOptions
  SendingOptions: 
    SendingOptions
  Tags: 
    - Tags
  TrackingOptions: 
    TrackingOptions

Properties

DeliveryOptions

An object that defines the dedicated IP pool that is used to send emails that you send using the configuration set.

Required: No

Type: DeliveryOptions

Update requires: No interruption

Name

The name of the configuration set.

Required: Yes

Type: String

Update requires: Replacement

ReputationOptions

An object that defines whether or not Amazon Pinpoint 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 Pinpoint can send email that you send using the configuration set.

Required: No

Type: SendingOptions

Update requires: No interruption

Tags

An object that defines the tags (keys and values) that you want to associate with the configuration set.

Required: No

Type: Array of Tags

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

Return values

Ref

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

{ "Ref": "myConfigurationSet" }

For the Amazon Pinpoint configuration set myConfigurationSet, Ref returns the name of the configuration set.

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

Fn::GetAtt