replication_sets

Creates, updates, deletes, gets or lists a replication_sets resource.

Overview

Name	replication_sets
Type	Resource
Id	aws.ssm_incidents.replication_sets

Fields

The following fields are returned by SELECT queries:

get_replication_set

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the replication set. (pattern: <code>^arn:aws(-cn|-us-gov)?:[a-z0-9-]:[a-z0-9-]:([0-9]{12})?:.+$</code>)
created_by	string	Details about who created the replication set. (pattern: <code>^arn:aws(-cn|-us-gov)?:[a-z0-9-]:[a-z0-9-]:([0-9]{12})?:.+$</code>)
created_time	string (date-time)	When the replication set was created.
deletion_protected	boolean	Determines if the replication set deletion protection is enabled or not. If deletion protection is enabled, you can't delete the last Amazon Web Services Region in the replication set.
last_modified_by	string	Who last modified the replication set. (pattern: <code>^arn:aws(-cn|-us-gov)?:[a-z0-9-]:[a-z0-9-]:([0-9]{12})?:.+$</code>)
last_modified_time	string (date-time)	When the replication set was last updated.
region_map	object	The map between each Amazon Web Services Region in your replication set and the KMS key that's used to encrypt the data in that Region.
status	string	The status of the replication set. If the replication set is still pending, you can't use Incident Manager functionality. (ACTIVE, CREATING, UPDATING, DELETING, FAILED)

list_replication_sets

Name	Datatype	Description
replication_set_arn	string	The Amazon Resource Name (ARN) of the list replication set.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_replication_set	select	arn, region		Retrieve your Incident Manager replication set.
list_replication_sets	select	region		Lists details about the replication set configured in your account.
create_replication_set	insert	region, regions		A replication set replicates and encrypts your data to the provided Regions with the provided KMS key.
update_replication_set	update	region, actions, arn		Add or delete Regions from your replication set.
delete_replication_set	delete	arn, region		Deletes all Regions in your replication set. Deleting the replication set deletes all Incident Manager data.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the replication set you're deleting.
region	string	AWS region (default: us-east-1)

SELECT examples

get_replication_set

Retrieve your Incident Manager replication set.

SELECT
arn,
created_by,
created_time,
deletion_protected,
last_modified_by,
last_modified_time,
region_map,
status
FROM aws.ssm_incidents.replication_sets
WHERE arn = '{{ arn }}' -- required
AND region = '{{ region }}' -- required
;

list_replication_sets

Lists details about the replication set configured in your account.

SELECT
replication_set_arn
FROM aws.ssm_incidents.replication_sets
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_replication_set

A replication set replicates and encrypts your data to the provided Regions with the provided KMS key.

INSERT INTO aws.ssm_incidents.replication_sets (
clientToken,
regions,
tags,
region
)
SELECT 
'{{ clientToken }}',
'{{ regions }}' /* required */,
'{{ tags }}',
'{{ region }}'
RETURNING
arn
;

Manifest

# Description fields are for documentation purposes
- name: replication_sets
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the replication_sets resource.
  - name: clientToken
    value: "{{ clientToken }}"
  - name: regions
    value: "{{ regions }}"
  - name: tags
    value: "{{ tags }}"

UPDATE examples

update_replication_set

Add or delete Regions from your replication set.

UPDATE aws.ssm_incidents.replication_sets
SET 
actions = '{{ actions }}',
arn = '{{ arn }}',
clientToken = '{{ clientToken }}'
WHERE 
region = '{{ region }}' --required
AND actions = '{{ actions }}' --required
AND arn = '{{ arn }}' --required;

DELETE examples

delete_replication_set

Deletes all Regions in your replication set. Deleting the replication set deletes all Incident Manager data.

DELETE FROM aws.ssm_incidents.replication_sets
WHERE arn = '{{ arn }}' --required
AND region = '{{ region }}' --required
;