Method: Aws::RDS::Client#copy_db_parameter_group

Defined in:

lib/aws-sdk-rds/client.rb

#copy_db_parameter_group(params = {}) ⇒ Types::CopyDBParameterGroupResult

Copies the specified DB parameter group.

<note markdown=“1”> 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.

</note>

Examples:

Example: To copy a DB parameter group

# The following example makes a copy of a DB parameter group.

resp = client.copy_db_parameter_group({
  source_db_parameter_group_identifier: "mydbpg", 
  target_db_parameter_group_description: "Copy of mydbpg parameter group", 
  target_db_parameter_group_identifier: "mydbpgcopy", 
})

resp.to_h outputs the following:
{
  db_parameter_group: {
    db_parameter_group_arn: "arn:aws:rds:us-east-1:814387698303:pg:mydbpgcopy", 
    db_parameter_group_family: "mysql5.7", 
    db_parameter_group_name: "mydbpgcopy", 
    description: "Copy of mydbpg parameter group", 
  }, 
}

Request syntax with placeholder values

resp = client.copy_db_parameter_group({
  source_db_parameter_group_identifier: "String", # required
  target_db_parameter_group_identifier: "String", # required
  target_db_parameter_group_description: "String", # required
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
})

Response structure

resp.db_parameter_group.db_parameter_group_name #=> String
resp.db_parameter_group.db_parameter_group_family #=> String
resp.db_parameter_group.description #=> String
resp.db_parameter_group.db_parameter_group_arn #=> String

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :source_db_parameter_group_identifier (required, String) —

  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.

  ^

  [1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.ARN.html#USER_Tagging.ARN.Constructing

• :target_db_parameter_group_identifier (required, String) —

  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`

• :target_db_parameter_group_description (required, String) —

  A description for the copied DB parameter group.

• :tags (Array<Types::Tag>) —

  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*.

  [1]: docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html [2]: docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html

Returns:

• (Types::CopyDBParameterGroupResult) —

  Returns a response object which responds to the following methods:

  • #db_parameter_group => Types::DBParameterGroup

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-rds/client.rb', line 1648

def copy_db_parameter_group(params = {}, options = {})
  req = build_request(:copy_db_parameter_group, params)
  req.send_request(options)
end