db_cluster_parameter_groups

Creates, updates, deletes, gets or lists a db_cluster_parameter_groups resource.

Overview

Name	`db_cluster_parameter_groups`
Type	Resource
Id	`aws.docdb.db_cluster_parameter_groups`

Fields

The following fields are returned by SELECT queries:

describe_db_cluster_parameter_groups

Name	Datatype	Description
`db_cluster_parameter_group_arn`	`string`	The Amazon Resource Name (ARN) for the cluster parameter group.
`db_cluster_parameter_group_name`	`string`	Provides the name of the cluster parameter group.
`db_parameter_group_family`	`string`	Provides the name of the parameter group family that this cluster parameter group is compatible with.
`description`	`string`	Provides the customer-specified description for this cluster parameter group.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
`describe_db_cluster_parameter_groups`	`select`	`region`	`DBClusterParameterGroupName`, `Filters`, `MaxRecords`, `Marker`	Returns a list of DBClusterParameterGroup descriptions. If a DBClusterParameterGroupName parameter is specified, the list contains only the description of the specified cluster parameter group.
`create_db_cluster_parameter_group`	`insert`	`DBClusterParameterGroupName`, `DBParameterGroupFamily`, `region`	`Description`, `Tags`	Creates a new cluster parameter group. Parameters in a cluster parameter group apply to all of the instances in a cluster. A cluster parameter group is initially created with the default parameters for the database engine used by instances in the cluster. In Amazon DocumentDB, you cannot make modifications directly to the default.docdb3.6 cluster parameter group. If your Amazon DocumentDB cluster is using the default cluster parameter group and you want to modify a value in it, you must first create a new parameter group or copy an existing parameter group, modify it, and then apply the modified parameter group to your cluster. For the new cluster parameter group and associated settings to take effect, you must then reboot the instances in the cluster without failover. For more information, see Modifying Amazon DocumentDB Cluster Parameter Groups.
`modify_db_cluster_parameter_group`	`update`	`DBClusterParameterGroupName`, `region`	`Parameters`	Modifies the parameters of a cluster 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 or maintenance window before the change can take effect. After you create a cluster parameter group, you should wait at least 5 minutes before creating your first cluster that uses that cluster parameter group as the default parameter group. This allows Amazon DocumentDB to fully complete the create action before the parameter group is used as the default for a new cluster. This step is especially important for parameters that are critical when creating the default database for a cluster, such as the character set for the default database defined by the character_set_database parameter.
`delete_db_cluster_parameter_group`	`delete`	`DBClusterParameterGroupName`, `region`		Deletes a specified cluster parameter group. The cluster parameter group to be deleted can't be associated with any clusters.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
`DBClusterParameterGroupName`	`string`	The name of the cluster parameter group. Constraints: Must be the name of an existing cluster parameter group. You can't delete a default cluster parameter group. Cannot be associated with any clusters.
`DBParameterGroupFamily`	`string`	The cluster parameter group family name.
`region`	`string`	AWS region (default: us-east-1)
`DBClusterParameterGroupName`	`string`	The name of a specific cluster parameter group to return details for. Constraints: If provided, must match the name of an existing DBClusterParameterGroup.
`Description`	`string`	The description for the cluster parameter group.
`Filters`	`array`	This parameter is not currently supported.
`Marker`	`string`	An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
`MaxRecords`	`integer`	The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved. Default: 100 Constraints: Minimum 20, maximum 100.
`Parameters`	`array`	A list of parameters in the cluster parameter group to modify.
`Tags`	`array`	The tags to be assigned to the cluster parameter group.

`SELECT` examples

describe_db_cluster_parameter_groups

Returns a list of DBClusterParameterGroup descriptions. If a DBClusterParameterGroupName parameter is specified, the list contains only the description of the specified cluster parameter group.

SELECT
db_cluster_parameter_group_arn,
db_cluster_parameter_group_name,
db_parameter_group_family,
description
FROM aws.docdb.db_cluster_parameter_groups
WHERE region = '{{ region }}' -- required
AND DBClusterParameterGroupName = '{{ DBClusterParameterGroupName }}'
AND Filters = '{{ Filters }}'
AND MaxRecords = '{{ MaxRecords }}'
AND Marker = '{{ Marker }}'
;

`INSERT` examples

create_db_cluster_parameter_group
Manifest

Creates a new cluster parameter group. Parameters in a cluster parameter group apply to all of the instances in a cluster. A cluster parameter group is initially created with the default parameters for the database engine used by instances in the cluster. In Amazon DocumentDB, you cannot make modifications directly to the default.docdb3.6 cluster parameter group. If your Amazon DocumentDB cluster is using the default cluster parameter group and you want to modify a value in it, you must first create a new parameter group or copy an existing parameter group, modify it, and then apply the modified parameter group to your cluster. For the new cluster parameter group and associated settings to take effect, you must then reboot the instances in the cluster without failover. For more information, see Modifying Amazon DocumentDB Cluster Parameter Groups.

INSERT INTO aws.docdb.db_cluster_parameter_groups (
DBClusterParameterGroupName,
DBParameterGroupFamily,
region,
Description,
Tags
)
SELECT 
'{{ DBClusterParameterGroupName }}',
'{{ DBParameterGroupFamily }}',
'{{ region }}',
'{{ Description }}',
'{{ Tags }}'
RETURNING
db_cluster_parameter_group_arn,
db_cluster_parameter_group_name,
db_parameter_group_family,
description
;

# Description fields are for documentation purposes
- name: db_cluster_parameter_groups
props:
  - name: DBClusterParameterGroupName
    value: "{{ DBClusterParameterGroupName }}"
    description: Required parameter for the db_cluster_parameter_groups resource.
  - name: DBParameterGroupFamily
    value: "{{ DBParameterGroupFamily }}"
    description: Required parameter for the db_cluster_parameter_groups resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the db_cluster_parameter_groups resource.
  - name: Description
    value: "{{ Description }}"
    description: The description for the cluster parameter group.
    description: The description for the cluster parameter group.
  - name: Tags
    value: "{{ Tags }}"
    description: The tags to be assigned to the cluster parameter group.
    description: The tags to be assigned to the cluster parameter group.

`UPDATE` examples

modify_db_cluster_parameter_group

Modifies the parameters of a cluster 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 or maintenance window before the change can take effect. After you create a cluster parameter group, you should wait at least 5 minutes before creating your first cluster that uses that cluster parameter group as the default parameter group. This allows Amazon DocumentDB to fully complete the create action before the parameter group is used as the default for a new cluster. This step is especially important for parameters that are critical when creating the default database for a cluster, such as the character set for the default database defined by the character_set_database parameter.

UPDATE aws.docdb.db_cluster_parameter_groups
SET 
-- No updatable properties
WHERE 
DBClusterParameterGroupName = '{{ DBClusterParameterGroupName }}' --required
AND region = '{{ region }}' --required
AND Parameters = '{{ Parameters}}'
RETURNING
db_cluster_parameter_group_name;

`DELETE` examples

delete_db_cluster_parameter_group

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

DELETE FROM aws.docdb.db_cluster_parameter_groups
WHERE DBClusterParameterGroupName = '{{ DBClusterParameterGroupName }}' --required
AND region = '{{ region }}' --required
;

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

UPDATE examples​

DELETE examples​