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.neptune.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 DB cluster parameter group.
db_cluster_parameter_group_name	string	Provides the name of the DB cluster parameter group.
db_parameter_group_family	string	Provides the name of the DB parameter group family that this DB cluster parameter group is compatible with.
description	string	Provides the customer-specified description for this DB 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 will contain only the description of the specified DB cluster parameter group.
create_db_cluster_parameter_group	insert	DBClusterParameterGroupName, DBParameterGroupFamily, region	Description, Tags	Creates a new DB cluster parameter group. Parameters in a DB cluster parameter group apply to all of the instances in a DB cluster. A DB cluster parameter group is initially created with the default parameters for the database engine used by instances in the DB cluster. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBClusterParameterGroup. Once you've created a DB cluster parameter group, you need to associate it with your DB cluster using ModifyDBCluster. When you associate a new DB cluster parameter group with a running DB cluster, you need to reboot the DB instances in the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect. After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon Neptune to fully complete the create action before the DB cluster parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, 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 Neptune console or the DescribeDBClusterParameters command to verify that your DB cluster parameter group has been created or modified.
modify_db_cluster_parameter_group	update	DBClusterParameterGroupName, region	Parameters	Modifies the parameters of a DB 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 without failover to the DB cluster associated with the parameter group before the change can take effect. After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon Neptune to fully complete the create action before the parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, 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 Neptune console or the DescribeDBClusterParameters command to verify that your DB cluster parameter group has been created or modified.
delete_db_cluster_parameter_group	delete	DBClusterParameterGroupName, region		Deletes a specified DB cluster parameter group. The DB cluster parameter group to be deleted can't be associated with any DB 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 DB cluster parameter group. Constraints: Must be the name of an existing DB cluster parameter group. You can't delete a default DB cluster parameter group. Cannot be associated with any DB clusters.
DBParameterGroupFamily	string	The DB cluster parameter group family name. A DB cluster parameter group can be associated with one and only one DB cluster parameter group family, and can be applied only to a DB cluster running a database engine and engine version compatible with that DB cluster parameter group family.
region	string	AWS region (default: us-east-1)
DBClusterParameterGroupName	string	The name of a specific DB cluster parameter group to return details for. Constraints: If supplied, must match the name of an existing DBClusterParameterGroup.
Description	string	The description for the DB cluster parameter group.
Filters	array	This parameter is not currently supported.
Marker	string	An optional pagination token provided by a previous DescribeDBClusterParameterGroups 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 called a 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 DB cluster parameter group to modify.
Tags	array	The tags to be assigned to the new DB cluster parameter group.

SELECT examples

describe_db_cluster_parameter_groups

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

SELECT
db_cluster_parameter_group_arn,
db_cluster_parameter_group_name,
db_parameter_group_family,
description
FROM aws.neptune.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

Creates a new DB cluster parameter group. Parameters in a DB cluster parameter group apply to all of the instances in a DB cluster. A DB cluster parameter group is initially created with the default parameters for the database engine used by instances in the DB cluster. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBClusterParameterGroup. Once you've created a DB cluster parameter group, you need to associate it with your DB cluster using ModifyDBCluster. When you associate a new DB cluster parameter group with a running DB cluster, you need to reboot the DB instances in the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect. After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon Neptune to fully complete the create action before the DB cluster parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, 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 Neptune console or the DescribeDBClusterParameters command to verify that your DB cluster parameter group has been created or modified.

INSERT INTO aws.neptune.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
;

Manifest

# 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 DB cluster parameter group.
    description: The description for the DB cluster parameter group.
  - name: Tags
    value: "{{ Tags }}"
    description: The tags to be assigned to the new DB cluster parameter group.
    description: The tags to be assigned to the new DB cluster parameter group.

UPDATE examples

modify_db_cluster_parameter_group

Modifies the parameters of a DB 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 without failover to the DB cluster associated with the parameter group before the change can take effect. After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon Neptune to fully complete the create action before the parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, 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 Neptune console or the DescribeDBClusterParameters command to verify that your DB cluster parameter group has been created or modified.

UPDATE aws.neptune.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 DB cluster parameter group. The DB cluster parameter group to be deleted can't be associated with any DB clusters.

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