CfnDBInstance

java.lang.Object
- software.constructs.Construct
- - software.amazon.awscdk.core.Construct
  - - software.amazon.awscdk.core.CfnElement
    - - software.amazon.awscdk.core.CfnRefElement
      - software.amazon.awscdk.core.CfnResource
        
        software.amazon.awscdk.services.neptune.CfnDBInstance

All Implemented Interfaces:

IConstruct, IDependable, IInspectable
```
@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:43.806Z")
public class CfnDBInstance
extends CfnResource
implements IInspectable
```
A CloudFormation `AWS::Neptune::DBInstance`.
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.
Example:
```
 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.neptune.*;
 CfnDBInstance cfnDBInstance = CfnDBInstance.Builder.create(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(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class CfnDBInstance.Builder
A fluent builder for CfnDBInstance.
- Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable
  IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
- Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
  IConstruct.Jsii$Default

Nested Classes
Modifier and Type	Class and Description
`static class`	`CfnDBInstance.Builder` A fluent builder for `CfnDBInstance`.

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`CFN_RESOURCE_TYPE_NAME` The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors
Modifier	Constructor and Description
	`CfnDBInstance(Construct scope, java.lang.String id, CfnDBInstanceProps props)` Create a new `AWS::Neptune::DBInstance`.
`protected`	`CfnDBInstance(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)`
`protected`	`CfnDBInstance(software.amazon.jsii.JsiiObjectRef objRef)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.Object`	`getAllowMajorVersionUpgrade()` Indicates that major version upgrades are allowed.
`java.lang.String`	`getAttrEndpoint()` The connection endpoint for the database.
`java.lang.String`	`getAttrPort()` The port number on which the database accepts connections.
`java.lang.Object`	`getAutoMinorVersionUpgrade()` Indicates that minor version patches are applied automatically.
`java.lang.String`	`getAvailabilityZone()` Specifies the name of the Availability Zone the DB instance is located in.
`protected java.util.Map<java.lang.String,java.lang.Object>`	`getCfnProperties()`
`java.lang.String`	`getDbClusterIdentifier()` 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.
`java.lang.String`	`getDbInstanceClass()` Contains the name of the compute and memory capacity class of the DB instance.
`java.lang.String`	`getDbInstanceIdentifier()` Contains a user-supplied database identifier.
`java.lang.String`	`getDbParameterGroupName()` The name of an existing DB parameter group or a reference to an AWS::Neptune::DBParameterGroup resource created in the template.
`java.lang.String`	`getDbSnapshotIdentifier()` This parameter is not supported.
`java.lang.String`	`getDbSubnetGroupName()` A DB subnet group to associate with the DB instance.
`java.lang.String`	`getPreferredMaintenanceWindow()` Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
`TagManager`	`getTags()` An arbitrary set of tags (key-value pairs) for this DB instance.
`void`	`inspect(TreeInspector inspector)` Examines the CloudFormation resource and discloses attributes.
`protected java.util.Map<java.lang.String,java.lang.Object>`	`renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)`
`void`	`setAllowMajorVersionUpgrade(java.lang.Boolean value)` Indicates that major version upgrades are allowed.
`void`	`setAllowMajorVersionUpgrade(IResolvable value)` Indicates that major version upgrades are allowed.
`void`	`setAutoMinorVersionUpgrade(java.lang.Boolean value)` Indicates that minor version patches are applied automatically.
`void`	`setAutoMinorVersionUpgrade(IResolvable value)` Indicates that minor version patches are applied automatically.
`void`	`setAvailabilityZone(java.lang.String value)` Specifies the name of the Availability Zone the DB instance is located in.
`void`	`setDbClusterIdentifier(java.lang.String value)` 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.
`void`	`setDbInstanceClass(java.lang.String value)` Contains the name of the compute and memory capacity class of the DB instance.
`void`	`setDbInstanceIdentifier(java.lang.String value)` Contains a user-supplied database identifier.
`void`	`setDbParameterGroupName(java.lang.String value)` The name of an existing DB parameter group or a reference to an AWS::Neptune::DBParameterGroup resource created in the template.
`void`	`setDbSnapshotIdentifier(java.lang.String value)` This parameter is not supported.
`void`	`setDbSubnetGroupName(java.lang.String value)` A DB subnet group to associate with the DB instance.
`void`	`setPreferredMaintenanceWindow(java.lang.String value)` Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Methods inherited from class software.amazon.awscdk.core.CfnResource
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement
getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - CFN_RESOURCE_TYPE_NAME
```
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
```
    The CloudFormation resource type name for this resource class.
- Constructor Detail
  - CfnDBInstance
```
protected CfnDBInstance(software.amazon.jsii.JsiiObjectRef objRef)
```
  - CfnDBInstance
```
protected CfnDBInstance(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
```
  - CfnDBInstance
```
public CfnDBInstance(Construct scope,
                     java.lang.String id,
                     CfnDBInstanceProps props)
```
    Create a new `AWS::Neptune::DBInstance`.
    
    Parameters:
    
    scope - - scope in which this resource is defined. This parameter is required.
    
    id - - scoped id of the resource. This parameter is required.
    
    props - - resource properties. This parameter is required.
- Method Detail
  - inspect
```
public void inspect(TreeInspector inspector)
```
    Examines the CloudFormation resource and discloses attributes.
    
    Specified by:
    
    inspect in interface IInspectable
    
    Parameters:
    
    inspector - - tree inspector to collect and process attributes. This parameter is required.
  - renderProperties
```
protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
```
    Overrides:
    
    renderProperties in class CfnResource
    
    Parameters:
    
    props - This parameter is required.
  - getAttrEndpoint
```
public java.lang.String getAttrEndpoint()
```
    The connection endpoint for the database.
    For example: mystack-mydb-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com .
  - getAttrPort
```
public java.lang.String getAttrPort()
```
    The port number on which the database accepts connections.
    For example: 8182 .
  - getCfnProperties
```
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
```
    Overrides:
    
    getCfnProperties in class CfnResource
  - getTags
```
public TagManager getTags()
```
    An arbitrary set of tags (key-value pairs) for this DB instance.
  - getDbInstanceClass
```
public java.lang.String getDbInstanceClass()
```
    Contains the name of the compute and memory capacity class of the DB instance.
    If you update this property, some interruptions may occur.
  - setDbInstanceClass
```
public void setDbInstanceClass(java.lang.String value)
```
    Contains the name of the compute and memory capacity class of the DB instance.
    If you update this property, some interruptions may occur.
  - getAllowMajorVersionUpgrade
```
public java.lang.Object getAllowMajorVersionUpgrade()
```
    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.
  - setAllowMajorVersionUpgrade
```
public void setAllowMajorVersionUpgrade(java.lang.Boolean value)
```
    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.
  - setAllowMajorVersionUpgrade
```
public void setAllowMajorVersionUpgrade(IResolvable value)
```
    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.
  - getAutoMinorVersionUpgrade
```
public java.lang.Object getAutoMinorVersionUpgrade()
```
    Indicates that minor version patches are applied automatically.
    When updating this property, some interruptions may occur.
  - setAutoMinorVersionUpgrade
```
public void setAutoMinorVersionUpgrade(java.lang.Boolean value)
```
    Indicates that minor version patches are applied automatically.
    When updating this property, some interruptions may occur.
  - setAutoMinorVersionUpgrade
```
public void setAutoMinorVersionUpgrade(IResolvable value)
```
    Indicates that minor version patches are applied automatically.
    When updating this property, some interruptions may occur.
  - getAvailabilityZone
```
public java.lang.String getAvailabilityZone()
```
    Specifies the name of the Availability Zone the DB instance is located in.
  - setAvailabilityZone
```
public void setAvailabilityZone(java.lang.String value)
```
    Specifies the name of the Availability Zone the DB instance is located in.
  - getDbClusterIdentifier
```
public java.lang.String getDbClusterIdentifier()
```
    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.
  - setDbClusterIdentifier
```
public void setDbClusterIdentifier(java.lang.String value)
```
    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.
  - getDbInstanceIdentifier
```
public java.lang.String getDbInstanceIdentifier()
```
    Contains a user-supplied database identifier.
    This identifier is the unique key that identifies a DB instance.
  - setDbInstanceIdentifier
```
public void setDbInstanceIdentifier(java.lang.String value)
```
    Contains a user-supplied database identifier.
    This identifier is the unique key that identifies a DB instance.
  - getDbParameterGroupName
```
public java.lang.String getDbParameterGroupName()
```
    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.
  - setDbParameterGroupName
```
public void setDbParameterGroupName(java.lang.String value)
```
    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.
  - getDbSnapshotIdentifier
```
public java.lang.String getDbSnapshotIdentifier()
```
    This parameter is not supported.
    AWS::Neptune::DBInstance does not support restoring from snapshots.
    AWS::Neptune::DBCluster does support restoring from snapshots.
  - setDbSnapshotIdentifier
```
public void setDbSnapshotIdentifier(java.lang.String value)
```
    This parameter is not supported.
    AWS::Neptune::DBInstance does not support restoring from snapshots.
    AWS::Neptune::DBCluster does support restoring from snapshots.
  - getDbSubnetGroupName
```
public java.lang.String getDbSubnetGroupName()
```
    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).
  - setDbSubnetGroupName
```
public void setDbSubnetGroupName(java.lang.String value)
```
    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).
  - getPreferredMaintenanceWindow
```
public java.lang.String getPreferredMaintenanceWindow()
```
    Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
  - setPreferredMaintenanceWindow
```
public void setPreferredMaintenanceWindow(java.lang.String value)
```
    Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Class CfnDBInstance

Nested Class Summary

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

Field Summary

Constructor Summary

Method Summary

Methods inherited from class software.amazon.awscdk.core.CfnResource

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

Methods inherited from class software.amazon.awscdk.core.CfnElement

Methods inherited from class software.amazon.awscdk.core.Construct

Methods inherited from class java.lang.Object

Field Detail

CFN_RESOURCE_TYPE_NAME

Constructor Detail

CfnDBInstance

CfnDBInstance

CfnDBInstance

Method Detail

inspect

renderProperties

getAttrEndpoint

getAttrPort

getCfnProperties

getTags

getDbInstanceClass

setDbInstanceClass

getAllowMajorVersionUpgrade

setAllowMajorVersionUpgrade

setAllowMajorVersionUpgrade

getAutoMinorVersionUpgrade

setAutoMinorVersionUpgrade

setAutoMinorVersionUpgrade

getAvailabilityZone

setAvailabilityZone

getDbClusterIdentifier

setDbClusterIdentifier

getDbInstanceIdentifier

setDbInstanceIdentifier

getDbParameterGroupName

setDbParameterGroupName

getDbSnapshotIdentifier

setDbSnapshotIdentifier

getDbSubnetGroupName

setDbSubnetGroupName

getPreferredMaintenanceWindow

setPreferredMaintenanceWindow