RDS / Client / copy_db_cluster_parameter_group

copy_db_cluster_parameter_group

RDS.Client.copy_db_cluster_parameter_group(**kwargs)

Copies the specified DB 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 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.

• TargetDBClusterParameterGroupIdentifier (string) –

  [REQUIRED]

  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

• TargetDBClusterParameterGroupDescription (string) –

  [REQUIRED]

  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.

  • (dict) –

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

    For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.

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

Return type:

dict

Returns:

Response Syntax

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

Response Structure

• (dict) –

  • DBClusterParameterGroup (dict) –

    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.

Exceptions

• RDS.Client.exceptions.DBParameterGroupNotFoundFault

• RDS.Client.exceptions.DBParameterGroupQuotaExceededFault

• RDS.Client.exceptions.DBParameterGroupAlreadyExistsFault

Examples

This example copies a DB cluster parameter group.

response = client.copy_db_cluster_parameter_group(
    SourceDBClusterParameterGroupIdentifier='mydbclusterparametergroup',
    TargetDBClusterParameterGroupDescription='My DB cluster parameter group copy',
    TargetDBClusterParameterGroupIdentifier='mydbclusterparametergroup-copy',
)

print(response)

Expected Output:

{
    'DBClusterParameterGroup': {
    },
    'ResponseMetadata': {
        '...': '...',
    },
}