[ aws . rds ]

copy-db-parameter-group

Description

Copies the specified DB parameter group.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

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

Options

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

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

Constraints:

• Must specify a valid DB parameter group.

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

The identifier for the copied DB 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-db-parameter-group

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

A description for the copied DB 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-parameter-group example makes a copy of a DB parameter group.

aws rds copy-db-parameter-group \
    --source-db-parameter-group-identifier mydbpg \
    --target-db-parameter-group-identifier mydbpgcopy \
    --target-db-parameter-group-description "Copy of mydbpg parameter group"

Output:

{
    "DBParameterGroup": {
        "DBParameterGroupName": "mydbpgcopy",
        "DBParameterGroupArn": "arn:aws:rds:us-east-1:814387698303:pg:mydbpgcopy",
        "DBParameterGroupFamily": "mysql5.7",
        "Description": "Copy of mydbpg parameter group"
    }
}

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

Output

DBParameterGroup -> (structure)

Contains the details of an Amazon RDS DB parameter group.

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

DBParameterGroupName -> (string)

The name of the DB parameter group.

DBParameterGroupFamily -> (string)

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

Description -> (string)

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

DBParameterGroupArn -> (string)

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