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

get (all properties)

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. The parameters are expressed as a JSON object consisting of key-value pairs. 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.

list (identifiers only)

Name	Datatype	Description
name	string	Provides the name of the DB parameter group.
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	db_parameter_groups	INSERT	Family, Description, Parameters, region
delete_resource	db_parameter_groups	DELETE	Identifier, region
update_resource	db_parameter_groups	UPDATE	Identifier, PatchDocument, region
list_resources	db_parameter_groups_list_only	SELECT	region
get_resource	db_parameter_groups	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual db_parameter_group.

SELECT
  region,
  name,
  description,
  family,
  parameters,
  tags
FROM awscc.neptune.db_parameter_groups
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ name }}';

list (identifiers only)

Lists all db_parameter_groups in a region.

SELECT
  region,
  name
FROM awscc.neptune.db_parameter_groups_list_only
WHERE
  region = '{{ region }}';

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 }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.neptune.db_parameter_groups (
  Name,
  Description,
  Family,
  Parameters,
  Tags,
  region
)
SELECT
  '{{ name }}',
  '{{ description }}',
  '{{ family }}',
  '{{ parameters }}',
  '{{ tags }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

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 }}'

UPDATE example

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

/*+ update */
UPDATE awscc.neptune.db_parameter_groups
SET PatchDocument = string('{{ {
    "Parameters": parameters,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ name }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.neptune.db_parameter_groups
WHERE
  Identifier = '{{ name }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

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