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	awscc.ssmincidents.replication_sets

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
arn	string	The ARN of the ReplicationSet.
region	string	AWS region.

For more information, see AWS::SSMIncidents::ReplicationSet.

Methods

Name	Resource	Accessible by	Required Params
create_resource	replication_sets	INSERT	Regions, region
delete_resource	replication_sets	DELETE	Identifier, region
update_resource	replication_sets	UPDATE	Identifier, PatchDocument, region
list_resources	replication_sets_list_only	SELECT	region
get_resource	replication_sets	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual replication_set.

SELECT
  region,
  arn,
  regions,
  deletion_protected,
  tags
FROM awscc.ssmincidents.replication_sets
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ arn }}';

list (identifiers only)

Lists all replication_sets in a region.

SELECT
  region,
  arn
FROM awscc.ssmincidents.replication_sets_list_only
WHERE
  region = '{{ region }}';

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 awscc.ssmincidents.replication_sets (
  Regions,
  region
)
SELECT
  '{{ regions }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.ssmincidents.replication_sets (
  Regions,
  DeletionProtected,
  Tags,
  region
)
SELECT
  '{{ regions }}',
  '{{ deletion_protected }}',
  '{{ 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: replication_set
  props:
    - name: regions
      value:
        - region_name: '{{ region_name }}'
          region_configuration:
            sse_kms_key_id: '{{ sse_kms_key_id }}'
    - name: deletion_protected
      value: '{{ deletion_protected }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.ssmincidents.replication_sets
SET PatchDocument = string('{{ {
    "Regions": regions,
    "DeletionProtected": deletion_protected,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ arn }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.ssmincidents.replication_sets
WHERE
  Identifier = '{{ arn }}' 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 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