Skip to content

RDS  >  Operations  >  copy_db_parameter_group

copy_db_parameter_group

Operation

copy_db_parameter_group async

copy_db_parameter_group(input: CopyDBParameterGroupInput, plugins: list[Plugin] | None = None) -> CopyDBParameterGroupOutput

Copies the specified DB parameter group.

Note

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

Parameters:

Name Type Description Default
input CopyDBParameterGroupInput

An instance of CopyDBParameterGroupInput.

required
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
CopyDBParameterGroupOutput

An instance of CopyDBParameterGroupOutput.

Input

CopyDBParameterGroupInput dataclass

Bases: _SerdeShape

Attributes

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

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.
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_parameter_group_description class-attribute instance-attribute
target_db_parameter_group_description: str | None = ...

A description for the copied DB parameter group.

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

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

Output

CopyDBParameterGroupOutput dataclass

Bases: _SerdeShape

Dataclass for CopyDBParameterGroupOutput structure.

Attributes

db_parameter_group class-attribute instance-attribute
db_parameter_group: DBParameterGroup | None = ...

Contains the details of an Amazon RDS DB parameter group.

This data type is used as a response element in the DescribeDBParameterGroups 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.