CfnDBCluster (software.amazon.awscdk:aws-cdk-lib 2.42.1 API)

java.lang.Object
- software.amazon.jsii.JsiiObject
- - software.constructs.Construct
  - - software.amazon.awscdk.CfnElement
    - - software.amazon.awscdk.CfnRefElement
      - software.amazon.awscdk.CfnResource
        
        software.amazon.awscdk.services.docdb.CfnDBCluster

All Implemented Interfaces:: IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:38.011Z")
 @Stability(value=Stable)
public class CfnDBCluster
extends CfnResource
implements IInspectable

A CloudFormation `AWS::DocDB::DBCluster`.

The AWS::DocDB::DBCluster Amazon DocumentDB (with MongoDB compatibility) resource describes a DBCluster. Amazon DocumentDB is a fully managed, MongoDB-compatible document database engine. For more information, see DBCluster in the Amazon DocumentDB Developer Guide .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.docdb.*;
 CfnDBCluster cfnDBCluster = CfnDBCluster.Builder.create(this, "MyCfnDBCluster")
         .availabilityZones(List.of("availabilityZones"))
         .backupRetentionPeriod(123)
         .copyTagsToSnapshot(false)
         .dbClusterIdentifier("dbClusterIdentifier")
         .dbClusterParameterGroupName("dbClusterParameterGroupName")
         .dbSubnetGroupName("dbSubnetGroupName")
         .deletionProtection(false)
         .enableCloudwatchLogsExports(List.of("enableCloudwatchLogsExports"))
         .engineVersion("engineVersion")
         .kmsKeyId("kmsKeyId")
         .masterUsername("masterUsername")
         .masterUserPassword("masterUserPassword")
         .port(123)
         .preferredBackupWindow("preferredBackupWindow")
         .preferredMaintenanceWindow("preferredMaintenanceWindow")
         .restoreToTime("restoreToTime")
         .restoreType("restoreType")
         .snapshotIdentifier("snapshotIdentifier")
         .sourceDbClusterIdentifier("sourceDbClusterIdentifier")
         .storageEncrypted(false)
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .useLatestRestorableTime(false)
         .vpcSecurityGroupIds(List.of("vpcSecurityGroupIds"))
         .build();

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class CfnDBCluster.Builder
A fluent builder for CfnDBCluster.
- Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
  software.amazon.jsii.JsiiObject.InitializationMode
- Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
  IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
- Nested classes/interfaces inherited from interface software.constructs.IConstruct
  software.constructs.IConstruct.Jsii$Default

Nested Classes
Modifier and Type	Class and Description
`static class`	`CfnDBCluster.Builder` A fluent builder for `CfnDBCluster`.

Field Summary

Fields
Modifier and Type Field and Description

static String CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.

Fields
Modifier and Type	Field and Description
`static String`	`CFN_RESOURCE_TYPE_NAME` The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors
Modifier	Constructor and Description
	`CfnDBCluster(software.constructs.Construct scope, String id)` Create a new `AWS::DocDB::DBCluster`.
	`CfnDBCluster(software.constructs.Construct scope, String id, CfnDBClusterProps props)` Create a new `AWS::DocDB::DBCluster`.
`protected`	`CfnDBCluster(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)`
`protected`	`CfnDBCluster(software.amazon.jsii.JsiiObjectRef objRef)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getAttrClusterResourceId()` The resource id for the cluster;
`String`	`getAttrEndpoint()` The connection endpoint for the cluster, such as `sample-cluster.cluster-cozrlsfrcjoc.us-east-1.docdb.amazonaws.com` .
`String`	`getAttrPort()` The port number on which the cluster accepts connections.
`String`	`getAttrReadEndpoint()` The reader endpoint for the cluster.
`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.
`protected Map<String,Object>`	`getCfnProperties()`
`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.
`TagManager`	`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.
`void`	`inspect(TreeInspector inspector)` Examines the CloudFormation resource and discloses attributes.
`protected Map<String,Object>`	`renderProperties(Map<String,Object> props)`
`void`	`setAvailabilityZones(List<String> value)` A list of Amazon EC2 Availability Zones that instances in the cluster can be created in.
`void`	`setBackupRetentionPeriod(Number value)` The number of days for which automated backups are retained.
`void`	`setCopyTagsToSnapshot(Boolean value)` `AWS::DocDB::DBCluster.CopyTagsToSnapshot`.
`void`	`setCopyTagsToSnapshot(IResolvable value)` `AWS::DocDB::DBCluster.CopyTagsToSnapshot`.
`void`	`setDbClusterIdentifier(String value)` The cluster identifier.
`void`	`setDbClusterParameterGroupName(String value)` The name of the cluster parameter group to associate with this cluster.
`void`	`setDbSubnetGroupName(String value)` A subnet group to associate with this cluster.
`void`	`setDeletionProtection(Boolean value)` Protects clusters from being accidentally deleted.
`void`	`setDeletionProtection(IResolvable value)` Protects clusters from being accidentally deleted.
`void`	`setEnableCloudwatchLogsExports(List<String> value)` The list of log types that need to be enabled for exporting to Amazon CloudWatch Logs.
`void`	`setEngineVersion(String value)` The version number of the database engine to use.
`void`	`setKmsKeyId(String value)` The AWS KMS key identifier for an encrypted cluster.
`void`	`setMasterUsername(String value)` The name of the master user for the cluster.
`void`	`setMasterUserPassword(String value)` The password for the master database user.
`void`	`setPort(Number value)` Specifies the port that the database engine is listening on.
`void`	`setPreferredBackupWindow(String value)` The daily time range during which automated backups are created if automated backups are enabled using the `BackupRetentionPeriod` parameter.
`void`	`setPreferredMaintenanceWindow(String value)` The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
`void`	`setRestoreToTime(String value)` `AWS::DocDB::DBCluster.RestoreToTime`.
`void`	`setRestoreType(String value)` `AWS::DocDB::DBCluster.RestoreType`.
`void`	`setSnapshotIdentifier(String value)` The identifier for the snapshot or cluster snapshot to restore from.
`void`	`setSourceDbClusterIdentifier(String value)` `AWS::DocDB::DBCluster.SourceDBClusterIdentifier`.
`void`	`setStorageEncrypted(Boolean value)` Specifies whether the cluster is encrypted.
`void`	`setStorageEncrypted(IResolvable value)` Specifies whether the cluster is encrypted.
`void`	`setUseLatestRestorableTime(Boolean value)` `AWS::DocDB::DBCluster.UseLatestRestorableTime`.
`void`	`setUseLatestRestorableTime(IResolvable value)` `AWS::DocDB::DBCluster.UseLatestRestorableTime`.
`void`	`setVpcSecurityGroupIds(List<String> value)` A list of EC2 VPC security groups to associate with this cluster.

Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement
getRef

Methods inherited from class software.amazon.awscdk.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct
getNode, isConstruct

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, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson

- Field Detail
  - CFN_RESOURCE_TYPE_NAME
```
@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME
```
    The CloudFormation resource type name for this resource class.
- Constructor Detail
  - CfnDBCluster
```
protected CfnDBCluster(software.amazon.jsii.JsiiObjectRef objRef)
```
  - CfnDBCluster
```
protected CfnDBCluster(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
```
  - CfnDBCluster
```
@Stability(value=Stable)
public CfnDBCluster(@NotNull
                                             software.constructs.Construct scope,
                                             @NotNull
                                             String id,
                                             @Nullable
                                             CfnDBClusterProps props)
```
    Create a new `AWS::DocDB::DBCluster`.
    
    Parameters:
    
    scope - - scope in which this resource is defined. This parameter is required.
    
    id - - scoped id of the resource. This parameter is required.
    
    props - - resource properties.
  - CfnDBCluster
```
@Stability(value=Stable)
public CfnDBCluster(@NotNull
                                             software.constructs.Construct scope,
                                             @NotNull
                                             String id)
```
    Create a new `AWS::DocDB::DBCluster`.
    
    Parameters:
    
    scope - - scope in which this resource is defined. This parameter is required.
    
    id - - scoped id of the resource. This parameter is required.
- Method Detail
  - inspect
```
@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)
```
    Examines the CloudFormation resource and discloses attributes.
    
    Specified by:
    
    inspect in interface IInspectable
    
    Parameters:
    
    inspector - - tree inspector to collect and process attributes. This parameter is required.
  - renderProperties
```
@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)
```
    Overrides:
    
    renderProperties in class CfnResource
    
    Parameters:
    
    props - This parameter is required.
  - getAttrClusterResourceId
```
@Stability(value=Stable)
 @NotNull
public String getAttrClusterResourceId()
```
    The resource id for the cluster;
    for example: cluster-ABCD1234EFGH5678IJKL90MNOP . The cluster ID uniquely identifies the cluster and is used in things like IAM authentication policies.
  - getAttrEndpoint
```
@Stability(value=Stable)
 @NotNull
public String getAttrEndpoint()
```
    The connection endpoint for the cluster, such as `sample-cluster.cluster-cozrlsfrcjoc.us-east-1.docdb.amazonaws.com` .
  - getAttrPort
```
@Stability(value=Stable)
 @NotNull
public String getAttrPort()
```
    The port number on which the cluster accepts connections.
    For example: 27017 .
  - getAttrReadEndpoint
```
@Stability(value=Stable)
 @NotNull
public String getAttrReadEndpoint()
```
    The reader endpoint for the cluster.
    For example: sample-cluster.cluster-ro-cozrlsfrcjoc.us-east-1.docdb.amazonaws.com .
  - getCfnProperties
```
@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()
```
    Overrides:
    
    getCfnProperties in class CfnResource
  - getTags
```
@Stability(value=Stable)
 @NotNull
public TagManager getTags()
```
    The tags to be assigned to the cluster.
  - getAvailabilityZones
```
@Stability(value=Stable)
 @Nullable
public List<String> getAvailabilityZones()
```
    A list of Amazon EC2 Availability Zones that instances in the cluster can be created in.
  - setAvailabilityZones
```
@Stability(value=Stable)
public void setAvailabilityZones(@Nullable
                                                          List<String> value)
```
    A list of Amazon EC2 Availability Zones that instances in the cluster can be created in.
  - getBackupRetentionPeriod
```
@Stability(value=Stable)
 @Nullable
public Number getBackupRetentionPeriod()
```
    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.
  - setBackupRetentionPeriod
```
@Stability(value=Stable)
public void setBackupRetentionPeriod(@Nullable
                                                              Number value)
```
    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.
  - getCopyTagsToSnapshot
```
@Stability(value=Stable)
 @Nullable
public Object getCopyTagsToSnapshot()
```
    `AWS::DocDB::DBCluster.CopyTagsToSnapshot`.
  - setCopyTagsToSnapshot
```
@Stability(value=Stable)
public void setCopyTagsToSnapshot(@Nullable
                                                           Boolean value)
```
    `AWS::DocDB::DBCluster.CopyTagsToSnapshot`.
  - setCopyTagsToSnapshot
```
@Stability(value=Stable)
public void setCopyTagsToSnapshot(@Nullable
                                                           IResolvable value)
```
    `AWS::DocDB::DBCluster.CopyTagsToSnapshot`.
  - getDbClusterIdentifier
```
@Stability(value=Stable)
 @Nullable
public String getDbClusterIdentifier()
```
    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
  - setDbClusterIdentifier
```
@Stability(value=Stable)
public void setDbClusterIdentifier(@Nullable
                                                            String value)
```
    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
  - getDbClusterParameterGroupName
```
@Stability(value=Stable)
 @Nullable
public String getDbClusterParameterGroupName()
```
    The name of the cluster parameter group to associate with this cluster.
  - setDbClusterParameterGroupName
```
@Stability(value=Stable)
public void setDbClusterParameterGroupName(@Nullable
                                                                    String value)
```
    The name of the cluster parameter group to associate with this cluster.
  - getDbSubnetGroupName
```
@Stability(value=Stable)
 @Nullable
public String getDbSubnetGroupName()
```
    A subnet group to associate with this cluster.
    Constraints: Must match the name of an existing DBSubnetGroup . Must not be default.
    Example: mySubnetgroup
  - setDbSubnetGroupName
```
@Stability(value=Stable)
public void setDbSubnetGroupName(@Nullable
                                                          String value)
```
    A subnet group to associate with this cluster.
    Constraints: Must match the name of an existing DBSubnetGroup . Must not be default.
    Example: mySubnetgroup
  - getDeletionProtection
```
@Stability(value=Stable)
 @Nullable
public Object getDeletionProtection()
```
    Protects clusters from being accidentally deleted.
    If enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled.
  - setDeletionProtection
```
@Stability(value=Stable)
public void setDeletionProtection(@Nullable
                                                           Boolean value)
```
    Protects clusters from being accidentally deleted.
    If enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled.
  - setDeletionProtection
```
@Stability(value=Stable)
public void setDeletionProtection(@Nullable
                                                           IResolvable value)
```
    Protects clusters from being accidentally deleted.
    If enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled.
  - getEnableCloudwatchLogsExports
```
@Stability(value=Stable)
 @Nullable
public List<String> getEnableCloudwatchLogsExports()
```
    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 .
  - setEnableCloudwatchLogsExports
```
@Stability(value=Stable)
public void setEnableCloudwatchLogsExports(@Nullable
                                                                    List<String> value)
```
    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 .
  - getEngineVersion
```
@Stability(value=Stable)
 @Nullable
public String getEngineVersion()
```
    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.
  - setEngineVersion
```
@Stability(value=Stable)
public void setEngineVersion(@Nullable
                                                      String value)
```
    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.
  - getKmsKeyId
```
@Stability(value=Stable)
 @Nullable
public String getKmsKeyId()
```
    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 .
  - setKmsKeyId
```
@Stability(value=Stable)
public void setKmsKeyId(@Nullable
                                                 String value)
```
    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 .
  - getMasterUsername
```
@Stability(value=Stable)
 @Nullable
public String getMasterUsername()
```
    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.
  - setMasterUsername
```
@Stability(value=Stable)
public void setMasterUsername(@Nullable
                                                       String value)
```
    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.
  - getMasterUserPassword
```
@Stability(value=Stable)
 @Nullable
public String getMasterUserPassword()
```
    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.
  - setMasterUserPassword
```
@Stability(value=Stable)
public void setMasterUserPassword(@Nullable
                                                           String value)
```
    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.
  - getPort
```
@Stability(value=Stable)
 @Nullable
public Number getPort()
```
    Specifies the port that the database engine is listening on.
  - setPort
```
@Stability(value=Stable)
public void setPort(@Nullable
                                             Number value)
```
    Specifies the port that the database engine is listening on.
  - getPreferredBackupWindow
```
@Stability(value=Stable)
 @Nullable
public String getPreferredBackupWindow()
```
    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.
  - setPreferredBackupWindow
```
@Stability(value=Stable)
public void setPreferredBackupWindow(@Nullable
                                                              String value)
```
    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.
  - getPreferredMaintenanceWindow
```
@Stability(value=Stable)
 @Nullable
public String getPreferredMaintenanceWindow()
```
    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.
  - setPreferredMaintenanceWindow
```
@Stability(value=Stable)
public void setPreferredMaintenanceWindow(@Nullable
                                                                   String value)
```
    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.
  - getRestoreToTime
```
@Stability(value=Stable)
 @Nullable
public String getRestoreToTime()
```
    `AWS::DocDB::DBCluster.RestoreToTime`.
  - setRestoreToTime
```
@Stability(value=Stable)
public void setRestoreToTime(@Nullable
                                                      String value)
```
    `AWS::DocDB::DBCluster.RestoreToTime`.
  - getRestoreType
```
@Stability(value=Stable)
 @Nullable
public String getRestoreType()
```
    `AWS::DocDB::DBCluster.RestoreType`.
  - setRestoreType
```
@Stability(value=Stable)
public void setRestoreType(@Nullable
                                                    String value)
```
    `AWS::DocDB::DBCluster.RestoreType`.
  - getSnapshotIdentifier
```
@Stability(value=Stable)
 @Nullable
public String getSnapshotIdentifier()
```
    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.
  - setSnapshotIdentifier
```
@Stability(value=Stable)
public void setSnapshotIdentifier(@Nullable
                                                           String value)
```
    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.
  - getSourceDbClusterIdentifier
```
@Stability(value=Stable)
 @Nullable
public String getSourceDbClusterIdentifier()
```
    `AWS::DocDB::DBCluster.SourceDBClusterIdentifier`.
  - setSourceDbClusterIdentifier
```
@Stability(value=Stable)
public void setSourceDbClusterIdentifier(@Nullable
                                                                  String value)
```
    `AWS::DocDB::DBCluster.SourceDBClusterIdentifier`.
  - getStorageEncrypted
```
@Stability(value=Stable)
 @Nullable
public Object getStorageEncrypted()
```
    Specifies whether the cluster is encrypted.
  - setStorageEncrypted
```
@Stability(value=Stable)
public void setStorageEncrypted(@Nullable
                                                         Boolean value)
```
    Specifies whether the cluster is encrypted.
  - setStorageEncrypted
```
@Stability(value=Stable)
public void setStorageEncrypted(@Nullable
                                                         IResolvable value)
```
    Specifies whether the cluster is encrypted.
  - getUseLatestRestorableTime
```
@Stability(value=Stable)
 @Nullable
public Object getUseLatestRestorableTime()
```
    `AWS::DocDB::DBCluster.UseLatestRestorableTime`.
  - setUseLatestRestorableTime
```
@Stability(value=Stable)
public void setUseLatestRestorableTime(@Nullable
                                                                Boolean value)
```
    `AWS::DocDB::DBCluster.UseLatestRestorableTime`.
  - setUseLatestRestorableTime
```
@Stability(value=Stable)
public void setUseLatestRestorableTime(@Nullable
                                                                IResolvable value)
```
    `AWS::DocDB::DBCluster.UseLatestRestorableTime`.
  - getVpcSecurityGroupIds
```
@Stability(value=Stable)
 @Nullable
public List<String> getVpcSecurityGroupIds()
```
    A list of EC2 VPC security groups to associate with this cluster.
  - setVpcSecurityGroupIds
```
@Stability(value=Stable)
public void setVpcSecurityGroupIds(@Nullable
                                                            List<String> value)
```
    A list of EC2 VPC security groups to associate with this cluster.

Class CfnDBCluster

Nested Class Summary

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

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

Nested classes/interfaces inherited from interface software.constructs.IConstruct

Field Summary

Constructor Summary

Method Summary

Methods inherited from class software.amazon.awscdk.CfnResource

Methods inherited from class software.amazon.awscdk.CfnRefElement

Methods inherited from class software.amazon.awscdk.CfnElement

Methods inherited from class software.constructs.Construct

Methods inherited from class software.amazon.jsii.JsiiObject

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Field Detail

CFN_RESOURCE_TYPE_NAME

Constructor Detail

CfnDBCluster

CfnDBCluster

CfnDBCluster

CfnDBCluster

Method Detail

inspect

renderProperties

getAttrClusterResourceId

getAttrEndpoint

getAttrPort

getAttrReadEndpoint

getCfnProperties

getTags

getAvailabilityZones

setAvailabilityZones

getBackupRetentionPeriod

setBackupRetentionPeriod

getCopyTagsToSnapshot

setCopyTagsToSnapshot

setCopyTagsToSnapshot

getDbClusterIdentifier

setDbClusterIdentifier

getDbClusterParameterGroupName

setDbClusterParameterGroupName

getDbSubnetGroupName

setDbSubnetGroupName

getDeletionProtection

setDeletionProtection

setDeletionProtection

getEnableCloudwatchLogsExports

setEnableCloudwatchLogsExports

getEngineVersion

setEngineVersion

getKmsKeyId

setKmsKeyId

getMasterUsername

setMasterUsername

getMasterUserPassword

setMasterUserPassword

getPort

setPort

getPreferredBackupWindow

setPreferredBackupWindow

getPreferredMaintenanceWindow

setPreferredMaintenanceWindow

getRestoreToTime

setRestoreToTime

getRestoreType

setRestoreType

getSnapshotIdentifier

setSnapshotIdentifier

getSourceDbClusterIdentifier

setSourceDbClusterIdentifier

getStorageEncrypted

setStorageEncrypted

setStorageEncrypted

getUseLatestRestorableTime

setUseLatestRestorableTime

setUseLatestRestorableTime

getVpcSecurityGroupIds

setVpcSecurityGroupIds