software.amazon.awscdk.services.docdb

Interface DatabaseInstanceProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

DatabaseInstanceProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.30.0 (build adae23f)",
           date="2021-06-30T10:01:06.443Z")
 @Stability(value=Experimental)
public interface DatabaseInstanceProps
extends software.amazon.jsii.JsiiSerializable

(experimental) Construction properties for a DatabaseInstanceNew.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static DatabaseInstanceProps.Builder	builder()
default Boolean	getAutoMinorVersionUpgrade() (experimental) Indicates that minor engine upgrades are applied automatically to the DB instance during the maintenance window.
default String	getAvailabilityZone() (experimental) The name of the Availability Zone where the DB instance will be located.
IDatabaseCluster	getCluster() (experimental) The DocumentDB database cluster the instance should launch into.
default String	getDbInstanceName() (experimental) A name for the DB instance.
InstanceType	getInstanceType() (experimental) The name of the compute and memory capacity classes.
default String	getPreferredMaintenanceWindow() (experimental) The weekly time range (in UTC) during which system maintenance can occur.
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 Detail

getCluster

@Stability(value=Experimental)
 @NotNull
IDatabaseCluster getCluster()

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

getInstanceType

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

(experimental) The name of the compute and memory capacity classes.

getAutoMinorVersionUpgrade

@Stability(value=Experimental)
 @Nullable
default Boolean getAutoMinorVersionUpgrade()

(experimental) Indicates that minor engine upgrades are applied automatically to the DB instance during the maintenance window.

Default: true

getAvailabilityZone

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

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

Default: - no preference

getDbInstanceName

@Stability(value=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

getPreferredMaintenanceWindow

@Stability(value=Experimental)
 @Nullable
default String getPreferredMaintenanceWindow()

(experimental) The weekly time range (in UTC) during which system maintenance can occur.

Format: ddd:hh24:mi-ddd:hh24:mi Constraint: Minimum 30-minute window

Default: - a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see https://docs.aws.amazon.com/documentdb/latest/developerguide/db-instance-maintain.html#maintenance-window

getRemovalPolicy

@Stability(value=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(value=Experimental)
static DatabaseInstanceProps.Builder builder()

Returns:

a DatabaseInstanceProps.Builder of DatabaseInstanceProps