Package software.amazon.awscdk.services.docdb

Class DatabaseInstanceProps.Builder

java.lang.Object

software.amazon.awscdk.services.docdb.DatabaseInstanceProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<DatabaseInstanceProps>

Enclosing interface:

DatabaseInstanceProps

@Stability(Stable)
public static final class DatabaseInstanceProps.Builder
extends Object
implements software.amazon.jsii.Builder<DatabaseInstanceProps>

A builder for DatabaseInstanceProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
DatabaseInstanceProps.Builder	autoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)	Sets the value of DatabaseInstanceProps.getAutoMinorVersionUpgrade()
DatabaseInstanceProps.Builder	availabilityZone(String availabilityZone)	Sets the value of DatabaseInstanceProps.getAvailabilityZone()
DatabaseInstanceProps	build()	Builds the configured instance.
DatabaseInstanceProps.Builder	caCertificate(CaCertificate caCertificate)	Sets the value of DatabaseInstanceProps.getCaCertificate()
DatabaseInstanceProps.Builder	cluster(IDatabaseCluster cluster)	Sets the value of DatabaseInstanceProps.getCluster()
DatabaseInstanceProps.Builder	dbInstanceName(String dbInstanceName)	Sets the value of DatabaseInstanceProps.getDbInstanceName()
DatabaseInstanceProps.Builder	enablePerformanceInsights(Boolean enablePerformanceInsights)	Sets the value of DatabaseInstanceProps.getEnablePerformanceInsights()
DatabaseInstanceProps.Builder	instanceType(InstanceType instanceType)	Sets the value of DatabaseInstanceProps.getInstanceType()
DatabaseInstanceProps.Builder	preferredMaintenanceWindow(String preferredMaintenanceWindow)	Sets the value of DatabaseInstanceProps.getPreferredMaintenanceWindow()
DatabaseInstanceProps.Builder	removalPolicy(RemovalPolicy removalPolicy)	Sets the value of DatabaseInstanceProps.getRemovalPolicy()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

cluster

@Stability(Stable)
public DatabaseInstanceProps.Builder cluster(IDatabaseCluster cluster)

Sets the value of DatabaseInstanceProps.getCluster()

Parameters:

cluster - The DocumentDB database cluster the instance should launch into. This parameter is required.

Returns:

this

instanceType

@Stability(Stable)
public DatabaseInstanceProps.Builder instanceType(InstanceType instanceType)

Sets the value of DatabaseInstanceProps.getInstanceType()

Parameters:

instanceType - The name of the compute and memory capacity classes. This parameter is required.

Returns:

this

autoMinorVersionUpgrade

@Stability(Stable)
public DatabaseInstanceProps.Builder autoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)

Sets the value of DatabaseInstanceProps.getAutoMinorVersionUpgrade()

Parameters:

autoMinorVersionUpgrade - Indicates that minor engine upgrades are applied automatically to the DB instance during the maintenance window.

Returns:

this

availabilityZone

@Stability(Stable)
public DatabaseInstanceProps.Builder availabilityZone(String availabilityZone)

Sets the value of DatabaseInstanceProps.getAvailabilityZone()

Parameters:

availabilityZone - The name of the Availability Zone where the DB instance will be located.

Returns:

this

caCertificate

@Stability(Stable)
public DatabaseInstanceProps.Builder caCertificate(CaCertificate caCertificate)

Sets the value of DatabaseInstanceProps.getCaCertificate()

Parameters:

caCertificate - The identifier of the CA certificate for this DB instance. Specifying or updating this property triggers a reboot.

Returns:

this

dbInstanceName

@Stability(Stable)
public DatabaseInstanceProps.Builder dbInstanceName(String dbInstanceName)

Sets the value of DatabaseInstanceProps.getDbInstanceName()

Parameters:

dbInstanceName - A name for the DB instance. If you specify a name, AWS CloudFormation converts it to lowercase.

Returns:

this

enablePerformanceInsights

@Stability(Stable)
public DatabaseInstanceProps.Builder enablePerformanceInsights(Boolean enablePerformanceInsights)

Sets the value of DatabaseInstanceProps.getEnablePerformanceInsights()

Parameters:

enablePerformanceInsights - A value that indicates whether to enable Performance Insights for the DB Instance.

Returns:

this

preferredMaintenanceWindow

@Stability(Stable)
public DatabaseInstanceProps.Builder preferredMaintenanceWindow(String preferredMaintenanceWindow)

Sets the value of DatabaseInstanceProps.getPreferredMaintenanceWindow()

Parameters:

preferredMaintenanceWindow - The weekly time range (in UTC) during which system maintenance can occur. Format: ddd:hh24:mi-ddd:hh24:mi Constraint: Minimum 30-minute window

Returns:

this

removalPolicy

@Stability(Stable)
public DatabaseInstanceProps.Builder removalPolicy(RemovalPolicy removalPolicy)

Sets the value of DatabaseInstanceProps.getRemovalPolicy()

Parameters:

removalPolicy - The CloudFormation policy to apply when the instance is removed from the stack or replaced during an update.

Returns:

this

build

@Stability(Stable)
public DatabaseInstanceProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of DatabaseInstanceProps

Throws:

NullPointerException - if any required attribute was not provided