Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

CreateSnapshot

Creates a copy of an entire cluster at a specific moment in time.

Request Syntax


{
   "ClusterName": "string",
   "KmsKeyId": "string",
   "SnapshotName": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

ClusterName

The snapshot is created from this cluster.

Type: String

Required: Yes

KmsKeyId

The ID of the KMS key used to encrypt the snapshot.

Type: String

Required: No

SnapshotName

A name for the snapshot being created.

Type: String

Required: Yes

Tags

A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.

Type: Array of Tag objects

Array Members: Maximum number of 200 items.

Required: No

Response Syntax


{
   "Snapshot": { 
      "ARN": "string",
      "ClusterConfiguration": { 
         "Description": "string",
         "Engine": "string",
         "EngineVersion": "string",
         "MaintenanceWindow": "string",
         "MultiRegionClusterName": "string",
         "MultiRegionParameterGroupName": "string",
         "Name": "string",
         "NodeType": "string",
         "NumShards": number,
         "ParameterGroupName": "string",
         "Port": number,
         "Shards": [ 
            { 
               "Configuration": { 
                  "ReplicaCount": number,
                  "Slots": "string"
               },
               "Name": "string",
               "Size": "string",
               "SnapshotCreationTime": number
            }
         ],
         "SnapshotRetentionLimit": number,
         "SnapshotWindow": "string",
         "SubnetGroupName": "string",
         "TopicArn": "string",
         "VpcId": "string"
      },
      "DataTiering": "string",
      "KmsKeyId": "string",
      "Name": "string",
      "Source": "string",
      "Status": "string"
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Snapshot

The newly-created snapshot.

Type: Snapshot object

Errors

For information about the errors that are common to all actions, see Common Errors.

ClusterNotFoundFault

HTTP Status Code: 400

InvalidClusterStateFault

HTTP Status Code: 400

InvalidParameterCombinationException

HTTP Status Code: 400

InvalidParameterValueException

HTTP Status Code: 400

ServiceLinkedRoleNotFoundFault

HTTP Status Code: 400

SnapshotAlreadyExistsFault

HTTP Status Code: 400

SnapshotQuotaExceededFault

HTTP Status Code: 400

TagQuotaPerResourceExceeded

HTTP Status Code: 400