AWS Amazon Neptune Cluster Snapshot

This page shows how to write Terraform and CloudFormation for Amazon Neptune Cluster Snapshot and write them securely.

aws_neptune_cluster_snapshot (Terraform)

The Cluster Snapshot in Amazon Neptune can be configured in Terraform with the resource name aws_neptune_cluster_snapshot. The following sections describe 5 examples of how to use the resource and its parameters.

Example Usage from GitHub

neptune_cluster_snapshot_test.tf#L23
resource "aws_neptune_cluster_snapshot" "fiveDaysRetenPeriod" {
  db_cluster_identifier          = aws_neptune_cluster.fiveDaysRetenPeriod.id
  db_cluster_snapshot_identifier = "resourcetestsnapshot1234"
}


neptune_cluster_snapshot_test.tf#L23
resource "aws_neptune_cluster_snapshot" "fiveDaysRetenPeriod" {
  db_cluster_identifier          = aws_neptune_cluster.fiveDaysRetenPeriod.id
  db_cluster_snapshot_identifier = "resourcetestsnapshot1234"
}


neptune.tf#L21
resource "aws_neptune_cluster_snapshot" "default" {
  db_cluster_identifier               = aws_neptune_cluster.default.id
  db_cluster_snapshot_identifier      = "resourcetestsnapshot1"
}

neptune.tf#L21
resource "aws_neptune_cluster_snapshot" "default" {
  db_cluster_identifier               = aws_neptune_cluster.default.id
  db_cluster_snapshot_identifier      = "resourcetestsnapshot1"
}

neptune.tf#L21
resource "aws_neptune_cluster_snapshot" "default" {
  db_cluster_identifier               = aws_neptune_cluster.default.id
  db_cluster_snapshot_identifier      = "resourcetestsnapshot1"
}

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 database cluster snapshot.

AWS::Neptune::DBCluster (CloudFormation)

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

Example Usage from GitHub

neptune-template.yml#L7
    Type: AWS::Neptune::DBClusterParameterGroup
    Properties:
      Name: {{dbName}}
      Description: {{description}}
      Family: {{parameterGroupFamily}}
      Parameters:
NeptuneClusterLogging-FAILED.yml#L4
    Type: "AWS::Neptune::DBCluster"
    Properties:
      DBClusterIdentifier: DBClusterIdentifier
  NeptuneDBClusterEmpty:
    Type: "AWS::Neptune::DBCluster"
    Properties:
NeptuneClusterLogging-FAILED.yml#L4
    Type: "AWS::Neptune::DBCluster"
    Properties:
      DBClusterIdentifier: DBClusterIdentifier
  NeptuneDBClusterEmpty:
    Type: "AWS::Neptune::DBCluster"
    Properties:
NeptuneClusterLogging-FAILED.yml#L4
    Type: "AWS::Neptune::DBCluster"
    Properties:
      DBClusterIdentifier: DBClusterIdentifier
  NeptuneDBClusterEmpty:
    Type: "AWS::Neptune::DBCluster"
    Properties:
NeptuneClusterLogging-FAILED.yml#L4
    Type: "AWS::Neptune::DBCluster"
    Properties:
      DBClusterIdentifier: DBClusterIdentifier
  NeptuneDBClusterEmpty:
    Type: "AWS::Neptune::DBCluster"
    Properties:
positive2.json#L6
      "Type": "AWS::Neptune::DBCluster",
      "Properties": {
        "IamAuthEnabled": false,
        "StorageEncrypted": true
      }
    },
negative2.json#L6
      "Type": "AWS::Neptune::DBCluster",
      "Properties": {
        "IamAuthEnabled": true,
        "StorageEncrypted": true
      }
    }
ENeptuneDBClusterStorageEncrypted.json#L6
      "Type": "AWS::Neptune::DBCluster",
      "Properties": {
        "StorageEncrypted": false
      }
    },
    "ENeptuneDBClusterStorageEncryptedSecondary": {
deploy.json#L5
      "Type" : "AWS::Neptune::DBCluster",
      "Properties" : {
          "DBClusterIdentifier" : "String",
          "EnableCloudwatchLogsExports" : [],
          "KmsKeyId" : "String",
          "Port" : 10000,
deploy.json#L5
      "Type" : "AWS::Neptune::DBCluster",
      "Properties" : {
          "DBClusterIdentifier" : "String",
          "EnableCloudwatchLogsExports" : [],
          "KmsKeyId" : "String",
          "Port" : 10000,

Parameters

Explanation in CloudFormation Registry

The AWS::Neptune::DBCluster resource creates an Amazon Neptune DB cluster. Neptune is a fully managed graph database.

Note Currently, you can create this resource only in AWS Regions in which Amazon Neptune is supported.

If no DeletionPolicy is set for AWS::Neptune::DBCluster resources, the default deletion behavior is that the entire volume will be deleted without a snapshot. To retain a backup of the volume, the DeletionPolicy should be set to Snapshot. For more information about how AWS CloudFormation deletes resources, see DeletionPolicy Attribute.

You can use AWS::Neptune::DBCluster.DeletionProtection to help guard against unintended deletion of your DB cluster.

Frequently asked questions

What is AWS Amazon Neptune Cluster Snapshot?

AWS Amazon Neptune Cluster Snapshot 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 Snapshot?

For Terraform, the gilyas/infracost, infracost/infracost and gopal1cloud/appsec-terraform source code examples are useful. See the Terraform Example section for further details.

For CloudFormation, the byu-oit/handel, bridgecrewio/checkov and SnidermanIndustries/checkov-fork source code examples are useful. See the CloudFormation Example section for further details.