software.amazon.awscdk.services.docdb

Class DatabaseClusterProps.Builder

java.lang.Object

software.amazon.awscdk.services.docdb.DatabaseClusterProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<DatabaseClusterProps>

Enclosing interface:

DatabaseClusterProps

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

A builder for DatabaseClusterProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
DatabaseClusterProps.Builder	backup(BackupProps backup) Sets the value of DatabaseClusterProps.getBackup()
DatabaseClusterProps	build() Builds the configured instance.
DatabaseClusterProps.Builder	dbClusterName(String dbClusterName) Sets the value of DatabaseClusterProps.getDbClusterName()
DatabaseClusterProps.Builder	engineVersion(String engineVersion) Sets the value of DatabaseClusterProps.getEngineVersion()
DatabaseClusterProps.Builder	instanceIdentifierBase(String instanceIdentifierBase) Sets the value of DatabaseClusterProps.getInstanceIdentifierBase()
DatabaseClusterProps.Builder	instances(Number instances) Sets the value of DatabaseClusterProps.getInstances()
DatabaseClusterProps.Builder	instanceType(InstanceType instanceType) Sets the value of DatabaseClusterProps.getInstanceType()
DatabaseClusterProps.Builder	kmsKey(IKey kmsKey) Sets the value of DatabaseClusterProps.getKmsKey()
DatabaseClusterProps.Builder	masterUser(Login masterUser) Sets the value of DatabaseClusterProps.getMasterUser()
DatabaseClusterProps.Builder	parameterGroup(IClusterParameterGroup parameterGroup) Sets the value of DatabaseClusterProps.getParameterGroup()
DatabaseClusterProps.Builder	port(Number port) Sets the value of DatabaseClusterProps.getPort()
DatabaseClusterProps.Builder	preferredMaintenanceWindow(String preferredMaintenanceWindow) Sets the value of DatabaseClusterProps.getPreferredMaintenanceWindow()
DatabaseClusterProps.Builder	removalPolicy(RemovalPolicy removalPolicy) Sets the value of DatabaseClusterProps.getRemovalPolicy()
DatabaseClusterProps.Builder	securityGroup(ISecurityGroup securityGroup) Sets the value of DatabaseClusterProps.getSecurityGroup()
DatabaseClusterProps.Builder	storageEncrypted(Boolean storageEncrypted) Sets the value of DatabaseClusterProps.getStorageEncrypted()
DatabaseClusterProps.Builder	vpc(IVpc vpc) Sets the value of DatabaseClusterProps.getVpc()
DatabaseClusterProps.Builder	vpcSubnets(SubnetSelection vpcSubnets) Sets the value of DatabaseClusterProps.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 DatabaseClusterProps.Builder instanceType(InstanceType instanceType)

Sets the value of DatabaseClusterProps.getInstanceType()

Parameters:

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

Returns:

this

masterUser

@Stability(value=Experimental)
public DatabaseClusterProps.Builder masterUser(Login masterUser)

Sets the value of DatabaseClusterProps.getMasterUser()

Parameters:

masterUser - Username and password for the administrative user. This parameter is required.

Returns:

this

vpc

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

Sets the value of DatabaseClusterProps.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

backup

@Stability(value=Experimental)
public DatabaseClusterProps.Builder backup(BackupProps backup)

Sets the value of DatabaseClusterProps.getBackup()

Parameters:

backup - Backup settings.

Returns:

this

dbClusterName

@Stability(value=Experimental)
public DatabaseClusterProps.Builder dbClusterName(String dbClusterName)

Sets the value of DatabaseClusterProps.getDbClusterName()

Parameters:

dbClusterName - An optional identifier for the cluster.

Returns:

this

engineVersion

@Stability(value=Experimental)
public DatabaseClusterProps.Builder engineVersion(String engineVersion)

Sets the value of DatabaseClusterProps.getEngineVersion()

Parameters:

engineVersion - What version of the database to start.

Returns:

this

instanceIdentifierBase

@Stability(value=Experimental)
public DatabaseClusterProps.Builder instanceIdentifierBase(String instanceIdentifierBase)

Sets the value of DatabaseClusterProps.getInstanceIdentifierBase()

Parameters:

instanceIdentifierBase - Base identifier for instances. Every replica is named by appending the replica number to this string, 1-based.

Returns:

this

instances

@Stability(value=Experimental)
public DatabaseClusterProps.Builder instances(Number instances)

Sets the value of DatabaseClusterProps.getInstances()

Parameters:

instances - Number of DocDB compute instances.

Returns:

this

kmsKey

@Stability(value=Experimental)
public DatabaseClusterProps.Builder kmsKey(IKey kmsKey)

Sets the value of DatabaseClusterProps.getKmsKey()

Parameters:

kmsKey - The KMS key for storage encryption.

Returns:

this

parameterGroup

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

Sets the value of DatabaseClusterProps.getParameterGroup()

Parameters:

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

Returns:

this

port

@Stability(value=Experimental)
public DatabaseClusterProps.Builder port(Number port)

Sets the value of DatabaseClusterProps.getPort()

Parameters:

port - The port the DocumentDB cluster will listen on.

Returns:

this

preferredMaintenanceWindow

@Stability(value=Experimental)
public DatabaseClusterProps.Builder preferredMaintenanceWindow(String preferredMaintenanceWindow)

Sets the value of DatabaseClusterProps.getPreferredMaintenanceWindow()

Parameters:

preferredMaintenanceWindow - A weekly time range in which maintenance should preferably execute. Must be at least 30 minutes long.

Example: 'tue:04:17-tue:04:47'

Returns:

this

removalPolicy

@Stability(value=Experimental)
public DatabaseClusterProps.Builder removalPolicy(RemovalPolicy removalPolicy)

Sets the value of DatabaseClusterProps.getRemovalPolicy()

Parameters:

removalPolicy - The removal policy to apply when the cluster and its instances are removed or replaced during a stack update, or when the stack is deleted. This removal policy also applies to the implicit security group created for the cluster if one is not supplied as a parameter.

Returns:

this

securityGroup

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

Sets the value of DatabaseClusterProps.getSecurityGroup()

Parameters:

securityGroup - Security group.

Returns:

this

storageEncrypted

@Stability(value=Experimental)
public DatabaseClusterProps.Builder storageEncrypted(Boolean storageEncrypted)

Sets the value of DatabaseClusterProps.getStorageEncrypted()

Parameters:

storageEncrypted - Whether to enable storage encryption.

Returns:

this

vpcSubnets

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

Sets the value of DatabaseClusterProps.getVpcSubnets()

Parameters:

vpcSubnets - Where to place the instances within the VPC.

Returns:

this

build

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

Builds the configured instance.

Specified by:

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

Returns:

a new instance of DatabaseClusterProps

Throws:

NullPointerException - if any required attribute was not provided