Sign In to the Console
AWS CloudFormation
User Guide (API Version 2010-05-15)

AWS Documentation » AWS CloudFormation » User Guide » Template Reference » AWS Resource and Property Types Reference » Amazon Neptune Resource Types Reference » AWS::Neptune::DBCluster

AWS::Neptune::DBCluster

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.

The default DeletionPolicy for AWS::Neptune::DBCluster resources is Snapshot. For more information about how AWS CloudFormation deletes resources, see DeletionPolicy Attribute.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::Neptune::DBCluster",
  "Properties" :
  {
    "AvailabilityZones" : [ String, ... ],
    "BackupRetentionPeriod" : Integer,
    "DBClusterIdentifier" : String,
    "DBClusterParameterGroupName" : String,
    "DBSubnetGroupName" : String,
    "IamAuthEnabled" : Boolean,
    "KmsKeyId" : String,
    "Port" : Integer,
    "PreferredBackupWindow" : String,
    "PreferredMaintenanceWindow" : String,
    "SnapshotIdentifier" : String,
    "StorageEncrypted" : Boolean,
    "Tags" : [ Resource Tag, ... ],
    "VpcSecurityGroupIds" : [ String, ... ]
  }
}

YAML

Type: "AWS::Neptune::DBCluster"
Properties:
  AvailabilityZones:
    - String
  BackupRetentionPeriod: Integer
  DBClusterIdentifier: String
  DBClusterParameterGroupName: String
  DBSubnetGroupName: String
  IamAuthEnabled: Boolean
  KmsKeyId: String
  Port: Integer
  PreferredBackupWindow: String
  PreferredMaintenanceWindow: String
  SnapshotIdentifier: String
  StorageEncrypted: Boolean
  Tags:
    - Resource Tag
  VpcSecurityGroupIds:
    - String

Properties

AvailabilityZones

A list of Availability Zones in which DB instances in the cluster can be created.

Required: No

Type: String

Update requires: Replacement

BackupRetentionPeriod

The number of days for which automatic backups are retained. For more information, see CreateDBCluster in the Amazon Neptune User Guide.

Required: No

Type: Integer

Update requires: No interruption or some interruption. For more information, see ModifyDBInstance in the Amazon Neptune User Guide.

DBClusterIdentifier

The DB cluster identifier. This parameter is stored as a lowercase string.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.

  • First character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Required: No

Type: String

Update requires: Replacement

DBClusterParameterGroupName

The name of the DB cluster parameter group to associate with this DB cluster.

Required: No

Type: String

Update requires: Some interruptions

DBSubnetGroupName

A DB subnet group that you want to associate with this DB cluster.

Required: No

Type: String

Update requires: Replacement

IamAuthEnabled

Enable IAM authentication and authorization on this cluster.

Type: Boolean

Update requires: No interruption

KmsKeyId

The Amazon Resource Name (ARN) of the AWS Key Management Service (AWS KMS) master key that is used to encrypt the database instances in the DB cluster, such as arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef. If you enable the StorageEncrypted property but don't specify this property, the default master key is used. If you specify this property, you must set the StorageEncrypted property to true.

If you specify the SnapshotIdentifier, do not specify this property. The value is inherited from the snapshot DB cluster.

Required: No

Type: String

Update requires: Replacement.

Port

The port number on which the DB instances in the cluster can accept connections.

Required: No

Type: Integer

Update requires: No interruption

PreferredBackupWindow

If automated backups are enabled (see the BackupRetentionPeriod property), the daily time range in UTC during which you want to create automated backups.

For valid values, see the PreferredBackupWindow parameter of the CreateDBInstance action.

Required: No

Type: String

Update requires: No interruption

PreferredMaintenanceWindow

The weekly time range (in UTC) during which system maintenance can occur.

For valid values, see the PreferredMaintenanceWindow parameter of the CreateDBInstance action.

Required: No

Type: String

Update requires: No interruption or some interruption. For more information, see ModifyDBInstance.

SnapshotIdentifier

The identifier for the DB cluster snapshot from which you want to restore.

Required: No

Type: String

Update requires: Replacement

StorageEncrypted

Indicates whether the DB instances in the cluster are encrypted.

If you specify the SnapshotIdentifier property, do not specify this property. The value is inherited from the snapshot DB cluster.

Required: Conditional. If you specify the KmsKeyId property, you must enable encryption.

Type: Boolean

Update requires: Replacement

Tags

The tags that you want to attach to this DB cluster.

Required: No

Type: A list of resource tags.

Update requires: No interruption

VpcSecurityGroupIds

A list of VPC security groups to associate with this DB cluster.

Required: No

Type: List of String values

Update requires: No interruption

Return Values

Ref

When the logical ID of this resource is provided to the Ref intrinsic function, Ref returns the resource name.

For more information about using the Ref function, see Ref.

Fn::GetAtt

Fn::GetAtt returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

Endpoint

The connection endpoint for the DB cluster. For example: mystack-mydbcluster-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com

Port

The port number on which the DB cluster accepts connections. For example: 8182

ReadEndpoint

The reader endpoint for the DB cluster. For example: mystack-mydbcluster-ro-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com

ClusterResourceId

The 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.

For more information about using Fn::GetAtt, see Fn::GetAtt.