Package 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(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	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	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final List<String>	getAvailabilityZones()	A list of Amazon EC2 Availability Zones that instances in the cluster can be created in.
final Number	getBackupRetentionPeriod()	The number of days for which automated backups are retained.
final Object	getCopyTagsToSnapshot()	Set to true to copy all tags from the source cluster snapshot to the target cluster snapshot, and otherwise false .
final String	getDbClusterIdentifier()	The cluster identifier.
final String	getDbClusterParameterGroupName()	The name of the cluster parameter group to associate with this cluster.
final String	getDbSubnetGroupName()	A subnet group to associate with this cluster.
final Object	getDeletionProtection()	Protects clusters from being accidentally deleted.
final List<String>	getEnableCloudwatchLogsExports()	The list of log types that need to be enabled for exporting to Amazon CloudWatch Logs.
final String	getEngineVersion()	The version number of the database engine to use.
final String	getGlobalClusterIdentifier()	The cluster identifier of the new global cluster.
final String	getKmsKeyId()	The AWS KMS key identifier for an encrypted cluster.
final Object	getManageMasterUserPassword()	Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.
final String	getMasterUsername()	The name of the master user for the cluster.
final String	getMasterUserPassword()	The password for the master database user.
final String	getMasterUserSecretKmsKeyId()	The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.
final String	getNetworkType()
final Number	getPort()	Specifies the port that the database engine is listening on.
final String	getPreferredBackupWindow()	The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.
final String	getPreferredMaintenanceWindow()	The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
final String	getRestoreToTime()	The date and time to restore the cluster to.
final String	getRestoreType()	The type of restore to be performed.
final Object	getRotateMasterUserPassword()	Specifies whether to rotate the secret managed by Amazon Web Services Secrets Manager for the master user password.
final Object	getServerlessV2ScalingConfiguration()	Contains the scaling configuration of an Amazon DocumentDB Serverless cluster.
final String	getSnapshotIdentifier()	The identifier for the snapshot or cluster snapshot to restore from.
final String	getSourceDbClusterIdentifier()	The identifier of the source cluster from which to restore.
final Object	getStorageEncrypted()	Specifies whether the cluster is encrypted.
final String	getStorageType()	The storage type to associate with the DB cluster.
final List<CfnTag>	getTags()	The tags to be assigned to the cluster.
final Object	getUseLatestRestorableTime()	A value that is set to true to restore the cluster to the latest restorable backup time, and false otherwise.
final List<String>	getVpcSecurityGroupIds()	A list of EC2 VPC security groups to associate with this cluster.
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(CfnDBClusterProps.Builder builder)

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

Method Details

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-availabilityzones

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-backupretentionperiod

getCopyTagsToSnapshot

public final Object getCopyTagsToSnapshot()

Description copied from interface: CfnDBClusterProps

Set to true to copy all tags from the source cluster snapshot to the target cluster snapshot, and otherwise false .

The default is false .

Specified by:

getCopyTagsToSnapshot in interface CfnDBClusterProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-copytagstosnapshot

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-dbclusteridentifier

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-dbclusterparametergroupname

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-dbsubnetgroupname

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-deletionprotection

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-enablecloudwatchlogsexports

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.

If you intend to trigger an in-place upgrade, please refer to Amazon DocumentDB in-place major version upgrade . Note that for an in-place engine version upgrade, you need to remove other cluster properties changes (e.g. SecurityGroupId) from the CFN template.

Specified by:

getEngineVersion in interface CfnDBClusterProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-engineversion

getGlobalClusterIdentifier

public final String getGlobalClusterIdentifier()

Description copied from interface: CfnDBClusterProps

The cluster identifier of the new global cluster.

Specified by:

getGlobalClusterIdentifier in interface CfnDBClusterProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-globalclusteridentifier

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-kmskeyid

getManageMasterUserPassword

public final Object getManageMasterUserPassword()

Description copied from interface: CfnDBClusterProps

Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.

Constraint: You can't manage the master user password with Amazon Web Services Secrets Manager if MasterUserPassword is specified.

Specified by:

getManageMasterUserPassword in interface CfnDBClusterProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-managemasteruserpassword

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-masterusername

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-masteruserpassword

getMasterUserSecretKmsKeyId

public final String getMasterUserSecretKmsKeyId()

Description copied from interface: CfnDBClusterProps

The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager.

This setting is valid only if the master user password is managed by Amazon DocumentDB in Amazon Web Services Secrets Manager for the DB cluster.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

If you don't specify MasterUserSecretKmsKeyId , then the aws/secretsmanager KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer managed KMS key.

There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.

Specified by:

getMasterUserSecretKmsKeyId in interface CfnDBClusterProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-masterusersecretkmskeyid

getNetworkType

public final String getNetworkType()

Specified by:

getNetworkType in interface CfnDBClusterProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-networktype

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-port

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-preferredbackupwindow

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-preferredmaintenancewindow

getRestoreToTime

public final String getRestoreToTime()

Description copied from interface: CfnDBClusterProps

The date and time to restore the cluster to.

Valid values: A time in Universal Coordinated Time (UTC) format.

Constraints:

• Must be before the latest restorable time for the instance.
• Must be specified if the UseLatestRestorableTime parameter is not provided.
• Cannot be specified if the UseLatestRestorableTime parameter is true .
• Cannot be specified if the RestoreType parameter is copy-on-write .

Example: 2015-03-07T23:45:00Z

Specified by:

getRestoreToTime in interface CfnDBClusterProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-restoretotime

getRestoreType

public final String getRestoreType()

Description copied from interface: CfnDBClusterProps

The type of restore to be performed. You can specify one of the following values:.

• full-copy - The new DB cluster is restored as a full copy of the source DB cluster.
• copy-on-write - The new DB cluster is restored as a clone of the source DB cluster.

Constraints: You can't specify copy-on-write if the engine version of the source DB cluster is earlier than 1.11.

If you don't specify a RestoreType value, then the new DB cluster is restored as a full copy of the source DB cluster.

Specified by:

getRestoreType in interface CfnDBClusterProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-restoretype

getRotateMasterUserPassword

public final Object getRotateMasterUserPassword()

Description copied from interface: CfnDBClusterProps

Specifies whether to rotate the secret managed by Amazon Web Services Secrets Manager for the master user password.

This setting is valid only if the master user password is managed by Amazon DocumentDB in Amazon Web Services Secrets Manager for the cluster. The secret value contains the updated password.

Constraint: You must apply the change immediately when rotating the master user password.

Specified by:

getRotateMasterUserPassword in interface CfnDBClusterProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-rotatemasteruserpassword

getServerlessV2ScalingConfiguration

public final Object getServerlessV2ScalingConfiguration()

Description copied from interface: CfnDBClusterProps

Contains the scaling configuration of an Amazon DocumentDB Serverless cluster.

Specified by:

getServerlessV2ScalingConfiguration in interface CfnDBClusterProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-serverlessv2scalingconfiguration

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-snapshotidentifier

getSourceDbClusterIdentifier

public final String getSourceDbClusterIdentifier()

Description copied from interface: CfnDBClusterProps

The identifier of the source cluster from which to restore.

Constraints:

• Must match the identifier of an existing DBCluster .

Specified by:

getSourceDbClusterIdentifier in interface CfnDBClusterProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-sourcedbclusteridentifier

getStorageEncrypted

public final Object getStorageEncrypted()

Description copied from interface: CfnDBClusterProps

Specifies whether the cluster is encrypted.

If you specify SourceDBClusterIdentifier or SnapshotIdentifier and don’t specify StorageEncrypted , the encryption property is inherited from the source cluster or snapshot (unless KMSKeyId is specified, in which case the restored cluster will be encrypted with that KMS key). If the source is encrypted and StorageEncrypted is specified to be true, the restored cluster will be encrypted (if you want to use a different KMS key, specify the KMSKeyId property as well). If the source is unencrypted and StorageEncrypted is specified to be true, then the KMSKeyId property must be specified. If the source is encrypted, don’t specify StorageEncrypted to be false as opting out of encryption is not allowed.

Specified by:

getStorageEncrypted in interface CfnDBClusterProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-storageencrypted

getStorageType

public final String getStorageType()

Description copied from interface: CfnDBClusterProps

The storage type to associate with the DB cluster.

For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the Amazon DocumentDB Developer Guide .

Valid values for storage type - standard | iopt1

Default value is standard

When you create an Amazon DocumentDB cluster with the storage type set to iopt1 , the storage type is returned in the response. The storage type isn't returned when you set it to standard .

Specified by:

getStorageType in interface CfnDBClusterProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-storagetype

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-tags

getUseLatestRestorableTime

public final Object getUseLatestRestorableTime()

Description copied from interface: CfnDBClusterProps

A value that is set to true to restore the cluster to the latest restorable backup time, and false otherwise.

Default: false

Constraints: Cannot be specified if the RestoreToTime parameter is provided.

Specified by:

getUseLatestRestorableTime in interface CfnDBClusterProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-uselatestrestorabletime

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-vpcsecuritygroupids

$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