java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.rds.CfnDBClusterPropsMixin.Builder

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

Enclosing class:: CfnDBClusterPropsMixin

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

A fluent builder for CfnDBClusterPropsMixin.

Method Summary

Modifier and Type

Method

Description

CfnDBClusterPropsMixin.Builder

allocatedStorage(Number allocatedStorage)

The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.

CfnDBClusterPropsMixin.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.

CfnDBClusterPropsMixin.Builder

associatedRoles(IResolvable associatedRoles)

Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster.

CfnDBClusterPropsMixin.Builder

autoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)

Specifies whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window.

CfnDBClusterPropsMixin.Builder

autoMinorVersionUpgrade(IResolvable autoMinorVersionUpgrade)

Specifies whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window.

CfnDBClusterPropsMixin.Builder

availabilityZones(List<String> availabilityZones)

A list of Availability Zones (AZs) where instances in the DB cluster can be created.

CfnDBClusterPropsMixin.Builder

backtrackWindow(Number backtrackWindow)

The target backtrack window, in seconds.

CfnDBClusterPropsMixin.Builder

backupRetentionPeriod(Number backupRetentionPeriod)

The number of days for which automated backups are retained.

CfnDBClusterPropsMixin

build()

CfnDBClusterPropsMixin.Builder

clusterScalabilityType(String clusterScalabilityType)

Specifies the scalability mode of the Aurora DB cluster.

CfnDBClusterPropsMixin.Builder

copyTagsToSnapshot(Boolean copyTagsToSnapshot)

A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster.

CfnDBClusterPropsMixin.Builder

copyTagsToSnapshot(IResolvable copyTagsToSnapshot)

A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster.

static CfnDBClusterPropsMixin.Builder

create()

static CfnDBClusterPropsMixin.Builder

create(CfnPropertyMixinOptions options)

CfnDBClusterPropsMixin.Builder

databaseInsightsMode(String databaseInsightsMode)

The mode of Database Insights to enable for the DB cluster.

CfnDBClusterPropsMixin.Builder

databaseName(String databaseName)

The name of your database.

CfnDBClusterPropsMixin.Builder

dbClusterIdentifier(String dbClusterIdentifier)

The DB cluster identifier.

CfnDBClusterPropsMixin.Builder

dbClusterInstanceClass(String dbClusterInstanceClass)

The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6gd.xlarge .

CfnDBClusterPropsMixin.Builder

dbClusterParameterGroupName(String dbClusterParameterGroupName)

The name of the DB cluster parameter group to associate with this DB cluster.

CfnDBClusterPropsMixin.Builder

dbClusterParameterGroupName(IDBClusterParameterGroupRef dbClusterParameterGroupName)

The name of the DB cluster parameter group to associate with this DB cluster.

CfnDBClusterPropsMixin.Builder

dbInstanceParameterGroupName(String dbInstanceParameterGroupName)

The name of the DB parameter group to apply to all instances of the DB cluster.

CfnDBClusterPropsMixin.Builder

dbSubnetGroupName(String dbSubnetGroupName)

A DB subnet group that you want to associate with this DB cluster.

CfnDBClusterPropsMixin.Builder

dbSubnetGroupName(IDBSubnetGroupRef dbSubnetGroupName)

A DB subnet group that you want to associate with this DB cluster.

CfnDBClusterPropsMixin.Builder

dbSystemId(String dbSystemId)

Reserved for future use.

CfnDBClusterPropsMixin.Builder

deleteAutomatedBackups(Boolean deleteAutomatedBackups)

Specifies whether to remove automated backups immediately after the DB cluster is deleted.

CfnDBClusterPropsMixin.Builder

deleteAutomatedBackups(IResolvable deleteAutomatedBackups)

Specifies whether to remove automated backups immediately after the DB cluster is deleted.

CfnDBClusterPropsMixin.Builder

deletionProtection(Boolean deletionProtection)

A value that indicates whether the DB cluster has deletion protection enabled.

CfnDBClusterPropsMixin.Builder

deletionProtection(IResolvable deletionProtection)

A value that indicates whether the DB cluster has deletion protection enabled.

CfnDBClusterPropsMixin.Builder

domain(String domain)

Indicates the directory ID of the Active Directory to create the DB cluster.

CfnDBClusterPropsMixin.Builder

domainIamRoleName(String domainIamRoleName)

Specifies the name of the IAM role to use when making API calls to the Directory Service.

CfnDBClusterPropsMixin.Builder

enableCloudwatchLogsExports(List<String> enableCloudwatchLogsExports)

The list of log types that need to be enabled for exporting to CloudWatch Logs.

CfnDBClusterPropsMixin.Builder

enableGlobalWriteForwarding(Boolean enableGlobalWriteForwarding)

Specifies whether to enable this DB cluster to forward write operations to the primary cluster of a global cluster (Aurora global database).

CfnDBClusterPropsMixin.Builder

enableGlobalWriteForwarding(IResolvable enableGlobalWriteForwarding)

Specifies whether to enable this DB cluster to forward write operations to the primary cluster of a global cluster (Aurora global database).

CfnDBClusterPropsMixin.Builder

enableHttpEndpoint(Boolean enableHttpEndpoint)

Specifies whether to enable the HTTP endpoint for the DB cluster.

CfnDBClusterPropsMixin.Builder

enableHttpEndpoint(IResolvable enableHttpEndpoint)

Specifies whether to enable the HTTP endpoint for the DB cluster.

CfnDBClusterPropsMixin.Builder

enableIamDatabaseAuthentication(Boolean enableIamDatabaseAuthentication)

A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts.

CfnDBClusterPropsMixin.Builder

enableIamDatabaseAuthentication(IResolvable enableIamDatabaseAuthentication)

A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts.

CfnDBClusterPropsMixin.Builder

enableLocalWriteForwarding(Boolean enableLocalWriteForwarding)

Specifies whether read replicas can forward write operations to the writer DB instance in the DB cluster.

CfnDBClusterPropsMixin.Builder

enableLocalWriteForwarding(IResolvable enableLocalWriteForwarding)

Specifies whether read replicas can forward write operations to the writer DB instance in the DB cluster.

CfnDBClusterPropsMixin.Builder

engine(String engine)

The name of the database engine to be used for this DB cluster.

CfnDBClusterPropsMixin.Builder

engineLifecycleSupport(String engineLifecycleSupport)

The life cycle type for this DB cluster.

CfnDBClusterPropsMixin.Builder

engineMode(String engineMode)

The DB engine mode of the DB cluster, either provisioned or serverless .

CfnDBClusterPropsMixin.Builder

engineVersion(String engineVersion)

The version number of the database engine to use.

CfnDBClusterPropsMixin.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.

CfnDBClusterPropsMixin.Builder

globalClusterIdentifier(IGlobalClusterRef 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.

CfnDBClusterPropsMixin.Builder

iops(Number iops)

The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.

CfnDBClusterPropsMixin.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 .

CfnDBClusterPropsMixin.Builder

kmsKeyId(IKeyRef 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 .

CfnDBClusterPropsMixin.Builder

manageMasterUserPassword(Boolean manageMasterUserPassword)

Specifies whether to manage the master user password with AWS Secrets Manager.

CfnDBClusterPropsMixin.Builder

manageMasterUserPassword(IResolvable manageMasterUserPassword)

Specifies whether to manage the master user password with AWS Secrets Manager.

CfnDBClusterPropsMixin.Builder

masterUserAuthenticationType(String masterUserAuthenticationType)

Specifies the authentication type for the master user.

CfnDBClusterPropsMixin.Builder

masterUsername(String masterUsername)

The name of the master user for the DB cluster.

CfnDBClusterPropsMixin.Builder

masterUserPassword(String masterUserPassword)

The master password for the DB instance.

CfnDBClusterPropsMixin.Builder

masterUserSecret(CfnDBClusterPropsMixin.MasterUserSecretProperty masterUserSecret)

The secret managed by RDS in AWS Secrets Manager for the master user password.

CfnDBClusterPropsMixin.Builder

masterUserSecret(IResolvable masterUserSecret)

The secret managed by RDS in AWS Secrets Manager for the master user password.

CfnDBClusterPropsMixin.Builder

monitoringInterval(Number monitoringInterval)

The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster.

CfnDBClusterPropsMixin.Builder

monitoringRoleArn(String monitoringRoleArn)

The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.

CfnDBClusterPropsMixin.Builder

networkType(String networkType)

The network type of the DB cluster.

CfnDBClusterPropsMixin.Builder

performanceInsightsEnabled(Boolean performanceInsightsEnabled)

Specifies whether to turn on Performance Insights for the DB cluster.

CfnDBClusterPropsMixin.Builder

performanceInsightsEnabled(IResolvable performanceInsightsEnabled)

Specifies whether to turn on Performance Insights for the DB cluster.

CfnDBClusterPropsMixin.Builder

performanceInsightsKmsKeyId(String performanceInsightsKmsKeyId)

The AWS KMS key identifier for encryption of Performance Insights data.

CfnDBClusterPropsMixin.Builder

performanceInsightsRetentionPeriod(Number performanceInsightsRetentionPeriod)

The number of days to retain Performance Insights data.

CfnDBClusterPropsMixin.Builder

port(Number port)

The port number on which the DB instances in the DB cluster accept connections.

CfnDBClusterPropsMixin.Builder

preferredBackupWindow(String preferredBackupWindow)

The daily time range during which automated backups are created.

CfnDBClusterPropsMixin.Builder

preferredMaintenanceWindow(String preferredMaintenanceWindow)

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

CfnDBClusterPropsMixin.Builder

publiclyAccessible(Boolean publiclyAccessible)

Specifies whether the DB cluster is publicly accessible.

CfnDBClusterPropsMixin.Builder

publiclyAccessible(IResolvable publiclyAccessible)

Specifies whether the DB cluster is publicly accessible.

CfnDBClusterPropsMixin.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.

CfnDBClusterPropsMixin.Builder

restoreToTime(String restoreToTime)

The date and time to restore the DB cluster to.

CfnDBClusterPropsMixin.Builder

restoreType(String restoreType)

The type of restore to be performed.

CfnDBClusterPropsMixin.Builder

scalingConfiguration(CfnDBClusterPropsMixin.ScalingConfigurationProperty scalingConfiguration)

The scaling configuration of an Aurora Serverless v1 DB cluster.

CfnDBClusterPropsMixin.Builder

scalingConfiguration(IResolvable scalingConfiguration)

The scaling configuration of an Aurora Serverless v1 DB cluster.

CfnDBClusterPropsMixin.Builder

serverlessV2ScalingConfiguration(CfnDBClusterPropsMixin.ServerlessV2ScalingConfigurationProperty serverlessV2ScalingConfiguration)

The scaling configuration of an Aurora Serverless V2 DB cluster.

CfnDBClusterPropsMixin.Builder

serverlessV2ScalingConfiguration(IResolvable serverlessV2ScalingConfiguration)

The scaling configuration of an Aurora Serverless V2 DB cluster.

CfnDBClusterPropsMixin.Builder

snapshotIdentifier(String snapshotIdentifier)

The identifier for the DB snapshot or DB cluster snapshot to restore from.

CfnDBClusterPropsMixin.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.

CfnDBClusterPropsMixin.Builder

sourceDbClusterResourceId(String sourceDbClusterResourceId)

The resource ID of the source DB cluster from which to restore.

CfnDBClusterPropsMixin.Builder

sourceRegion(String sourceRegion)

The AWS Region which contains the source DB cluster when replicating a DB cluster.

CfnDBClusterPropsMixin.Builder

storageEncrypted(Boolean storageEncrypted)

Indicates whether the DB cluster is encrypted.

CfnDBClusterPropsMixin.Builder

storageEncrypted(IResolvable storageEncrypted)

Indicates whether the DB cluster is encrypted.

CfnDBClusterPropsMixin.Builder

storageType(String storageType)

The storage type to associate with the DB cluster.

CfnDBClusterPropsMixin.Builder

tags(List<? extends CfnTag> tags)

Tags to assign to the DB cluster.

CfnDBClusterPropsMixin.Builder

useLatestRestorableTime(Boolean useLatestRestorableTime)

A value that indicates whether to restore the DB cluster to the latest restorable backup time.

CfnDBClusterPropsMixin.Builder

useLatestRestorableTime(IResolvable useLatestRestorableTime)

A value that indicates whether to restore the DB cluster to the latest restorable backup time.

CfnDBClusterPropsMixin.Builder

vpcSecurityGroupIds(List<? extends Object> 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 Details
- create
  
  @Stability(Stable) public static CfnDBClusterPropsMixin.Builder create(CfnPropertyMixinOptions options)
  
  Parameters:
  
  options - Mixin options.
  
  Returns:
  
  a new instance of CfnDBClusterPropsMixin.Builder.
- create
  
  @Stability(Stable) public static CfnDBClusterPropsMixin.Builder create()
  
  Returns:
  
  a new instance of CfnDBClusterPropsMixin.Builder.
- allocatedStorage
  
  @Stability(Stable) public CfnDBClusterPropsMixin.Builder allocatedStorage(Number allocatedStorage)
  
  The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.
  Valid for Cluster Type: Multi-AZ DB clusters only
  This setting is required to create a Multi-AZ DB cluster.
  Parameters:
  
  allocatedStorage - The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster. This parameter is required.
  
  Returns:
  
  this
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-allocatedstorage
- associatedRoles
  
  @Stability(Stable) public CfnDBClusterPropsMixin.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.
  Valid for: Aurora DB clusters and Multi-AZ DB clusters
  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
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-associatedroles
- associatedRoles
  
  @Stability(Stable) public CfnDBClusterPropsMixin.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.
  Valid for: Aurora DB clusters and Multi-AZ DB clusters
  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
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-associatedroles
- autoMinorVersionUpgrade
  
  @Stability(Stable) public CfnDBClusterPropsMixin.Builder autoMinorVersionUpgrade(Boolean autoMinorVersionUpgrade)
  
  Specifies whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window.
  By default, minor engine upgrades are applied automatically.
  Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB cluster.
  For more information about automatic minor version upgrades, see Automatically upgrading the minor engine version .
  Parameters:
  
  autoMinorVersionUpgrade - Specifies whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. This parameter is required.
  
  Returns:
  
  this
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-autominorversionupgrade
- autoMinorVersionUpgrade
  
  @Stability(Stable) public CfnDBClusterPropsMixin.Builder autoMinorVersionUpgrade(IResolvable autoMinorVersionUpgrade)
  
  Specifies whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window.
  By default, minor engine upgrades are applied automatically.
  Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB cluster.
  For more information about automatic minor version upgrades, see Automatically upgrading the minor engine version .
  Parameters:
  
  autoMinorVersionUpgrade - Specifies whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. This parameter is required.
  
  Returns:
  
  this
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-autominorversionupgrade
- availabilityZones
  
  @Stability(Stable) public CfnDBClusterPropsMixin.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 .
  Valid for: Aurora DB clusters only
  Parameters:
  
  availabilityZones - A list of Availability Zones (AZs) where instances in the DB cluster can be created. This parameter is required.
  
  Returns:
  
  this
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-availabilityzones
- backtrackWindow
  
  @Stability(Stable) public CfnDBClusterPropsMixin.Builder backtrackWindow(Number backtrackWindow)
  The target backtrack window, in seconds. To disable backtracking, set this value to 0 .
  Valid for Cluster Type: Aurora MySQL DB clusters only
  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
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-backtrackwindow
- backupRetentionPeriod
  
  @Stability(Stable) public CfnDBClusterPropsMixin.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
  
  Valid for: Aurora DB clusters and Multi-AZ DB clusters
  Default: - 1
  Parameters:
  
  backupRetentionPeriod - The number of days for which automated backups are retained. This parameter is required.
  
  Returns:
  
  this
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-backupretentionperiod
- clusterScalabilityType
  
  @Stability(Stable) public CfnDBClusterPropsMixin.Builder clusterScalabilityType(String clusterScalabilityType)
  
  Specifies the scalability mode of the Aurora DB cluster.
  When set to limitless , the cluster operates as an Aurora Limitless Database, allowing you to create a DB shard group for horizontal scaling (sharding) capabilities. When set to standard (the default), the cluster uses normal DB instance creation.
  Important: Automated backup retention isn't supported with Aurora Limitless Database clusters. If you set this property to limitless , you cannot set DeleteAutomatedBackups to false . To create a backup, use manual snapshots instead.
  Parameters:
  
  clusterScalabilityType - Specifies the scalability mode of the Aurora DB cluster. This parameter is required.
  
  Returns:
  
  this
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-clusterscalabilitytype
- copyTagsToSnapshot
  
  @Stability(Stable) public CfnDBClusterPropsMixin.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.
  Valid for: Aurora DB clusters and Multi-AZ DB clusters
  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
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-copytagstosnapshot
- copyTagsToSnapshot
  
  @Stability(Stable) public CfnDBClusterPropsMixin.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.
  Valid for: Aurora DB clusters and Multi-AZ DB clusters
  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
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-copytagstosnapshot
- databaseInsightsMode
  
  @Stability(Stable) public CfnDBClusterPropsMixin.Builder databaseInsightsMode(String databaseInsightsMode)
  
  The mode of Database Insights to enable for the DB cluster.
  If you set this value to advanced , you must also set the PerformanceInsightsEnabled parameter to true and the PerformanceInsightsRetentionPeriod parameter to 465.
  Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
  Parameters:
  
  databaseInsightsMode - The mode of Database Insights to enable for the DB cluster. This parameter is required.
  
  Returns:
  
  this
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-databaseinsightsmode
- databaseName
  
  @Stability(Stable) public CfnDBClusterPropsMixin.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 .
  Valid for: Aurora DB clusters and Multi-AZ DB clusters
  Parameters:
  
  databaseName - The name of your database. This parameter is required.
  
  Returns:
  
  this
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-databasename
- dbClusterIdentifier
  
  @Stability(Stable) public CfnDBClusterPropsMixin.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
  Valid for: Aurora DB clusters and Multi-AZ DB clusters
  Parameters:
  
  dbClusterIdentifier - The DB cluster identifier. This parameter is stored as a lowercase string. This parameter is required.
  
  Returns:
  
  this
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-dbclusteridentifier
- dbClusterInstanceClass
  
  @Stability(Stable) public CfnDBClusterPropsMixin.Builder dbClusterInstanceClass(String dbClusterInstanceClass)
  
  The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6gd.xlarge . Not all DB instance classes are available in all AWS Regions , or for all database engines.
  For the full list of DB instance classes and availability for your engine, see DB instance class in the Amazon RDS User Guide .
  This setting is required to create a Multi-AZ DB cluster.
  Valid for Cluster Type: Multi-AZ DB clusters only
  Parameters:
  
  dbClusterInstanceClass - The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6gd.xlarge . Not all DB instance classes are available in all AWS Regions , or for all database engines. This parameter is required.
  
  Returns:
  
  this
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-dbclusterinstanceclass
- dbClusterParameterGroupName
  
  @Stability(Stable) public CfnDBClusterPropsMixin.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
  Valid for: Aurora DB clusters and Multi-AZ DB clusters
  Parameters:
  
  dbClusterParameterGroupName - The name of the DB cluster parameter group to associate with this DB cluster. This parameter is required.
  
  Returns:
  
  this
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-dbclusterparametergroupname
- dbClusterParameterGroupName
  
  @Stability(Stable) public CfnDBClusterPropsMixin.Builder dbClusterParameterGroupName(IDBClusterParameterGroupRef 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
  Valid for: Aurora DB clusters and Multi-AZ DB clusters
  Parameters:
  
  dbClusterParameterGroupName - The name of the DB cluster parameter group to associate with this DB cluster. This parameter is required.
  
  Returns:
  
  this
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-dbclusterparametergroupname
- dbInstanceParameterGroupName
  
  @Stability(Stable) public CfnDBClusterPropsMixin.Builder dbInstanceParameterGroupName(String dbInstanceParameterGroupName)
  The name of the DB parameter group to apply to all instances of the DB cluster.
  
  When you apply a parameter group using the DBInstanceParameterGroupName parameter, the DB cluster isn't rebooted automatically. Also, parameter changes are applied immediately rather than during the next maintenance window.
  
  Valid for Cluster Type: Aurora DB clusters only
  Default: The existing name setting
  Constraints:
  
  The DB parameter group must be in the same DB parameter group family as this DB cluster.
  
  The DBInstanceParameterGroupName parameter is valid in combination with the AllowMajorVersionUpgrade parameter for a major version upgrade only.
  Parameters:
  
  dbInstanceParameterGroupName - The name of the DB parameter group to apply to all instances of the DB cluster. This parameter is required.
  
  Returns:
  
  this
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-dbinstanceparametergroupname
- dbSubnetGroupName
  
  @Stability(Stable) public CfnDBClusterPropsMixin.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.
  Valid for: Aurora DB clusters and Multi-AZ DB clusters
  Parameters:
  
  dbSubnetGroupName - A DB subnet group that you want to associate with this DB cluster. This parameter is required.
  
  Returns:
  
  this
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-dbsubnetgroupname
- dbSubnetGroupName
  
  @Stability(Stable) public CfnDBClusterPropsMixin.Builder dbSubnetGroupName(IDBSubnetGroupRef 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.
  Valid for: Aurora DB clusters and Multi-AZ DB clusters
  Parameters:
  
  dbSubnetGroupName - A DB subnet group that you want to associate with this DB cluster. This parameter is required.
  
  Returns:
  
  this
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-dbsubnetgroupname
- dbSystemId
  
  @Stability(Stable) public CfnDBClusterPropsMixin.Builder dbSystemId(String dbSystemId)
  
  Reserved for future use.
  Parameters:
  
  dbSystemId - Reserved for future use. This parameter is required.
  
  Returns:
  
  this
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-dbsystemid
- deleteAutomatedBackups
  
  @Stability(Stable) public CfnDBClusterPropsMixin.Builder deleteAutomatedBackups(Boolean deleteAutomatedBackups)
  
  Specifies whether to remove automated backups immediately after the DB cluster is deleted.
  This parameter isn't case-sensitive. The default is to remove automated backups immediately after the DB cluster is deleted, unless the AWS Backup policy specifies a point-in-time restore rule.
  Parameters:
  
  deleteAutomatedBackups - Specifies whether to remove automated backups immediately after the DB cluster is deleted. This parameter is required.
  
  Returns:
  
  this
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-deleteautomatedbackups
- deleteAutomatedBackups
  
  @Stability(Stable) public CfnDBClusterPropsMixin.Builder deleteAutomatedBackups(IResolvable deleteAutomatedBackups)
  
  Specifies whether to remove automated backups immediately after the DB cluster is deleted.
  This parameter isn't case-sensitive. The default is to remove automated backups immediately after the DB cluster is deleted, unless the AWS Backup policy specifies a point-in-time restore rule.
  Parameters:
  
  deleteAutomatedBackups - Specifies whether to remove automated backups immediately after the DB cluster is deleted. This parameter is required.
  
  Returns:
  
  this
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-deleteautomatedbackups
- deletionProtection
  
  @Stability(Stable) public CfnDBClusterPropsMixin.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.
  Valid for: Aurora DB clusters and Multi-AZ DB clusters
  Parameters:
  
  deletionProtection - A value that indicates whether the DB cluster has deletion protection enabled. This parameter is required.
  
  Returns:
  
  this
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-deletionprotection
- deletionProtection
  
  @Stability(Stable) public CfnDBClusterPropsMixin.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.
  Valid for: Aurora DB clusters and Multi-AZ DB clusters
  Parameters:
  
  deletionProtection - A value that indicates whether the DB cluster has deletion protection enabled. This parameter is required.
  
  Returns:
  
  this
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-deletionprotection
- domain
  
  @Stability(Stable) public CfnDBClusterPropsMixin.Builder domain(String domain)
  
  Indicates the directory ID of the Active Directory to create the DB cluster.
  For Amazon Aurora DB clusters, Amazon RDS can use Kerberos authentication to authenticate users that connect to the DB cluster.
  For more information, see Kerberos authentication in the Amazon Aurora User Guide .
  Valid for: Aurora DB clusters only
  Parameters:
  
  domain - Indicates the directory ID of the Active Directory to create the DB cluster. This parameter is required.
  
  Returns:
  
  this
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-domain
- domainIamRoleName
  
  @Stability(Stable) public CfnDBClusterPropsMixin.Builder domainIamRoleName(String domainIamRoleName)
  
  Specifies the name of the IAM role to use when making API calls to the Directory Service.
  Valid for: Aurora DB clusters only
  Parameters:
  
  domainIamRoleName - Specifies the name of the IAM role to use when making API calls to the Directory Service. This parameter is required.
  
  Returns:
  
  this
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-domainiamrolename
- enableCloudwatchLogsExports
  
  @Stability(Stable) public CfnDBClusterPropsMixin.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
  Valid for: Aurora DB clusters and Multi-AZ DB clusters
  Parameters:
  
  enableCloudwatchLogsExports - The list of log types that need to be enabled for exporting to CloudWatch Logs. This parameter is required.
  
  Returns:
  
  this
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-enablecloudwatchlogsexports
- enableGlobalWriteForwarding
  
  @Stability(Stable) public CfnDBClusterPropsMixin.Builder enableGlobalWriteForwarding(Boolean enableGlobalWriteForwarding)
  
  Specifies whether to enable this DB cluster to forward write operations to the primary cluster of a global cluster (Aurora global database).
  By default, write operations are not allowed on Aurora DB clusters that are secondary clusters in an Aurora global database.
  You can set this value only on Aurora DB clusters that are members of an Aurora global database. With this parameter enabled, a secondary cluster can forward writes to the current primary cluster, and the resulting changes are replicated back to this cluster. For the primary DB cluster of an Aurora global database, this value is used immediately if the primary is demoted by a global cluster API operation, but it does nothing until then.
  Valid for Cluster Type: Aurora DB clusters only
  Parameters:
  
  enableGlobalWriteForwarding - Specifies whether to enable this DB cluster to forward write operations to the primary cluster of a global cluster (Aurora global database). This parameter is required.
  
  Returns:
  
  this
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-enableglobalwriteforwarding
- enableGlobalWriteForwarding
  
  @Stability(Stable) public CfnDBClusterPropsMixin.Builder enableGlobalWriteForwarding(IResolvable enableGlobalWriteForwarding)
  
  Specifies whether to enable this DB cluster to forward write operations to the primary cluster of a global cluster (Aurora global database).
  By default, write operations are not allowed on Aurora DB clusters that are secondary clusters in an Aurora global database.
  You can set this value only on Aurora DB clusters that are members of an Aurora global database. With this parameter enabled, a secondary cluster can forward writes to the current primary cluster, and the resulting changes are replicated back to this cluster. For the primary DB cluster of an Aurora global database, this value is used immediately if the primary is demoted by a global cluster API operation, but it does nothing until then.
  Valid for Cluster Type: Aurora DB clusters only
  Parameters:
  
  enableGlobalWriteForwarding - Specifies whether to enable this DB cluster to forward write operations to the primary cluster of a global cluster (Aurora global database). This parameter is required.
  
  Returns:
  
  this
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-enableglobalwriteforwarding
- enableHttpEndpoint
  
  @Stability(Stable) public CfnDBClusterPropsMixin.Builder enableHttpEndpoint(Boolean enableHttpEndpoint)
  
  Specifies whether to enable the HTTP endpoint for the DB cluster. By default, the HTTP endpoint isn't enabled.
  When enabled, the HTTP endpoint provides a connectionless web service API (RDS Data API) for running SQL queries on the DB cluster. You can also query your database from inside the RDS console with the RDS query editor.
  For more information, see Using RDS Data API in the Amazon Aurora User Guide .
  Valid for Cluster Type: Aurora DB clusters only
  Parameters:
  
  enableHttpEndpoint - Specifies whether to enable the HTTP endpoint for the DB cluster. By default, the HTTP endpoint isn't enabled. This parameter is required.
  
  Returns:
  
  this
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-enablehttpendpoint
- enableHttpEndpoint
  
  @Stability(Stable) public CfnDBClusterPropsMixin.Builder enableHttpEndpoint(IResolvable enableHttpEndpoint)
  
  Specifies whether to enable the HTTP endpoint for the DB cluster. By default, the HTTP endpoint isn't enabled.
  When enabled, the HTTP endpoint provides a connectionless web service API (RDS Data API) for running SQL queries on the DB cluster. You can also query your database from inside the RDS console with the RDS query editor.
  For more information, see Using RDS Data API in the Amazon Aurora User Guide .
  Valid for Cluster Type: Aurora DB clusters only
  Parameters:
  
  enableHttpEndpoint - Specifies whether to enable the HTTP endpoint for the DB cluster. By default, the HTTP endpoint isn't enabled. This parameter is required.
  
  Returns:
  
  this
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-enablehttpendpoint
- enableIamDatabaseAuthentication
  
  @Stability(Stable) public CfnDBClusterPropsMixin.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.
  Valid for: Aurora DB clusters only
  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
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-enableiamdatabaseauthentication
- enableIamDatabaseAuthentication
  
  @Stability(Stable) public CfnDBClusterPropsMixin.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.
  Valid for: Aurora DB clusters only
  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
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-enableiamdatabaseauthentication
- enableLocalWriteForwarding
  
  @Stability(Stable) public CfnDBClusterPropsMixin.Builder enableLocalWriteForwarding(Boolean enableLocalWriteForwarding)
  
  Specifies whether read replicas can forward write operations to the writer DB instance in the DB cluster.
  By default, write operations aren't allowed on reader DB instances.
  Valid for: Aurora DB clusters only
  Parameters:
  
  enableLocalWriteForwarding - Specifies whether read replicas can forward write operations to the writer DB instance in the DB cluster. This parameter is required.
  
  Returns:
  
  this
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-enablelocalwriteforwarding
- enableLocalWriteForwarding
  
  @Stability(Stable) public CfnDBClusterPropsMixin.Builder enableLocalWriteForwarding(IResolvable enableLocalWriteForwarding)
  
  Specifies whether read replicas can forward write operations to the writer DB instance in the DB cluster.
  By default, write operations aren't allowed on reader DB instances.
  Valid for: Aurora DB clusters only
  Parameters:
  
  enableLocalWriteForwarding - Specifies whether read replicas can forward write operations to the writer DB instance in the DB cluster. This parameter is required.
  
  Returns:
  
  this
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-enablelocalwriteforwarding
- engine
  
  @Stability(Stable) public CfnDBClusterPropsMixin.Builder engine(String engine)
  The name of the database engine to be used for this DB cluster.
  Valid Values:
  
  aurora-mysql
  
  aurora-postgresql
  
  mysql
  
  postgres
  
  Valid for: Aurora DB clusters and Multi-AZ DB clusters
  Parameters:
  
  engine - The name of the database engine to be used for this DB cluster. This parameter is required.
  
  Returns:
  
  this
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-engine
- engineLifecycleSupport
  
  @Stability(Stable) public CfnDBClusterPropsMixin.Builder engineLifecycleSupport(String engineLifecycleSupport)
  The life cycle type for this DB cluster.
  
  By default, this value is set to open-source-rds-extended-support , which enrolls your DB cluster into Amazon RDS Extended Support. At the end of standard support, you can avoid charges for Extended Support by setting the value to open-source-rds-extended-support-disabled . In this case, creating the DB cluster will fail if the DB major version is past its end of standard support date.
  
  You can use this setting to enroll your DB cluster into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB cluster past the end of standard support for that engine version. For more information, see the following sections:
  
  Amazon Aurora - Amazon RDS Extended Support with Amazon Aurora in the Amazon Aurora User Guide
  
  Amazon RDS - Amazon RDS Extended Support with Amazon RDS in the Amazon RDS User Guide
  
  Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
  Valid Values: open-source-rds-extended-support | open-source-rds-extended-support-disabled
  Default: open-source-rds-extended-support
  Parameters:
  
  engineLifecycleSupport - The life cycle type for this DB cluster. This parameter is required.
  
  Returns:
  
  this
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-enginelifecyclesupport
- engineMode
  
  @Stability(Stable) public CfnDBClusterPropsMixin.Builder engineMode(String engineMode)
  The DB engine mode of the DB cluster, either provisioned or serverless .
  The serverless engine mode only applies for Aurora Serverless v1 DB clusters. Aurora Serverless v2 DB clusters use the provisioned engine mode.
  For information about limitations and requirements for Serverless DB clusters, see the following sections in the Amazon Aurora User Guide :
  
  Limitations of Aurora Serverless v1
  
  Requirements for Aurora Serverless v2
  
  Valid for Cluster Type: Aurora DB clusters only
  Parameters:
  
  engineMode - The DB engine mode of the DB cluster, either provisioned or serverless . This parameter is required.
  
  Returns:
  
  this
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-enginemode
- engineVersion
  
  @Stability(Stable) public CfnDBClusterPropsMixin.Builder engineVersion(String engineVersion)
  
  The version number of the database engine to use.
  To list all of the available engine versions for Aurora MySQL version 2 (5.7-compatible) and version 3 (8.0-compatible), use the following command:
  aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"
  You can supply either 5.7 or 8.0 to use the default engine version for Aurora MySQL version 2 or version 3, respectively.
  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"
  To list all of the available engine versions for RDS for MySQL, use the following command:
  aws rds describe-db-engine-versions --engine mysql --query "DBEngineVersions[].EngineVersion"
  To list all of the available engine versions for RDS for PostgreSQL, use the following command:
  aws rds describe-db-engine-versions --engine postgres --query "DBEngineVersions[].EngineVersion"
  Aurora MySQL
  For information, see Database engine updates for Amazon Aurora MySQL in the Amazon Aurora User Guide .
  Aurora PostgreSQL
  For information, see Amazon Aurora PostgreSQL releases and engine versions in the Amazon Aurora User Guide .
  MySQL
  For information, see Amazon RDS for MySQL in the Amazon RDS User Guide .
  PostgreSQL
  For information, see Amazon RDS for PostgreSQL in the Amazon RDS User Guide .
  Valid for: Aurora DB clusters and Multi-AZ DB clusters
  Parameters:
  
  engineVersion - The version number of the database engine to use. This parameter is required.
  
  Returns:
  
  this
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-engineversion
- globalClusterIdentifier
  
  @Stability(Stable) public CfnDBClusterPropsMixin.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 .
  Valid for: Aurora DB clusters only
  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
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-globalclusteridentifier
- globalClusterIdentifier
  
  @Stability(Stable) public CfnDBClusterPropsMixin.Builder globalClusterIdentifier(IGlobalClusterRef 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 .
  Valid for: Aurora DB clusters only
  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
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-globalclusteridentifier
- iops
  
  @Stability(Stable) public CfnDBClusterPropsMixin.Builder iops(Number iops)
  The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.
  For information about valid IOPS values, see Provisioned IOPS storage in the Amazon RDS User Guide .
  This setting is required to create a Multi-AZ DB cluster.
  Valid for Cluster Type: Multi-AZ DB clusters only
  Constraints:
  
  Must be a multiple between .5 and 50 of the storage amount for the DB cluster.
  Parameters:
  
  iops - The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster. This parameter is required.
  
  Returns:
  
  this
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-iops
- kmsKeyId
  
  @Stability(Stable) public CfnDBClusterPropsMixin.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.
  If you create a read replica of an encrypted DB cluster in another AWS Region, make sure to set KmsKeyId to a KMS key identifier that is valid in the destination AWS Region. This KMS key is used to encrypt the read replica in that AWS Region.
  Valid for: Aurora DB clusters and Multi-AZ DB clusters
  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
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-kmskeyid
- kmsKeyId
  
  @Stability(Stable) public CfnDBClusterPropsMixin.Builder kmsKeyId(IKeyRef 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.
  If you create a read replica of an encrypted DB cluster in another AWS Region, make sure to set KmsKeyId to a KMS key identifier that is valid in the destination AWS Region. This KMS key is used to encrypt the read replica in that AWS Region.
  Valid for: Aurora DB clusters and Multi-AZ DB clusters
  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
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-kmskeyid
- manageMasterUserPassword
  
  @Stability(Stable) public CfnDBClusterPropsMixin.Builder manageMasterUserPassword(Boolean manageMasterUserPassword)
  Specifies whether to manage the master user password with AWS Secrets Manager.
  For more information, see Password management with AWS Secrets Manager in the Amazon RDS User Guide and Password management with AWS Secrets Manager in the Amazon Aurora User Guide.
  Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
  Constraints:
  
  Can't manage the master user password with AWS Secrets Manager if MasterUserPassword is specified.
  Parameters:
  
  manageMasterUserPassword - Specifies whether to manage the master user password with AWS Secrets Manager. This parameter is required.
  
  Returns:
  
  this
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-managemasteruserpassword
- manageMasterUserPassword
  
  @Stability(Stable) public CfnDBClusterPropsMixin.Builder manageMasterUserPassword(IResolvable manageMasterUserPassword)
  Specifies whether to manage the master user password with AWS Secrets Manager.
  For more information, see Password management with AWS Secrets Manager in the Amazon RDS User Guide and Password management with AWS Secrets Manager in the Amazon Aurora User Guide.
  Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
  Constraints:
  
  Can't manage the master user password with AWS Secrets Manager if MasterUserPassword is specified.
  Parameters:
  
  manageMasterUserPassword - Specifies whether to manage the master user password with AWS Secrets Manager. This parameter is required.
  
  Returns:
  
  this
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-managemasteruserpassword
- masterUserAuthenticationType
  
  @Stability(Stable) public CfnDBClusterPropsMixin.Builder masterUserAuthenticationType(String masterUserAuthenticationType)
  Specifies the authentication type for the master user.
  With IAM master user authentication, you can configure the master DB user with IAM database authentication when you create a DB cluster.
  You can specify one of the following values:
  
  password - Use standard database authentication with a password.
  
  iam-db-auth - Use IAM database authentication for the master user.
  
  Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
  This option is only valid for RDS for MySQL, RDS for MariaDB, RDS for PostgreSQL, Aurora MySQL, and Aurora PostgreSQL engines.
  Parameters:
  
  masterUserAuthenticationType - Specifies the authentication type for the master user. This parameter is required.
  
  Returns:
  
  this
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-masteruserauthenticationtype
- masterUsername
  
  @Stability(Stable) public CfnDBClusterPropsMixin.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.
  
  Valid for: Aurora DB clusters and Multi-AZ DB clusters
  Parameters:
  
  masterUsername - The name of the master user for the DB cluster. This parameter is required.
  
  Returns:
  
  this
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-masterusername
- masterUserPassword
  
  @Stability(Stable) public CfnDBClusterPropsMixin.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.
  
  Valid for: Aurora DB clusters and Multi-AZ DB clusters
  Parameters:
  
  masterUserPassword - The master password for the DB instance. This parameter is required.
  
  Returns:
  
  this
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-masteruserpassword
- masterUserSecret
  
  @Stability(Stable) public CfnDBClusterPropsMixin.Builder masterUserSecret(IResolvable masterUserSecret)
  
  The secret managed by RDS in AWS Secrets Manager for the master user password.
  
  When you restore a DB cluster from a snapshot, Amazon RDS generates a new secret instead of reusing the secret specified in the SecretArn property. This ensures that the restored DB cluster is securely managed with a dedicated secret. To maintain consistent integration with your application, you might need to update resource configurations to reference the newly created secret.
  
  For more information, see Password management with AWS Secrets Manager in the Amazon RDS User Guide and Password management with AWS Secrets Manager in the Amazon Aurora User Guide.
  Parameters:
  
  masterUserSecret - The secret managed by RDS in AWS Secrets Manager for the master user password. This parameter is required.
  
  Returns:
  
  this
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-masterusersecret
- masterUserSecret
  
  @Stability(Stable) public CfnDBClusterPropsMixin.Builder masterUserSecret(CfnDBClusterPropsMixin.MasterUserSecretProperty masterUserSecret)
  
  The secret managed by RDS in AWS Secrets Manager for the master user password.
  
  When you restore a DB cluster from a snapshot, Amazon RDS generates a new secret instead of reusing the secret specified in the SecretArn property. This ensures that the restored DB cluster is securely managed with a dedicated secret. To maintain consistent integration with your application, you might need to update resource configurations to reference the newly created secret.
  
  For more information, see Password management with AWS Secrets Manager in the Amazon RDS User Guide and Password management with AWS Secrets Manager in the Amazon Aurora User Guide.
  Parameters:
  
  masterUserSecret - The secret managed by RDS in AWS Secrets Manager for the master user password. This parameter is required.
  
  Returns:
  
  this
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-masterusersecret
- monitoringInterval
  
  @Stability(Stable) public CfnDBClusterPropsMixin.Builder monitoringInterval(Number monitoringInterval)
  
  The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster.
  To turn off collecting Enhanced Monitoring metrics, specify 0 .
  If MonitoringRoleArn is specified, also set MonitoringInterval to a value other than 0 .
  Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
  Valid Values: 0 | 1 | 5 | 10 | 15 | 30 | 60
  Default: 0
  Parameters:
  
  monitoringInterval - The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. This parameter is required.
  
  Returns:
  
  this
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-monitoringinterval
- monitoringRoleArn
  
  @Stability(Stable) public CfnDBClusterPropsMixin.Builder monitoringRoleArn(String monitoringRoleArn)
  
  The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
  An example is arn:aws:iam:123456789012:role/emaccess . For information on creating a monitoring role, see Setting up and enabling Enhanced Monitoring in the Amazon RDS User Guide .
  If MonitoringInterval is set to a value other than 0 , supply a MonitoringRoleArn value.
  Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
  Parameters:
  
  monitoringRoleArn - The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. This parameter is required.
  
  Returns:
  
  this
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-monitoringrolearn
- networkType
  
  @Stability(Stable) public CfnDBClusterPropsMixin.Builder networkType(String networkType)
  The network type of the DB cluster.
  Valid values:
  
  IPV4
  
  DUAL
  
  The network type is determined by the DBSubnetGroup specified for the DB cluster. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and IPv6 protocols ( DUAL ).
  For more information, see Working with a DB instance in a VPC in the Amazon Aurora User Guide.
  Valid for: Aurora DB clusters only
  Parameters:
  
  networkType - The network type of the DB cluster. This parameter is required.
  
  Returns:
  
  this
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-networktype
- performanceInsightsEnabled
  
  @Stability(Stable) public CfnDBClusterPropsMixin.Builder performanceInsightsEnabled(Boolean performanceInsightsEnabled)
  
  Specifies whether to turn on Performance Insights for the DB cluster.
  For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide .
  Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
  Parameters:
  
  performanceInsightsEnabled - Specifies whether to turn on Performance Insights for the DB cluster. This parameter is required.
  
  Returns:
  
  this
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-performanceinsightsenabled
- performanceInsightsEnabled
  
  @Stability(Stable) public CfnDBClusterPropsMixin.Builder performanceInsightsEnabled(IResolvable performanceInsightsEnabled)
  
  Specifies whether to turn on Performance Insights for the DB cluster.
  For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide .
  Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
  Parameters:
  
  performanceInsightsEnabled - Specifies whether to turn on Performance Insights for the DB cluster. This parameter is required.
  
  Returns:
  
  this
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-performanceinsightsenabled
- performanceInsightsKmsKeyId
  
  @Stability(Stable) public CfnDBClusterPropsMixin.Builder performanceInsightsKmsKeyId(String performanceInsightsKmsKeyId)
  
  The AWS KMS key identifier for encryption of Performance Insights data.
  The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
  If you don't specify a value for PerformanceInsightsKMSKeyId , then Amazon RDS uses your default KMS key. There is a default KMS key for your AWS account . Your AWS account has a different default KMS key for each AWS Region .
  Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
  Parameters:
  
  performanceInsightsKmsKeyId - The AWS KMS key identifier for encryption of Performance Insights data. This parameter is required.
  
  Returns:
  
  this
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-performanceinsightskmskeyid
- performanceInsightsRetentionPeriod
  
  @Stability(Stable) public CfnDBClusterPropsMixin.Builder performanceInsightsRetentionPeriod(Number performanceInsightsRetentionPeriod)
  The number of days to retain Performance Insights data.
  When creating a DB cluster without enabling Performance Insights, you can't specify the parameter PerformanceInsightsRetentionPeriod .
  Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
  Valid Values:
  
  7
  
  month * 31, where month is a number of months from 1-23. Examples: 93 (3 months * 31), 341 (11 months * 31), 589 (19 months * 31)
  
  731
  
  Default: 7 days
  If you specify a retention period that isn't valid, such as 94 , Amazon RDS issues an error.
  Parameters:
  
  performanceInsightsRetentionPeriod - The number of days to retain Performance Insights data. This parameter is required.
  
  Returns:
  
  this
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-performanceinsightsretentionperiod
- port
  
  @Stability(Stable) public CfnDBClusterPropsMixin.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.
  
  Valid for: Aurora DB clusters and Multi-AZ DB clusters
  Parameters:
  
  port - The port number on which the DB instances in the DB cluster accept connections. This parameter is required.
  
  Returns:
  
  this
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-port
- preferredBackupWindow
  
  @Stability(Stable) public CfnDBClusterPropsMixin.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.
  
  Valid for: Aurora DB clusters and Multi-AZ DB clusters
  Parameters:
  
  preferredBackupWindow - The daily time range during which automated backups are created. This parameter is required.
  
  Returns:
  
  this
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-preferredbackupwindow
- preferredMaintenanceWindow
  
  @Stability(Stable) public CfnDBClusterPropsMixin.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 Maintaining an Amazon Aurora DB cluster in the Amazon Aurora User Guide.
  Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
  Constraints: Minimum 30-minute window.
  Valid for: Aurora DB clusters and Multi-AZ DB clusters
  Parameters:
  
  preferredMaintenanceWindow - The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). This parameter is required.
  
  Returns:
  
  this
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-preferredmaintenancewindow
- publiclyAccessible
  
  @Stability(Stable) public CfnDBClusterPropsMixin.Builder publiclyAccessible(Boolean publiclyAccessible)
  
  Specifies whether the DB cluster is publicly accessible.
  Valid for Cluster Type: Multi-AZ DB clusters only
  When the DB cluster is publicly accessible and you connect from outside of the DB cluster's virtual private cloud (VPC), its domain name system (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB cluster, the endpoint resolves to the private IP address. Access to the DB cluster is controlled by its security group settings.
  When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.
  The default behavior when PubliclyAccessible is not specified depends on whether a DBSubnetGroup is specified.
  If DBSubnetGroup isn't specified, PubliclyAccessible defaults to true .
  If DBSubnetGroup is specified, PubliclyAccessible defaults to false unless the value of DBSubnetGroup is default , in which case PubliclyAccessible defaults to true .
  If PubliclyAccessible is true and the VPC that the DBSubnetGroup is in doesn't have an internet gateway attached to it, Amazon RDS returns an error.
  Parameters:
  
  publiclyAccessible - Specifies whether the DB cluster is publicly accessible. This parameter is required.
  
  Returns:
  
  this
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-publiclyaccessible
- publiclyAccessible
  
  @Stability(Stable) public CfnDBClusterPropsMixin.Builder publiclyAccessible(IResolvable publiclyAccessible)
  
  Specifies whether the DB cluster is publicly accessible.
  Valid for Cluster Type: Multi-AZ DB clusters only
  When the DB cluster is publicly accessible and you connect from outside of the DB cluster's virtual private cloud (VPC), its domain name system (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB cluster, the endpoint resolves to the private IP address. Access to the DB cluster is controlled by its security group settings.
  When the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.
  The default behavior when PubliclyAccessible is not specified depends on whether a DBSubnetGroup is specified.
  If DBSubnetGroup isn't specified, PubliclyAccessible defaults to true .
  If DBSubnetGroup is specified, PubliclyAccessible defaults to false unless the value of DBSubnetGroup is default , in which case PubliclyAccessible defaults to true .
  If PubliclyAccessible is true and the VPC that the DBSubnetGroup is in doesn't have an internet gateway attached to it, Amazon RDS returns an error.
  Parameters:
  
  publiclyAccessible - Specifies whether the DB cluster is publicly accessible. This parameter is required.
  
  Returns:
  
  this
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-publiclyaccessible
- replicationSourceIdentifier
  
  @Stability(Stable) public CfnDBClusterPropsMixin.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.
  Valid for: Aurora DB clusters only
  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
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-replicationsourceidentifier
- restoreToTime
  
  @Stability(Stable) public CfnDBClusterPropsMixin.Builder restoreToTime(String restoreToTime)
  The date and time to restore the DB cluster to.
  Valid Values: Value must be a time in Universal Coordinated Time (UTC) format
  Constraints:
  
  Must be before the latest restorable time for the DB instance
  
  Must be specified if UseLatestRestorableTime parameter isn't provided
  
  Can't be specified if the UseLatestRestorableTime parameter is enabled
  
  Can't be specified if the RestoreType parameter is copy-on-write
  
  This property must be used with SourceDBClusterIdentifier property. The resulting cluster will have the identifier that matches the value of the DBclusterIdentifier property.
  Example: 2015-03-07T23:45:00Z
  Valid for: Aurora DB clusters and Multi-AZ DB clusters
  Parameters:
  
  restoreToTime - The date and time to restore the DB cluster to. This parameter is required.
  
  Returns:
  
  this
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-restoretotime
- restoreType
  
  @Stability(Stable) public CfnDBClusterPropsMixin.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.
  
  If you don't specify a RestoreType value, then the new DB cluster is restored as a full copy of the source DB cluster.
  Valid for: Aurora DB clusters and Multi-AZ DB clusters
  Parameters:
  
  restoreType - The type of restore to be performed. You can specify one of the following values:. This parameter is required.
  
  Returns:
  
  this
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-restoretype
- scalingConfiguration
  
  @Stability(Stable) public CfnDBClusterPropsMixin.Builder scalingConfiguration(IResolvable scalingConfiguration)
  
  The scaling configuration of an Aurora Serverless v1 DB cluster.
  This property is only supported for Aurora Serverless v1. For Aurora Serverless v2, Use the ServerlessV2ScalingConfiguration property.
  Valid for: Aurora Serverless v1 DB clusters only
  Parameters:
  
  scalingConfiguration - The scaling configuration of an Aurora Serverless v1 DB cluster. This parameter is required.
  
  Returns:
  
  this
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-scalingconfiguration
- scalingConfiguration
  
  @Stability(Stable) public CfnDBClusterPropsMixin.Builder scalingConfiguration(CfnDBClusterPropsMixin.ScalingConfigurationProperty scalingConfiguration)
  
  The scaling configuration of an Aurora Serverless v1 DB cluster.
  This property is only supported for Aurora Serverless v1. For Aurora Serverless v2, Use the ServerlessV2ScalingConfiguration property.
  Valid for: Aurora Serverless v1 DB clusters only
  Parameters:
  
  scalingConfiguration - The scaling configuration of an Aurora Serverless v1 DB cluster. This parameter is required.
  
  Returns:
  
  this
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-scalingconfiguration
- serverlessV2ScalingConfiguration
  
  @Stability(Stable) public CfnDBClusterPropsMixin.Builder serverlessV2ScalingConfiguration(IResolvable serverlessV2ScalingConfiguration)
  
  The scaling configuration of an Aurora Serverless V2 DB cluster.
  This property is only supported for Aurora Serverless v2. For Aurora Serverless v1, Use the ScalingConfiguration property.
  Valid for: Aurora Serverless v2 DB clusters only
  Parameters:
  
  serverlessV2ScalingConfiguration - The scaling configuration of an Aurora Serverless V2 DB cluster. This parameter is required.
  
  Returns:
  
  this
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-serverlessv2scalingconfiguration
- serverlessV2ScalingConfiguration
  
  @Stability(Stable) public CfnDBClusterPropsMixin.Builder serverlessV2ScalingConfiguration(CfnDBClusterPropsMixin.ServerlessV2ScalingConfigurationProperty serverlessV2ScalingConfiguration)
  
  The scaling configuration of an Aurora Serverless V2 DB cluster.
  This property is only supported for Aurora Serverless v2. For Aurora Serverless v1, Use the ScalingConfiguration property.
  Valid for: Aurora Serverless v2 DB clusters only
  Parameters:
  
  serverlessV2ScalingConfiguration - The scaling configuration of an Aurora Serverless V2 DB cluster. This parameter is required.
  
  Returns:
  
  this
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-serverlessv2scalingconfiguration
- snapshotIdentifier
  
  @Stability(Stable) public CfnDBClusterPropsMixin.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.
  
  Valid for: Aurora DB clusters and Multi-AZ DB clusters
  Parameters:
  
  snapshotIdentifier - The identifier for the DB snapshot or DB cluster snapshot to restore from. This parameter is required.
  
  Returns:
  
  this
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-snapshotidentifier
- sourceDbClusterIdentifier
  
  @Stability(Stable) public CfnDBClusterPropsMixin.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.
  
  Cannot be specified if SourceDbClusterResourceId is specified. You must specify either SourceDBClusterIdentifier or SourceDbClusterResourceId , but not both.
  
  Valid for: Aurora DB clusters and Multi-AZ DB clusters
  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
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-sourcedbclusteridentifier
- sourceDbClusterResourceId
  
  @Stability(Stable) public CfnDBClusterPropsMixin.Builder sourceDbClusterResourceId(String sourceDbClusterResourceId)
  
  The resource ID of the source DB cluster from which to restore.
  Parameters:
  
  sourceDbClusterResourceId - The resource ID of the source DB cluster from which to restore. This parameter is required.
  
  Returns:
  
  this
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-sourcedbclusterresourceid
- sourceRegion
  
  @Stability(Stable) public CfnDBClusterPropsMixin.Builder sourceRegion(String sourceRegion)
  
  The AWS Region which contains the source DB cluster when replicating a DB cluster. For example, us-east-1 .
  Valid for: Aurora DB clusters only
  Parameters:
  
  sourceRegion - The AWS Region which contains the source DB cluster when replicating a DB cluster. For example, us-east-1 . This parameter is required.
  
  Returns:
  
  this
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-sourceregion
- storageEncrypted
  
  @Stability(Stable) public CfnDBClusterPropsMixin.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 .
  
  If you specify both the StorageEncrypted and SnapshotIdentifier properties without specifying the KmsKeyId property, then the restored DB cluster inherits the encryption settings from the DB snapshot that provide.
  
  Valid for: Aurora DB clusters and Multi-AZ DB clusters
  Parameters:
  
  storageEncrypted - Indicates whether the DB cluster is encrypted. This parameter is required.
  
  Returns:
  
  this
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-storageencrypted
- storageEncrypted
  
  @Stability(Stable) public CfnDBClusterPropsMixin.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 .
  
  If you specify both the StorageEncrypted and SnapshotIdentifier properties without specifying the KmsKeyId property, then the restored DB cluster inherits the encryption settings from the DB snapshot that provide.
  
  Valid for: Aurora DB clusters and Multi-AZ DB clusters
  Parameters:
  
  storageEncrypted - Indicates whether the DB cluster is encrypted. This parameter is required.
  
  Returns:
  
  this
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-storageencrypted
- storageType
  
  @Stability(Stable) public CfnDBClusterPropsMixin.Builder storageType(String storageType)
  The storage type to associate with the DB cluster.
  For information on storage types for Aurora DB clusters, see Storage configurations for Amazon Aurora DB clusters . For information on storage types for Multi-AZ DB clusters, see Settings for creating Multi-AZ DB clusters .
  This setting is required to create a Multi-AZ DB cluster.
  When specified for a Multi-AZ DB cluster, a value for the Iops parameter is required.
  Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
  Valid Values:
  
  Aurora DB clusters - aurora | aurora-iopt1
  
  Multi-AZ DB clusters - io1 | io2 | gp3
  
  Default:
  
  Aurora DB clusters - aurora
  
  Multi-AZ DB clusters - io1
  
  When you create an Aurora DB cluster with the storage type set to aurora-iopt1 , the storage type is returned in the response. The storage type isn't returned when you set it to aurora .
  Parameters:
  
  storageType - The storage type to associate with the DB cluster. This parameter is required.
  
  Returns:
  
  this
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-storagetype
- tags
  
  @Stability(Stable) public CfnDBClusterPropsMixin.Builder tags(List<? extends CfnTag> tags)
  
  Tags to assign to the DB cluster.
  Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
  Parameters:
  
  tags - Tags to assign to the DB cluster. This parameter is required.
  
  Returns:
  
  this
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-tags
- useLatestRestorableTime
  
  @Stability(Stable) public CfnDBClusterPropsMixin.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.
  Valid for: Aurora DB clusters and Multi-AZ DB clusters
  Parameters:
  
  useLatestRestorableTime - A value that indicates whether to restore the DB cluster to the latest restorable backup time. This parameter is required.
  
  Returns:
  
  this
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-uselatestrestorabletime
- useLatestRestorableTime
  
  @Stability(Stable) public CfnDBClusterPropsMixin.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.
  Valid for: Aurora DB clusters and Multi-AZ DB clusters
  Parameters:
  
  useLatestRestorableTime - A value that indicates whether to restore the DB cluster to the latest restorable backup time. This parameter is required.
  
  Returns:
  
  this
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-uselatestrestorabletime
- vpcSecurityGroupIds
  
  @Stability(Stable) public CfnDBClusterPropsMixin.Builder vpcSecurityGroupIds(List<? extends Object> 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.
  Valid for: Aurora DB clusters and Multi-AZ DB clusters
  Parameters:
  
  vpcSecurityGroupIds - A list of EC2 VPC security groups to associate with this DB cluster. This parameter is required.
  
  Returns:
  
  this
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-vpcsecuritygroupids
- build
  
  @Stability(Stable) public CfnDBClusterPropsMixin build()
  
  Specified by:
  
  build in interface software.amazon.jsii.Builder<CfnDBClusterPropsMixin>
  
  Returns:
  
  a newly built instance of CfnDBClusterPropsMixin.

Class CfnDBClusterPropsMixin.Builder

Method Summary

Methods inherited from class java.lang.Object

Method Details

create

create

allocatedStorage

associatedRoles

associatedRoles

autoMinorVersionUpgrade

autoMinorVersionUpgrade

availabilityZones

backtrackWindow

backupRetentionPeriod

clusterScalabilityType

copyTagsToSnapshot

copyTagsToSnapshot

databaseInsightsMode

databaseName

dbClusterIdentifier

dbClusterInstanceClass

dbClusterParameterGroupName

dbClusterParameterGroupName

dbInstanceParameterGroupName

dbSubnetGroupName

dbSubnetGroupName

dbSystemId

deleteAutomatedBackups

deleteAutomatedBackups

deletionProtection

deletionProtection

domain

domainIamRoleName

enableCloudwatchLogsExports

enableGlobalWriteForwarding

enableGlobalWriteForwarding

enableHttpEndpoint

enableHttpEndpoint

enableIamDatabaseAuthentication

enableIamDatabaseAuthentication

enableLocalWriteForwarding

enableLocalWriteForwarding

engine

engineLifecycleSupport

engineMode

engineVersion

globalClusterIdentifier

globalClusterIdentifier

iops

kmsKeyId

kmsKeyId

manageMasterUserPassword

manageMasterUserPassword

masterUserAuthenticationType

masterUsername

masterUserPassword

masterUserSecret

masterUserSecret

monitoringInterval

monitoringRoleArn

networkType

performanceInsightsEnabled

performanceInsightsEnabled

performanceInsightsKmsKeyId

performanceInsightsRetentionPeriod

port

preferredBackupWindow

preferredMaintenanceWindow

publiclyAccessible

publiclyAccessible

replicationSourceIdentifier

restoreToTime

restoreType

scalingConfiguration

scalingConfiguration

serverlessV2ScalingConfiguration

serverlessV2ScalingConfiguration

snapshotIdentifier

sourceDbClusterIdentifier

sourceDbClusterResourceId