replication_sets

Creates, updates, deletes or gets a replication_set resource or lists replication_sets in a region

Overview

Name	replication_sets
Type	Resource
Description	Resource type definition for AWS::SSMIncidents::ReplicationSet
Id	aws.ssmincidents.replication_sets

Fields

Name	Datatype	Description
arn	string	The ARN of the ReplicationSet.
regions	array	The ReplicationSet configuration.
deletion_protected	boolean	Configures the ReplicationSet deletion protection.
tags	array	The tags to apply to the replication set.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	Regions, 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 replication_sets in a region.

SELECT
region,
arn,
regions,
deletion_protected,
tags
FROM aws.ssmincidents.replication_sets
WHERE region = 'us-east-1';

Gets all properties from an individual replication_set.

SELECT
region,
arn,
regions,
deletion_protected,
tags
FROM aws.ssmincidents.replication_sets
WHERE region = 'us-east-1' AND data__Identifier = '<Arn>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.ssmincidents.replication_sets (
 Regions,
 region
)
SELECT 
'{{ Regions }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.ssmincidents.replication_sets (
 Regions,
 DeletionProtected,
 Tags,
 region
)
SELECT 
 '{{ Regions }}',
 '{{ DeletionProtected }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: replication_set
    props:
      - name: Regions
        value:
          - RegionName: '{{ RegionName }}'
            RegionConfiguration:
              SseKmsKeyId: '{{ SseKmsKeyId }}'
      - name: DeletionProtected
        value: '{{ DeletionProtected }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.ssmincidents.replication_sets
WHERE data__Identifier = '<Arn>'
AND region = 'us-east-1';

Permissions

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

Create

ssm-incidents:CreateReplicationSet,
ssm-incidents:ListReplicationSets,
ssm-incidents:UpdateDeletionProtection,
ssm-incidents:GetReplicationSet,
ssm-incidents:TagResource,
ssm-incidents:ListTagsForResource,
iam:CreateServiceLinkedRole

Read

ssm-incidents:ListReplicationSets,
ssm-incidents:GetReplicationSet,
ssm-incidents:ListTagsForResource

Update

ssm-incidents:UpdateReplicationSet,
ssm-incidents:UpdateDeletionProtection,
ssm-incidents:GetReplicationSet,
ssm-incidents:TagResource,
ssm-incidents:UntagResource,
ssm-incidents:ListTagsForResource

Delete

ssm-incidents:DeleteReplicationSet,
ssm-incidents:GetReplicationSet

List

ssm-incidents:ListReplicationSets