interface CfnDBInstanceProps

Language	Type name
.NET	`Amazon.CDK.AWS.Neptune.CfnDBInstanceProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsneptune#CfnDBInstanceProps`
Java	`software.amazon.awscdk.services.neptune.CfnDBInstanceProps`
Python	`aws_cdk.aws_neptune.CfnDBInstanceProps`
TypeScript	`aws-cdk-lib` » `aws_neptune` » `CfnDBInstanceProps`

Properties for defining a CfnDBInstance.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_neptune as neptune } from 'aws-cdk-lib';
const cfnDBInstanceProps: neptune.CfnDBInstanceProps = {
  dbInstanceClass: 'dbInstanceClass',

  // the properties below are optional
  allowMajorVersionUpgrade: false,
  autoMinorVersionUpgrade: false,
  availabilityZone: 'availabilityZone',
  dbClusterIdentifier: 'dbClusterIdentifier',
  dbInstanceIdentifier: 'dbInstanceIdentifier',
  dbParameterGroupName: 'dbParameterGroupName',
  dbSnapshotIdentifier: 'dbSnapshotIdentifier',
  dbSubnetGroupName: 'dbSubnetGroupName',
  preferredMaintenanceWindow: 'preferredMaintenanceWindow',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

Name	Type	Description
dbInstanceClass	`string`	Contains the name of the compute and memory capacity class of the DB instance.
allowMajorVersionUpgrade?	`boolean \|` `IResolvable`	Indicates that major version upgrades are allowed.
autoMinorVersionUpgrade?	`boolean \|` `IResolvable`	Indicates that minor version patches are applied automatically.
availabilityZone?	`string`	Specifies the name of the Availability Zone the DB instance is located in.
dbClusterIdentifier?	`string`	If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.
dbInstanceIdentifier?	`string`	Contains a user-supplied database identifier.
dbParameterGroupName?	`string`	The name of an existing DB parameter group or a reference to an AWS::Neptune::DBParameterGroup resource created in the template.
dbSnapshotIdentifier?	`string`	This parameter is not supported.
dbSubnetGroupName?	`string`	A DB subnet group to associate with the DB instance.
preferredMaintenanceWindow?	`string`	Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
tags?	`CfnTag[]`	An arbitrary set of tags (key-value pairs) for this DB instance.

dbInstanceClass

Type: string

Contains the name of the compute and memory capacity class of the DB instance.

If you update this property, some interruptions may occur.

allowMajorVersionUpgrade?

Type: boolean | IResolvable (optional)

Indicates that major version upgrades are allowed.

Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. This parameter must be set to true when specifying a value for the EngineVersion parameter that is a different major version than the DB instance's current version.

When you change this parameter for an existing DB cluster, CloudFormation will replace your existing DB cluster with a new, empty one that uses the engine version you specified.

autoMinorVersionUpgrade?

Type: boolean | IResolvable (optional)

Indicates that minor version patches are applied automatically.

When updating this property, some interruptions may occur.

availabilityZone?

Type: string (optional)

Specifies the name of the Availability Zone the DB instance is located in.

dbClusterIdentifier?

Type: string (optional)

If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.

dbInstanceIdentifier?

Type: string (optional)

Contains a user-supplied database identifier.

This identifier is the unique key that identifies a DB instance.

dbParameterGroupName?

Type: string (optional)

The name of an existing DB parameter group or a reference to an AWS::Neptune::DBParameterGroup resource created in the template.

If any of the data members of the referenced parameter group are changed during an update, the DB instance might need to be restarted, which causes some interruption. If the parameter group contains static parameters, whether they were changed or not, an update triggers a reboot.

dbSnapshotIdentifier?

Type: string (optional)

This parameter is not supported.

AWS::Neptune::DBInstance does not support restoring from snapshots.

AWS::Neptune::DBCluster does support restoring from snapshots.

dbSubnetGroupName?

Type: string (optional)

A DB subnet group to associate with the DB instance.

If you update this value, the new subnet group must be a subnet group in a new virtual private cloud (VPC).

preferredMaintenanceWindow?

Type: string (optional)

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

tags?

Type: CfnTag[] (optional)

An arbitrary set of tags (key-value pairs) for this DB instance.