software.amazon.awscdk.services.docdb

Class InstanceProps.Builder

java.lang.Object

software.amazon.awscdk.services.docdb.InstanceProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<InstanceProps>

Enclosing interface:

InstanceProps

@Stability(value=Experimental)
public static final class InstanceProps.Builder
extends Object
implements software.amazon.jsii.Builder<InstanceProps>

A builder for InstanceProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
InstanceProps	build() Builds the configured instance.
InstanceProps.Builder	instanceType(InstanceType instanceType) Sets the value of InstanceProps.getInstanceType()
InstanceProps.Builder	parameterGroup(IClusterParameterGroup parameterGroup) Sets the value of InstanceProps.getParameterGroup()
InstanceProps.Builder	securityGroup(ISecurityGroup securityGroup) Sets the value of InstanceProps.getSecurityGroup()
InstanceProps.Builder	vpc(IVpc vpc) Sets the value of InstanceProps.getVpc()
InstanceProps.Builder	vpcSubnets(SubnetSelection vpcSubnets) Sets the value of InstanceProps.getVpcSubnets()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

instanceType

@Stability(value=Experimental)
public InstanceProps.Builder instanceType(InstanceType instanceType)

Sets the value of InstanceProps.getInstanceType()

Parameters:

instanceType - What type of instance to start for the replicas. This parameter is required.

Returns:

this

vpc

@Stability(value=Experimental)
public InstanceProps.Builder vpc(IVpc vpc)

Sets the value of InstanceProps.getVpc()

Parameters:

vpc - What subnets to run the DocumentDB instances in. This parameter is required. Must be at least 2 subnets in two different AZs.

Returns:

this

parameterGroup

@Stability(value=Experimental)
public InstanceProps.Builder parameterGroup(IClusterParameterGroup parameterGroup)

Sets the value of InstanceProps.getParameterGroup()

Parameters:

parameterGroup - The DB parameter group to associate with the instance.

Returns:

this

securityGroup

@Stability(value=Experimental)
public InstanceProps.Builder securityGroup(ISecurityGroup securityGroup)

Sets the value of InstanceProps.getSecurityGroup()

Parameters:

securityGroup - Security group.

Returns:

this

vpcSubnets

@Stability(value=Experimental)
public InstanceProps.Builder vpcSubnets(SubnetSelection vpcSubnets)

Sets the value of InstanceProps.getVpcSubnets()

Parameters:

vpcSubnets - Where to place the instances within the VPC.

Returns:

this

build

@Stability(value=Experimental)
public InstanceProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<InstanceProps>

Returns:

a new instance of InstanceProps

Throws:

NullPointerException - if any required attribute was not provided