[ aws . docdb ]

copy-db-cluster-parameter-group

Description

Copies the specified cluster parameter group.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  copy-db-cluster-parameter-group
--source-db-cluster-parameter-group-identifier <value>
--target-db-cluster-parameter-group-identifier <value>
--target-db-cluster-parameter-group-description <value>
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--source-db-cluster-parameter-group-identifier (string)

The identifier or Amazon Resource Name (ARN) for the source cluster parameter group.

Constraints:

• Must specify a valid cluster parameter group.

• If the source cluster parameter group is in the same AWS Region as the copy, specify a valid parameter group identifier; for example, my-db-cluster-param-group , or a valid ARN.

• If the source parameter group is in a different AWS Region than the copy, specify a valid cluster parameter group ARN; for example, arn:aws:rds:us-east-1:123456789012:sample-cluster:sample-parameter-group .

--target-db-cluster-parameter-group-identifier (string)

The identifier for the copied cluster parameter group.

Constraints:

• Cannot be null, empty, or blank.

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

• The first character must be a letter.

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

Example: my-cluster-param-group1

--target-db-cluster-parameter-group-description (string)

A description for the copied cluster parameter group.

--tags (list)

The tags that are to be assigned to the parameter group.

(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 duplicate an existing DB cluster parameter group

The following copy-db-cluster-parameter-group example makes a copy of the parameter group custom-docdb3-6 named custom-docdb3-6-copy. When making the copy it adds tags to the new parameter group.

aws docdb copy-db-cluster-parameter-group \
    --source-db-cluster-parameter-group-identifier custom-docdb3-6 \
    --target-db-cluster-parameter-group-identifier custom-docdb3-6-copy \
    --target-db-cluster-parameter-group-description "Copy of custom-docdb3-6" \
    --tags Key="CopyNumber",Value="1" Key="Modifiable",Value="Yes"

Output:

{
    "DBClusterParameterGroup": {
        "DBParameterGroupFamily": "docdb3.6",
        "DBClusterParameterGroupArn": "arn:aws:rds:us-east-1:12345678901:cluster-pg:custom-docdb3-6-copy",
        "DBClusterParameterGroupName": "custom-docdb3-6-copy",
        "Description": "Copy of custom-docdb3-6"
    }
}

For more information, see Copying an Amazon DocumentDB Cluster Parameter Group in the Amazon DocumentDB Developer Guide.

Output

DBClusterParameterGroup -> (structure)

Detailed information about a cluster parameter group.

DBClusterParameterGroupName -> (string)

Provides the name of the cluster parameter group.

DBParameterGroupFamily -> (string)

Provides the name of the parameter group family that this cluster parameter group is compatible with.

Description -> (string)

Provides the customer-specified description for this cluster parameter group.

DBClusterParameterGroupArn -> (string)

The Amazon Resource Name (ARN) for the cluster parameter group.