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

All Superinterfaces:: software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:: CfnDBClusterProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:38.015Z")
 @Stability(value=Stable)
public interface CfnDBClusterProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `CfnDBCluster`.

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.*;
 CfnDBClusterProps cfnDBClusterProps = CfnDBClusterProps.builder()
         .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	Interface and Description
`static class`	`CfnDBClusterProps.Builder` A builder for `CfnDBClusterProps`
`static class`	`CfnDBClusterProps.Jsii$Proxy` An implementation for `CfnDBClusterProps`

Method Summary

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

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

- Method Detail
  - getAvailabilityZones
```
@Stability(value=Stable)
 @Nullable
default List<String> getAvailabilityZones()
```
    A list of Amazon EC2 Availability Zones that instances in the cluster can be created in.
  - getBackupRetentionPeriod
```
@Stability(value=Stable)
 @Nullable
default 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.
  - getCopyTagsToSnapshot
```
@Stability(value=Stable)
 @Nullable
default Object getCopyTagsToSnapshot()
```
    `AWS::DocDB::DBCluster.CopyTagsToSnapshot`.
  - getDbClusterIdentifier
```
@Stability(value=Stable)
 @Nullable
default 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
  - getDbClusterParameterGroupName
```
@Stability(value=Stable)
 @Nullable
default String getDbClusterParameterGroupName()
```
    The name of the cluster parameter group to associate with this cluster.
  - getDbSubnetGroupName
```
@Stability(value=Stable)
 @Nullable
default 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
  - getDeletionProtection
```
@Stability(value=Stable)
 @Nullable
default Object getDeletionProtection()
```
    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
default 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 .
  - getEngineVersion
```
@Stability(value=Stable)
 @Nullable
default 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.
  - getKmsKeyId
```
@Stability(value=Stable)
 @Nullable
default 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 .
  - getMasterUsername
```
@Stability(value=Stable)
 @Nullable
default 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.
  - getMasterUserPassword
```
@Stability(value=Stable)
 @Nullable
default 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.
  - getPort
```
@Stability(value=Stable)
 @Nullable
default Number getPort()
```
    Specifies the port that the database engine is listening on.
  - getPreferredBackupWindow
```
@Stability(value=Stable)
 @Nullable
default 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.
  - getPreferredMaintenanceWindow
```
@Stability(value=Stable)
 @Nullable
default 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.
  - getRestoreToTime
```
@Stability(value=Stable)
 @Nullable
default String getRestoreToTime()
```
    `AWS::DocDB::DBCluster.RestoreToTime`.
  - getRestoreType
```
@Stability(value=Stable)
 @Nullable
default String getRestoreType()
```
    `AWS::DocDB::DBCluster.RestoreType`.
  - getSnapshotIdentifier
```
@Stability(value=Stable)
 @Nullable
default 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.
  - getSourceDbClusterIdentifier
```
@Stability(value=Stable)
 @Nullable
default String getSourceDbClusterIdentifier()
```
    `AWS::DocDB::DBCluster.SourceDBClusterIdentifier`.
  - getStorageEncrypted
```
@Stability(value=Stable)
 @Nullable
default Object getStorageEncrypted()
```
    Specifies whether the cluster is encrypted.
  - getTags
```
@Stability(value=Stable)
 @Nullable
default List<CfnTag> getTags()
```
    The tags to be assigned to the cluster.
  - getUseLatestRestorableTime
```
@Stability(value=Stable)
 @Nullable
default Object getUseLatestRestorableTime()
```
    `AWS::DocDB::DBCluster.UseLatestRestorableTime`.
  - getVpcSecurityGroupIds
```
@Stability(value=Stable)
 @Nullable
default List<String> getVpcSecurityGroupIds()
```
    A list of EC2 VPC security groups to associate with this cluster.
  - builder
```
@Stability(value=Stable)
static CfnDBClusterProps.Builder builder()
```
    Returns:
    
    a CfnDBClusterProps.Builder of CfnDBClusterProps

Interface CfnDBClusterProps

Nested Class Summary

Method Summary

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Method Detail

getAvailabilityZones

getBackupRetentionPeriod

getCopyTagsToSnapshot

getDbClusterIdentifier

getDbClusterParameterGroupName

getDbSubnetGroupName

getDeletionProtection

getEnableCloudwatchLogsExports

getEngineVersion

getKmsKeyId

getMasterUsername

getMasterUserPassword

getPort

getPreferredBackupWindow

getPreferredMaintenanceWindow

getRestoreToTime

getRestoreType

getSnapshotIdentifier

getSourceDbClusterIdentifier

getStorageEncrypted

getTags

getUseLatestRestorableTime

getVpcSecurityGroupIds

builder