[ aws . rds ]

copy-db-cluster-parameter-group

Description

Copies the specified DB cluster parameter group.

Note

This action only applies to Aurora DB clusters.

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>]

Options

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

The identifier or Amazon Resource Name (ARN) for the source DB cluster parameter group. For information about creating an ARN, see Constructing an ARN for Amazon RDS in the Amazon Aurora User Guide .

Constraints:

  • Must specify a valid DB cluster parameter group.

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

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

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

The identifier for the copied DB cluster parameter group.

Constraints:

  • Can’t be null, empty, or blank

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

  • First character must be a letter

  • Can’t 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 DB cluster parameter group.

--tags (list)

A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.

(structure)

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

Key -> (string)

A key is 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 only contain only the set of Unicode letters, digits, white-space, ‘_’, ‘.’, ‘:’, ‘/’, ‘=’, ‘+’, ‘-‘, ‘@’ (Java regex: “^([\p{L}\p{Z}\p{N}_.:/=+-@]*)$”).

Value -> (string)

A value is 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 only 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.

See ‘aws help’ for descriptions of global parameters.

Examples

To copy a DB cluster parameter group

The following copy-db-cluster-parameter-group example makes a copy of a DB cluster parameter group.

aws rds copy-db-cluster-parameter-group \
    --source-db-cluster-parameter-group-identifier mydbclusterpg \
    --target-db-cluster-parameter-group-identifier mydbclusterpgcopy \
    --target-db-cluster-parameter-group-description "Copy of mydbclusterpg parameter group"

Output:

{
    "DBClusterParameterGroup": {
        "DBClusterParameterGroupName": "mydbclusterpgcopy",
        "DBClusterParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:cluster-pg:mydbclusterpgcopy",
        "DBParameterGroupFamily": "aurora-mysql5.7",
        "Description": "Copy of mydbclusterpg parameter group"
    }
}

For more information, see Copying a DB Cluster Parameter Group in the Amazon Aurora Users Guide.

Output

DBClusterParameterGroup -> (structure)

Contains the details of an Amazon RDS DB cluster parameter group.

This data type is used as a response element in the DescribeDBClusterParameterGroups action.

DBClusterParameterGroupName -> (string)

The name of the DB cluster parameter group.

DBParameterGroupFamily -> (string)

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

Description -> (string)

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

DBClusterParameterGroupArn -> (string)

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