software.amazon.awscdk.services.neptune

Interface CfnDBInstanceProps

All Known Implementing Classes:

CfnDBInstanceProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:43.808Z")
public interface 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 software.amazon.awscdk.services.neptune.*;
 CfnDBInstanceProps cfnDBInstanceProps = CfnDBInstanceProps.builder()
         .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	Interface and Description
static class	CfnDBInstanceProps.Builder A builder for CfnDBInstanceProps
static class	CfnDBInstanceProps.Jsii$Proxy An implementation for CfnDBInstanceProps

Method Summary

Modifier and Type	Method and Description
static CfnDBInstanceProps.Builder	builder()
default java.lang.Object	getAllowMajorVersionUpgrade() Indicates that major version upgrades are allowed.
default java.lang.Object	getAutoMinorVersionUpgrade() Indicates that minor version patches are applied automatically.
default java.lang.String	getAvailabilityZone() Specifies the name of the Availability Zone the DB instance is located in.
default 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.
default java.lang.String	getDbInstanceIdentifier() Contains a user-supplied database identifier.
default 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.
default java.lang.String	getDbSnapshotIdentifier() This parameter is not supported.
default java.lang.String	getDbSubnetGroupName() A DB subnet group to associate with the DB instance.
default java.lang.String	getPreferredMaintenanceWindow() Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
default java.util.List<CfnTag>	getTags() An arbitrary set of tags (key-value pairs) for this DB instance.

Method Detail

getDbInstanceClass

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.

getAllowMajorVersionUpgrade

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

getAutoMinorVersionUpgrade

default java.lang.Object getAutoMinorVersionUpgrade()

Indicates that minor version patches are applied automatically.

When updating this property, some interruptions may occur.

getAvailabilityZone

default java.lang.String getAvailabilityZone()

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

getDbClusterIdentifier

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

getDbInstanceIdentifier

default java.lang.String getDbInstanceIdentifier()

Contains a user-supplied database identifier.

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

getDbParameterGroupName

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

getDbSnapshotIdentifier

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

getDbSubnetGroupName

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

getPreferredMaintenanceWindow

default java.lang.String getPreferredMaintenanceWindow()

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

getTags

default java.util.List<CfnTag> getTags()

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

builder

static CfnDBInstanceProps.Builder builder()

Returns:

a CfnDBInstanceProps.Builder of CfnDBInstanceProps