configuration_sets

Creates, updates, deletes or gets a configuration_set resource or lists configuration_sets in a region

Overview

Name	configuration_sets
Type	Resource
Description	Resource schema for AWS::SES::ConfigurationSet.
Id	aws.ses.configuration_sets

Fields

Name	Datatype	Description
name	string	The name of the configuration set.
tracking_options	object	An object that defines the open and click tracking options for emails that you send using the configuration set.
delivery_options	object	An object that defines the dedicated IP pool that is used to send emails that you send using the configuration set.
reputation_options	object	An object that defines whether or not Amazon SES collects reputation metrics for the emails that you send that use the configuration set.
sending_options	object	An object that defines whether or not Amazon SES can send email that you send using the configuration set.
suppression_options	object	An object that contains information about the suppression list preferences for your account.
vdm_options	object	An object that contains Virtual Deliverability Manager (VDM) settings for this configuration set.
region	string	AWS region.

For more information, see AWS::SES::ConfigurationSet.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all configuration_sets in a region.

SELECT
region,
name,
tracking_options,
delivery_options,
reputation_options,
sending_options,
suppression_options,
vdm_options
FROM aws.ses.configuration_sets
WHERE region = 'us-east-1';

Gets all properties from an individual configuration_set.

SELECT
region,
name,
tracking_options,
delivery_options,
reputation_options,
sending_options,
suppression_options,
vdm_options
FROM aws.ses.configuration_sets
WHERE region = 'us-east-1' AND data__Identifier = '<Name>';

INSERT example

Use the following StackQL query and manifest file to create a new configuration_set resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.ses.configuration_sets (
 Name,
 TrackingOptions,
 DeliveryOptions,
 ReputationOptions,
 SendingOptions,
 SuppressionOptions,
 VdmOptions,
 region
)
SELECT 
'{{ Name }}',
 '{{ TrackingOptions }}',
 '{{ DeliveryOptions }}',
 '{{ ReputationOptions }}',
 '{{ SendingOptions }}',
 '{{ SuppressionOptions }}',
 '{{ VdmOptions }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.ses.configuration_sets (
 Name,
 TrackingOptions,
 DeliveryOptions,
 ReputationOptions,
 SendingOptions,
 SuppressionOptions,
 VdmOptions,
 region
)
SELECT 
 '{{ Name }}',
 '{{ TrackingOptions }}',
 '{{ DeliveryOptions }}',
 '{{ ReputationOptions }}',
 '{{ SendingOptions }}',
 '{{ SuppressionOptions }}',
 '{{ VdmOptions }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: configuration_set
    props:
      - name: Name
        value: '{{ Name }}'
      - name: TrackingOptions
        value:
          CustomRedirectDomain: '{{ CustomRedirectDomain }}'
          HttpsPolicy: '{{ HttpsPolicy }}'
      - name: DeliveryOptions
        value:
          TlsPolicy: '{{ TlsPolicy }}'
          SendingPoolName: '{{ SendingPoolName }}'
          MaxDeliverySeconds: null
      - name: ReputationOptions
        value:
          ReputationMetricsEnabled: '{{ ReputationMetricsEnabled }}'
      - name: SendingOptions
        value:
          SendingEnabled: '{{ SendingEnabled }}'
      - name: SuppressionOptions
        value:
          SuppressedReasons:
            - '{{ SuppressedReasons[0] }}'
      - name: VdmOptions
        value:
          DashboardOptions:
            EngagementMetrics: '{{ EngagementMetrics }}'
          GuardianOptions:
            OptimizedSharedDelivery: '{{ OptimizedSharedDelivery }}'

DELETE example

/*+ delete */
DELETE FROM aws.ses.configuration_sets
WHERE data__Identifier = '<Name>'
AND region = 'us-east-1';

Permissions

To operate on the configuration_sets resource, the following permissions are required:

Create

ses:CreateConfigurationSet

Read

ses:GetConfigurationSet,
ses:DescribeConfigurationSet

Update

ses:PutConfigurationSetTrackingOptions,
ses:PutConfigurationSetDeliveryOptions,
ses:PutConfigurationSetReputationOptions,
ses:PutConfigurationSetSendingOptions,
ses:PutConfigurationSetSuppressionOptions,
ses:PutConfigurationSetVdmOptions

Delete

ses:DeleteConfigurationSet

List

ses:ListConfigurationSets