configuration_sets

Creates, updates, deletes, gets or lists a configuration_sets resource.

Overview

Name	configuration_sets
Type	Resource
Id	aws.pinpoint_email.configuration_sets

Fields

The following fields are returned by SELECT queries:

get_configuration_set

Name	Datatype	Description
configuration_set_name	string	The name of a configuration set. In Amazon Pinpoint, configuration sets are groups of rules that you can apply to the emails you send. 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.
delivery_options	object	Used to associate a configuration set with a dedicated IP pool.
reputation_options	object	Enable or disable collection of reputation metrics for emails that you send using this configuration set in the current AWS Region.
sending_options	object	Used to enable or disable email sending for messages that use this configuration set in the current AWS Region.
tags	array	An array of objects that define the tags (keys and values) that are associated with the configuration set.
tracking_options	object	An object that defines the tracking options for a configuration set. When you use Amazon Pinpoint to send an email, it contains an invisible image that's used to track when recipients open your email. If your email contains links, those links are changed slightly in order to track when recipients click them. These images and links include references to a domain operated by AWS. You can optionally configure Amazon Pinpoint to use a domain that you operate for these images and links.

list_configuration_sets

Name	Datatype	Description
configuration_set	string	An array that contains all of the configuration sets in your Amazon Pinpoint account in the current AWS Region.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_configuration_set	select	configuration_set_name, region		Get information about an existing configuration set, including the dedicated IP pool that it's associated with, whether or not it's enabled for sending email, and more. In Amazon Pinpoint, configuration sets are groups of rules that you can apply to the emails you send. 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.
list_configuration_sets	select	region	NextToken, PageSize	List all of the configuration sets associated with your Amazon Pinpoint account in the current region. In Amazon Pinpoint, configuration sets are groups of rules that you can apply to the emails you send. 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.
create_configuration_set	insert	region, ConfigurationSetName		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.
put_configuration_set_delivery_options	replace	configuration_set_name, region		Associate a configuration set with a dedicated IP pool. You can use dedicated IP pools to create groups of dedicated IP addresses for sending specific types of email.
delete_configuration_set	delete	configuration_set_name, region		Delete an existing configuration set. In Amazon Pinpoint, configuration sets are groups of rules that you can apply to the emails you send. 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.
put_configuration_set_reputation_options	exec	configuration_set_name, region		Enable or disable collection of reputation metrics for emails that you send using a particular configuration set in a specific AWS Region.
put_configuration_set_sending_options	exec	configuration_set_name, region		Enable or disable email sending for messages that use a particular configuration set in a specific AWS Region.
put_configuration_set_tracking_options	exec	configuration_set_name, region		Specify a custom domain to use for open and click tracking elements in email that you send using Amazon Pinpoint.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
configuration_set_name	string	The name of the configuration set that you want to add a custom tracking domain to.
region	string	AWS region (default: us-east-1)
NextToken	string	A token returned from a previous call to ListConfigurationSets to indicate the position in the list of configuration sets.
PageSize	integer	The number of results to show in a single call to ListConfigurationSets. If the number of results is larger than the number you specified in this parameter, then the response includes a NextToken element, which you can use to obtain additional results.

SELECT examples

get_configuration_set

Get information about an existing configuration set, including the dedicated IP pool that it's associated with, whether or not it's enabled for sending email, and more. In Amazon Pinpoint, configuration sets are groups of rules that you can apply to the emails you send. 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.

SELECT
configuration_set_name,
delivery_options,
reputation_options,
sending_options,
tags,
tracking_options
FROM aws.pinpoint_email.configuration_sets
WHERE configuration_set_name = '{{ configuration_set_name }}' -- required
AND region = '{{ region }}' -- required
;

list_configuration_sets

List all of the configuration sets associated with your Amazon Pinpoint account in the current region. In Amazon Pinpoint, configuration sets are groups of rules that you can apply to the emails you send. 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.

SELECT
configuration_set
FROM aws.pinpoint_email.configuration_sets
WHERE region = '{{ region }}' -- required
AND NextToken = '{{ NextToken }}'
AND PageSize = '{{ PageSize }}'
;

INSERT examples

create_configuration_set

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.

INSERT INTO aws.pinpoint_email.configuration_sets (
ConfigurationSetName,
TrackingOptions,
DeliveryOptions,
ReputationOptions,
SendingOptions,
Tags,
region
)
SELECT 
'{{ ConfigurationSetName }}' /* required */,
'{{ TrackingOptions }}',
'{{ DeliveryOptions }}',
'{{ ReputationOptions }}',
'{{ SendingOptions }}',
'{{ Tags }}',
'{{ region }}'
;

Manifest

# Description fields are for documentation purposes
- name: configuration_sets
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the configuration_sets resource.
  - name: ConfigurationSetName
    value: "{{ ConfigurationSetName }}"
    description: |
      The name of a configuration set. In Amazon Pinpoint, configuration sets are groups of rules that you can apply to the emails you send. 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.
  - name: TrackingOptions
    description: |
      An object that defines the tracking options for a configuration set. When you use Amazon Pinpoint to send an email, it contains an invisible image that's used to track when recipients open your email. If your email contains links, those links are changed slightly in order to track when recipients click them. These images and links include references to a domain operated by AWS. You can optionally configure Amazon Pinpoint to use a domain that you operate for these images and links.
    value:
      CustomRedirectDomain: "{{ CustomRedirectDomain }}"
  - name: DeliveryOptions
    description: |
      Used to associate a configuration set with a dedicated IP pool.
    value:
      TlsPolicy: "{{ TlsPolicy }}"
      SendingPoolName: "{{ SendingPoolName }}"
  - name: ReputationOptions
    description: |
      Enable or disable collection of reputation metrics for emails that you send using this configuration set in the current AWS Region.
    value:
      ReputationMetricsEnabled: {{ ReputationMetricsEnabled }}
      LastFreshStart: "{{ LastFreshStart }}"
  - name: SendingOptions
    description: |
      Used to enable or disable email sending for messages that use this configuration set in the current AWS Region.
    value:
      SendingEnabled: {{ SendingEnabled }}
  - name: Tags
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"

REPLACE examples

put_configuration_set_delivery_options

Associate a configuration set with a dedicated IP pool. You can use dedicated IP pools to create groups of dedicated IP addresses for sending specific types of email.

REPLACE aws.pinpoint_email.configuration_sets
SET 
TlsPolicy = '{{ TlsPolicy }}',
SendingPoolName = '{{ SendingPoolName }}'
WHERE 
configuration_set_name = '{{ configuration_set_name }}' --required
AND region = '{{ region }}' --required;

DELETE examples

delete_configuration_set

Delete an existing configuration set. In Amazon Pinpoint, configuration sets are groups of rules that you can apply to the emails you send. 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.

DELETE FROM aws.pinpoint_email.configuration_sets
WHERE configuration_set_name = '{{ configuration_set_name }}' --required
AND region = '{{ region }}' --required
;

Lifecycle Methods

put_configuration_set_reputation_options

Enable or disable collection of reputation metrics for emails that you send using a particular configuration set in a specific AWS Region.

EXEC aws.pinpoint_email.configuration_sets.put_configuration_set_reputation_options 
@configuration_set_name='{{ configuration_set_name }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"ReputationMetricsEnabled": {{ ReputationMetricsEnabled }}
}'
;

put_configuration_set_sending_options

Enable or disable email sending for messages that use a particular configuration set in a specific AWS Region.

EXEC aws.pinpoint_email.configuration_sets.put_configuration_set_sending_options 
@configuration_set_name='{{ configuration_set_name }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"SendingEnabled": {{ SendingEnabled }}
}'
;

put_configuration_set_tracking_options

Specify a custom domain to use for open and click tracking elements in email that you send using Amazon Pinpoint.

EXEC aws.pinpoint_email.configuration_sets.put_configuration_set_tracking_options 
@configuration_set_name='{{ configuration_set_name }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"CustomRedirectDomain": "{{ CustomRedirectDomain }}"
}'
;