AWS Fundamentals Logo
AWS Fundamentals
AWS::Neptune::DBCluster

Neptune DBCluster

The AWS::Neptune::DBCluster resource creates an Amazon Neptune DB cluster.

Properties

25 configurable properties. Click a row to see details.

Filter:
PropertyTypeFlags
AssociatedRoles
Array<DBClusterRole>
AvailabilityZones
Array<string>
Create-only
BackupRetentionPeriod
integer
CopyTagsToSnapshot
boolean
DBClusterIdentifier
string
Create-only
DBClusterParameterGroupName
string
DBInstanceParameterGroupName
string
Write-only
DBPort
integer
DBSubnetGroupName
string
Create-only
DeletionProtection
boolean
EnableCloudwatchLogsExports
Array<string>
EngineVersion
string
IamAuthEnabled
boolean
KmsKeyId
string
Create-only
PreferredBackupWindow
string
PreferredMaintenanceWindow
string
RestoreToTime
string
Create-onlyWrite-only
RestoreType
string
Create-onlyWrite-only
ServerlessScalingConfiguration
ServerlessScalingConfiguration
SnapshotIdentifier
string
Create-onlyWrite-only
SourceDBClusterIdentifier
string
Create-onlyWrite-only
StorageEncrypted
boolean
Create-only
Tags
Array<Tag>
UseLatestRestorableTime
boolean
Create-onlyWrite-only
VpcSecurityGroupIds
Array<string>

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

AttributeTypeDescription
ClusterResourceIdstringThe resource id for the DB cluster. For example: `cluster-ABCD1234EFGH5678IJKL90MNOP`. The cluster ID uniquely identifies the cluster and is used in things like IAM authentication policies.
EndpointstringThe connection endpoint for the DB cluster. For example: `mystack-mydbcluster-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com`
PortstringThe port number on which the DB cluster accepts connections. For example: `8182`.
ReadEndpointstringThe reader endpoint for the DB cluster. For example: `mystack-mydbcluster-ro-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com`

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml
AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::Neptune::DBCluster

Resources:
  MyResource:
    Type: AWS::Neptune::DBCluster
    Properties:
      Tags:
        - Key: Environment
          Value: Production

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

iam:PassRoleiam:CreateServiceLinkedRolerds:AddRoleToDBClusterrds:AddTagsToResourcerds:CreateDBClusterrds:CreateDBInstancerds:DescribeDBClustersrds:ListTagsForResource

read

rds:DescribeDBClustersrds:ListTagsForResourcekms:CreateGrantkms:DescribeKey

update

ec2:DescribeSecurityGroupsiam:PassRolerds:AddRoleToDBClusterrds:AddTagsToResourcerds:DescribeDBClustersrds:DescribeDBInstancesrds:DescribeDBSubnetGroupsrds:DescribeGlobalClusters

delete

rds:DeleteDBClusterrds:DeleteDBInstancerds:DescribeDBClustersrds:DescribeGlobalClustersrds:ListTagsForResourcerds:RemoveFromGlobalClusterrds:CreateDBClusterSnapshotkms:CreateGrant

list

rds:DescribeDBClustersrds:ListTagsForResourcekms:CreateGrantkms:DescribeKey

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

ServiceNeptune
Properties29
Required0
TaggingSupported
Primary IDDBClusterIdentifier

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

AvailabilityZonesDBClusterIdentifierDBSubnetGroupNameKmsKeyIdRestoreToTimeRestoreTypeSnapshotIdentifierSourceDBClusterIdentifierStorageEncryptedUseLatestRestorableTime

Related Resources

External Links