configuration_set_event_destinations

Creates, updates, deletes or gets a configuration_set_event_destination resource or lists configuration_set_event_destinations in a region

Overview

Name	configuration_set_event_destinations
Type	Resource
Description	Resource Type definition for AWS::SES::ConfigurationSetEventDestination
Id	awscc.ses.configuration_set_event_destinations

Fields

get (all properties)

Name	Datatype	Description
id	string
configuration_set_name	string	The name of the configuration set that contains the event destination.
▶event_destination	object	The event destination object.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
id	string
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	configuration_set_event_destinations	INSERT	ConfigurationSetName, EventDestination, region
delete_resource	configuration_set_event_destinations	DELETE	Identifier, region
update_resource	configuration_set_event_destinations	UPDATE	Identifier, PatchDocument, region
list_resources	configuration_set_event_destinations_list_only	SELECT	region
get_resource	configuration_set_event_destinations	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual configuration_set_event_destination.

SELECT
  region,
  id,
  configuration_set_name,
  event_destination
FROM awscc.ses.configuration_set_event_destinations
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ id }}';

list (identifiers only)

Lists all configuration_set_event_destinations in a region.

SELECT
  region,
  id
FROM awscc.ses.configuration_set_event_destinations_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.ses.configuration_set_event_destinations (
  ConfigurationSetName,
  EventDestination,
  region
)
SELECT
  '{{ configuration_set_name }}',
  '{{ event_destination }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.ses.configuration_set_event_destinations (
  ConfigurationSetName,
  EventDestination,
  region
)
SELECT
  '{{ configuration_set_name }}',
  '{{ event_destination }}',
  '{{ 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_event_destination
  props:
    - name: configuration_set_name
      value: '{{ configuration_set_name }}'
    - name: event_destination
      value:
        name: '{{ name }}'
        enabled: '{{ enabled }}'
        matching_event_types:
          - '{{ matching_event_types[0] }}'
        cloud_watch_destination:
          dimension_configurations:
            - dimension_value_source: '{{ dimension_value_source }}'
              default_dimension_value: '{{ default_dimension_value }}'
              dimension_name: '{{ dimension_name }}'
        kinesis_firehose_destination:
          iam_role_arn: '{{ iam_role_arn }}'
          delivery_stream_arn: '{{ delivery_stream_arn }}'
        sns_destination:
          topic_arn: '{{ topic_arn }}'
        event_bridge_destination:
          event_bus_arn: '{{ event_bus_arn }}'

UPDATE example

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

/*+ update */
UPDATE awscc.ses.configuration_set_event_destinations
SET PatchDocument = string('{{ {
    "EventDestination": event_destination
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ id }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.ses.configuration_set_event_destinations
WHERE
  Identifier = '{{ id }}' 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_set_event_destinations resource, the following permissions are required:

Create

ses:CreateConfigurationSetEventDestination,
ses:GetConfigurationSetEventDestinations,
ses:DescribeConfigurationSet

Update

ses:UpdateConfigurationSetEventDestination,
ses:GetConfigurationSetEventDestinations

Delete

ses:DeleteConfigurationSetEventDestination

Read

ses:GetConfigurationSetEventDestinations,
ses:DescribeConfigurationSet

List

ses:GetConfigurationSetEventDestinations,
ses:DescribeConfigurationSet