class CfnDBInstance (construct)

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

Implements IConstruct, IDependable, IInspectable, ITaggable

The AWS::Neptune::DBInstance type creates an Amazon Neptune DB instance.

Updating DB Instances

You can set a deletion policy for your DB instance to control how AWS CloudFormation handles the instance when the stack is deleted. For Neptune DB instances, you can choose to retain the instance, to delete the instance, or to create a snapshot of the instance. The default AWS CloudFormation behavior depends on the DBClusterIdentifier property:

• For AWS::Neptune::DBInstance resources that don't specify the DBClusterIdentifier property, AWS CloudFormation saves a snapshot of the DB instance.
• For AWS::Neptune::DBInstance resources that do specify the DBClusterIdentifier property, AWS CloudFormation deletes the DB instance.

Deleting DB Instances

If a DB instance is deleted or replaced during an update, AWS CloudFormation deletes all automated snapshots. However, it retains manual DB snapshots. During an update that requires replacement, you can apply a stack policy to prevent DB instances from being replaced.

When properties labeled Update requires: Replacement are updated, AWS CloudFormation first creates a replacement DB instance, changes references from other dependent resources to point to the replacement DB instance, and finally deletes the old DB instance.

We highly recommend that you take a snapshot of the database before updating the stack. If you don't, you lose the data when AWS CloudFormation replaces your DB instance. To preserve your data, perform the following procedure:

• Deactivate any applications that are using the DB instance so that there's no activity on the DB instance.
• Create a snapshot of the DB instance.
• If you want to restore your instance using a DB snapshot, modify the updated template with your DB instance changes and add the DBSnapshotIdentifier property with the ID of the DB snapshot that you want to use.
• Update the stack.

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

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 cfnDBInstance = new neptune.CfnDBInstance(this, 'MyCfnDBInstance', {
  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',
  }],
});

Initializer

new CfnDBInstance(scope: Construct, id: string, props: CfnDBInstanceProps)

Parameters

• scope Construct — Scope in which this resource is defined.
• id string — Construct identifier for this resource (unique in its scope).
• props CfnDBInstanceProps — Resource properties.

Construct Props

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbinstance.html#cfn-neptune-dbinstance-dbinstanceclass

---

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbinstance.html#cfn-neptune-dbinstance-allowmajorversionupgrade

---

autoMinorVersionUpgrade?

Type: boolean | IResolvable (optional)

Indicates that minor version patches are applied automatically.

When updating this property, some interruptions may occur.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbinstance.html#cfn-neptune-dbinstance-autominorversionupgrade

---

availabilityZone?

Type: string (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbinstance.html#cfn-neptune-dbinstance-availabilityzone

---

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbinstance.html#cfn-neptune-dbinstance-dbclusteridentifier

---

dbInstanceIdentifier?

Type: string (optional)

Contains a user-supplied database identifier.

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbinstance.html#cfn-neptune-dbinstance-dbinstanceidentifier

---

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbinstance.html#cfn-neptune-dbinstance-dbparametergroupname

---

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbinstance.html#cfn-neptune-dbinstance-dbsnapshotidentifier

---

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbinstance.html#cfn-neptune-dbinstance-dbsubnetgroupname

---

preferredMaintenanceWindow?

Type: string (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbinstance.html#cfn-neptune-dbinstance-preferredmaintenancewindow

---

tags?

Type: CfnTag[] (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbinstance.html#cfn-neptune-dbinstance-tags

Properties

Name	Type	Description
attrEndpoint	string	The connection endpoint for the database.
attrId	string
attrPort	string	The port number on which the database accepts connections.
cfnOptions	ICfnResourceOptions	Options for this resource, such as condition, update policy etc.
cfnProperties	{ [string]: any }
cfnResourceType	string	AWS resource type.
creationStack	string[]
dbInstanceClass	string	Contains the name of the compute and memory capacity class of the DB instance.
logicalId	string	The logical ID for this CloudFormation stack element.
node	Node	The tree node.
ref	string	Return a string that will be resolved to a CloudFormation { Ref } for this element.
stack	Stack	The stack in which this element is defined.
tags	TagManager	Tag Manager which manages the tags for this resource.
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).
tagsRaw?	CfnTag[]	An arbitrary set of tags (key-value pairs) for this DB instance.
static CFN_RESOURCE_TYPE_NAME	string	The CloudFormation resource type name for this resource class.

---

attrEndpoint

Type: string

The connection endpoint for the database.

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

---

attrId

Type: string

---

attrPort

Type: string

The port number on which the database accepts connections.

For example: 8182 .

---

cfnOptions

Type: ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

---

cfnProperties

Type: { [string]: any }

---

cfnResourceType

Type: string

AWS resource type.

---

creationStack

Type: string[]

---

dbInstanceClass

Type: string

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

---

logicalId

Type: string

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

---

node

Type: Node

The tree node.

---

ref

Type: string

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

---

stack

Type: Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

---

tags

Type: TagManager

Tag Manager which manages the tags for this resource.

---

allowMajorVersionUpgrade?

Type: boolean | IResolvable (optional)

Indicates that major version upgrades are allowed.

---

autoMinorVersionUpgrade?

Type: boolean | IResolvable (optional)

Indicates that minor version patches are applied automatically.

---

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.

---

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.

---

dbSnapshotIdentifier?

Type: string (optional)

This parameter is not supported.

---

dbSubnetGroupName?

Type: string (optional)

A DB subnet group to associate with the DB instance.

---

preferredMaintenanceWindow?

Type: string (optional)

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

---

tagsRaw?

Type: CfnTag[] (optional)

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

---

static CFN_RESOURCE_TYPE_NAME

Type: string

The CloudFormation resource type name for this resource class.

Methods

Name	Description
addDeletionOverride(path)	Syntactic sugar for addOverride(path, undefined).
addDependency(target)	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addDependsOn(target)⚠️	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)	Add a value to the CloudFormation Resource Metadata.
addOverride(path, value)	Adds an override to the synthesized CloudFormation resource.
addPropertyDeletionOverride(propertyPath)	Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)	Adds an override to a resource property.
applyRemovalPolicy(policy?, options?)	Sets the deletion policy of the resource based on the removal policy specified.
getAtt(attributeName, typeHint?)	Returns a token for an runtime attribute of this resource.
getMetadata(key)	Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector)	Examines the CloudFormation resource and discloses attributes.
obtainDependencies()	Retrieves an array of resources this resource depends on.
obtainResourceDependencies()	Get a shallow copy of dependencies between this resource and other resources in the same stack.
overrideLogicalId(newLogicalId)	Overrides the auto-generated logical ID with a specific ID.
removeDependency(target)	Indicates that this resource no longer depends on another resource.
replaceDependency(target, newTarget)	Replaces one dependency with another.
toString()	Returns a string representation of this construct.
protected renderProperties(props)

---

addDeletionOverride(path)

public addDeletionOverride(path: string): void

Parameters

• path string — The path of the value to delete.

Syntactic sugar for addOverride(path, undefined).

---

addDependency(target)

public addDependency(target: CfnResource): void

Parameters

• target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

---

addDependsOn(target)⚠️

public addDependsOn(target: CfnResource): void

⚠️ Deprecated: use addDependency

Parameters

• target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

---

addMetadata(key, value)

public addMetadata(key: string, value: any): void

Parameters

• key string
• value any

Add a value to the CloudFormation Resource Metadata.

See also: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

---

addOverride(path, value)

public addOverride(path: string, value: any): void

Parameters

• path string — - The path of the property, you can use dot notation to override values in complex types.
• value any — - The value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

---

addPropertyDeletionOverride(propertyPath)

public addPropertyDeletionOverride(propertyPath: string): void

Parameters

• propertyPath string — The path to the property.

Adds an override that deletes the value of a property from the resource definition.

---

addPropertyOverride(propertyPath, value)

public addPropertyOverride(propertyPath: string, value: any): void

Parameters

• propertyPath string — The path of the property.
• value any — The value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

---

applyRemovalPolicy(policy?, options?)

public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void

Parameters

• policy RemovalPolicy
• options RemovalPolicyOptions

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

See also: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

---

getAtt(attributeName, typeHint?)

public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference

Parameters

• attributeName string — The name of the attribute.
• typeHint ResolutionTypeHint

Returns

• Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

---

getMetadata(key)

public getMetadata(key: string): any

Parameters

• key string

Returns

• any

Retrieve a value value from the CloudFormation Resource Metadata.

See also: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

---

inspect(inspector)

public inspect(inspector: TreeInspector): void

Parameters

• inspector TreeInspector — tree inspector to collect and process attributes.

Examines the CloudFormation resource and discloses attributes.

---

obtainDependencies()

public obtainDependencies(): Stack | CfnResource[]

Returns

• Stack | CfnResource[]

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

---

obtainResourceDependencies()

public obtainResourceDependencies(): CfnResource[]

Returns

• CfnResource[]

Get a shallow copy of dependencies between this resource and other resources in the same stack.

---

overrideLogicalId(newLogicalId)

public overrideLogicalId(newLogicalId: string): void

Parameters

• newLogicalId string — The new logical ID to use for this stack element.

Overrides the auto-generated logical ID with a specific ID.

---

removeDependency(target)

public removeDependency(target: CfnResource): void

Parameters

• target CfnResource

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

---

replaceDependency(target, newTarget)

public replaceDependency(target: CfnResource, newTarget: CfnResource): void

Parameters

• target CfnResource — The dependency to replace.
• newTarget CfnResource — The new dependency to add.

Replaces one dependency with another.

---

toString()

public toString(): string

Returns

• string

Returns a string representation of this construct.

---

protected renderProperties(props)

protected renderProperties(props: { [string]: any }): { [string]: any }

Parameters

• props { [string]: any }

Returns

• { [string]: any }