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	awscc.ses.configuration_sets

Fields

get (all properties)

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.
▶tags	array	The tags (keys and values) associated with the contact list.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
name	string	The name of the configuration set.
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	configuration_sets	INSERT	region
delete_resource	configuration_sets	DELETE	Identifier, region
update_resource	configuration_sets	UPDATE	Identifier, PatchDocument, region
list_resources	configuration_sets_list_only	SELECT	region
get_resource	configuration_sets	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual configuration_set.

SELECT
  region,
  name,
  tracking_options,
  delivery_options,
  reputation_options,
  sending_options,
  suppression_options,
  vdm_options,
  tags
FROM awscc.ses.configuration_sets
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ name }}';

list (identifiers only)

Lists all configuration_sets in a region.

SELECT
  region,
  name
FROM awscc.ses.configuration_sets_list_only
WHERE
  region = '{{ region }}';

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 awscc.ses.configuration_sets (
  Name,
  TrackingOptions,
  DeliveryOptions,
  ReputationOptions,
  SendingOptions,
  SuppressionOptions,
  VdmOptions,
  Tags,
  region
)
SELECT
  '{{ name }}',
  '{{ tracking_options }}',
  '{{ delivery_options }}',
  '{{ reputation_options }}',
  '{{ sending_options }}',
  '{{ suppression_options }}',
  '{{ vdm_options }}',
  '{{ tags }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.ses.configuration_sets (
  Name,
  TrackingOptions,
  DeliveryOptions,
  ReputationOptions,
  SendingOptions,
  SuppressionOptions,
  VdmOptions,
  Tags,
  region
)
SELECT
  '{{ name }}',
  '{{ tracking_options }}',
  '{{ delivery_options }}',
  '{{ reputation_options }}',
  '{{ sending_options }}',
  '{{ suppression_options }}',
  '{{ vdm_options }}',
  '{{ tags }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

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: tracking_options
      value:
        custom_redirect_domain: '{{ custom_redirect_domain }}'
        https_policy: '{{ https_policy }}'
    - name: delivery_options
      value:
        tls_policy: '{{ tls_policy }}'
        sending_pool_name: '{{ sending_pool_name }}'
        max_delivery_seconds: null
    - name: reputation_options
      value:
        reputation_metrics_enabled: '{{ reputation_metrics_enabled }}'
    - name: sending_options
      value:
        sending_enabled: '{{ sending_enabled }}'
    - name: suppression_options
      value:
        suppressed_reasons:
          - '{{ suppressed_reasons[0] }}'
    - name: vdm_options
      value:
        dashboard_options:
          engagement_metrics: '{{ engagement_metrics }}'
        guardian_options:
          optimized_shared_delivery: '{{ optimized_shared_delivery }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.ses.configuration_sets
SET PatchDocument = string('{{ {
    "TrackingOptions": tracking_options,
    "DeliveryOptions": delivery_options,
    "ReputationOptions": reputation_options,
    "SendingOptions": sending_options,
    "SuppressionOptions": suppression_options,
    "VdmOptions": vdm_options,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ name }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.ses.configuration_sets
WHERE
  Identifier = '{{ name }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

Permissions

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

Create

ses:CreateConfigurationSet,
ses:UntagResource,
ses:TagResource,
ses:DescribeConfigurationSet,
ses:GetConfigurationSet

Read

ses:GetConfigurationSet,
ses:DescribeConfigurationSet

Update

ses:PutConfigurationSetTrackingOptions,
ses:PutConfigurationSetDeliveryOptions,
ses:PutConfigurationSetReputationOptions,
ses:PutConfigurationSetSendingOptions,
ses:PutConfigurationSetSuppressionOptions,
ses:PutConfigurationSetVdmOptions,
ses:DescribeConfigurationSet,
ses:UntagResource,
ses:TagResource

Delete

ses:DeleteConfigurationSet

List

ses:ListConfigurationSets