Class CfnDBCluster

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

Inheritance
object
CfnElement
CfnRefElement
CfnResource
CfnDBCluster
Implements
IConstruct
IDependable
Inherited Members
Namespace: Amazon.CDK.AWS.Neptune
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnDBCluster : CfnResource, IInspectable, IDBClusterRef, IConstruct, IDependable, IEnvironmentAware, ITaggable
Syntax (vb)
Public Class CfnDBCluster Inherits CfnResource Implements IInspectable, IDBClusterRef, IConstruct, IDependable, IEnvironmentAware, ITaggable
Remarks
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 .

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html

CloudformationResource: AWS::Neptune::DBCluster

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Neptune;

             var cfnDBCluster = new CfnDBCluster(this, "MyCfnDBCluster", new CfnDBClusterProps {
                 AssociatedRoles = new [] { new DBClusterRoleProperty {
                     RoleArn = "roleArn",

                     // the properties below are optional
                     FeatureName = "featureName"
                 } },
                 AvailabilityZones = new [] { "availabilityZones" },
                 BackupRetentionPeriod = 123,
                 CopyTagsToSnapshot = false,
                 DbClusterIdentifier = "dbClusterIdentifier",
                 DbClusterParameterGroupName = "dbClusterParameterGroupName",
                 DbInstanceParameterGroupName = "dbInstanceParameterGroupName",
                 DbPort = 123,
                 DbSubnetGroupName = "dbSubnetGroupName",
                 DeletionProtection = false,
                 EnableCloudwatchLogsExports = new [] { "enableCloudwatchLogsExports" },
                 EngineVersion = "engineVersion",
                 IamAuthEnabled = false,
                 KmsKeyId = "kmsKeyId",
                 PreferredBackupWindow = "preferredBackupWindow",
                 PreferredMaintenanceWindow = "preferredMaintenanceWindow",
                 RestoreToTime = "restoreToTime",
                 RestoreType = "restoreType",
                 ServerlessScalingConfiguration = new ServerlessScalingConfigurationProperty {
                     MaxCapacity = 123,
                     MinCapacity = 123
                 },
                 SnapshotIdentifier = "snapshotIdentifier",
                 SourceDbClusterIdentifier = "sourceDbClusterIdentifier",
                 StorageEncrypted = false,
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 UseLatestRestorableTime = false,
                 VpcSecurityGroupIds = new [] { "vpcSecurityGroupIds" }
             });

Synopsis

Constructors

CfnDBCluster(Construct, string, ICfnDBClusterProps?)

Create a new AWS::Neptune::DBCluster.

Properties

AssociatedRoles

Provides a list of the Amazon Identity and Access Management (IAM) roles that are associated with the DB cluster.
AttrClusterResourceId

The resource id for the DB cluster.
AttrEndpoint

The connection endpoint for the DB cluster.
AttrPort

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

The reader endpoint for the DB cluster.
AvailabilityZones

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

Specifies the number of days for which automatic DB snapshots are retained.
CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.
CfnProperties

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

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

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

Contains a user-supplied DB cluster identifier.
DbClusterParameterGroupName

Provides the name of the DB cluster parameter group.
DbClusterRef

A reference to a DBCluster resource.
DbInstanceParameterGroupName

The name of the DB parameter group to apply to all instances of the DB cluster.
DbPort

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

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

Indicates whether or not the DB cluster has deletion protection enabled.
EnableCloudwatchLogsExports

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

Indicates the database engine version.
IamAuthEnabled

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

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

Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod .
PreferredMaintenanceWindow

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

Creates a new DB cluster from a DB snapshot or DB cluster snapshot.
RestoreType

Creates a new DB cluster from a DB snapshot or DB cluster snapshot.
ServerlessScalingConfiguration

Contains the scaling configuration of an Neptune Serverless DB cluster.
SnapshotIdentifier

Specifies the identifier for a DB cluster snapshot.
SourceDbClusterIdentifier

Creates a new DB cluster from a DB snapshot or DB cluster snapshot.
StorageEncrypted

Indicates whether the DB cluster is encrypted.
Tags

Tag Manager which manages the tags for this resource.
TagsRaw

The tags assigned to this cluster.
UseLatestRestorableTime

Creates a new DB cluster from a DB snapshot or DB cluster snapshot.
VpcSecurityGroupIds

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

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.
IsCfnDBCluster(object)

Checks whether the given object is a CfnDBCluster.
RenderProperties(IDictionary<string, object>)

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

Constructors

CfnDBCluster(Construct, string, ICfnDBClusterProps?)

Create a new AWS::Neptune::DBCluster.

public CfnDBCluster(Construct scope, string id, ICfnDBClusterProps? props = null)
Parameters
scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnDBClusterProps

Resource properties.

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

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html

CloudformationResource: AWS::Neptune::DBCluster

ExampleMetadata: fixture=_generated

Properties

AssociatedRoles

Provides a list of the Amazon Identity and Access Management (IAM) roles that are associated with the DB cluster.

public virtual object? AssociatedRoles { get; set; }
Property Value

object

Remarks

Type union: either IResolvable or (either IResolvable or CfnDBCluster.IDBClusterRoleProperty)[]

AttrClusterResourceId

The resource id for the DB cluster.

public virtual string AttrClusterResourceId { get; }
Property Value

string

Remarks

For example: cluster-ABCD1234EFGH5678IJKL90MNOP . The cluster ID uniquely identifies the cluster and is used in things like IAM authentication policies.

CloudformationAttribute: ClusterResourceId

AttrEndpoint

The connection endpoint for the DB cluster.

public virtual string AttrEndpoint { get; }
Property Value

string

Remarks

For example: mystack-mydbcluster-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com

CloudformationAttribute: Endpoint

AttrPort

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

public virtual string AttrPort { get; }
Property Value

string

Remarks

CloudformationAttribute: Port

AttrReadEndpoint

The reader endpoint for the DB cluster.

public virtual string AttrReadEndpoint { get; }
Property Value

string

Remarks

For example: mystack-mydbcluster-ro-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com

CloudformationAttribute: ReadEndpoint

AvailabilityZones

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

public virtual string[]? AvailabilityZones { get; set; }
Property Value

string[]

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

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html

CloudformationResource: AWS::Neptune::DBCluster

ExampleMetadata: fixture=_generated

BackupRetentionPeriod

Specifies the number of days for which automatic DB snapshots are retained.

public virtual double? BackupRetentionPeriod { get; set; }
Property Value

double?

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

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html

CloudformationResource: AWS::Neptune::DBCluster

ExampleMetadata: fixture=_generated

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value

string

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

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html

CloudformationResource: AWS::Neptune::DBCluster

ExampleMetadata: fixture=_generated

CfnProperties

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

protected override IDictionary<string, object> CfnProperties { get; }
Property Value

IDictionary<string, object>

Overrides
Remarks
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 .

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html

CloudformationResource: AWS::Neptune::DBCluster

ExampleMetadata: fixture=_generated

CfnPropertyNames

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

protected override IDictionary<string, string> CfnPropertyNames { get; }
Property Value

IDictionary<string, string>

Overrides
Remarks
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 .

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html

CloudformationResource: AWS::Neptune::DBCluster

ExampleMetadata: fixture=_generated

CopyTagsToSnapshot

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

public virtual object? CopyTagsToSnapshot { get; set; }
Property Value

object

Remarks

Type union: either bool or IResolvable

DbClusterIdentifier

Contains a user-supplied DB cluster identifier.

public virtual string? DbClusterIdentifier { get; set; }
Property Value

string

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

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html

CloudformationResource: AWS::Neptune::DBCluster

ExampleMetadata: fixture=_generated

DbClusterParameterGroupName

Provides the name of the DB cluster parameter group.

public virtual string? DbClusterParameterGroupName { get; set; }
Property Value

string

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

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html

CloudformationResource: AWS::Neptune::DBCluster

ExampleMetadata: fixture=_generated

DbClusterRef

A reference to a DBCluster resource.

public virtual IDBClusterReference DbClusterRef { get; }
Property Value

IDBClusterReference

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

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html

CloudformationResource: AWS::Neptune::DBCluster

ExampleMetadata: fixture=_generated

DbInstanceParameterGroupName

The name of the DB parameter group to apply to all instances of the DB cluster.

public virtual string? DbInstanceParameterGroupName { get; set; }
Property Value

string

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

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html

CloudformationResource: AWS::Neptune::DBCluster

ExampleMetadata: fixture=_generated

DbPort

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

public virtual double? DbPort { get; set; }
Property Value

double?

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

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html

CloudformationResource: AWS::Neptune::DBCluster

ExampleMetadata: fixture=_generated

DbSubnetGroupName

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

public virtual string? DbSubnetGroupName { get; set; }
Property Value

string

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

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html

CloudformationResource: AWS::Neptune::DBCluster

ExampleMetadata: fixture=_generated

DeletionProtection

Indicates whether or not the DB cluster has deletion protection enabled.

public virtual object? DeletionProtection { get; set; }
Property Value

object

Remarks

Type union: either bool or IResolvable

EnableCloudwatchLogsExports

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

public virtual string[]? EnableCloudwatchLogsExports { get; set; }
Property Value

string[]

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

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html

CloudformationResource: AWS::Neptune::DBCluster

ExampleMetadata: fixture=_generated

EngineVersion

Indicates the database engine version.

public virtual string? EngineVersion { get; set; }
Property Value

string

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

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html

CloudformationResource: AWS::Neptune::DBCluster

ExampleMetadata: fixture=_generated

IamAuthEnabled

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

public virtual object? IamAuthEnabled { get; set; }
Property Value

object

Remarks

Type union: either bool or IResolvable

KmsKeyId

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 .

public virtual string? KmsKeyId { get; set; }
Property Value

string

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

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html

CloudformationResource: AWS::Neptune::DBCluster

ExampleMetadata: fixture=_generated

PreferredBackupWindow

Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod .

public virtual string? PreferredBackupWindow { get; set; }
Property Value

string

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

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html

CloudformationResource: AWS::Neptune::DBCluster

ExampleMetadata: fixture=_generated

PreferredMaintenanceWindow

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

public virtual string? PreferredMaintenanceWindow { get; set; }
Property Value

string

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

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html

CloudformationResource: AWS::Neptune::DBCluster

ExampleMetadata: fixture=_generated

RestoreToTime

Creates a new DB cluster from a DB snapshot or DB cluster snapshot.

public virtual string? RestoreToTime { get; set; }
Property Value

string

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

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html

CloudformationResource: AWS::Neptune::DBCluster

ExampleMetadata: fixture=_generated

RestoreType

Creates a new DB cluster from a DB snapshot or DB cluster snapshot.

public virtual string? RestoreType { get; set; }
Property Value

string

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

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html

CloudformationResource: AWS::Neptune::DBCluster

ExampleMetadata: fixture=_generated

ServerlessScalingConfiguration

Contains the scaling configuration of an Neptune Serverless DB cluster.

public virtual object? ServerlessScalingConfiguration { get; set; }
Property Value

object

Remarks

Type union: either IResolvable or CfnDBCluster.IServerlessScalingConfigurationProperty

SnapshotIdentifier

Specifies the identifier for a DB cluster snapshot.

public virtual string? SnapshotIdentifier { get; set; }
Property Value

string

Remarks

Must match the identifier of an existing snapshot.

SourceDbClusterIdentifier

Creates a new DB cluster from a DB snapshot or DB cluster snapshot.

public virtual string? SourceDbClusterIdentifier { get; set; }
Property Value

string

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

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html

CloudformationResource: AWS::Neptune::DBCluster

ExampleMetadata: fixture=_generated

StorageEncrypted

Indicates whether the DB cluster is encrypted.

public virtual object? StorageEncrypted { get; set; }
Property Value

object

Remarks

Type union: either bool or IResolvable

Tags

Tag Manager which manages the tags for this resource.

public virtual TagManager Tags { get; }
Property Value

TagManager

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

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html

CloudformationResource: AWS::Neptune::DBCluster

ExampleMetadata: fixture=_generated

TagsRaw

The tags assigned to this cluster.

public virtual ICfnTag[]? TagsRaw { get; set; }
Property Value

ICfnTag[]

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

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html

CloudformationResource: AWS::Neptune::DBCluster

ExampleMetadata: fixture=_generated

UseLatestRestorableTime

Creates a new DB cluster from a DB snapshot or DB cluster snapshot.

public virtual object? UseLatestRestorableTime { get; set; }
Property Value

object

Remarks

Type union: either bool or IResolvable

VpcSecurityGroupIds

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

public virtual string[]? VpcSecurityGroupIds { get; set; }
Property Value

string[]

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

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html

CloudformationResource: AWS::Neptune::DBCluster

ExampleMetadata: fixture=_generated

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)
Parameters
inspector TreeInspector

tree inspector to collect and process attributes.

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

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html

CloudformationResource: AWS::Neptune::DBCluster

ExampleMetadata: fixture=_generated

IsCfnDBCluster(object)

Checks whether the given object is a CfnDBCluster.

public static bool IsCfnDBCluster(object x)
Parameters
x object
Returns

bool

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

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html

CloudformationResource: AWS::Neptune::DBCluster

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

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

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
props IDictionary<string, object>
Returns

IDictionary<string, object>

Overrides
Remarks
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 .

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbcluster.html

CloudformationResource: AWS::Neptune::DBCluster

ExampleMetadata: fixture=_generated

Implements

Constructs.IConstruct
Constructs.IDependable