AWS::SSMIncidents::ReplicationSet

The AWS::SSMIncidents::ReplicationSet resource specifies a set of AWS Regions that Incident Manager data is replicated to and the AWS Key Management Service (AWS KMS key used to encrypt the data.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::SSMIncidents::ReplicationSet",
  "Properties" : {
      "DeletionProtected" : Boolean,
      "Regions" : [ ReplicationRegion, ... ],
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::SSMIncidents::ReplicationSet
Properties:
  DeletionProtected: Boolean
  Regions: 
    - ReplicationRegion
  Tags: 
    - Tag

Properties

DeletionProtected

Determines if the replication set deletion protection is enabled or not. If deletion protection is enabled, you can't delete the last Region in the replication set.

Required: No

Type: Boolean

Update requires: No interruption

Regions

Specifies the Regions of the replication set.

Required: Yes

Type: Array of ReplicationRegion

Minimum: 1

Maximum: 3

Update requires: No interruption

Tags

A list of tags to add to the replication set.

Required: No

Type: Array of Tag

Maximum: 50

Update requires: No interruption

Examples

Create a replication set

The following example creates a replication set.

Note

We recommend creating a replication set and response plan using a single template. For a demonstration, see the examples for AWS::SSMIncidents::ResponsePlan.

JSON

{
   "AWSTemplateFormatVersion": "2010-09-09",
   "Description": "Sample AWS CloudFormation template to create a replication set (JSON).",
   "Resources": {
      "MyReplicationSet": {
         "Type": "AWS::SSMIncidents::ReplicationSet",
         "Properties": {
            "DeletionProtected": true,
            "Regions": [
               {
                  "RegionName": {
                     "Ref": "AWS::Region"
                  }
               }
            ],
            "Tags": [
               {
                  "Key": "MyReplicationSetTagKey",
                  "Value": "MyReplicationSetTagValue"
               }
            ]
         }
      }
   }
}

YAML

---
AWSTemplateFormatVersion: 2010-09-09
Description: "Sample AWS CloudFormation template to create a replication set (YAML)."
Resources:
  MyReplicationSet:
    Type: AWS::SSMIncidents::ReplicationSet
    Properties:
      DeletionProtected: true
      Regions:
        - RegionName:
            Ref: "AWS::Region"
      Tags:
        - Key: MyReplicationSetTagKey
          Value: MyReplicationSetTagValue