CfnDBCluster

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

All Implemented Interfaces:: IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-12-07T17:24:42.906Z")
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 interface software.amazon.awscdk.core.IInspectable
  IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
- Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
  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 java.lang.String CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.

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

Constructor Summary

Constructors
Modifier	Constructor and Description
	`CfnDBCluster(Construct scope, java.lang.String id)` Create a new `AWS::DocDB::DBCluster`.
	`CfnDBCluster(Construct scope, java.lang.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
`java.lang.String`	`getAttrClusterResourceId()` The resource id for the cluster;
`java.lang.String`	`getAttrEndpoint()` The connection endpoint for the cluster, such as `sample-cluster.cluster-cozrlsfrcjoc.us-east-1.docdb.amazonaws.com` .
`java.lang.String`	`getAttrPort()` The port number on which the cluster accepts connections.
`java.lang.String`	`getAttrReadEndpoint()` The reader endpoint for the cluster.
`java.util.List<java.lang.String>`	`getAvailabilityZones()` A list of Amazon EC2 Availability Zones that instances in the cluster can be created in.
`java.lang.Number`	`getBackupRetentionPeriod()` The number of days for which automated backups are retained.
`protected java.util.Map<java.lang.String,java.lang.Object>`	`getCfnProperties()`
`java.lang.Object`	`getCopyTagsToSnapshot()` `AWS::DocDB::DBCluster.CopyTagsToSnapshot`.
`java.lang.String`	`getDbClusterIdentifier()` The cluster identifier.
`java.lang.String`	`getDbClusterParameterGroupName()` The name of the cluster parameter group to associate with this cluster.
`java.lang.String`	`getDbSubnetGroupName()` A subnet group to associate with this cluster.
`java.lang.Object`	`getDeletionProtection()` Protects clusters from being accidentally deleted.
`java.util.List<java.lang.String>`	`getEnableCloudwatchLogsExports()` The list of log types that need to be enabled for exporting to Amazon CloudWatch Logs.
`java.lang.String`	`getEngineVersion()` The version number of the database engine to use.
`java.lang.String`	`getKmsKeyId()` The AWS KMS key identifier for an encrypted cluster.
`java.lang.String`	`getMasterUsername()` The name of the master user for the cluster.
`java.lang.String`	`getMasterUserPassword()` The password for the master database user.
`java.lang.Number`	`getPort()` Specifies the port that the database engine is listening on.
`java.lang.String`	`getPreferredBackupWindow()` The daily time range during which automated backups are created if automated backups are enabled using the `BackupRetentionPeriod` parameter.
`java.lang.String`	`getPreferredMaintenanceWindow()` The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
`java.lang.String`	`getRestoreToTime()` The date and time to restore the cluster to.
`java.lang.String`	`getRestoreType()` The type of restore to be performed.
`java.lang.String`	`getSnapshotIdentifier()` The identifier for the snapshot or cluster snapshot to restore from.
`java.lang.String`	`getSourceDbClusterIdentifier()` The identifier of the source cluster from which to restore.
`java.lang.Object`	`getStorageEncrypted()` Specifies whether the cluster is encrypted.
`TagManager`	`getTags()` The tags to be assigned to the cluster.
`java.lang.Object`	`getUseLatestRestorableTime()` A value that is set to `true` to restore the cluster to the latest restorable backup time, and `false` otherwise.
`java.util.List<java.lang.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 java.util.Map<java.lang.String,java.lang.Object>`	`renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)`
`void`	`setAvailabilityZones(java.util.List<java.lang.String> value)` A list of Amazon EC2 Availability Zones that instances in the cluster can be created in.
`void`	`setBackupRetentionPeriod(java.lang.Number value)` The number of days for which automated backups are retained.
`void`	`setCopyTagsToSnapshot(java.lang.Boolean value)` `AWS::DocDB::DBCluster.CopyTagsToSnapshot`.
`void`	`setCopyTagsToSnapshot(IResolvable value)` `AWS::DocDB::DBCluster.CopyTagsToSnapshot`.
`void`	`setDbClusterIdentifier(java.lang.String value)` The cluster identifier.
`void`	`setDbClusterParameterGroupName(java.lang.String value)` The name of the cluster parameter group to associate with this cluster.
`void`	`setDbSubnetGroupName(java.lang.String value)` A subnet group to associate with this cluster.
`void`	`setDeletionProtection(java.lang.Boolean value)` Protects clusters from being accidentally deleted.
`void`	`setDeletionProtection(IResolvable value)` Protects clusters from being accidentally deleted.
`void`	`setEnableCloudwatchLogsExports(java.util.List<java.lang.String> value)` The list of log types that need to be enabled for exporting to Amazon CloudWatch Logs.
`void`	`setEngineVersion(java.lang.String value)` The version number of the database engine to use.
`void`	`setKmsKeyId(java.lang.String value)` The AWS KMS key identifier for an encrypted cluster.
`void`	`setMasterUsername(java.lang.String value)` The name of the master user for the cluster.
`void`	`setMasterUserPassword(java.lang.String value)` The password for the master database user.
`void`	`setPort(java.lang.Number value)` Specifies the port that the database engine is listening on.
`void`	`setPreferredBackupWindow(java.lang.String value)` The daily time range during which automated backups are created if automated backups are enabled using the `BackupRetentionPeriod` parameter.
`void`	`setPreferredMaintenanceWindow(java.lang.String value)` The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
`void`	`setRestoreToTime(java.lang.String value)` The date and time to restore the cluster to.
`void`	`setRestoreType(java.lang.String value)` The type of restore to be performed.
`void`	`setSnapshotIdentifier(java.lang.String value)` The identifier for the snapshot or cluster snapshot to restore from.
`void`	`setSourceDbClusterIdentifier(java.lang.String value)` The identifier of the source cluster from which to restore.
`void`	`setStorageEncrypted(java.lang.Boolean value)` Specifies whether the cluster is encrypted.
`void`	`setStorageEncrypted(IResolvable value)` Specifies whether the cluster is encrypted.
`void`	`setUseLatestRestorableTime(java.lang.Boolean value)` A value that is set to `true` to restore the cluster to the latest restorable backup time, and `false` otherwise.
`void`	`setUseLatestRestorableTime(IResolvable value)` A value that is set to `true` to restore the cluster to the latest restorable backup time, and `false` otherwise.
`void`	`setVpcSecurityGroupIds(java.util.List<java.lang.String> value)` A list of EC2 VPC security groups to associate with this cluster.

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

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

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

Methods inherited from class software.amazon.awscdk.core.Construct
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - CFN_RESOURCE_TYPE_NAME
```
public static final java.lang.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
```
public CfnDBCluster(Construct scope,
                    java.lang.String id,
                    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
```
public CfnDBCluster(Construct scope,
                    java.lang.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
```
public void inspect(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
```
protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
```
    Overrides:
    
    renderProperties in class CfnResource
    
    Parameters:
    
    props - This parameter is required.
  - getAttrClusterResourceId
```
public java.lang.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
```
public java.lang.String getAttrEndpoint()
```
    The connection endpoint for the cluster, such as `sample-cluster.cluster-cozrlsfrcjoc.us-east-1.docdb.amazonaws.com` .
  - getAttrPort
```
public java.lang.String getAttrPort()
```
    The port number on which the cluster accepts connections.
    For example: 27017 .
  - getAttrReadEndpoint
```
public java.lang.String getAttrReadEndpoint()
```
    The reader endpoint for the cluster.
    For example: sample-cluster.cluster-ro-cozrlsfrcjoc.us-east-1.docdb.amazonaws.com .
  - getCfnProperties
```
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
```
    Overrides:
    
    getCfnProperties in class CfnResource
  - getTags
```
public TagManager getTags()
```
    The tags to be assigned to the cluster.
  - getAvailabilityZones
```
public java.util.List<java.lang.String> getAvailabilityZones()
```
    A list of Amazon EC2 Availability Zones that instances in the cluster can be created in.
  - setAvailabilityZones
```
public void setAvailabilityZones(java.util.List<java.lang.String> value)
```
    A list of Amazon EC2 Availability Zones that instances in the cluster can be created in.
  - getBackupRetentionPeriod
```
public java.lang.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
```
public void setBackupRetentionPeriod(java.lang.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
```
public java.lang.Object getCopyTagsToSnapshot()
```
    `AWS::DocDB::DBCluster.CopyTagsToSnapshot`.
  - setCopyTagsToSnapshot
```
public void setCopyTagsToSnapshot(java.lang.Boolean value)
```
    `AWS::DocDB::DBCluster.CopyTagsToSnapshot`.
  - setCopyTagsToSnapshot
```
public void setCopyTagsToSnapshot(IResolvable value)
```
    `AWS::DocDB::DBCluster.CopyTagsToSnapshot`.
  - getDbClusterIdentifier
```
public java.lang.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
```
public void setDbClusterIdentifier(java.lang.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
```
public java.lang.String getDbClusterParameterGroupName()
```
    The name of the cluster parameter group to associate with this cluster.
  - setDbClusterParameterGroupName
```
public void setDbClusterParameterGroupName(java.lang.String value)
```
    The name of the cluster parameter group to associate with this cluster.
  - getDbSubnetGroupName
```
public java.lang.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
```
public void setDbSubnetGroupName(java.lang.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
```
public java.lang.Object getDeletionProtection()
```
    Protects clusters from being accidentally deleted.
    If enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled.
  - setDeletionProtection
```
public void setDeletionProtection(java.lang.Boolean value)
```
    Protects clusters from being accidentally deleted.
    If enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled.
  - setDeletionProtection
```
public void setDeletionProtection(IResolvable value)
```
    Protects clusters from being accidentally deleted.
    If enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled.
  - getEnableCloudwatchLogsExports
```
public java.util.List<java.lang.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
```
public void setEnableCloudwatchLogsExports(java.util.List<java.lang.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
```
public java.lang.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
```
public void setEngineVersion(java.lang.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
```
public java.lang.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
```
public void setKmsKeyId(java.lang.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
```
public java.lang.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
```
public void setMasterUsername(java.lang.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
```
public java.lang.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
```
public void setMasterUserPassword(java.lang.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
```
public java.lang.Number getPort()
```
    Specifies the port that the database engine is listening on.
  - setPort
```
public void setPort(java.lang.Number value)
```
    Specifies the port that the database engine is listening on.
  - getPreferredBackupWindow
```
public java.lang.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
```
public void setPreferredBackupWindow(java.lang.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
```
public java.lang.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
```
public void setPreferredMaintenanceWindow(java.lang.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
```
public java.lang.String getRestoreToTime()
```
    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
  - setRestoreToTime
```
public void setRestoreToTime(java.lang.String value)
```
    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
  - getRestoreType
```
public java.lang.String getRestoreType()
```
    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.
  - setRestoreType
```
public void setRestoreType(java.lang.String value)
```
    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.
  - getSnapshotIdentifier
```
public java.lang.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
```
public void setSnapshotIdentifier(java.lang.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
```
public java.lang.String getSourceDbClusterIdentifier()
```
    The identifier of the source cluster from which to restore.
    Constraints:
    - Must match the identifier of an existing DBCluster .
  - setSourceDbClusterIdentifier
```
public void setSourceDbClusterIdentifier(java.lang.String value)
```
    The identifier of the source cluster from which to restore.
    Constraints:
    - Must match the identifier of an existing DBCluster .
  - getStorageEncrypted
```
public java.lang.Object getStorageEncrypted()
```
    Specifies whether the cluster is encrypted.
  - setStorageEncrypted
```
public void setStorageEncrypted(java.lang.Boolean value)
```
    Specifies whether the cluster is encrypted.
  - setStorageEncrypted
```
public void setStorageEncrypted(IResolvable value)
```
    Specifies whether the cluster is encrypted.
  - getUseLatestRestorableTime
```
public java.lang.Object getUseLatestRestorableTime()
```
    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.
  - setUseLatestRestorableTime
```
public void setUseLatestRestorableTime(java.lang.Boolean value)
```
    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.
  - setUseLatestRestorableTime
```
public void setUseLatestRestorableTime(IResolvable value)
```
    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.
  - getVpcSecurityGroupIds
```
public java.util.List<java.lang.String> getVpcSecurityGroupIds()
```
    A list of EC2 VPC security groups to associate with this cluster.
  - setVpcSecurityGroupIds
```
public void setVpcSecurityGroupIds(java.util.List<java.lang.String> value)
```
    A list of EC2 VPC security groups to associate with this cluster.

Class CfnDBCluster

Nested Class Summary

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

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

Field Summary

Constructor Summary

Method Summary

Methods inherited from class software.amazon.awscdk.core.CfnResource

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

Methods inherited from class software.amazon.awscdk.core.CfnElement

Methods inherited from class software.amazon.awscdk.core.Construct

Methods inherited from class java.lang.Object

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