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

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

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

Enclosing interface:: CfnDBClusterProps

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

A builder for CfnDBClusterProps

Constructor Summary

Constructors
Constructor and Description

Builder()

Constructors
Constructor and Description
`Builder()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CfnDBClusterProps.Builder`	`associatedRoles(IResolvable associatedRoles)` Sets the value of `CfnDBClusterProps.getAssociatedRoles()`
`CfnDBClusterProps.Builder`	`associatedRoles(List<? extends Object> associatedRoles)` Sets the value of `CfnDBClusterProps.getAssociatedRoles()`
`CfnDBClusterProps.Builder`	`availabilityZones(List<String> availabilityZones)` Sets the value of `CfnDBClusterProps.getAvailabilityZones()`
`CfnDBClusterProps.Builder`	`backtrackWindow(Number backtrackWindow)` Sets the value of `CfnDBClusterProps.getBacktrackWindow()`
`CfnDBClusterProps.Builder`	`backupRetentionPeriod(Number backupRetentionPeriod)` Sets the value of `CfnDBClusterProps.getBackupRetentionPeriod()`
`CfnDBClusterProps`	`build()` Builds the configured instance.
`CfnDBClusterProps.Builder`	`copyTagsToSnapshot(Boolean copyTagsToSnapshot)` Sets the value of `CfnDBClusterProps.getCopyTagsToSnapshot()`
`CfnDBClusterProps.Builder`	`copyTagsToSnapshot(IResolvable copyTagsToSnapshot)` Sets the value of `CfnDBClusterProps.getCopyTagsToSnapshot()`
`CfnDBClusterProps.Builder`	`databaseName(String databaseName)` Sets the value of `CfnDBClusterProps.getDatabaseName()`
`CfnDBClusterProps.Builder`	`dbClusterIdentifier(String dbClusterIdentifier)` Sets the value of `CfnDBClusterProps.getDbClusterIdentifier()`
`CfnDBClusterProps.Builder`	`dbClusterParameterGroupName(String dbClusterParameterGroupName)` Sets the value of `CfnDBClusterProps.getDbClusterParameterGroupName()`
`CfnDBClusterProps.Builder`	`dbSubnetGroupName(String dbSubnetGroupName)` Sets the value of `CfnDBClusterProps.getDbSubnetGroupName()`
`CfnDBClusterProps.Builder`	`deletionProtection(Boolean deletionProtection)` Sets the value of `CfnDBClusterProps.getDeletionProtection()`
`CfnDBClusterProps.Builder`	`deletionProtection(IResolvable deletionProtection)` Sets the value of `CfnDBClusterProps.getDeletionProtection()`
`CfnDBClusterProps.Builder`	`enableCloudwatchLogsExports(List<String> enableCloudwatchLogsExports)` Sets the value of `CfnDBClusterProps.getEnableCloudwatchLogsExports()`
`CfnDBClusterProps.Builder`	`enableHttpEndpoint(Boolean enableHttpEndpoint)` Sets the value of `CfnDBClusterProps.getEnableHttpEndpoint()`
`CfnDBClusterProps.Builder`	`enableHttpEndpoint(IResolvable enableHttpEndpoint)` Sets the value of `CfnDBClusterProps.getEnableHttpEndpoint()`
`CfnDBClusterProps.Builder`	`enableIamDatabaseAuthentication(Boolean enableIamDatabaseAuthentication)` Sets the value of `CfnDBClusterProps.getEnableIamDatabaseAuthentication()`
`CfnDBClusterProps.Builder`	`enableIamDatabaseAuthentication(IResolvable enableIamDatabaseAuthentication)` Sets the value of `CfnDBClusterProps.getEnableIamDatabaseAuthentication()`
`CfnDBClusterProps.Builder`	`engine(String engine)` Sets the value of `CfnDBClusterProps.getEngine()`
`CfnDBClusterProps.Builder`	`engineMode(String engineMode)` Sets the value of `CfnDBClusterProps.getEngineMode()`
`CfnDBClusterProps.Builder`	`engineVersion(String engineVersion)` Sets the value of `CfnDBClusterProps.getEngineVersion()`
`CfnDBClusterProps.Builder`	`globalClusterIdentifier(String globalClusterIdentifier)` Sets the value of `CfnDBClusterProps.getGlobalClusterIdentifier()`
`CfnDBClusterProps.Builder`	`kmsKeyId(String kmsKeyId)` Sets the value of `CfnDBClusterProps.getKmsKeyId()`
`CfnDBClusterProps.Builder`	`masterUsername(String masterUsername)` Sets the value of `CfnDBClusterProps.getMasterUsername()`
`CfnDBClusterProps.Builder`	`masterUserPassword(String masterUserPassword)` Sets the value of `CfnDBClusterProps.getMasterUserPassword()`
`CfnDBClusterProps.Builder`	`port(Number port)` Sets the value of `CfnDBClusterProps.getPort()`
`CfnDBClusterProps.Builder`	`preferredBackupWindow(String preferredBackupWindow)` Sets the value of `CfnDBClusterProps.getPreferredBackupWindow()`
`CfnDBClusterProps.Builder`	`preferredMaintenanceWindow(String preferredMaintenanceWindow)` Sets the value of `CfnDBClusterProps.getPreferredMaintenanceWindow()`
`CfnDBClusterProps.Builder`	`replicationSourceIdentifier(String replicationSourceIdentifier)` Sets the value of `CfnDBClusterProps.getReplicationSourceIdentifier()`
`CfnDBClusterProps.Builder`	`restoreType(String restoreType)` Sets the value of `CfnDBClusterProps.getRestoreType()`
`CfnDBClusterProps.Builder`	`scalingConfiguration(CfnDBCluster.ScalingConfigurationProperty scalingConfiguration)` Sets the value of `CfnDBClusterProps.getScalingConfiguration()`
`CfnDBClusterProps.Builder`	`scalingConfiguration(IResolvable scalingConfiguration)` Sets the value of `CfnDBClusterProps.getScalingConfiguration()`
`CfnDBClusterProps.Builder`	`snapshotIdentifier(String snapshotIdentifier)` Sets the value of `CfnDBClusterProps.getSnapshotIdentifier()`
`CfnDBClusterProps.Builder`	`sourceDbClusterIdentifier(String sourceDbClusterIdentifier)` Sets the value of `CfnDBClusterProps.getSourceDbClusterIdentifier()`
`CfnDBClusterProps.Builder`	`sourceRegion(String sourceRegion)` Sets the value of `CfnDBClusterProps.getSourceRegion()`
`CfnDBClusterProps.Builder`	`storageEncrypted(Boolean storageEncrypted)` Sets the value of `CfnDBClusterProps.getStorageEncrypted()`
`CfnDBClusterProps.Builder`	`storageEncrypted(IResolvable storageEncrypted)` Sets the value of `CfnDBClusterProps.getStorageEncrypted()`
`CfnDBClusterProps.Builder`	`tags(List<? extends CfnTag> tags)` Sets the value of `CfnDBClusterProps.getTags()`
`CfnDBClusterProps.Builder`	`useLatestRestorableTime(Boolean useLatestRestorableTime)` Sets the value of `CfnDBClusterProps.getUseLatestRestorableTime()`
`CfnDBClusterProps.Builder`	`useLatestRestorableTime(IResolvable useLatestRestorableTime)` Sets the value of `CfnDBClusterProps.getUseLatestRestorableTime()`
`CfnDBClusterProps.Builder`	`vpcSecurityGroupIds(List<String> vpcSecurityGroupIds)` Sets the value of `CfnDBClusterProps.getVpcSecurityGroupIds()`

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

- Constructor Detail
  - Builder
```
public Builder()
```
- Method Detail
  - engine
```
@Stability(value=Stable)
public CfnDBClusterProps.Builder engine(String engine)
```
    Sets the value of CfnDBClusterProps.getEngine()
    
    Parameters:
    
    engine - The name of the database engine to be used for this DB cluster. This parameter is required. Valid Values: aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL 5.7-compatible Aurora), and aurora-postgresql
    
    Returns:
    
    this
  - associatedRoles
```
@Stability(value=Stable)
public CfnDBClusterProps.Builder associatedRoles(IResolvable associatedRoles)
```
    Sets the value of CfnDBClusterProps.getAssociatedRoles()
    
    Parameters:
    
    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.
    
    Returns:
    
    this
  - associatedRoles
```
@Stability(value=Stable)
public CfnDBClusterProps.Builder associatedRoles(List<? extends Object> associatedRoles)
```
    Sets the value of CfnDBClusterProps.getAssociatedRoles()
    
    Parameters:
    
    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.
    
    Returns:
    
    this
  - availabilityZones
```
@Stability(value=Stable)
public CfnDBClusterProps.Builder availabilityZones(List<String> availabilityZones)
```
    Sets the value of CfnDBClusterProps.getAvailabilityZones()
    
    Parameters:
    
    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 .
    
    Returns:
    
    this
  - backtrackWindow
```
@Stability(value=Stable)
public CfnDBClusterProps.Builder backtrackWindow(Number backtrackWindow)
```
    Sets the value of CfnDBClusterProps.getBacktrackWindow()
    Parameters:
    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).
    Returns:
    
    this
  - backupRetentionPeriod
```
@Stability(value=Stable)
public CfnDBClusterProps.Builder backupRetentionPeriod(Number backupRetentionPeriod)
```
    Sets the value of CfnDBClusterProps.getBackupRetentionPeriod()
    Parameters:
    backupRetentionPeriod - The number of days for which automated backups are retained. Default: 1
    Constraints:
    
    Must be a value from 1 to 35
    Returns:
    
    this
  - copyTagsToSnapshot
```
@Stability(value=Stable)
public CfnDBClusterProps.Builder copyTagsToSnapshot(Boolean copyTagsToSnapshot)
```
    Sets the value of CfnDBClusterProps.getCopyTagsToSnapshot()
    
    Parameters:
    
    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.
    
    Returns:
    
    this
  - copyTagsToSnapshot
```
@Stability(value=Stable)
public CfnDBClusterProps.Builder copyTagsToSnapshot(IResolvable copyTagsToSnapshot)
```
    Sets the value of CfnDBClusterProps.getCopyTagsToSnapshot()
    
    Parameters:
    
    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.
    
    Returns:
    
    this
  - databaseName
```
@Stability(value=Stable)
public CfnDBClusterProps.Builder databaseName(String databaseName)
```
    Sets the value of CfnDBClusterProps.getDatabaseName()
    
    Parameters:
    
    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 .
    
    Returns:
    
    this
  - dbClusterIdentifier
```
@Stability(value=Stable)
public CfnDBClusterProps.Builder dbClusterIdentifier(String dbClusterIdentifier)
```
    Sets the value of CfnDBClusterProps.getDbClusterIdentifier()
    Parameters:
    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
    Returns:
    
    this
  - dbClusterParameterGroupName
```
@Stability(value=Stable)
public CfnDBClusterProps.Builder dbClusterParameterGroupName(String dbClusterParameterGroupName)
```
    Sets the value of CfnDBClusterProps.getDbClusterParameterGroupName()
    
    Parameters:
    
    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
    
    Returns:
    
    this
  - dbSubnetGroupName
```
@Stability(value=Stable)
public CfnDBClusterProps.Builder dbSubnetGroupName(String dbSubnetGroupName)
```
    Sets the value of CfnDBClusterProps.getDbSubnetGroupName()
    
    Parameters:
    
    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.
    
    Returns:
    
    this
  - deletionProtection
```
@Stability(value=Stable)
public CfnDBClusterProps.Builder deletionProtection(Boolean deletionProtection)
```
    Sets the value of CfnDBClusterProps.getDeletionProtection()
    
    Parameters:
    
    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.
    
    Returns:
    
    this
  - deletionProtection
```
@Stability(value=Stable)
public CfnDBClusterProps.Builder deletionProtection(IResolvable deletionProtection)
```
    Sets the value of CfnDBClusterProps.getDeletionProtection()
    
    Parameters:
    
    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.
    
    Returns:
    
    this
  - enableCloudwatchLogsExports
```
@Stability(value=Stable)
public CfnDBClusterProps.Builder enableCloudwatchLogsExports(List<String> enableCloudwatchLogsExports)
```
    Sets the value of CfnDBClusterProps.getEnableCloudwatchLogsExports()
    
    Parameters:
    
    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
    
    Returns:
    
    this
  - enableHttpEndpoint
```
@Stability(value=Stable)
public CfnDBClusterProps.Builder enableHttpEndpoint(Boolean enableHttpEndpoint)
```
    Sets the value of CfnDBClusterProps.getEnableHttpEndpoint()
    
    Parameters:
    
    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 .
    
    Returns:
    
    this
  - enableHttpEndpoint
```
@Stability(value=Stable)
public CfnDBClusterProps.Builder enableHttpEndpoint(IResolvable enableHttpEndpoint)
```
    Sets the value of CfnDBClusterProps.getEnableHttpEndpoint()
    
    Parameters:
    
    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 .
    
    Returns:
    
    this
  - enableIamDatabaseAuthentication
```
@Stability(value=Stable)
public CfnDBClusterProps.Builder enableIamDatabaseAuthentication(Boolean enableIamDatabaseAuthentication)
```
    Sets the value of CfnDBClusterProps.getEnableIamDatabaseAuthentication()
    
    Parameters:
    
    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.
    
    Returns:
    
    this
  - enableIamDatabaseAuthentication
```
@Stability(value=Stable)
public CfnDBClusterProps.Builder enableIamDatabaseAuthentication(IResolvable enableIamDatabaseAuthentication)
```
    Sets the value of CfnDBClusterProps.getEnableIamDatabaseAuthentication()
    
    Parameters:
    
    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.
    
    Returns:
    
    this
  - engineMode
```
@Stability(value=Stable)
public CfnDBClusterProps.Builder engineMode(String engineMode)
```
    Sets the value of CfnDBClusterProps.getEngineMode()
    Parameters:
    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 :
    
    Limitations of Aurora Serverless
    
    Limitations of Parallel Query
    
    Limitations of Aurora Global Databases
    
    Limitations of Multi-Master Clusters
    Returns:
    
    this
  - engineVersion
```
@Stability(value=Stable)
public CfnDBClusterProps.Builder engineVersion(String engineVersion)
```
    Sets the value of CfnDBClusterProps.getEngineVersion()
    
    Parameters:
    
    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"
    
    Returns:
    
    this
  - globalClusterIdentifier
```
@Stability(value=Stable)
public CfnDBClusterProps.Builder globalClusterIdentifier(String globalClusterIdentifier)
```
    Sets the value of CfnDBClusterProps.getGlobalClusterIdentifier()
    
    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. 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 .
    
    Returns:
    
    this
  - kmsKeyId
```
@Stability(value=Stable)
public CfnDBClusterProps.Builder kmsKeyId(String kmsKeyId)
```
    Sets the value of CfnDBClusterProps.getKmsKeyId()
    
    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` . 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.
    
    Returns:
    
    this
  - masterUsername
```
@Stability(value=Stable)
public CfnDBClusterProps.Builder masterUsername(String masterUsername)
```
    Sets the value of CfnDBClusterProps.getMasterUsername()
    
    Parameters:
    
    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.
    
    Returns:
    
    this
  - masterUserPassword
```
@Stability(value=Stable)
public CfnDBClusterProps.Builder masterUserPassword(String masterUserPassword)
```
    Sets the value of CfnDBClusterProps.getMasterUserPassword()
    
    Parameters:
    
    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.
    
    Returns:
    
    this
  - port
```
@Stability(value=Stable)
public CfnDBClusterProps.Builder port(Number port)
```
    Sets the value of CfnDBClusterProps.getPort()
    Parameters:
    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.
    Returns:
    
    this
  - preferredBackupWindow
```
@Stability(value=Stable)
public CfnDBClusterProps.Builder preferredBackupWindow(String preferredBackupWindow)
```
    Sets the value of CfnDBClusterProps.getPreferredBackupWindow()
    Parameters:
    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.
    Returns:
    
    this
  - preferredMaintenanceWindow
```
@Stability(value=Stable)
public CfnDBClusterProps.Builder preferredMaintenanceWindow(String preferredMaintenanceWindow)
```
    Sets the value of CfnDBClusterProps.getPreferredMaintenanceWindow()
    
    Parameters:
    
    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.
    
    Returns:
    
    this
  - replicationSourceIdentifier
```
@Stability(value=Stable)
public CfnDBClusterProps.Builder replicationSourceIdentifier(String replicationSourceIdentifier)
```
    Sets the value of CfnDBClusterProps.getReplicationSourceIdentifier()
    
    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.
    
    Returns:
    
    this
  - restoreType
```
@Stability(value=Stable)
public CfnDBClusterProps.Builder restoreType(String restoreType)
```
    Sets the value of CfnDBClusterProps.getRestoreType()
    Parameters:
    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.
    Returns:
    
    this
  - scalingConfiguration
```
@Stability(value=Stable)
public CfnDBClusterProps.Builder scalingConfiguration(CfnDBCluster.ScalingConfigurationProperty scalingConfiguration)
```
    Sets the value of CfnDBClusterProps.getScalingConfiguration()
    
    Parameters:
    
    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.
    
    Returns:
    
    this
  - scalingConfiguration
```
@Stability(value=Stable)
public CfnDBClusterProps.Builder scalingConfiguration(IResolvable scalingConfiguration)
```
    Sets the value of CfnDBClusterProps.getScalingConfiguration()
    
    Parameters:
    
    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.
    
    Returns:
    
    this
  - snapshotIdentifier
```
@Stability(value=Stable)
public CfnDBClusterProps.Builder snapshotIdentifier(String snapshotIdentifier)
```
    Sets the value of CfnDBClusterProps.getSnapshotIdentifier()
    Parameters:
    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.
    Returns:
    
    this
  - sourceDbClusterIdentifier
```
@Stability(value=Stable)
public CfnDBClusterProps.Builder sourceDbClusterIdentifier(String sourceDbClusterIdentifier)
```
    Sets the value of CfnDBClusterProps.getSourceDbClusterIdentifier()
    Parameters:
    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.
    Returns:
    
    this
  - sourceRegion
```
@Stability(value=Stable)
public CfnDBClusterProps.Builder sourceRegion(String sourceRegion)
```
    Sets the value of CfnDBClusterProps.getSourceRegion()
    
    Parameters:
    
    sourceRegion - The AWS Region which contains the source DB cluster when replicating a DB cluster. For example, us-east-1 .
    
    Returns:
    
    this
  - storageEncrypted
```
@Stability(value=Stable)
public CfnDBClusterProps.Builder storageEncrypted(Boolean storageEncrypted)
```
    Sets the value of CfnDBClusterProps.getStorageEncrypted()
    
    Parameters:
    
    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 .
    
    Returns:
    
    this
  - storageEncrypted
```
@Stability(value=Stable)
public CfnDBClusterProps.Builder storageEncrypted(IResolvable storageEncrypted)
```
    Sets the value of CfnDBClusterProps.getStorageEncrypted()
    
    Parameters:
    
    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 .
    
    Returns:
    
    this
  - tags
```
@Stability(value=Stable)
public CfnDBClusterProps.Builder tags(List<? extends CfnTag> tags)
```
    Sets the value of CfnDBClusterProps.getTags()
    
    Parameters:
    
    tags - Tags to assign to the DB cluster.
    
    Returns:
    
    this
  - useLatestRestorableTime
```
@Stability(value=Stable)
public CfnDBClusterProps.Builder useLatestRestorableTime(Boolean useLatestRestorableTime)
```
    Sets the value of CfnDBClusterProps.getUseLatestRestorableTime()
    
    Parameters:
    
    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.
    
    Returns:
    
    this
  - useLatestRestorableTime
```
@Stability(value=Stable)
public CfnDBClusterProps.Builder useLatestRestorableTime(IResolvable useLatestRestorableTime)
```
    Sets the value of CfnDBClusterProps.getUseLatestRestorableTime()
    
    Parameters:
    
    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.
    
    Returns:
    
    this
  - vpcSecurityGroupIds
```
@Stability(value=Stable)
public CfnDBClusterProps.Builder vpcSecurityGroupIds(List<String> vpcSecurityGroupIds)
```
    Sets the value of CfnDBClusterProps.getVpcSecurityGroupIds()
    
    Parameters:
    
    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.
    
    Returns:
    
    this
  - build
```
@Stability(value=Stable)
public CfnDBClusterProps build()
```
    Builds the configured instance.
    
    Specified by:
    
    build in interface software.amazon.jsii.Builder<CfnDBClusterProps>
    
    Returns:
    
    a new instance of CfnDBClusterProps
    
    Throws:
    
    NullPointerException - if any required attribute was not provided

Class CfnDBClusterProps.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

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