software.amazon.awscdk.services.neptune

Class CfnDBInstance

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.neptune.CfnDBInstance

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:41.007Z")
 @Stability(value=Stable)
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 class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnDBInstance(software.constructs.Construct scope, 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

Modifier and Type	Method and Description
Object	getAllowMajorVersionUpgrade() Indicates that major version upgrades are allowed.
String	getAttrEndpoint() The connection endpoint for the database.
String	getAttrPort() The port number on which the database accepts connections.
Object	getAutoMinorVersionUpgrade() Indicates that minor version patches are applied automatically.
String	getAvailabilityZone() Specifies the name of the Availability Zone the DB instance is located in.
protected Map<String,Object>	getCfnProperties()
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.
String	getDbInstanceClass() Contains the name of the compute and memory capacity class of the DB instance.
String	getDbInstanceIdentifier() Contains a user-supplied database identifier.
String	getDbParameterGroupName() The name of an existing DB parameter group or a reference to an AWS::Neptune::DBParameterGroup resource created in the template.
String	getDbSnapshotIdentifier() This parameter is not supported.
String	getDbSubnetGroupName() A DB subnet group to associate with the DB instance.
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 Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAllowMajorVersionUpgrade(Boolean value) Indicates that major version upgrades are allowed.
void	setAllowMajorVersionUpgrade(IResolvable value) Indicates that major version upgrades are allowed.
void	setAutoMinorVersionUpgrade(Boolean value) Indicates that minor version patches are applied automatically.
void	setAutoMinorVersionUpgrade(IResolvable value) Indicates that minor version patches are applied automatically.
void	setAvailabilityZone(String value) Specifies the name of the Availability Zone the DB instance is located in.
void	setDbClusterIdentifier(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(String value) Contains the name of the compute and memory capacity class of the DB instance.
void	setDbInstanceIdentifier(String value) Contains a user-supplied database identifier.
void	setDbParameterGroupName(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(String value) This parameter is not supported.
void	setDbSubnetGroupName(String value) A DB subnet group to associate with the DB instance.
void	setPreferredMaintenanceWindow(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.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final 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

@Stability(value=Stable)
public CfnDBInstance(@NotNull
                                              software.constructs.Construct scope,
                                              @NotNull
                                              String id,
                                              @NotNull
                                              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

@Stability(value=Stable)
public void inspect(@NotNull
                                             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

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrEndpoint

@Stability(value=Stable)
 @NotNull
public String getAttrEndpoint()

The connection endpoint for the database.

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

getAttrPort

@Stability(value=Stable)
 @NotNull
public String getAttrPort()

The port number on which the database accepts connections.

For example: 8182 .

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

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

getDbInstanceClass

@Stability(value=Stable)
 @NotNull
public 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

@Stability(value=Stable)
public void setDbInstanceClass(@NotNull
                                                        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

@Stability(value=Stable)
 @Nullable
public 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

@Stability(value=Stable)
public void setAllowMajorVersionUpgrade(@Nullable
                                                                 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

@Stability(value=Stable)
public void setAllowMajorVersionUpgrade(@Nullable
                                                                 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

@Stability(value=Stable)
 @Nullable
public Object getAutoMinorVersionUpgrade()

Indicates that minor version patches are applied automatically.

When updating this property, some interruptions may occur.

setAutoMinorVersionUpgrade

@Stability(value=Stable)
public void setAutoMinorVersionUpgrade(@Nullable
                                                                Boolean value)

Indicates that minor version patches are applied automatically.

When updating this property, some interruptions may occur.

setAutoMinorVersionUpgrade

@Stability(value=Stable)
public void setAutoMinorVersionUpgrade(@Nullable
                                                                IResolvable value)

Indicates that minor version patches are applied automatically.

When updating this property, some interruptions may occur.

getAvailabilityZone

@Stability(value=Stable)
 @Nullable
public String getAvailabilityZone()

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

setAvailabilityZone

@Stability(value=Stable)
public void setAvailabilityZone(@Nullable
                                                         String value)

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

getDbClusterIdentifier

@Stability(value=Stable)
 @Nullable
public 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

@Stability(value=Stable)
public void setDbClusterIdentifier(@Nullable
                                                            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

@Stability(value=Stable)
 @Nullable
public String getDbInstanceIdentifier()

Contains a user-supplied database identifier.

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

setDbInstanceIdentifier

@Stability(value=Stable)
public void setDbInstanceIdentifier(@Nullable
                                                             String value)

Contains a user-supplied database identifier.

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

getDbParameterGroupName

@Stability(value=Stable)
 @Nullable
public 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

@Stability(value=Stable)
public void setDbParameterGroupName(@Nullable
                                                             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

@Stability(value=Stable)
 @Nullable
public 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

@Stability(value=Stable)
public void setDbSnapshotIdentifier(@Nullable
                                                             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

@Stability(value=Stable)
 @Nullable
public 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

@Stability(value=Stable)
public void setDbSubnetGroupName(@Nullable
                                                          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

@Stability(value=Stable)
 @Nullable
public String getPreferredMaintenanceWindow()

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

setPreferredMaintenanceWindow

@Stability(value=Stable)
public void setPreferredMaintenanceWindow(@Nullable
                                                                   String value)

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