AWS Amazon Neptune Parameter Group

This page shows how to write Terraform and CloudFormation for Amazon Neptune Parameter Group and write them securely.

aws_neptune_parameter_group (Terraform)

The Parameter Group in Amazon Neptune can be configured in Terraform with the resource name aws_neptune_parameter_group. The following sections describe 4 examples of how to use the resource and its parameters.

Example Usage from GitHub

main.tf#L7
resource "aws_neptune_parameter_group" "this" {
  description = var.description
  family      = var.family
  name        = var.name
  tags        = var.tags

aws_neptune_parameter_group.examplea.tf#L1
resource "aws_neptune_parameter_group" "examplea" {
  family = "neptune1"
  name   = "example"

  parameter {
    name  = "neptune_query_timeout"
ParameterGroups.tf#L1
resource "aws_neptune_parameter_group" "dbParameterGroup" {
  name   = format("%s-%s-%s-%s",lookup(var.data, "name"),lookup(var.tags, "product"),lookup(var.tags, "env"),"neptunedb-parametergroup")
  family = lookup(var.data, "family")


  count = length(var.data.dbParameterGroup)
main.tf#L7
resource "aws_neptune_parameter_group" "neptune_parameter_group" {
  count  = length(var.neptune_param_group)
  family = lookup(var.neptune_param_group[count.index], "family")
  name   = lookup(var.neptune_param_group[count.index], "name")

  dynamic "parameter" {

Review your Terraform file for AWS best practices

Shisho Cloud, our free checker to make sure your Terraform configuration follows best practices, is available (beta).

Parameters

Explanation in Terraform Registry

Manages a Neptune Parameter Group

AWS::Neptune::DBParameterGroup (CloudFormation)

The DBParameterGroup in Neptune can be configured in CloudFormation with the resource name AWS::Neptune::DBParameterGroup. The following sections describe 10 examples of how to use the resource and its parameters.

Example Usage from GitHub

product.template-me-south-1.yaml#L15
    Type: AWS::Neptune::DBParameterGroup
    Description: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbparametergroup.html
    Properties:
      Description: !Ref 'Description'
      Parameters: !Ref 'Parameters'
      Family: !Ref 'Family'
product.template-us-east-1.yaml#L15
    Type: AWS::Neptune::DBParameterGroup
    Description: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbparametergroup.html
    Properties:
      Description: !Ref 'Description'
      Parameters: !Ref 'Parameters'
      Family: !Ref 'Family'
product.template-us-east-2.yaml#L15
    Type: AWS::Neptune::DBParameterGroup
    Description: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbparametergroup.html
    Properties:
      Description: !Ref 'Description'
      Parameters: !Ref 'Parameters'
      Family: !Ref 'Family'
product.template-eu-west-1.yaml#L15
    Type: AWS::Neptune::DBParameterGroup
    Description: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbparametergroup.html
    Properties:
      Description: !Ref 'Description'
      Parameters: !Ref 'Parameters'
      Family: !Ref 'Family'
product.template-eu-west-3.yaml#L15
    Type: AWS::Neptune::DBParameterGroup
    Description: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbparametergroup.html
    Properties:
      Description: !Ref 'Description'
      Parameters: !Ref 'Parameters'
      Family: !Ref 'Family'
NeptuneDBParameterGroupSpecification.json#L22
    "AWS::Neptune::DBParameterGroup": {
      "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbparametergroup.html",
      "Properties": {
        "Description": {
          "Required": true,
          "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbparametergroup.html#cfn-neptune-dbparametergroup-description",
NeptuneDBParameterGroupSpecification.json#L22
    "AWS::Neptune::DBParameterGroup": {
      "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbparametergroup.html",
      "Properties": {
        "Description": {
          "Required": true,
          "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbparametergroup.html#cfn-neptune-dbparametergroup-description",
NeptuneDBParameterGroupSpecification.json#L22
    "AWS::Neptune::DBParameterGroup": {
      "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbparametergroup.html",
      "Properties": {
        "Description": {
          "Required": true,
          "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbparametergroup.html#cfn-neptune-dbparametergroup-description",
NeptuneDBParameterGroupSpecification.json#L22
    "AWS::Neptune::DBParameterGroup": {
      "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbparametergroup.html",
      "Properties": {
        "Description": {
          "Required": true,
          "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbparametergroup.html#cfn-neptune-dbparametergroup-description",
NeptuneDBParameterGroupSpecification.json#L22
    "AWS::Neptune::DBParameterGroup": {
      "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbparametergroup.html",
      "Properties": {
        "Description": {
          "Required": true,
          "Documentation": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbparametergroup.html#cfn-neptune-dbparametergroup-description",

Parameters

Explanation in CloudFormation Registry

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.

Note Applying a parameter group to a DB instance might require the instance to reboot, resulting in a database outage for the duration of the reboot.

A DB parameter group is initially created with the default parameters for the database engine used by the DB instance. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBParameterGroup. Once you've created a DB parameter group, you need to associate it with your DB instance using ModifyDBInstance. When you associate a new DB parameter group with a running DB instance, you need to reboot the DB instance without failover for the new DB parameter group and associated settings to take effect.

Important After you create a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB 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 instance. This is especially important for parameters that are critical when creating the default database for a DB instance, 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 DescribeDBParameters command to verify that your DB parameter group has been created or modified.

Frequently asked questions

What is AWS Amazon Neptune Parameter Group?

AWS Amazon Neptune 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 Parameter Group?

For Terraform, the niveklabs/aws, JamesWoolfenden/terraform-aws-neptune and suyog1pathak/eks source code examples are useful. See the Terraform Example section for further details.

For CloudFormation, the awslabs/aws-service-catalog-products, awslabs/aws-service-catalog-products and awslabs/aws-service-catalog-products source code examples are useful. See the CloudFormation Example section for further details.