[ aws . docdb ]

create-db-cluster-snapshot

Description

Creates a snapshot of a cluster.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-db-cluster-snapshot
--db-cluster-snapshot-identifier <value>
--db-cluster-identifier <value>
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--db-cluster-snapshot-identifier (string)

The identifier of the cluster snapshot. This parameter is stored as a lowercase string.

Constraints:

• Must contain from 1 to 63 letters, numbers, or hyphens.

• The first character must be a letter.

• Cannot end with a hyphen or contain two consecutive hyphens.

Example: my-cluster-snapshot1

--db-cluster-identifier (string)

The identifier of the cluster to create a snapshot for. This parameter is not case sensitive.

Constraints:

• Must match the identifier of an existing DBCluster .

Example: my-cluster

--tags (list)

The tags to be assigned to the cluster snapshot.

(structure)

Metadata assigned to an Amazon DocumentDB resource consisting of a key-value pair.

Key -> (string)

The required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can’t be prefixed with “aws:” or “rds:”. The string can contain only the set of Unicode letters, digits, white space, ‘_’, ‘.’, ‘/’, ‘=’, ‘+’, ‘-‘ (Java regex: “^([\p{L}\p{Z}\p{N}_.:/=+-]*)$”).

Value -> (string)

The optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can’t be prefixed with “aws:” or “rds:”. The string can contain only the set of Unicode letters, digits, white space, ‘_’, ‘.’, ‘/’, ‘=’, ‘+’, ‘-‘ (Java regex: “^([\p{L}\p{Z}\p{N}_.:/=+-]*)$”).

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Examples

To create a manual Amazon DocumentDB cluster snapshot

The following create-db-cluster-snapshot example creates an Amazon DB cluster snapshot named sample-cluster-snapshot.

aws docdb create-db-cluster-snapshot \
   --db-cluster-identifier sample-cluster \
   --db-cluster-snapshot-identifier sample-cluster-snapshot

Output:

{
    "DBClusterSnapshot": {
        "MasterUsername": "master-user",
        "SnapshotCreateTime": "2019-03-18T18:27:14.794Z",
        "AvailabilityZones": [
            "us-west-2a",
            "us-west-2b",
            "us-west-2c",
            "us-west-2d",
            "us-west-2e",
            "us-west-2f"
        ],
        "SnapshotType": "manual",
        "DBClusterSnapshotArn": "arn:aws:rds:us-west-2:123456789012:cluster-snapshot:sample-cluster-snapshot",
        "EngineVersion": "3.6.0",
        "PercentProgress": 0,
        "DBClusterSnapshotIdentifier": "sample-cluster-snapshot",
        "Engine": "docdb",
        "DBClusterIdentifier": "sample-cluster",
        "Status": "creating",
        "ClusterCreateTime": "2019-03-15T20:29:58.836Z",
        "Port": 0,
        "StorageEncrypted": false,
        "VpcId": "vpc-91280df6"
    }
}

For more information, see Creating a Manual Cluster Snapshot in the Amazon DocumentDB Developer Guide.

Output

DBClusterSnapshot -> (structure)

Detailed information about a cluster snapshot.

AvailabilityZones -> (list)

Provides the list of Amazon EC2 Availability Zones that instances in the cluster snapshot can be restored in.

(string)

DBClusterSnapshotIdentifier -> (string)

Specifies the identifier for the cluster snapshot.

DBClusterIdentifier -> (string)

Specifies the cluster identifier of the cluster that this cluster snapshot was created from.

SnapshotCreateTime -> (timestamp)

Provides the time when the snapshot was taken, in UTC.

Engine -> (string)

Specifies the name of the database engine.

Status -> (string)

Specifies the status of this cluster snapshot.

Port -> (integer)

Specifies the port that the cluster was listening on at the time of the snapshot.

VpcId -> (string)

Provides the virtual private cloud (VPC) ID that is associated with the cluster snapshot.

ClusterCreateTime -> (timestamp)

Specifies the time when the cluster was created, in Universal Coordinated Time (UTC).

MasterUsername -> (string)

Provides the master user name for the cluster snapshot.

EngineVersion -> (string)

Provides the version of the database engine for this cluster snapshot.

SnapshotType -> (string)

Provides the type of the cluster snapshot.

PercentProgress -> (integer)

Specifies the percentage of the estimated data that has been transferred.

StorageEncrypted -> (boolean)

Specifies whether the cluster snapshot is encrypted.

KmsKeyId -> (string)

If StorageEncrypted is true , the AWS KMS key identifier for the encrypted cluster snapshot.

DBClusterSnapshotArn -> (string)

The Amazon Resource Name (ARN) for the cluster snapshot.

SourceDBClusterSnapshotArn -> (string)

If the cluster snapshot was copied from a source cluster snapshot, the ARN for the source cluster snapshot; otherwise, a null value.