db_parameter_groups

Creates, updates, deletes or gets a db_parameter_group resource or lists db_parameter_groups in a region

Overview

Name	db_parameter_groups
Type	Resource
Description	AWS::Neptune::DBParameterGroup creates a new DB parameter group. This type can be declared in a template and referenced in the DBParameterGroupName parameter of AWS::Neptune::DBInstance
Id	awscc.neptune.db_parameter_groups

Fields

Name	Datatype	Description
name	string	Provides the name of the DB parameter group.
description	string	Provides the customer-specified description for this DB parameter group.
family	string	Must be `neptune1` for engine versions prior to 1.2.0.0, or `neptune1.2` for engine version `1.2.0.0` and higher.
parameters	object	The parameters to set for this DB parameter group.<br />The parameters are expressed as a JSON object consisting of key-value pairs.<br />Changes to dynamic parameters are applied immediately. During an update, if you have static parameters (whether they were changed or not), it triggers AWS CloudFormation to reboot the associated DB instance without failover.
▶tags	array	An optional array of key-value pairs to apply to this DB parameter group.
region	string	AWS region.

For more information, see AWS::Neptune::DBParameterGroup.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	Family, Description, Parameters, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all properties from an individual db_parameter_group.

SELECT
region,
name,
description,
family,
parameters,
tags
FROM awscc.neptune.db_parameter_groups
WHERE region = 'us-east-1' AND data__Identifier = '<Name>';

INSERT example

Use the following StackQL query and manifest file to create a new db_parameter_group resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO awscc.neptune.db_parameter_groups (
 Description,
 Family,
 Parameters,
 region
)
SELECT 
'{{ Description }}',
 '{{ Family }}',
 '{{ Parameters }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.neptune.db_parameter_groups (
 Name,
 Description,
 Family,
 Parameters,
 Tags,
 region
)
SELECT 
 '{{ Name }}',
 '{{ Description }}',
 '{{ Family }}',
 '{{ Parameters }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: db_parameter_group
    props:
      - name: Name
        value: '{{ Name }}'
      - name: Description
        value: '{{ Description }}'
      - name: Family
        value: '{{ Family }}'
      - name: Parameters
        value: {}
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM awscc.neptune.db_parameter_groups
WHERE data__Identifier = '<Name>'
AND region = 'us-east-1';

Permissions

To operate on the db_parameter_groups resource, the following permissions are required:

Create

rds:AddTagsToResource,
rds:CreateDBParameterGroup,
rds:DescribeDBParameterGroups,
rds:DescribeDBParameters,
rds:DescribeEngineDefaultParameters,
rds:ModifyDBParameterGroup,
rds:ListTagsForResource,
iam:CreateServiceLinkedRole

Read

rds:DescribeDBParameterGroups,
rds:ListTagsForResource,
rds:DescribeDBParameters,
rds:DescribeEngineDefaultParameters

Update

rds:AddTagsToResource,
rds:DescribeDBParameterGroups,
rds:DescribeDBParameters,
rds:DescribeEngineDefaultParameters,
rds:ListTagsForResource,
rds:ModifyDBParameterGroup,
rds:ResetDBParameterGroup,
rds:RemoveTagsFromResource,
rds:DescribeDBInstances

Delete

rds:DeleteDBParameterGroup,
rds:RemoveTagsFromResource

List

rds:DescribeDBParameterGroups,
rds:ListTagsForResource