L1 ConstructAWS::Neptune::DBCluster

CfnDBCluster

The `AWS::Neptune::DBCluster` resource creates an Amazon Neptune DB cluster. Neptune is a fully managed graph database. > 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 CloudFormation deletes resources, see [DeletionPolicy Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html) . You can use `AWS::Neptune::DBCluster.DeletionProtection` to help guard against unintended deletion of your DB cluster.

Import

import { CfnDBCluster } from 'aws-cdk-lib/aws-neptune';

Or use the module namespace:

import * as neptune from 'aws-cdk-lib/aws-neptune';
// neptune.CfnDBCluster

Properties

Configuration passed to the constructor as CfnDBClusterProps.

associatedRolesOptional

IResolvable | IResolvable | DBClusterRoleProperty[]

Provides a list of the Amazon Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon services on your behalf.

availabilityZonesOptional

string[]

Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.

backupRetentionPeriodOptional

number

Specifies the number of days for which automatic DB snapshots are retained. An update may require some interruption. See [ModifyDBInstance](https://docs.aws.amazon.com/neptune/latest/userguide/api-instances.html#ModifyDBInstance) in the Amazon Neptune User Guide for more information.

Default: - 1

copyTagsToSnapshotOptional

boolean | IResolvable

*If set to `true` , tags are copied to any snapshot of the DB cluster that is created.*.

dbClusterIdentifierOptional

string

Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.

dbClusterParameterGroupNameOptional

string

Provides the name of the DB cluster parameter group. An update may require some interruption. See [ModifyDBInstance](https://docs.aws.amazon.com/neptune/latest/userguide/api-instances.html#ModifyDBInstance) in the Amazon Neptune User Guide for more information.

dbInstanceParameterGroupNameOptional

string

The name of the DB parameter group to apply to all instances of the DB cluster. Used only in case of a major engine version upgrade request Note that when you apply a parameter group using `DBInstanceParameterGroupName` , parameter changes are applied immediately, not during the next maintenance window. **Constraints** - The DB parameter group must be in the same DB parameter group family as the target DB cluster version. - The `DBInstanceParameterGroupName` parameter is only valid for major engine version upgrades.

dbPortOptional

number

The port number on which the DB instances in the DB cluster accept connections. If not specified, the default port used is `8182` . > The `Port` property will soon be deprecated. Please update existing templates to use the new `DBPort` property that has the same functionality.

dbSubnetGroupNameOptional

string

Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.

deletionProtectionOptional

boolean | IResolvable

Indicates whether or not the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.

enableCloudwatchLogsExportsOptional

string[]

Specifies a list of log types that are enabled for export to CloudWatch Logs.

engineVersionOptional

string

Indicates the database engine version.

iamAuthEnabledOptional

boolean | IResolvable

True if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

kmsKeyIdOptional

string | IKeyRef

The Amazon Resource Name (ARN) of the KMS 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 KMS key is used. If you specify this property, you must set the `StorageEncrypted` property to `true` .

preferredBackupWindowOptional

string

Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the `BackupRetentionPeriod` . An update may require some interruption.

preferredMaintenanceWindowOptional

string

Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

restoreToTimeOptional

string

Creates a new DB cluster from a DB snapshot or DB cluster snapshot. If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group. If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.

restoreTypeOptional

string

Default: - "full-copy"

serverlessScalingConfigurationOptional

IResolvable | ServerlessScalingConfigurationProperty

Contains the scaling configuration of an Neptune Serverless DB cluster.

snapshotIdentifierOptional

string

Specifies the identifier for a DB cluster snapshot. Must match the identifier of an existing snapshot. After you restore a DB cluster using a `SnapshotIdentifier` , you must specify the same `SnapshotIdentifier` for any future updates to the DB cluster. When you specify this property for an update, the DB cluster is not restored from the snapshot again, and the data in the database is not changed. However, if you don't specify the `SnapshotIdentifier` , an empty DB cluster is created, and the original DB cluster is deleted. If you specify a property that is different from the previous snapshot restore property, the DB cluster is restored from the snapshot specified by the `SnapshotIdentifier` , and the original DB cluster is deleted.

sourceDbClusterIdentifierOptional

string

storageEncryptedOptional

boolean | IResolvable

Indicates whether the DB cluster is encrypted. If you specify the `KmsKeyId` property, then you must enable encryption and set this property to `true` . If you enable the `StorageEncrypted` property but don't specify the `KmsKeyId` property, then the default KMS key is used. If you specify the `KmsKeyId` property, then that KMS key is used to encrypt the database instances in the DB cluster. If you specify the `SourceDBClusterIdentifier` property, and don't specify this property or disable it, the value is inherited from the source DB cluster. If the source DB cluster is encrypted, the `KmsKeyId` property from the source cluster is used. If you specify the `DBSnapshotIdentifier` and don't specify this property or disable it, the value is inherited from the snapshot and the specified `KmsKeyId` property from the snapshot is used.

tagsOptional

CfnTag[]

The tags assigned to this cluster.

useLatestRestorableTimeOptional

boolean | IResolvable

vpcSecurityGroupIdsOptional

string | ISecurityGroupRef[]

Provides a list of VPC security groups that the DB cluster belongs to.

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

AWS::Neptune::DBClusterView in CloudFormation Explorer

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

LevelL1 (CloudFormation)

Moduleaws-neptune

CFN TypeAWS::Neptune::DBCluster

Properties25

Related Constructs

Explore This Service

External Links

CDK API Documentation