software.amazon.awscdk.services.docdb

Class DatabaseClusterProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.docdb.DatabaseClusterProps.Jsii$Proxy

All Implemented Interfaces:

DatabaseClusterProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

DatabaseClusterProps

@Stability(value=Experimental)
 @Internal
public static final class DatabaseClusterProps.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements DatabaseClusterProps

An implementation for DatabaseClusterProps

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.docdb.DatabaseClusterProps

DatabaseClusterProps.Builder, DatabaseClusterProps.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Jsii$Proxy(InstanceType instanceType, Login masterUser, IVpc vpc, BackupProps backup, String dbClusterName, String engineVersion, String instanceIdentifierBase, Number instances, IKey kmsKey, IClusterParameterGroup parameterGroup, Number port, String preferredMaintenanceWindow, RemovalPolicy removalPolicy, ISecurityGroup securityGroup, Boolean storageEncrypted, SubnetSelection vpcSubnets) Constructor that initializes the object based on literal property values passed by the DatabaseClusterProps.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method and Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
boolean	equals(Object o)
BackupProps	getBackup() (experimental) Backup settings.
String	getDbClusterName() (experimental) An optional identifier for the cluster.
String	getEngineVersion() (experimental) What version of the database to start.
String	getInstanceIdentifierBase() (experimental) Base identifier for instances.
Number	getInstances() (experimental) Number of DocDB compute instances.
InstanceType	getInstanceType() (experimental) What type of instance to start for the replicas.
IKey	getKmsKey() (experimental) The KMS key for storage encryption.
Login	getMasterUser() (experimental) Username and password for the administrative user.
IClusterParameterGroup	getParameterGroup() (experimental) The DB parameter group to associate with the instance.
Number	getPort() (experimental) The port the DocumentDB cluster will listen on.
String	getPreferredMaintenanceWindow() (experimental) A weekly time range in which maintenance should preferably execute.
RemovalPolicy	getRemovalPolicy() (experimental) 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.
ISecurityGroup	getSecurityGroup() (experimental) Security group.
Boolean	getStorageEncrypted() (experimental) Whether to enable storage encryption.
IVpc	getVpc() (experimental) What subnets to run the DocumentDB instances in.
SubnetSelection	getVpcSubnets() (experimental) Where to place the instances within the VPC.
int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awscdk.services.docdb.DatabaseClusterProps

builder

Constructor Detail

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(InstanceType instanceType,
                     Login masterUser,
                     IVpc vpc,
                     BackupProps backup,
                     String dbClusterName,
                     String engineVersion,
                     String instanceIdentifierBase,
                     Number instances,
                     IKey kmsKey,
                     IClusterParameterGroup parameterGroup,
                     Number port,
                     String preferredMaintenanceWindow,
                     RemovalPolicy removalPolicy,
                     ISecurityGroup securityGroup,
                     Boolean storageEncrypted,
                     SubnetSelection vpcSubnets)

Constructor that initializes the object based on literal property values passed by the DatabaseClusterProps.Builder.

Method Detail

getInstanceType

public final InstanceType getInstanceType()

Description copied from interface: DatabaseClusterProps

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

Specified by:

getInstanceType in interface DatabaseClusterProps

getMasterUser

public final Login getMasterUser()

Description copied from interface: DatabaseClusterProps

(experimental) Username and password for the administrative user.

Specified by:

getMasterUser in interface DatabaseClusterProps

getVpc

public final IVpc getVpc()

Description copied from interface: DatabaseClusterProps

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

Must be at least 2 subnets in two different AZs.

Specified by:

getVpc in interface DatabaseClusterProps

getBackup

public final BackupProps getBackup()

Description copied from interface: DatabaseClusterProps

(experimental) Backup settings.

Default: - Backup retention period for automated backups is 1 day. Backup preferred window is set to 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.

Specified by:

getBackup in interface DatabaseClusterProps

See Also:

https://docs.aws.amazon.com/documentdb/latest/developerguide/backup-restore.db-cluster-snapshots.html#backup-restore.backup-window

getDbClusterName

public final String getDbClusterName()

Description copied from interface: DatabaseClusterProps

(experimental) An optional identifier for the cluster.

Default: - A name is automatically generated.

Specified by:

getDbClusterName in interface DatabaseClusterProps

getEngineVersion

public final String getEngineVersion()

Description copied from interface: DatabaseClusterProps

(experimental) What version of the database to start.

Default: - The default engine version.

Specified by:

getEngineVersion in interface DatabaseClusterProps

getInstanceIdentifierBase

public final String getInstanceIdentifierBase()

Description copied from interface: DatabaseClusterProps

(experimental) Base identifier for instances.

Every replica is named by appending the replica number to this string, 1-based.

Default: - `dbClusterName` is used with the word "Instance" appended. If `dbClusterName` is not provided, the identifier is automatically generated.

Specified by:

getInstanceIdentifierBase in interface DatabaseClusterProps

getInstances

public final Number getInstances()

Description copied from interface: DatabaseClusterProps

(experimental) Number of DocDB compute instances.

Default: 1

Specified by:

getInstances in interface DatabaseClusterProps

getKmsKey

public final IKey getKmsKey()

Description copied from interface: DatabaseClusterProps

(experimental) The KMS key for storage encryption.

Default: - default master key.

Specified by:

getKmsKey in interface DatabaseClusterProps

getParameterGroup

public final IClusterParameterGroup getParameterGroup()

Description copied from interface: DatabaseClusterProps

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

Default: no parameter group

Specified by:

getParameterGroup in interface DatabaseClusterProps

getPort

public final Number getPort()

Description copied from interface: DatabaseClusterProps

(experimental) The port the DocumentDB cluster will listen on.

Default: DatabaseCluster.DEFAULT_PORT

Specified by:

getPort in interface DatabaseClusterProps

getPreferredMaintenanceWindow

public final String getPreferredMaintenanceWindow()

Description copied from interface: DatabaseClusterProps

(experimental) A weekly time range in which maintenance should preferably execute.

Must be at least 30 minutes long.

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

Default: - 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.

Specified by:

getPreferredMaintenanceWindow in interface DatabaseClusterProps

See Also:

https://docs.aws.amazon.com/documentdb/latest/developerguide/db-instance-maintain.html#maintenance-window

getRemovalPolicy

public final RemovalPolicy getRemovalPolicy()

Description copied from interface: DatabaseClusterProps

(experimental) 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.

Default: - Retain cluster.

Specified by:

getRemovalPolicy in interface DatabaseClusterProps

getSecurityGroup

public final ISecurityGroup getSecurityGroup()

Description copied from interface: DatabaseClusterProps

(experimental) Security group.

Default: a new security group is created.

Specified by:

getSecurityGroup in interface DatabaseClusterProps

getStorageEncrypted

public final Boolean getStorageEncrypted()

Description copied from interface: DatabaseClusterProps

(experimental) Whether to enable storage encryption.

Default: true

Specified by:

getStorageEncrypted in interface DatabaseClusterProps

getVpcSubnets

public final SubnetSelection getVpcSubnets()

Description copied from interface: DatabaseClusterProps

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

Default: private subnets

Specified by:

getVpcSubnets in interface DatabaseClusterProps

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object