copy_db_cluster_parameter_group

DocDB.Client.copy_db_cluster_parameter_group(**kwargs)

Copies the specified cluster parameter group.

See also: AWS API Documentation

Request Syntax

response = client.copy_db_cluster_parameter_group(
    SourceDBClusterParameterGroupIdentifier='string',
    TargetDBClusterParameterGroupIdentifier='string',
    TargetDBClusterParameterGroupDescription='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

Parameters

• SourceDBClusterParameterGroupIdentifier (string) --

  [REQUIRED]

  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 Amazon Web Services 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 Amazon Web Services 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 .
• TargetDBClusterParameterGroupIdentifier (string) --

  [REQUIRED]

  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

• TargetDBClusterParameterGroupDescription (string) --

  [REQUIRED]

  A description for the copied cluster parameter group.

• Tags (list) --

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

  • (dict) --

    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}_.:/=+\-]*)$").

Return type

dict

Returns

Response Syntax

{
    'DBClusterParameterGroup': {
        'DBClusterParameterGroupName': 'string',
        'DBParameterGroupFamily': 'string',
        'Description': 'string',
        'DBClusterParameterGroupArn': 'string'
    }
}

Response Structure

• (dict) --

  • DBClusterParameterGroup (dict) --

    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.

Exceptions

• DocDB.Client.exceptions.DBParameterGroupNotFoundFault
• DocDB.Client.exceptions.DBParameterGroupQuotaExceededFault
• DocDB.Client.exceptions.DBParameterGroupAlreadyExistsFault