Skip to content

RDS  >  Operations  >  copy_db_cluster_parameter_group

copy_db_cluster_parameter_group

Operation

copy_db_cluster_parameter_group async

copy_db_cluster_parameter_group(request: CopyDBClusterParameterGroupInput | CopyDBClusterParameterGroupInputDict, /, *, plugins: list[Plugin] | None = None) -> CopyDBClusterParameterGroupOutput
copy_db_cluster_parameter_group(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[CopyDBClusterParameterGroupInputDict]) -> CopyDBClusterParameterGroupOutput

Copies the specified DB cluster parameter group.

Note

You can't copy a default DB cluster parameter group. Instead, create a new custom DB cluster parameter group, which copies the default parameters and values for the specified DB cluster parameter group family.

Parameters:

Name Type Description Default
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None

Returns:

Type Description
CopyDBClusterParameterGroupOutput

An instance of CopyDBClusterParameterGroupOutput.

Input

Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.

Model

CopyDBClusterParameterGroupInput dataclass

Bases: _SerdeShape

Dataclass for CopyDBClusterParameterGroupInput structure.

Attributes
source_db_cluster_parameter_group_identifier class-attribute instance-attribute
source_db_cluster_parameter_group_identifier: str | None = ...

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.
tags class-attribute instance-attribute
tags: list[Tag] | None = ...

A list of tags.

For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.

target_db_cluster_parameter_group_description class-attribute instance-attribute
target_db_cluster_parameter_group_description: str | None = ...

A description for the copied DB cluster parameter group.

target_db_cluster_parameter_group_identifier class-attribute instance-attribute
target_db_cluster_parameter_group_identifier: str | None = ...

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

Dictionaries

CopyDBClusterParameterGroupInputDict

Bases: TypedDict

Dictionary form of CopyDBClusterParameterGroupInput.

Attributes
source_db_cluster_parameter_group_identifier instance-attribute
source_db_cluster_parameter_group_identifier: Required[str]

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.
tags instance-attribute
tags: Sequence[Tag | TagDict] | None

A list of tags.

For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.

target_db_cluster_parameter_group_description instance-attribute
target_db_cluster_parameter_group_description: Required[str]

A description for the copied DB cluster parameter group.

target_db_cluster_parameter_group_identifier instance-attribute
target_db_cluster_parameter_group_identifier: Required[str]

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

Output

CopyDBClusterParameterGroupOutput dataclass

Bases: _SerdeShape

Dataclass for CopyDBClusterParameterGroupOutput structure.

Attributes

db_cluster_parameter_group class-attribute instance-attribute
db_cluster_parameter_group: DBClusterParameterGroup | None = ...

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

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

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.