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
resource "aws_neptune_cluster_snapshot" "fiveDaysRetenPeriod" {
db_cluster_identifier = aws_neptune_cluster.fiveDaysRetenPeriod.id
db_cluster_snapshot_identifier = "resourcetestsnapshot1234"
}
resource "aws_neptune_cluster_snapshot" "fiveDaysRetenPeriod" {
db_cluster_identifier = aws_neptune_cluster.fiveDaysRetenPeriod.id
db_cluster_snapshot_identifier = "resourcetestsnapshot1234"
}
resource "aws_neptune_cluster_snapshot" "default" {
db_cluster_identifier = aws_neptune_cluster.default.id
db_cluster_snapshot_identifier = "resourcetestsnapshot1"
}
resource "aws_neptune_cluster_snapshot" "default" {
db_cluster_identifier = aws_neptune_cluster.default.id
db_cluster_snapshot_identifier = "resourcetestsnapshot1"
}
resource "aws_neptune_cluster_snapshot" "default" {
db_cluster_identifier = aws_neptune_cluster.default.id
db_cluster_snapshot_identifier = "resourcetestsnapshot1"
}
Parameters
-
allocated_storageoptional computed - number -
availability_zonesoptional computed - list of string -
db_cluster_identifierrequired - string -
db_cluster_snapshot_arnoptional computed - string -
db_cluster_snapshot_identifierrequired - string -
engineoptional computed - string -
engine_versionoptional computed - string -
idoptional computed - string -
kms_key_idoptional computed - string -
license_modeloptional computed - string -
portoptional computed - number -
snapshot_typeoptional computed - string -
source_db_cluster_snapshot_arnoptional computed - string -
statusoptional computed - string -
storage_encryptedoptional computed - bool -
vpc_idoptional computed - string -
timeoutssingle block-
createoptional - string
-
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
Type: AWS::Neptune::DBClusterParameterGroup
Properties:
Name: {{dbName}}
Description: {{description}}
Family: {{parameterGroupFamily}}
Parameters:
Type: "AWS::Neptune::DBCluster"
Properties:
DBClusterIdentifier: DBClusterIdentifier
NeptuneDBClusterEmpty:
Type: "AWS::Neptune::DBCluster"
Properties:
Type: "AWS::Neptune::DBCluster"
Properties:
DBClusterIdentifier: DBClusterIdentifier
NeptuneDBClusterEmpty:
Type: "AWS::Neptune::DBCluster"
Properties:
Type: "AWS::Neptune::DBCluster"
Properties:
DBClusterIdentifier: DBClusterIdentifier
NeptuneDBClusterEmpty:
Type: "AWS::Neptune::DBCluster"
Properties:
Type: "AWS::Neptune::DBCluster"
Properties:
DBClusterIdentifier: DBClusterIdentifier
NeptuneDBClusterEmpty:
Type: "AWS::Neptune::DBCluster"
Properties:
"Type": "AWS::Neptune::DBCluster",
"Properties": {
"StorageEncrypted": false
}
},
"ENeptuneDBClusterStorageEncryptedSecondary": {
"Type": "AWS::Neptune::DBCluster",
"Properties": {
"IamAuthEnabled": false,
"StorageEncrypted": true
}
},
"Type": "AWS::Neptune::DBCluster",
"Properties": {
"IamAuthEnabled": true,
"StorageEncrypted": true
}
}
"Type" : "AWS::Neptune::DBCluster",
"Properties" : {
"DBClusterIdentifier" : "String",
"EnableCloudwatchLogsExports" : [],
"KmsKeyId" : "String",
"Port" : 10000,
"Type" : "AWS::Neptune::DBCluster",
"Properties" : {
"DBClusterIdentifier" : "String",
"EnableCloudwatchLogsExports" : [],
"KmsKeyId" : "String",
"Port" : 10000,
Parameters
-
StorageEncryptedoptional - Boolean -
RestoreToTimeoptional - String -
EngineVersionoptional - String -
KmsKeyIdoptional - String -
AssociatedRolesoptional - List of DBClusterRole -
AvailabilityZonesoptional - List -
SnapshotIdentifieroptional - String -
Portoptional - Integer -
DBClusterIdentifieroptional - String -
PreferredMaintenanceWindowoptional - String -
IamAuthEnabledoptional - Boolean -
DBSubnetGroupNameoptional - String -
DeletionProtectionoptional - Boolean -
PreferredBackupWindowoptional - String -
UseLatestRestorableTimeoptional - Boolean -
VpcSecurityGroupIdsoptional - List -
SourceDBClusterIdentifieroptional - String -
DBClusterParameterGroupNameoptional - String -
BackupRetentionPeriodoptional - Integer -
RestoreTypeoptional - String -
Tagsoptional - List of Tag -
EnableCloudwatchLogsExportsoptional - List
Explanation in CloudFormation Registry
The
AWS::Neptune::DBClusterresource 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
DeletionPolicyis set forAWS::Neptune::DBClusterresources, the default deletion behavior is that the entire volume will be deleted without a snapshot. To retain a backup of the volume, theDeletionPolicyshould be set toSnapshot. For more information about how AWS CloudFormation deletes resources, see DeletionPolicy Attribute.You can use
AWS::Neptune::DBCluster.DeletionProtectionto 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, melscoop-test/check and SnidermanIndustries/checkov-fork source code examples are useful. See the CloudFormation Example section for further details.
