Neptune / Client / copy_db_cluster_parameter_group

copy_db_cluster_parameter_group#

Neptune.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 Amazon Resource Name (ARN).

    Constraints:

    • Must specify a valid DB cluster parameter group.

    • If the source DB cluster parameter group is in the same Amazon 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 Amazon 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.

  • TargetDBClusterParameterGroupIdentifier (string) –

    [REQUIRED]

    The identifier for the copied DB cluster parameter group.

    Constraints:

    • Cannot be null, empty, or blank

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

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

  • Tags (list) –

    The tags to be assigned to the copied DB cluster parameter group.

    • (dict) –

      Metadata assigned to an Amazon Neptune 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 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 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 Neptune DB cluster parameter group.

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

      • DBClusterParameterGroupName (string) –

        Provides the name of the DB cluster parameter group.

      • DBParameterGroupFamily (string) –

        Provides 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