Skip to content
This repository has been archived by the owner on Jun 5, 2020. It is now read-only.

Latest commit

 

History

History
45 lines (33 loc) · 4.55 KB

aws_db_parameter_group.md

File metadata and controls

45 lines (33 loc) · 4.55 KB

Document: "rds"

Path: "https://github.com/aws/aws-sdk-go-v2/tree/master/models/apis/rds/2014-10-31/api-2.json")

DBParameterGroup

aws_db_parameter_group {
  db_parameter_group_family => "db_parameter_group_family (optional)",
  db_parameter_group_name => "db_parameter_group_name (optional)",
  description => "description (optional)",
  filters => "Filters (optional)",
  max_records => "MaxRecords (optional)",
  parameters => "Parameters (optional)",
  tags => "Tags (optional)",
}
Name Type Required
db_parameter_group_family String false
db_parameter_group_name String false
description String false
filters FilterList false
max_records IntegerOptional false
parameters ParametersList false
tags TagList false

CRUD operations

Here is a list of endpoints that we use to create, read, update and delete the DBParameterGroup

Operation Path Verb Description OperationID
Create / POST

Creates a new DB parameter group.

A DB parameter group is initially created with the default parameters for the database engine used by the DB instance. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBParameterGroup. Once you've created a DB parameter group, you need to associate it with your DB instance using ModifyDBInstance. When you associate a new DB parameter group with a running DB instance, you need to reboot the DB instance without failover for the new DB parameter group and associated settings to take effect.

After you create a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBParameters command to verify that your DB parameter group has been created or modified.

CreateDBParameterGroup
List - list all / POST

Returns a list of DBParameterGroup descriptions. If a DBParameterGroupName is specified, the list will contain only the description of the specified DB parameter group.

DescribeDBParameterGroups
List - get one ``
List - get list using params / POST

Returns a list of DBParameterGroup descriptions. If a DBParameterGroupName is specified, the list will contain only the description of the specified DB parameter group.

DescribeDBParameterGroups
Update / POST

Modifies the parameters of a DB parameter group. To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request.

Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot without failover to the DB instance associated with the parameter group before the change can take effect.

After you modify a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon RDS to fully complete the modify action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBParameters command to verify that your DB parameter group has been created or modified.

ModifyDBParameterGroup
Delete / POST

Deletes a specified DB parameter group. The DB parameter group to be deleted can't be associated with any DB instances.

DeleteDBParameterGroup