Package software.amazon.awscdk.services.neptune

Interface DatabaseInstanceProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

DatabaseInstanceProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:40.338Z")
@Stability(Experimental)
public interface DatabaseInstanceProps
extends software.amazon.jsii.JsiiSerializable

(experimental) Construction properties for a DatabaseInstanceNew.

Example:

 DatabaseInstance replica1 = DatabaseInstance.Builder.create(this, "Instance")
         .cluster(cluster)
         .instanceType(InstanceType.R5_LARGE)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	DatabaseInstanceProps.Builder	A builder for DatabaseInstanceProps
static final class	DatabaseInstanceProps.Jsii$Proxy	An implementation for DatabaseInstanceProps

Method Summary

Modifier and Type	Method	Description
static DatabaseInstanceProps.Builder	builder()
default String	getAvailabilityZone()	(experimental) The name of the Availability Zone where the DB instance will be located.
IDatabaseCluster	getCluster()	(experimental) The Neptune database cluster the instance should launch into.
default String	getDbInstanceName()	(experimental) A name for the DB instance.
InstanceType	getInstanceType()	(experimental) What type of instance to start for the replicas.
default IParameterGroup	getParameterGroup()	(experimental) The DB parameter group to associate with the instance.
default RemovalPolicy	getRemovalPolicy()	(experimental) The CloudFormation policy to apply when the instance is removed from the stack or replaced during an update.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCluster

@Stability(Experimental)
@NotNull
IDatabaseCluster getCluster()

(experimental) The Neptune database cluster the instance should launch into.

getInstanceType

@Stability(Experimental)
@NotNull
InstanceType getInstanceType()

(experimental) What type of instance to start for the replicas.

getAvailabilityZone

@Stability(Experimental)
@Nullable
default String getAvailabilityZone()

(experimental) The name of the Availability Zone where the DB instance will be located.

Default: - no preference

getDbInstanceName

@Stability(Experimental)
@Nullable
default String getDbInstanceName()

(experimental) A name for the DB instance.

If you specify a name, AWS CloudFormation converts it to lowercase.

Default: - a CloudFormation generated name

getParameterGroup

@Stability(Experimental)
@Nullable
default IParameterGroup getParameterGroup()

(experimental) The DB parameter group to associate with the instance.

Default: no parameter group

getRemovalPolicy

@Stability(Experimental)
@Nullable
default RemovalPolicy getRemovalPolicy()

(experimental) The CloudFormation policy to apply when the instance is removed from the stack or replaced during an update.

Default: RemovalPolicy.Retain

builder

@Stability(Experimental)
static DatabaseInstanceProps.Builder builder()

Returns:

a DatabaseInstanceProps.Builder of DatabaseInstanceProps