software.amazon.awscdk.services.docdb

Class CfnDBClusterProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

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

All Implemented Interfaces:

CfnDBClusterProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnDBClusterProps

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

An implementation for CfnDBClusterProps

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.CfnDBClusterProps

CfnDBClusterProps.Builder, CfnDBClusterProps.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Jsii$Proxy(CfnDBClusterProps.Builder builder) Constructor that initializes the object based on literal property values passed by the CfnDBClusterProps.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)
List<String>	getAvailabilityZones() A list of Amazon EC2 Availability Zones that instances in the cluster can be created in.
Number	getBackupRetentionPeriod() The number of days for which automated backups are retained.
Object	getCopyTagsToSnapshot() `AWS::DocDB::DBCluster.CopyTagsToSnapshot`.
String	getDbClusterIdentifier() The cluster identifier.
String	getDbClusterParameterGroupName() The name of the cluster parameter group to associate with this cluster.
String	getDbSubnetGroupName() A subnet group to associate with this cluster.
Object	getDeletionProtection() Protects clusters from being accidentally deleted.
List<String>	getEnableCloudwatchLogsExports() The list of log types that need to be enabled for exporting to Amazon CloudWatch Logs.
String	getEngineVersion() The version number of the database engine to use.
String	getKmsKeyId() The AWS KMS key identifier for an encrypted cluster.
String	getMasterUsername() The name of the master user for the cluster.
String	getMasterUserPassword() The password for the master database user.
Number	getPort() Specifies the port that the database engine is listening on.
String	getPreferredBackupWindow() The daily time range during which automated backups are created if automated backups are enabled using the `BackupRetentionPeriod` parameter.
String	getPreferredMaintenanceWindow() The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
String	getRestoreToTime() `AWS::DocDB::DBCluster.RestoreToTime`.
String	getRestoreType() `AWS::DocDB::DBCluster.RestoreType`.
String	getSnapshotIdentifier() The identifier for the snapshot or cluster snapshot to restore from.
String	getSourceDbClusterIdentifier() `AWS::DocDB::DBCluster.SourceDBClusterIdentifier`.
Object	getStorageEncrypted() Specifies whether the cluster is encrypted.
List<CfnTag>	getTags() The tags to be assigned to the cluster.
Object	getUseLatestRestorableTime() `AWS::DocDB::DBCluster.UseLatestRestorableTime`.
List<String>	getVpcSecurityGroupIds() A list of EC2 VPC security groups to associate with this cluster.
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.CfnDBClusterProps

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

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

Method Detail

getAvailabilityZones

public final List<String> getAvailabilityZones()

Description copied from interface: CfnDBClusterProps

A list of Amazon EC2 Availability Zones that instances in the cluster can be created in.

Specified by:

getAvailabilityZones in interface CfnDBClusterProps

getBackupRetentionPeriod

public final Number getBackupRetentionPeriod()

Description copied from interface: CfnDBClusterProps

The number of days for which automated backups are retained. You must specify a minimum value of 1.

Default: 1

Constraints:

• Must be a value from 1 to 35.

Specified by:

getBackupRetentionPeriod in interface CfnDBClusterProps

getCopyTagsToSnapshot

public final Object getCopyTagsToSnapshot()

Description copied from interface: CfnDBClusterProps

`AWS::DocDB::DBCluster.CopyTagsToSnapshot`.

Specified by:

getCopyTagsToSnapshot in interface CfnDBClusterProps

getDbClusterIdentifier

public final String getDbClusterIdentifier()

Description copied from interface: CfnDBClusterProps

The cluster identifier. This parameter is stored as a lowercase string.

Constraints:

• Must contain from 1 to 63 letters, numbers, or hyphens.
• The first character must be a letter.
• Cannot end with a hyphen or contain two consecutive hyphens.

Example: my-cluster

Specified by:

getDbClusterIdentifier in interface CfnDBClusterProps

getDbClusterParameterGroupName

public final String getDbClusterParameterGroupName()

Description copied from interface: CfnDBClusterProps

The name of the cluster parameter group to associate with this cluster.

Specified by:

getDbClusterParameterGroupName in interface CfnDBClusterProps

getDbSubnetGroupName

public final String getDbSubnetGroupName()

Description copied from interface: CfnDBClusterProps

A subnet group to associate with this cluster.

Constraints: Must match the name of an existing DBSubnetGroup . Must not be default.

Example: mySubnetgroup

Specified by:

getDbSubnetGroupName in interface CfnDBClusterProps

getDeletionProtection

public final Object getDeletionProtection()

Description copied from interface: CfnDBClusterProps

Protects clusters from being accidentally deleted.

If enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled.

Specified by:

getDeletionProtection in interface CfnDBClusterProps

getEnableCloudwatchLogsExports

public final List<String> getEnableCloudwatchLogsExports()

Description copied from interface: CfnDBClusterProps

The list of log types that need to be enabled for exporting to Amazon CloudWatch Logs.

You can enable audit logs or profiler logs. For more information, see Auditing Amazon DocumentDB Events and Profiling Amazon DocumentDB Operations .

Specified by:

getEnableCloudwatchLogsExports in interface CfnDBClusterProps

getEngineVersion

public final String getEngineVersion()

Description copied from interface: CfnDBClusterProps

The version number of the database engine to use.

The --engine-version will default to the latest major engine version. For production workloads, we recommend explicitly declaring this parameter with the intended major engine version.

Specified by:

getEngineVersion in interface CfnDBClusterProps

getKmsKeyId

public final String getKmsKeyId()

Description copied from interface: CfnDBClusterProps

The AWS KMS key identifier for an encrypted cluster.

The AWS KMS key identifier is the Amazon Resource Name (ARN) for the AWS KMS encryption key. If you are creating a cluster using the same AWS account that owns the AWS KMS encryption key that is used to encrypt the new cluster, you can use the AWS KMS key alias instead of the ARN for the AWS KMS encryption key.

If an encryption key is not specified in KmsKeyId :

• If the StorageEncrypted parameter is true , Amazon DocumentDB uses your default encryption key.

AWS KMS creates the default encryption key for your AWS account . Your AWS account has a different default encryption key for each AWS Regions .

Specified by:

getKmsKeyId in interface CfnDBClusterProps

getMasterUsername

public final String getMasterUsername()

Description copied from interface: CfnDBClusterProps

The name of the master user for the cluster.

Constraints:

• Must be from 1 to 63 letters or numbers.
• The first character must be a letter.
• Cannot be a reserved word for the chosen database engine.

Specified by:

getMasterUsername in interface CfnDBClusterProps

getMasterUserPassword

public final String getMasterUserPassword()

Description copied from interface: CfnDBClusterProps

The password for the master database user.

This password can contain any printable ASCII character except forward slash (/), double quote ("), or the "at" symbol (@).

Constraints: Must contain from 8 to 100 characters.

Specified by:

getMasterUserPassword in interface CfnDBClusterProps

getPort

public final Number getPort()

Description copied from interface: CfnDBClusterProps

Specifies the port that the database engine is listening on.

Specified by:

getPort in interface CfnDBClusterProps

getPreferredBackupWindow

public final String getPreferredBackupWindow()

Description copied from interface: CfnDBClusterProps

The daily time range during which automated backups are created if automated backups are enabled using the `BackupRetentionPeriod` parameter.

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region .

Constraints:

• Must be in the format hh24:mi-hh24:mi .
• Must be in Universal Coordinated Time (UTC).
• Must not conflict with the preferred maintenance window.
• Must be at least 30 minutes.

Specified by:

getPreferredBackupWindow in interface CfnDBClusterProps

getPreferredMaintenanceWindow

public final String getPreferredMaintenanceWindow()

Description copied from interface: CfnDBClusterProps

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Format: ddd:hh24:mi-ddd:hh24:mi

The default is 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.

Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

Constraints: Minimum 30-minute window.

Specified by:

getPreferredMaintenanceWindow in interface CfnDBClusterProps

getRestoreToTime

public final String getRestoreToTime()

Description copied from interface: CfnDBClusterProps

`AWS::DocDB::DBCluster.RestoreToTime`.

Specified by:

getRestoreToTime in interface CfnDBClusterProps

getRestoreType

public final String getRestoreType()

Description copied from interface: CfnDBClusterProps

`AWS::DocDB::DBCluster.RestoreType`.

Specified by:

getRestoreType in interface CfnDBClusterProps

getSnapshotIdentifier

public final String getSnapshotIdentifier()

Description copied from interface: CfnDBClusterProps

The identifier for the snapshot or cluster snapshot to restore from.

You can use either the name or the Amazon Resource Name (ARN) to specify a cluster snapshot. However, you can use only the ARN to specify a snapshot.

Constraints:

• Must match the identifier of an existing snapshot.

Specified by:

getSnapshotIdentifier in interface CfnDBClusterProps

getSourceDbClusterIdentifier

public final String getSourceDbClusterIdentifier()

Description copied from interface: CfnDBClusterProps

`AWS::DocDB::DBCluster.SourceDBClusterIdentifier`.

Specified by:

getSourceDbClusterIdentifier in interface CfnDBClusterProps

getStorageEncrypted

public final Object getStorageEncrypted()

Description copied from interface: CfnDBClusterProps

Specifies whether the cluster is encrypted.

Specified by:

getStorageEncrypted in interface CfnDBClusterProps

getTags

public final List<CfnTag> getTags()

Description copied from interface: CfnDBClusterProps

The tags to be assigned to the cluster.

Specified by:

getTags in interface CfnDBClusterProps

getUseLatestRestorableTime

public final Object getUseLatestRestorableTime()

Description copied from interface: CfnDBClusterProps

`AWS::DocDB::DBCluster.UseLatestRestorableTime`.

Specified by:

getUseLatestRestorableTime in interface CfnDBClusterProps

getVpcSecurityGroupIds

public final List<String> getVpcSecurityGroupIds()

Description copied from interface: CfnDBClusterProps

A list of EC2 VPC security groups to associate with this cluster.

Specified by:

getVpcSecurityGroupIds in interface CfnDBClusterProps

$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