db_cluster_parameter_groups

Creates, updates, deletes or gets a db_cluster_parameter_group resource or lists db_cluster_parameter_groups in a region

Overview

Name	db_cluster_parameter_groups
Type	Resource
Description	The AWS::Neptune::DBClusterParameterGroup resource creates a new Amazon Neptune DB cluster parameter group
Id	awscc.neptune.db_cluster_parameter_groups

Fields

get (all properties)

Name	Datatype	Description
description	string	Provides the customer-specified description for this DB cluster 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	An array of parameters to be modified. A maximum of 20 parameters can be modified in a single request.
name	string	Provides the name of the DB cluster parameter group.
▶tags	array	The list of tags for the cluster parameter group.
region	string	AWS region.

list (identifiers only)

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

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

Methods

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

SELECT examples

get (all properties)

Gets all properties from an individual db_cluster_parameter_group.

SELECT
  region,
  description,
  family,
  parameters,
  name,
  tags
FROM awscc.neptune.db_cluster_parameter_groups
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ name }}';

list (identifiers only)

Lists all db_cluster_parameter_groups in a region.

SELECT
  region,
  name
FROM awscc.neptune.db_cluster_parameter_groups_list_only
WHERE
  region = 'us-east-1';

INSERT example

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

Required Properties

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

All Properties

/*+ create */
INSERT INTO awscc.neptune.db_cluster_parameter_groups (
  Description,
  Family,
  Parameters,
  Name,
  Tags,
  region
)
SELECT
  '{{ description }}',
  '{{ family }}',
  '{{ parameters }}',
  '{{ name }}',
  '{{ tags }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: db_cluster_parameter_group
    props:
      - name: description
        value: '{{ description }}'
      - name: family
        value: '{{ family }}'
      - name: parameters
        value: {}
      - name: name
        value: '{{ name }}'
      - name: tags
        value:
          - key: '{{ key }}'
            value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.neptune.db_cluster_parameter_groups
SET PatchDocument = string('{{ {
    "Parameters": parameters,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ name }}';

DELETE example

/*+ delete */
DELETE FROM awscc.neptune.db_cluster_parameter_groups
WHERE
  Identifier = '{{ name }}' AND
  region = 'us-east-1';

Permissions

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

Create

rds:AddTagsToResource,
rds:CreateDBClusterParameterGroup,
rds:DescribeDBClusterParameterGroups,
rds:DescribeDBClusterParameters,
rds:DescribeEngineDefaultClusterParameters,
rds:ListTagsForResource,
rds:ModifyDBClusterParameterGroup,
iam:CreateServiceLinkedRole

Read

rds:DescribeDBClusterParameterGroups,
rds:ListTagsForResource,
rds:DescribeDBClusterParameters

Update

rds:AddTagsToResource,
rds:DescribeDBClusterParameterGroups,
rds:DescribeDBClusterParameters,
rds:DescribeDBClusters,
rds:DescribeEngineDefaultClusterParameters,
rds:ListTagsForResource,
rds:ModifyDBClusterParameterGroup,
rds:RemoveTagsFromResource,
rds:ResetDBClusterParameterGroup

Delete

rds:DeleteDBClusterParameterGroup,
rds:ListTagsForResource,
rds:RemoveTagsFromResource

List

rds:DescribeDBClusterParameterGroups,
rds:ListTagsForResource