software.amazon.awscdk.services.docdb

Interface InstanceProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

InstanceProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.26.0 (build 7d76e02)",
           date="2021-03-25T11:29:45.773Z")
 @Stability(value=Experimental)
public interface InstanceProps
extends software.amazon.jsii.JsiiSerializable

(experimental) Instance properties for database instances.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static InstanceProps.Builder	builder()
InstanceType	getInstanceType() (experimental) What type of instance to start for the replicas.
default IClusterParameterGroup	getParameterGroup() (experimental) The DB parameter group to associate with the instance.
default ISecurityGroup	getSecurityGroup() (experimental) Security group.
IVpc	getVpc() (experimental) What subnets to run the DocumentDB instances in.
default SubnetSelection	getVpcSubnets() (experimental) Where to place the instances within the VPC.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getInstanceType

@Stability(value=Experimental)
 @NotNull
InstanceType getInstanceType()

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

getVpc

@Stability(value=Experimental)
 @NotNull
IVpc getVpc()

(experimental) What subnets to run the DocumentDB instances in.

Must be at least 2 subnets in two different AZs.

getParameterGroup

@Stability(value=Experimental)
 @Nullable
default IClusterParameterGroup getParameterGroup()

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

Default: no parameter group

getSecurityGroup

@Stability(value=Experimental)
 @Nullable
default ISecurityGroup getSecurityGroup()

(experimental) Security group.

Default: a new security group is created.

getVpcSubnets

@Stability(value=Experimental)
 @Nullable
default SubnetSelection getVpcSubnets()

(experimental) Where to place the instances within the VPC.

Default: private subnets

builder

@Stability(value=Experimental)
static InstanceProps.Builder builder()

Returns:

a InstanceProps.Builder of InstanceProps