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

java.lang.Object
- software.amazon.awscdk.services.rds.CfnDBCluster.Builder

All Implemented Interfaces:: software.amazon.jsii.Builder<CfnDBCluster>

Enclosing class:: CfnDBCluster

@Stability(value=Stable)
public static final class CfnDBCluster.Builder
extends Object
implements software.amazon.jsii.Builder<CfnDBCluster>

A fluent builder for CfnDBCluster.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CfnDBCluster.Builder`	`associatedRoles(IResolvable associatedRoles)` Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster.
`CfnDBCluster.Builder`	`associatedRoles(List<? extends Object> associatedRoles)` Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster.
`CfnDBCluster.Builder`	`availabilityZones(List<String> availabilityZones)` A list of Availability Zones (AZs) where instances in the DB cluster can be created.
`CfnDBCluster.Builder`	`backtrackWindow(Number backtrackWindow)` The target backtrack window, in seconds.
`CfnDBCluster.Builder`	`backupRetentionPeriod(Number backupRetentionPeriod)` The number of days for which automated backups are retained.
`CfnDBCluster`	`build()`
`CfnDBCluster.Builder`	`copyTagsToSnapshot(Boolean copyTagsToSnapshot)` A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster.
`CfnDBCluster.Builder`	`copyTagsToSnapshot(IResolvable copyTagsToSnapshot)` A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster.
`static CfnDBCluster.Builder`	`create(software.constructs.Construct scope, String id)`
`CfnDBCluster.Builder`	`databaseName(String databaseName)` The name of your database.
`CfnDBCluster.Builder`	`dbClusterIdentifier(String dbClusterIdentifier)` The DB cluster identifier.
`CfnDBCluster.Builder`	`dbClusterParameterGroupName(String dbClusterParameterGroupName)` The name of the DB cluster parameter group to associate with this DB cluster.
`CfnDBCluster.Builder`	`dbSubnetGroupName(String dbSubnetGroupName)` A DB subnet group that you want to associate with this DB cluster.
`CfnDBCluster.Builder`	`deletionProtection(Boolean deletionProtection)` A value that indicates whether the DB cluster has deletion protection enabled.
`CfnDBCluster.Builder`	`deletionProtection(IResolvable deletionProtection)` A value that indicates whether the DB cluster has deletion protection enabled.
`CfnDBCluster.Builder`	`enableCloudwatchLogsExports(List<String> enableCloudwatchLogsExports)` The list of log types that need to be enabled for exporting to CloudWatch Logs.
`CfnDBCluster.Builder`	`enableHttpEndpoint(Boolean enableHttpEndpoint)` A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster.
`CfnDBCluster.Builder`	`enableHttpEndpoint(IResolvable enableHttpEndpoint)` A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster.
`CfnDBCluster.Builder`	`enableIamDatabaseAuthentication(Boolean enableIamDatabaseAuthentication)` A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts.
`CfnDBCluster.Builder`	`enableIamDatabaseAuthentication(IResolvable enableIamDatabaseAuthentication)` A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts.
`CfnDBCluster.Builder`	`engine(String engine)` The name of the database engine to be used for this DB cluster.
`CfnDBCluster.Builder`	`engineMode(String engineMode)` The DB engine mode of the DB cluster, either `provisioned` , `serverless` , `parallelquery` , `global` , or `multimaster` .
`CfnDBCluster.Builder`	`engineVersion(String engineVersion)` The version number of the database engine to use.
`CfnDBCluster.Builder`	`globalClusterIdentifier(String globalClusterIdentifier)` If you are configuring an Aurora global database cluster and want your Aurora DB cluster to be a secondary member in the global database cluster, specify the global cluster ID of the global database cluster.
`CfnDBCluster.Builder`	`kmsKeyId(String kmsKeyId)` The Amazon Resource Name (ARN) of the AWS KMS key that is used to encrypt the database instances in the DB cluster, such as `arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef` .
`CfnDBCluster.Builder`	`masterUsername(String masterUsername)` The name of the master user for the DB cluster.
`CfnDBCluster.Builder`	`masterUserPassword(String masterUserPassword)` The master password for the DB instance.
`CfnDBCluster.Builder`	`port(Number port)` The port number on which the DB instances in the DB cluster accept connections.
`CfnDBCluster.Builder`	`preferredBackupWindow(String preferredBackupWindow)` The daily time range during which automated backups are created.
`CfnDBCluster.Builder`	`preferredMaintenanceWindow(String preferredMaintenanceWindow)` The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
`CfnDBCluster.Builder`	`replicationSourceIdentifier(String replicationSourceIdentifier)` The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a read replica.
`CfnDBCluster.Builder`	`restoreType(String restoreType)` The type of restore to be performed.
`CfnDBCluster.Builder`	`scalingConfiguration(CfnDBCluster.ScalingConfigurationProperty scalingConfiguration)` The `ScalingConfiguration` property type specifies the scaling configuration of an Aurora Serverless DB cluster.
`CfnDBCluster.Builder`	`scalingConfiguration(IResolvable scalingConfiguration)` The `ScalingConfiguration` property type specifies the scaling configuration of an Aurora Serverless DB cluster.
`CfnDBCluster.Builder`	`snapshotIdentifier(String snapshotIdentifier)` The identifier for the DB snapshot or DB cluster snapshot to restore from.
`CfnDBCluster.Builder`	`sourceDbClusterIdentifier(String sourceDbClusterIdentifier)` When restoring a DB cluster to a point in time, the identifier of the source DB cluster from which to restore.
`CfnDBCluster.Builder`	`sourceRegion(String sourceRegion)` The AWS Region which contains the source DB cluster when replicating a DB cluster.
`CfnDBCluster.Builder`	`storageEncrypted(Boolean storageEncrypted)` Indicates whether the DB cluster is encrypted.
`CfnDBCluster.Builder`	`storageEncrypted(IResolvable storageEncrypted)` Indicates whether the DB cluster is encrypted.
`CfnDBCluster.Builder`	`tags(List<? extends CfnTag> tags)` Tags to assign to the DB cluster.
`CfnDBCluster.Builder`	`useLatestRestorableTime(Boolean useLatestRestorableTime)` A value that indicates whether to restore the DB cluster to the latest restorable backup time.
`CfnDBCluster.Builder`	`useLatestRestorableTime(IResolvable useLatestRestorableTime)` A value that indicates whether to restore the DB cluster to the latest restorable backup time.
`CfnDBCluster.Builder`	`vpcSecurityGroupIds(List<String> vpcSecurityGroupIds)` A list of EC2 VPC security groups to associate with this DB cluster.

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

- Method Detail
  - create
```
@Stability(value=Stable)
public static CfnDBCluster.Builder create(software.constructs.Construct scope,
                                                                   String id)
```
    Parameters:
    
    scope - - scope in which this resource is defined. This parameter is required.
    
    id - - scoped id of the resource. This parameter is required.
    
    Returns:
    
    a new instance of CfnDBCluster.DBClusterRoleProperty.Builder.
  - engine
```
@Stability(value=Stable)
public CfnDBCluster.Builder engine(String engine)
```
    The name of the database engine to be used for this DB cluster.
    Valid Values: aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL 5.7-compatible Aurora), and aurora-postgresql
    
    Parameters:
    
    engine - The name of the database engine to be used for this DB cluster. This parameter is required.
    
    Returns:
    
    this
  - associatedRoles
```
@Stability(value=Stable)
public CfnDBCluster.Builder associatedRoles(IResolvable associatedRoles)
```
    Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster.
    IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon Web Services on your behalf.
    
    Parameters:
    
    associatedRoles - Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster. This parameter is required.
    
    Returns:
    
    this
  - associatedRoles
```
@Stability(value=Stable)
public CfnDBCluster.Builder associatedRoles(List<? extends Object> associatedRoles)
```
    Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster.
    IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon Web Services on your behalf.
    
    Parameters:
    
    associatedRoles - Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster. This parameter is required.
    
    Returns:
    
    this
  - availabilityZones
```
@Stability(value=Stable)
public CfnDBCluster.Builder availabilityZones(List<String> availabilityZones)
```
    A list of Availability Zones (AZs) where instances in the DB cluster can be created.
    For information on AWS Regions and Availability Zones, see Choosing the Regions and Availability Zones in the Amazon Aurora User Guide .
    
    Parameters:
    
    availabilityZones - A list of Availability Zones (AZs) where instances in the DB cluster can be created. This parameter is required.
    
    Returns:
    
    this
  - backtrackWindow
```
@Stability(value=Stable)
public CfnDBCluster.Builder backtrackWindow(Number backtrackWindow)
```
    The target backtrack window, in seconds. To disable backtracking, set this value to 0.
    
    Currently, Backtrack is only supported for Aurora MySQL DB clusters.
    
    Default: 0
    Constraints:
    - If specified, this value must be set to a number from 0 to 259,200 (72 hours).
    Parameters:
    
    backtrackWindow - The target backtrack window, in seconds. To disable backtracking, set this value to 0. This parameter is required.
    
    Returns:
    
    this
  - backupRetentionPeriod
```
@Stability(value=Stable)
public CfnDBCluster.Builder backupRetentionPeriod(Number backupRetentionPeriod)
```
    The number of days for which automated backups are retained.
    Default: 1
    Constraints:
    - Must be a value from 1 to 35
    Parameters:
    
    backupRetentionPeriod - The number of days for which automated backups are retained. This parameter is required.
    
    Returns:
    
    this
  - copyTagsToSnapshot
```
@Stability(value=Stable)
public CfnDBCluster.Builder copyTagsToSnapshot(Boolean copyTagsToSnapshot)
```
    A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster.
    The default is not to copy them.
    
    Parameters:
    
    copyTagsToSnapshot - A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. This parameter is required.
    
    Returns:
    
    this
  - copyTagsToSnapshot
```
@Stability(value=Stable)
public CfnDBCluster.Builder copyTagsToSnapshot(IResolvable copyTagsToSnapshot)
```
    A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster.
    The default is not to copy them.
    
    Parameters:
    
    copyTagsToSnapshot - A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. This parameter is required.
    
    Returns:
    
    this
  - databaseName
```
@Stability(value=Stable)
public CfnDBCluster.Builder databaseName(String databaseName)
```
    The name of your database.
    If you don't provide a name, then Amazon RDS won't create a database in this DB cluster. For naming constraints, see Naming Constraints in the Amazon Aurora User Guide .
    
    Parameters:
    
    databaseName - The name of your database. This parameter is required.
    
    Returns:
    
    this
  - dbClusterIdentifier
```
@Stability(value=Stable)
public CfnDBCluster.Builder dbClusterIdentifier(String dbClusterIdentifier)
```
    The DB cluster identifier. This parameter is stored as a lowercase string.
    Constraints:
    - Must contain from 1 to 63 letters, numbers, or hyphens.
    - First character must be a letter.
    - Can't end with a hyphen or contain two consecutive hyphens.
    Example: my-cluster1
    Parameters:
    
    dbClusterIdentifier - The DB cluster identifier. This parameter is stored as a lowercase string. This parameter is required.
    
    Returns:
    
    this
  - dbClusterParameterGroupName
```
@Stability(value=Stable)
public CfnDBCluster.Builder dbClusterParameterGroupName(String dbClusterParameterGroupName)
```
    The name of the DB cluster parameter group to associate with this DB cluster.
    
    If you apply a parameter group to an existing DB cluster, then its DB instances might need to reboot. This can result in an outage while the DB instances are rebooting.
    If you apply a change to parameter group associated with a stopped DB cluster, then the update stack waits until the DB cluster is started.
    
    To list all of the available DB cluster parameter group names, use the following command:
    aws rds describe-db-cluster-parameter-groups --query "DBClusterParameterGroups[].DBClusterParameterGroupName" --output text
    
    Parameters:
    
    dbClusterParameterGroupName - The name of the DB cluster parameter group to associate with this DB cluster. This parameter is required.
    
    Returns:
    
    this
  - dbSubnetGroupName
```
@Stability(value=Stable)
public CfnDBCluster.Builder dbSubnetGroupName(String dbSubnetGroupName)
```
    A DB subnet group that you want to associate with this DB cluster.
    If you are restoring a DB cluster to a point in time with RestoreType set to copy-on-write , and don't specify a DB subnet group name, then the DB cluster is restored with a default DB subnet group.
    
    Parameters:
    
    dbSubnetGroupName - A DB subnet group that you want to associate with this DB cluster. This parameter is required.
    
    Returns:
    
    this
  - deletionProtection
```
@Stability(value=Stable)
public CfnDBCluster.Builder deletionProtection(Boolean deletionProtection)
```
    A value that indicates whether the DB cluster has deletion protection enabled.
    The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.
    
    Parameters:
    
    deletionProtection - A value that indicates whether the DB cluster has deletion protection enabled. This parameter is required.
    
    Returns:
    
    this
  - deletionProtection
```
@Stability(value=Stable)
public CfnDBCluster.Builder deletionProtection(IResolvable deletionProtection)
```
    A value that indicates whether the DB cluster has deletion protection enabled.
    The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.
    
    Parameters:
    
    deletionProtection - A value that indicates whether the DB cluster has deletion protection enabled. This parameter is required.
    
    Returns:
    
    this
  - enableCloudwatchLogsExports
```
@Stability(value=Stable)
public CfnDBCluster.Builder enableCloudwatchLogsExports(List<String> enableCloudwatchLogsExports)
```
    The list of log types that need to be enabled for exporting to CloudWatch Logs.
    The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide .
    Aurora MySQL
    Valid values: audit , error , general , slowquery
    Aurora PostgreSQL
    Valid values: postgresql
    
    Parameters:
    
    enableCloudwatchLogsExports - The list of log types that need to be enabled for exporting to CloudWatch Logs. This parameter is required.
    
    Returns:
    
    this
  - enableHttpEndpoint
```
@Stability(value=Stable)
public CfnDBCluster.Builder enableHttpEndpoint(Boolean enableHttpEndpoint)
```
    A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster.
    By default, the HTTP endpoint is disabled.
    When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor.
    For more information, see Using the Data API for Aurora Serverless in the Amazon Aurora User Guide .
    
    Parameters:
    
    enableHttpEndpoint - A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster. This parameter is required.
    
    Returns:
    
    this
  - enableHttpEndpoint
```
@Stability(value=Stable)
public CfnDBCluster.Builder enableHttpEndpoint(IResolvable enableHttpEndpoint)
```
    A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster.
    By default, the HTTP endpoint is disabled.
    When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor.
    For more information, see Using the Data API for Aurora Serverless in the Amazon Aurora User Guide .
    
    Parameters:
    
    enableHttpEndpoint - A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster. This parameter is required.
    
    Returns:
    
    this
  - enableIamDatabaseAuthentication
```
@Stability(value=Stable)
public CfnDBCluster.Builder enableIamDatabaseAuthentication(Boolean enableIamDatabaseAuthentication)
```
    A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts.
    By default, mapping is disabled.
    For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
    
    Parameters:
    
    enableIamDatabaseAuthentication - A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. This parameter is required.
    
    Returns:
    
    this
  - enableIamDatabaseAuthentication
```
@Stability(value=Stable)
public CfnDBCluster.Builder enableIamDatabaseAuthentication(IResolvable enableIamDatabaseAuthentication)
```
    A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts.
    By default, mapping is disabled.
    For more information, see IAM Database Authentication in the Amazon Aurora User Guide.
    
    Parameters:
    
    enableIamDatabaseAuthentication - A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. This parameter is required.
    
    Returns:
    
    this
  - engineMode
```
@Stability(value=Stable)
public CfnDBCluster.Builder engineMode(String engineMode)
```
    The DB engine mode of the DB cluster, either `provisioned` , `serverless` , `parallelquery` , `global` , or `multimaster` .
    The serverless engine mode only supports Aurora Serverless v1. Currently, AWS CloudFormation doesn't support Aurora Serverless v2.
    The parallelquery engine mode isn't required for Aurora MySQL version 1.23 and higher 1.x versions, and version 2.09 and higher 2.x versions.
    The global engine mode isn't required for Aurora MySQL version 1.22 and higher 1.x versions, and global engine mode isn't required for any 2.x versions.
    The multimaster engine mode only applies for DB clusters created with Aurora MySQL version 5.6.10a.
    For Aurora PostgreSQL, the global engine mode isn't required, and both the parallelquery and the multimaster engine modes currently aren't supported.
    Limitations and requirements apply to some DB engine modes. For more information, see the following sections in the Amazon Aurora User Guide :
    Parameters:
    
    engineMode - The DB engine mode of the DB cluster, either `provisioned` , `serverless` , `parallelquery` , `global` , or `multimaster` . This parameter is required.
    
    Returns:
    
    this
  - engineVersion
```
@Stability(value=Stable)
public CfnDBCluster.Builder engineVersion(String engineVersion)
```
    The version number of the database engine to use.
    To list all of the available engine versions for aurora (for MySQL 5.6-compatible Aurora), use the following command:
    aws rds describe-db-engine-versions --engine aurora --query "DBEngineVersions[].EngineVersion"
    To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible Aurora), use the following command:
    aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"
    To list all of the available engine versions for aurora-postgresql , use the following command:
    aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion"
    
    Parameters:
    
    engineVersion - The version number of the database engine to use. This parameter is required.
    
    Returns:
    
    this
  - globalClusterIdentifier
```
@Stability(value=Stable)
public CfnDBCluster.Builder globalClusterIdentifier(String globalClusterIdentifier)
```
    If you are configuring an Aurora global database cluster and want your Aurora DB cluster to be a secondary member in the global database cluster, specify the global cluster ID of the global database cluster.
    To define the primary database cluster of the global cluster, use the AWS::RDS::GlobalCluster resource.
    If you aren't configuring a global database cluster, don't specify this property.
    
    To remove the DB cluster from a global database cluster, specify an empty value for the GlobalClusterIdentifier property.
    
    For information about Aurora global databases, see Working with Amazon Aurora Global Databases in the Amazon Aurora User Guide .
    
    Parameters:
    
    globalClusterIdentifier - If you are configuring an Aurora global database cluster and want your Aurora DB cluster to be a secondary member in the global database cluster, specify the global cluster ID of the global database cluster. This parameter is required.
    
    Returns:
    
    this
  - kmsKeyId
```
@Stability(value=Stable)
public CfnDBCluster.Builder kmsKeyId(String kmsKeyId)
```
    The Amazon Resource Name (ARN) of the AWS KMS key that is used to encrypt the database instances in the DB cluster, such as `arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef` .
    If you enable the StorageEncrypted property but don't specify this property, the default KMS key is used. If you specify this property, you must set the StorageEncrypted property to true .
    If you specify the SnapshotIdentifier property, the StorageEncrypted property value is inherited from the snapshot, and if the DB cluster is encrypted, the specified KmsKeyId property is used.
    
    Parameters:
    
    kmsKeyId - The Amazon Resource Name (ARN) of the AWS KMS key that is used to encrypt the database instances in the DB cluster, such as `arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef` . This parameter is required.
    
    Returns:
    
    this
  - masterUsername
```
@Stability(value=Stable)
public CfnDBCluster.Builder masterUsername(String masterUsername)
```
    The name of the master user for the DB cluster.
    
    If you specify the SourceDBClusterIdentifier , SnapshotIdentifier , or GlobalClusterIdentifier property, don't specify this property. The value is inherited from the source DB cluster, the snapshot, or the primary DB cluster for the global database cluster, respectively.
    
    Parameters:
    
    masterUsername - The name of the master user for the DB cluster. This parameter is required.
    
    Returns:
    
    this
  - masterUserPassword
```
@Stability(value=Stable)
public CfnDBCluster.Builder masterUserPassword(String masterUserPassword)
```
    The master password for the DB instance.
    
    If you specify the SourceDBClusterIdentifier , SnapshotIdentifier , or GlobalClusterIdentifier property, don't specify this property. The value is inherited from the source DB cluster, the snapshot, or the primary DB cluster for the global database cluster, respectively.
    
    Parameters:
    
    masterUserPassword - The master password for the DB instance. This parameter is required.
    
    Returns:
    
    this
  - port
```
@Stability(value=Stable)
public CfnDBCluster.Builder port(Number port)
```
    The port number on which the DB instances in the DB cluster accept connections.
    Default:
    - When EngineMode is provisioned , 3306 (for both Aurora MySQL and Aurora PostgreSQL)
    - When EngineMode is serverless :
    - 3306 when Engine is aurora or aurora-mysql
    - 5432 when Engine is aurora-postgresql
    The No interruption on update behavior only applies to DB clusters. If you are updating a DB instance, see Port for the AWS::RDS::DBInstance resource.
    Parameters:
    
    port - The port number on which the DB instances in the DB cluster accept connections. This parameter is required.
    
    Returns:
    
    this
  - preferredBackupWindow
```
@Stability(value=Stable)
public CfnDBCluster.Builder preferredBackupWindow(String preferredBackupWindow)
```
    The daily time range during which automated backups are created.
    For more information, see Backup Window in the Amazon Aurora User Guide.
    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.
    Parameters:
    
    preferredBackupWindow - The daily time range during which automated backups are created. This parameter is required.
    
    Returns:
    
    this
  - preferredMaintenanceWindow
```
@Stability(value=Stable)
public CfnDBCluster.Builder preferredMaintenanceWindow(String preferredMaintenanceWindow)
```
    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. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.
    Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
    Constraints: Minimum 30-minute window.
    
    Parameters:
    
    preferredMaintenanceWindow - The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). This parameter is required.
    
    Returns:
    
    this
  - replicationSourceIdentifier
```
@Stability(value=Stable)
public CfnDBCluster.Builder replicationSourceIdentifier(String replicationSourceIdentifier)
```
    The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a read replica.
    
    Parameters:
    
    replicationSourceIdentifier - The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a read replica. This parameter is required.
    
    Returns:
    
    this
  - restoreType
```
@Stability(value=Stable)
public CfnDBCluster.Builder restoreType(String restoreType)
```
    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.
    Parameters:
    
    restoreType - The type of restore to be performed. You can specify one of the following values:. This parameter is required.
    
    Returns:
    
    this
  - scalingConfiguration
```
@Stability(value=Stable)
public CfnDBCluster.Builder scalingConfiguration(CfnDBCluster.ScalingConfigurationProperty scalingConfiguration)
```
    The `ScalingConfiguration` property type specifies the scaling configuration of an Aurora Serverless DB cluster.
    Currently, AWS CloudFormation only supports Aurora Serverless v1. AWS CloudFormation doesn't support Aurora Serverless v2.
    
    Parameters:
    
    scalingConfiguration - The `ScalingConfiguration` property type specifies the scaling configuration of an Aurora Serverless DB cluster. This parameter is required.
    
    Returns:
    
    this
  - scalingConfiguration
```
@Stability(value=Stable)
public CfnDBCluster.Builder scalingConfiguration(IResolvable scalingConfiguration)
```
    The `ScalingConfiguration` property type specifies the scaling configuration of an Aurora Serverless DB cluster.
    Currently, AWS CloudFormation only supports Aurora Serverless v1. AWS CloudFormation doesn't support Aurora Serverless v2.
    
    Parameters:
    
    scalingConfiguration - The `ScalingConfiguration` property type specifies the scaling configuration of an Aurora Serverless DB cluster. This parameter is required.
    
    Returns:
    
    this
  - snapshotIdentifier
```
@Stability(value=Stable)
public CfnDBCluster.Builder snapshotIdentifier(String snapshotIdentifier)
```
    The identifier for the DB snapshot or DB cluster snapshot to restore from.
    You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot.
    After you restore a DB cluster with a SnapshotIdentifier property, you must specify the same SnapshotIdentifier property for any future updates to the DB cluster. When you specify this property for an update, the DB cluster is not restored from the snapshot again, and the data in the database is not changed. However, if you don't specify the SnapshotIdentifier property, an empty DB cluster is created, and the original DB cluster is deleted. If you specify a property that is different from the previous snapshot restore property, a new DB cluster is restored from the specified SnapshotIdentifier property, and the original DB cluster is deleted.
    If you specify the SnapshotIdentifier property to restore a DB cluster (as opposed to specifying it for DB cluster updates), then don't specify the following properties:
    - GlobalClusterIdentifier
    - MasterUsername
    - MasterUserPassword
    - ReplicationSourceIdentifier
    - RestoreType
    - SourceDBClusterIdentifier
    - SourceRegion
    - StorageEncrypted (for an encrypted snapshot)
    - UseLatestRestorableTime
    Constraints:
    - Must match the identifier of an existing Snapshot.
    Parameters:
    
    snapshotIdentifier - The identifier for the DB snapshot or DB cluster snapshot to restore from. This parameter is required.
    
    Returns:
    
    this
  - sourceDbClusterIdentifier
```
@Stability(value=Stable)
public CfnDBCluster.Builder sourceDbClusterIdentifier(String sourceDbClusterIdentifier)
```
    When restoring a DB cluster to a point in time, the identifier of the source DB cluster from which to restore.
    Constraints:
    - Must match the identifier of an existing DBCluster.
    Parameters:
    
    sourceDbClusterIdentifier - When restoring a DB cluster to a point in time, the identifier of the source DB cluster from which to restore. This parameter is required.
    
    Returns:
    
    this
  - sourceRegion
```
@Stability(value=Stable)
public CfnDBCluster.Builder sourceRegion(String sourceRegion)
```
    The AWS Region which contains the source DB cluster when replicating a DB cluster.
    For example, us-east-1 .
    
    Parameters:
    
    sourceRegion - The AWS Region which contains the source DB cluster when replicating a DB cluster. This parameter is required.
    
    Returns:
    
    this
  - storageEncrypted
```
@Stability(value=Stable)
public CfnDBCluster.Builder storageEncrypted(Boolean storageEncrypted)
```
    Indicates whether the DB cluster is encrypted.
    If you specify the KmsKeyId property, then you must enable encryption.
    If you specify the SourceDBClusterIdentifier property, don't specify this property. The value is inherited from the source DB cluster, and if the DB cluster is encrypted, the specified KmsKeyId property is used.
    If you specify the SnapshotIdentifier and the specified snapshot is encrypted, don't specify this property. The value is inherited from the snapshot, and the specified KmsKeyId property is used.
    If you specify the SnapshotIdentifier and the specified snapshot isn't encrypted, you can use this property to specify that the restored DB cluster is encrypted. Specify the KmsKeyId property for the KMS key to use for encryption. If you don't want the restored DB cluster to be encrypted, then don't set this property or set it to false .
    
    Parameters:
    
    storageEncrypted - Indicates whether the DB cluster is encrypted. This parameter is required.
    
    Returns:
    
    this
  - storageEncrypted
```
@Stability(value=Stable)
public CfnDBCluster.Builder storageEncrypted(IResolvable storageEncrypted)
```
    Indicates whether the DB cluster is encrypted.
    If you specify the KmsKeyId property, then you must enable encryption.
    If you specify the SourceDBClusterIdentifier property, don't specify this property. The value is inherited from the source DB cluster, and if the DB cluster is encrypted, the specified KmsKeyId property is used.
    If you specify the SnapshotIdentifier and the specified snapshot is encrypted, don't specify this property. The value is inherited from the snapshot, and the specified KmsKeyId property is used.
    If you specify the SnapshotIdentifier and the specified snapshot isn't encrypted, you can use this property to specify that the restored DB cluster is encrypted. Specify the KmsKeyId property for the KMS key to use for encryption. If you don't want the restored DB cluster to be encrypted, then don't set this property or set it to false .
    
    Parameters:
    
    storageEncrypted - Indicates whether the DB cluster is encrypted. This parameter is required.
    
    Returns:
    
    this
  - tags
```
@Stability(value=Stable)
public CfnDBCluster.Builder tags(List<? extends CfnTag> tags)
```
    Tags to assign to the DB cluster.
    
    Parameters:
    
    tags - Tags to assign to the DB cluster. This parameter is required.
    
    Returns:
    
    this
  - useLatestRestorableTime
```
@Stability(value=Stable)
public CfnDBCluster.Builder useLatestRestorableTime(Boolean useLatestRestorableTime)
```
    A value that indicates whether to restore the DB cluster to the latest restorable backup time.
    By default, the DB cluster is not restored to the latest restorable backup time.
    
    Parameters:
    
    useLatestRestorableTime - A value that indicates whether to restore the DB cluster to the latest restorable backup time. This parameter is required.
    
    Returns:
    
    this
  - useLatestRestorableTime
```
@Stability(value=Stable)
public CfnDBCluster.Builder useLatestRestorableTime(IResolvable useLatestRestorableTime)
```
    A value that indicates whether to restore the DB cluster to the latest restorable backup time.
    By default, the DB cluster is not restored to the latest restorable backup time.
    
    Parameters:
    
    useLatestRestorableTime - A value that indicates whether to restore the DB cluster to the latest restorable backup time. This parameter is required.
    
    Returns:
    
    this
  - vpcSecurityGroupIds
```
@Stability(value=Stable)
public CfnDBCluster.Builder vpcSecurityGroupIds(List<String> vpcSecurityGroupIds)
```
    A list of EC2 VPC security groups to associate with this DB cluster.
    If you plan to update the resource, don't specify VPC security groups in a shared VPC.
    
    Parameters:
    
    vpcSecurityGroupIds - A list of EC2 VPC security groups to associate with this DB cluster. This parameter is required.
    
    Returns:
    
    this
  - build
```
@Stability(value=Stable)
public CfnDBCluster build()
```
    Specified by:
    
    build in interface software.amazon.jsii.Builder<CfnDBCluster>

Class CfnDBCluster.Builder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

create

engine

associatedRoles

associatedRoles

availabilityZones

backtrackWindow

backupRetentionPeriod

copyTagsToSnapshot

copyTagsToSnapshot

databaseName

dbClusterIdentifier

dbClusterParameterGroupName

dbSubnetGroupName

deletionProtection

deletionProtection

enableCloudwatchLogsExports

enableHttpEndpoint

enableHttpEndpoint

enableIamDatabaseAuthentication

enableIamDatabaseAuthentication

engineMode

engineVersion

globalClusterIdentifier

kmsKeyId

masterUsername

masterUserPassword

port

preferredBackupWindow

preferredMaintenanceWindow

replicationSourceIdentifier

restoreType

scalingConfiguration

scalingConfiguration

snapshotIdentifier

sourceDbClusterIdentifier

sourceRegion

storageEncrypted

storageEncrypted

tags

useLatestRestorableTime

useLatestRestorableTime

vpcSecurityGroupIds

build