AWS Amazon Neptune Cluster Parameter Group
This page shows how to write Terraform and CloudFormation for Amazon Neptune Cluster Parameter Group and write them securely.
aws_neptune_cluster_parameter_group (Terraform)
The Cluster Parameter Group in Amazon Neptune can be configured in Terraform with the resource name aws_neptune_cluster_parameter_group. The following sections describe 4 examples of how to use the resource and its parameters.
Example Usage from GitHub
resource "aws_neptune_cluster_parameter_group" "param_group" {
family = "neptune1"
name = "param-group"
description = "neptune cluster parameter group"
parameter {
resource "aws_neptune_cluster_parameter_group" "this" {
description = var.description
family = var.family
name = var.name
name_prefix = var.name_prefix
tags = var.tags
resource "aws_neptune_cluster_parameter_group" "clusterParameterGroup" {
name = format("%s-%s-%s-%s",lookup(var.data, "name"),lookup(var.tags, "product"),lookup(var.tags, "env"),"neptunecluster-parametergroup")
family = lookup(var.data, "family")
count = length(var.data.clusterParameterGroup)
parameter {
resource "aws_neptune_cluster_parameter_group" "cluster_parameter_group" {
count = length(var.cluster_ParamGroup)
family = lookup(var.cluster_ParamGroup[count.index], "family")
name = lookup(var.cluster_ParamGroup[count.index], "name", null)
description = lookup(var.cluster_ParamGroup[count.index], "description", null)
Parameters
-
arnoptional computed - string -
descriptionoptional - string -
familyrequired - string -
idoptional computed - string -
nameoptional computed - string -
name_prefixoptional computed - string -
tagsoptional - map from string to string -
parameterset block-
apply_methodoptional - string -
namerequired - string -
valuerequired - string
-
Explanation in Terraform Registry
Manages a Neptune Cluster Parameter Group
AWS::Neptune::DBClusterParameterGroup (CloudFormation)
The DBClusterParameterGroup in Neptune can be configured in CloudFormation with the resource name AWS::Neptune::DBClusterParameterGroup. The following sections describe 10 examples of how to use the resource and its parameters.
Example Usage from GitHub
Type: 'AWS::Neptune::DBClusterParameterGroup'
Properties:
Family: neptune1
Description: test-cfn-neptune-db-cluster-parameter-group-description
Parameters:
neptune_enable_audit_log: !Ref NeptuneEnableAuditLog
Type: AWS::Neptune::DBClusterParameterGroup
Properties:
Description: Parameter Group for Neptune Cluster
Family: neptune1 # must be 'neptune1'
Parameters:
neptune_streams: !If [ NeptuneStreamsEnabled, 1, 0]
Type: "AWS::Neptune::DBClusterParameterGroup"
Properties:
Description: default cluster parameter group for the leech graph layer
Parameters:
neptune_enable_audit_log: 1
Family: neptune1
Type: "AWS::Neptune::DBClusterParameterGroup"
Properties:
Description: default cluster parameter group for the leech graph layer
Parameters:
neptune_enable_audit_log: 1
Family: neptune1
Type: "AWS::Neptune::DBClusterParameterGroup"
Properties:
Description: default cluster parameter group for the leech graph layer
Parameters:
neptune_enable_audit_log: 1
Family: neptune1
"AWS::Neptune::DBClusterParameterGroup": {
"Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbclusterparametergroup.html",
"Properties": {
"Description": {
"Required": true,
"Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbclusterparametergroup.html#cfn-neptune-dbclusterparametergroup-description",
"AWS::Neptune::DBClusterParameterGroup": {
"Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbclusterparametergroup.html",
"Properties": {
"Description": {
"Required": true,
"Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbclusterparametergroup.html#cfn-neptune-dbclusterparametergroup-description",
"AWS::Neptune::DBClusterParameterGroup": {
"Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbclusterparametergroup.html",
"Properties": {
"Description": {
"Required": true,
"Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbclusterparametergroup.html#cfn-neptune-dbclusterparametergroup-description",
"AWS::Neptune::DBClusterParameterGroup": {
"Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbclusterparametergroup.html",
"Properties": {
"Description": {
"Required": true,
"Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbclusterparametergroup.html#cfn-neptune-dbclusterparametergroup-description",
"AWS::Neptune::DBClusterParameterGroup": {
"Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbclusterparametergroup.html",
"Properties": {
"Description": {
"Required": true,
"Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbclusterparametergroup.html#cfn-neptune-dbclusterparametergroup-description",
Parameters
-
Descriptionrequired - String -
Parametersrequired - Json -
Familyrequired - String -
Tagsoptional - List of Tag -
Nameoptional - String
Explanation in CloudFormation Registry
The
AWS::Neptune::DBClusterParameterGroupresource creates a new Amazon Neptune DB cluster parameter group.Note Applying a parameter group to a DB cluster might require instances to reboot, resulting in a database outage while the instances reboot.
Frequently asked questions
What is AWS Amazon Neptune Cluster Parameter Group?
AWS Amazon Neptune Cluster Parameter Group is a resource for Amazon Neptune of Amazon Web Service. Settings can be wrote in Terraform and CloudFormation.
Where can I find the example code for the AWS Amazon Neptune Cluster Parameter Group?
For Terraform, the farahbhr/AWS, niveklabs/aws and suyog1pathak/eks source code examples are useful. See the Terraform Example section for further details.
For CloudFormation, the hobbit-project/neptune-system-adapter, rbilleci/aws-example-cloudformation and AlgernonSolutions/eventful_leech source code examples are useful. See the CloudFormation Example section for further details.
