Package 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(Stable)
@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	Description
protected	Jsii$Proxy(DatabaseClusterProps.Builder builder)	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	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final BackupProps	getBackup()	Backup settings.
final CaCertificate	getCaCertificate()	The identifier of the CA certificate used for the instances.
final RetentionDays	getCloudWatchLogsRetention()	The number of days log events are kept in CloudWatch Logs.
final IRole	getCloudWatchLogsRetentionRole()	The IAM role for the Lambda function associated with the custom resource that sets the retention policy.
final Boolean	getCopyTagsToSnapshot()	Whether to copy tags to the snapshot when a snapshot is created.
final String	getDbClusterName()	An optional identifier for the cluster.
final Boolean	getDeletionProtection()	Specifies whether this cluster can be deleted.
final Boolean	getEnablePerformanceInsights()	A value that indicates whether to enable Performance Insights for the instances in the DB Cluster.
final String	getEngineVersion()	What version of the database to start.
final Boolean	getExportAuditLogsToCloudWatch()	Whether the audit logs should be exported to CloudWatch.
final Boolean	getExportProfilerLogsToCloudWatch()	Whether the profiler logs should be exported to CloudWatch.
final String	getInstanceIdentifierBase()	Base identifier for instances.
final RemovalPolicy	getInstanceRemovalPolicy()	The removal policy to apply to the cluster's instances.
final Number	getInstances()	Number of DocDB compute instances.
final InstanceType	getInstanceType()	What type of instance to start for the replicas.
final IKey	getKmsKey()	The KMS key for storage encryption.
final Login	getMasterUser()	Username and password for the administrative user.
final IClusterParameterGroup	getParameterGroup()	The DB parameter group to associate with the instance.
final Number	getPort()	The port the DocumentDB cluster will listen on.
final String	getPreferredMaintenanceWindow()	A weekly time range in which maintenance should preferably execute.
final RemovalPolicy	getRemovalPolicy()	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.
final ISecurityGroup	getSecurityGroup()	Security group.
final RemovalPolicy	getSecurityGroupRemovalPolicy()	The removal policy to apply to the cluster's security group.
final ServerlessV2ScalingConfiguration	getServerlessV2ScalingConfiguration()	ServerlessV2 scaling configuration.
final Boolean	getStorageEncrypted()	Whether to enable storage encryption.
final StorageType	getStorageType()	The storage type of the DocDB cluster.
final IVpc	getVpc()	What subnets to run the DocumentDB instances in.
final SubnetSelection	getVpcSubnets()	Where to place the instances within the VPC.
final 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

Constructor Details

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(DatabaseClusterProps.Builder builder)

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

Method Details

getMasterUser

public final Login getMasterUser()

Description copied from interface: DatabaseClusterProps

Username and password for the administrative user.

Specified by:

getMasterUser in interface DatabaseClusterProps

getVpc

public final IVpc getVpc()

Description copied from interface: DatabaseClusterProps

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

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

getCaCertificate

public final CaCertificate getCaCertificate()

Description copied from interface: DatabaseClusterProps

The identifier of the CA certificate used for the instances.

Specifying or updating this property triggers a reboot.

Default: - DocumentDB will choose a certificate authority

Specified by:

getCaCertificate in interface DatabaseClusterProps

See Also:

• https://docs.aws.amazon.com/documentdb/latest/developerguide/ca_cert_rotation.html

getCloudWatchLogsRetention

public final RetentionDays getCloudWatchLogsRetention()

Description copied from interface: DatabaseClusterProps

The number of days log events are kept in CloudWatch Logs.

When updating this property, unsetting it doesn't remove the log retention policy. To remove the retention policy, set the value to Infinity.

Default: - logs never expire

Specified by:

getCloudWatchLogsRetention in interface DatabaseClusterProps

getCloudWatchLogsRetentionRole

public final IRole getCloudWatchLogsRetentionRole()

Description copied from interface: DatabaseClusterProps

The IAM role for the Lambda function associated with the custom resource that sets the retention policy.

Default: - a new role is created.

Specified by:

getCloudWatchLogsRetentionRole in interface DatabaseClusterProps

getCopyTagsToSnapshot

public final Boolean getCopyTagsToSnapshot()

Description copied from interface: DatabaseClusterProps

Whether to copy tags to the snapshot when a snapshot is created.

Default: - false

Specified by:

getCopyTagsToSnapshot in interface DatabaseClusterProps

getDbClusterName

public final String getDbClusterName()

Description copied from interface: DatabaseClusterProps

An optional identifier for the cluster.

Default: - A name is automatically generated.

Specified by:

getDbClusterName in interface DatabaseClusterProps

getDeletionProtection

public final Boolean getDeletionProtection()

Description copied from interface: DatabaseClusterProps

Specifies whether this cluster can be deleted.

If deletionProtection is enabled, the cluster cannot be deleted unless it is modified and deletionProtection is disabled. deletionProtection protects clusters from being accidentally deleted.

Default: - false

Specified by:

getDeletionProtection in interface DatabaseClusterProps

getEnablePerformanceInsights

public final Boolean getEnablePerformanceInsights()

Description copied from interface: DatabaseClusterProps

A value that indicates whether to enable Performance Insights for the instances in the DB Cluster.

Default: - false

Specified by:

getEnablePerformanceInsights in interface DatabaseClusterProps

getEngineVersion

public final String getEngineVersion()

Description copied from interface: DatabaseClusterProps

What version of the database to start.

Default: - the latest major version

Specified by:

getEngineVersion in interface DatabaseClusterProps

getExportAuditLogsToCloudWatch

public final Boolean getExportAuditLogsToCloudWatch()

Description copied from interface: DatabaseClusterProps

Whether the audit logs should be exported to CloudWatch.

Note that you also have to configure the audit log export in the Cluster's Parameter Group.

Default: false

Specified by:

getExportAuditLogsToCloudWatch in interface DatabaseClusterProps

See Also:

• https://docs.aws.amazon.com/documentdb/latest/developerguide/event-auditing.html#event-auditing-enabling-auditing

getExportProfilerLogsToCloudWatch

public final Boolean getExportProfilerLogsToCloudWatch()

Description copied from interface: DatabaseClusterProps

Whether the profiler logs should be exported to CloudWatch.

Note that you also have to configure the profiler log export in the Cluster's Parameter Group.

Default: false

Specified by:

getExportProfilerLogsToCloudWatch in interface DatabaseClusterProps

See Also:

• https://docs.aws.amazon.com/documentdb/latest/developerguide/profiling.html#profiling.enable-profiling

getInstanceIdentifierBase

public final String getInstanceIdentifierBase()

Description copied from interface: DatabaseClusterProps

Base identifier for instances.

Every replica is named by appending the replica number to this string, 1-based. Only applicable for provisioned clusters.

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

getInstanceRemovalPolicy

public final RemovalPolicy getInstanceRemovalPolicy()

Description copied from interface: DatabaseClusterProps

The removal policy to apply to the cluster's instances.

Cannot be set to SNAPSHOT.

Default: - `RemovalPolicy.DESTROY` when `removalPolicy` is set to `SNAPSHOT`, `removalPolicy` otherwise.

Specified by:

getInstanceRemovalPolicy in interface DatabaseClusterProps

See Also:

• https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html

getInstances

public final Number getInstances()

Description copied from interface: DatabaseClusterProps

Number of DocDB compute instances.

Default: 1

Specified by:

getInstances in interface DatabaseClusterProps

getInstanceType

public final InstanceType getInstanceType()

Description copied from interface: DatabaseClusterProps

What type of instance to start for the replicas.

Required for provisioned clusters, not applicable for serverless clusters.

Default: None

Specified by:

getInstanceType in interface DatabaseClusterProps

getKmsKey

public final IKey getKmsKey()

Description copied from interface: DatabaseClusterProps

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

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

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

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

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.

When set to SNAPSHOT, the removal policy for the instances and the security group will default to DESTROY as those resources do not support the policy.

Use the instanceRemovalPolicy and securityGroupRemovalPolicy to change the behavior.

Default: - Retain cluster.

Specified by:

getRemovalPolicy in interface DatabaseClusterProps

getSecurityGroup

public final ISecurityGroup getSecurityGroup()

Description copied from interface: DatabaseClusterProps

Security group.

Default: a new security group is created.

Specified by:

getSecurityGroup in interface DatabaseClusterProps

getSecurityGroupRemovalPolicy

public final RemovalPolicy getSecurityGroupRemovalPolicy()

Description copied from interface: DatabaseClusterProps

The removal policy to apply to the cluster's security group.

Cannot be set to SNAPSHOT.

Default: - `RemovalPolicy.DESTROY` when `removalPolicy` is set to `SNAPSHOT`, `removalPolicy` otherwise.

Specified by:

getSecurityGroupRemovalPolicy in interface DatabaseClusterProps

See Also:

• https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html

getServerlessV2ScalingConfiguration

public final ServerlessV2ScalingConfiguration getServerlessV2ScalingConfiguration()

Description copied from interface: DatabaseClusterProps

ServerlessV2 scaling configuration.

When specified, the cluster will be created as a serverless cluster.

Default: None

Specified by:

getServerlessV2ScalingConfiguration in interface DatabaseClusterProps

getStorageEncrypted

public final Boolean getStorageEncrypted()

Description copied from interface: DatabaseClusterProps

Whether to enable storage encryption.

Default: true

Specified by:

getStorageEncrypted in interface DatabaseClusterProps

getStorageType

public final StorageType getStorageType()

Description copied from interface: DatabaseClusterProps

The storage type of the DocDB cluster.

I/O-optimized storage is supported starting with engine version 5.0.0.

Default: StorageType.STANDARD

Specified by:

getStorageType in interface DatabaseClusterProps

See Also:

• https://docs.aws.amazon.com/documentdb/latest/developerguide/release-notes.html#release-notes.11-21-2023

getVpcSubnets

public final SubnetSelection getVpcSubnets()

Description copied from interface: DatabaseClusterProps

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