CreateReplicationSet
A replication set replicates and encrypts your data to the provided Regions with the provided AWS KMS key.
Request Syntax
POST /createReplicationSet HTTP/1.1
Content-type: application/json
{
"clientToken": "string
",
"regions": {
"string
" : {
"sseKmsKeyId": "string
"
}
},
"tags": {
"string
" : "string
"
}
}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- clientToken
-
A token that ensures that the operation is called only once with the specified details.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 128.
Required: No
- regions
-
The Regions that Incident Manager replicates your data to. You can have up to three Regions in your replication set.
Type: String to RegionMapInputValue object map
Map Entries: Maximum number of 3 items.
Key Length Constraints: Minimum length of 0. Maximum length of 20.
Required: Yes
-
A list of tags to add to the replication set.
Type: String to string map
Map Entries: Maximum number of 50 items.
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Key Pattern:
^(?!aws:)[A-Za-z0-9 _=@:.+-/]+$
Value Length Constraints: Minimum length of 0. Maximum length of 256.
Value Pattern:
^[A-Za-z0-9 _=@:.+-/]*$
Required: No
Response Syntax
HTTP/1.1 201
Content-type: application/json
{
"arn": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 201 response.
The following data is returned in JSON format by the service.
- arn
-
The Amazon Resource Name (ARN) of the replication set.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1000.
Pattern:
^arn:aws(-cn|-us-gov)?:[a-z0-9-]*:[a-z0-9-]*:([0-9]{12})?:.+$
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You don't have sufficient access to perform this operation.
HTTP Status Code: 403
- ConflictException
-
Updating or deleting a resource causes an inconsistent state.
HTTP Status Code: 409
- InternalServerException
-
The request processing has failed because of an unknown error, exception or failure.
HTTP Status Code: 500
- ServiceQuotaExceededException
-
Request would cause a service quota to be exceeded.
HTTP Status Code: 402
- ThrottlingException
-
The request was denied due to request throttling.
HTTP Status Code: 429
- ValidationException
-
The input fails to satisfy the constraints specified by an AWS service.
HTTP Status Code: 400
Examples
Example
This example illustrates one usage of CreateReplicationSet.
Sample Request
POST /createReplicationSet HTTP/1.1
Host: ssm-incidents.us-east-1.amazonaws.com
Accept-Encoding: identity
User-Agent: aws-cli/2.2.4 Python/3.8.8 Linux/5.4.129-72.229.amzn2int.x86_64 exe/x86_64.amzn.2 prompt/off command/ssm-incidents.create-replication-set
X-Amz-Date: 20210810T210320Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210810/us-east-1/ssm-incidents/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 286
{
"regions": {"us-east-1": {"sseKmsKeyId": "arn:aws:kms:us-east-1:111122223333:key/de6a2f4e-5d40-4443-ad82-1db179510a32"}, "us-east-2": {"sseKmsKeyId": "arn:aws:kms:us-east-2:111122223333:key/6f1572c9-05ca-43cf-bf03-ee7bc93f59bd"}},
"clientToken": "aa1b2cde-27e3-42ff-9cac-99380EXAMPLE"
}
Sample Response
{
"arn":"arn:aws:ssm-incidents::111122223333:replication-set/40bd98f0-4110-2dee-b35e-b87006f9e172"
}
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: