Package software.amazon.awscdk.services.rds

Class CfnDBCluster

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.rds.CfnDBCluster
All Implemented Interfaces:
IEnvironmentAware, IInspectable, ITaggable, IDBClusterRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)", date="2025-11-10T13:40:13.130Z") @Stability(Stable) public class CfnDBCluster extends CfnResource implements IInspectable, IDBClusterRef, ITaggable
The AWS::RDS::DBCluster resource creates an Amazon Aurora DB cluster or Multi-AZ DB cluster.

For more information about creating an Aurora DB cluster, see Creating an Amazon Aurora DB cluster in the Amazon Aurora User Guide .

For more information about creating a Multi-AZ DB cluster, see Creating a Multi-AZ DB cluster in the Amazon RDS User Guide .

You can only create this resource in AWS Regions where Amazon Aurora or Multi-AZ DB clusters are supported.

Updating DB clusters

When properties labeled " Update requires: Replacement " are updated, AWS CloudFormation first creates a replacement DB cluster, then changes references from other dependent resources to point to the replacement DB cluster, and finally deletes the old DB cluster.

We highly recommend that you take a snapshot of the database before updating the stack. If you don't, you lose the data when AWS CloudFormation replaces your DB cluster. To preserve your data, perform the following procedure:

  • Deactivate any applications that are using the DB cluster so that there's no activity on the DB instance.
  • Create a snapshot of the DB cluster. For more information, see Creating a DB cluster snapshot .
  • If you want to restore your DB cluster using a DB cluster snapshot, modify the updated template with your DB cluster changes and add the SnapshotIdentifier property with the ID of the DB cluster snapshot that you want to use.

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 DB cluster 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.

  • Update the stack.

Currently, when you are updating the stack for an Aurora Serverless DB cluster, you can't include changes to any other properties when you specify one of the following properties: PreferredBackupWindow , PreferredMaintenanceWindow , and Port . This limitation doesn't apply to provisioned DB clusters.

For more information about updating other properties of this resource, see [ModifyDBCluster](https://docs.aws.amazon.com//AmazonRDS/latest/APIReference/API_ModifyDBCluster.html) . For more information about updating stacks, see AWS CloudFormation Stacks Updates .

Deleting DB clusters

The default DeletionPolicy for AWS::RDS::DBCluster resources is Snapshot . For more information about how AWS CloudFormation deletes resources, see DeletionPolicy Attribute .

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.rds.*;
 CfnDBCluster cfnDBCluster = CfnDBCluster.Builder.create(this, "MyCfnDBCluster")
         .allocatedStorage(123)
         .associatedRoles(List.of(DBClusterRoleProperty.builder()
                 .roleArn("roleArn")
                 // the properties below are optional
                 .featureName("featureName")
                 .build()))
         .autoMinorVersionUpgrade(false)
         .availabilityZones(List.of("availabilityZones"))
         .backtrackWindow(123)
         .backupRetentionPeriod(123)
         .clusterScalabilityType("clusterScalabilityType")
         .copyTagsToSnapshot(false)
         .databaseInsightsMode("databaseInsightsMode")
         .databaseName("databaseName")
         .dbClusterIdentifier("dbClusterIdentifier")
         .dbClusterInstanceClass("dbClusterInstanceClass")
         .dbClusterParameterGroupName("dbClusterParameterGroupName")
         .dbInstanceParameterGroupName("dbInstanceParameterGroupName")
         .dbSubnetGroupName("dbSubnetGroupName")
         .dbSystemId("dbSystemId")
         .deleteAutomatedBackups(false)
         .deletionProtection(false)
         .domain("domain")
         .domainIamRoleName("domainIamRoleName")
         .enableCloudwatchLogsExports(List.of("enableCloudwatchLogsExports"))
         .enableGlobalWriteForwarding(false)
         .enableHttpEndpoint(false)
         .enableIamDatabaseAuthentication(false)
         .enableLocalWriteForwarding(false)
         .engine("engine")
         .engineLifecycleSupport("engineLifecycleSupport")
         .engineMode("engineMode")
         .engineVersion("engineVersion")
         .globalClusterIdentifier("globalClusterIdentifier")
         .iops(123)
         .kmsKeyId("kmsKeyId")
         .manageMasterUserPassword(false)
         .masterUserAuthenticationType("masterUserAuthenticationType")
         .masterUsername("masterUsername")
         .masterUserPassword("masterUserPassword")
         .masterUserSecret(MasterUserSecretProperty.builder()
                 .kmsKeyId("kmsKeyId")
                 .secretArn("secretArn")
                 .build())
         .monitoringInterval(123)
         .monitoringRoleArn("monitoringRoleArn")
         .networkType("networkType")
         .performanceInsightsEnabled(false)
         .performanceInsightsKmsKeyId("performanceInsightsKmsKeyId")
         .performanceInsightsRetentionPeriod(123)
         .port(123)
         .preferredBackupWindow("preferredBackupWindow")
         .preferredMaintenanceWindow("preferredMaintenanceWindow")
         .publiclyAccessible(false)
         .replicationSourceIdentifier("replicationSourceIdentifier")
         .restoreToTime("restoreToTime")
         .restoreType("restoreType")
         .scalingConfiguration(ScalingConfigurationProperty.builder()
                 .autoPause(false)
                 .maxCapacity(123)
                 .minCapacity(123)
                 .secondsBeforeTimeout(123)
                 .secondsUntilAutoPause(123)
                 .timeoutAction("timeoutAction")
                 .build())
         .serverlessV2ScalingConfiguration(ServerlessV2ScalingConfigurationProperty.builder()
                 .maxCapacity(123)
                 .minCapacity(123)
                 .secondsUntilAutoPause(123)
                 .build())
         .snapshotIdentifier("snapshotIdentifier")
         .sourceDbClusterIdentifier("sourceDbClusterIdentifier")
         .sourceDbClusterResourceId("sourceDbClusterResourceId")
         .sourceRegion("sourceRegion")
         .storageEncrypted(false)
         .storageType("storageType")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .useLatestRestorableTime(false)
         .vpcSecurityGroupIds(List.of("vpcSecurityGroupIds"))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnDBCluster

      protected CfnDBCluster(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnDBCluster

      protected CfnDBCluster(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnDBCluster

      @Stability(Stable) public CfnDBCluster(@NotNull software.constructs.Construct scope, @NotNull String id, @Nullable CfnDBClusterProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties.

    • CfnDBCluster

      @Stability(Stable) public CfnDBCluster(@NotNull software.constructs.Construct scope, @NotNull String id)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrDbClusterArn

      @Stability(Stable) @NotNull public String getAttrDbClusterArn()
      The Amazon Resource Name (ARN) for the DB cluster.

    • getAttrDbClusterResourceId

      @Stability(Stable) @NotNull public String getAttrDbClusterResourceId()
      The AWS Region -unique, immutable identifier for the DB cluster.

      This identifier is found in AWS CloudTrail log entries whenever the KMS key for the DB cluster is accessed.

    • getAttrEndpoint

      @Stability(Stable) @NotNull public IResolvable getAttrEndpoint()
      The Endpoint return value specifies the connection endpoint for the primary instance of the DB cluster.

    • getAttrEndpointAddress

      @Stability(Stable) @NotNull public String getAttrEndpointAddress()
      The connection endpoint for the DB cluster.

      For example: mystack-mydbcluster-123456789012.us-east-2.rds.amazonaws.com

    • getAttrEndpointPort

      @Stability(Stable) @NotNull public String getAttrEndpointPort()
      The port number that will accept connections on this DB cluster.

      For example: 3306

    • getAttrMasterUserSecretSecretArn

      @Stability(Stable) @NotNull public String getAttrMasterUserSecretSecretArn()
      The Amazon Resource Name (ARN) of the secret.

    • getAttrReadEndpoint

      @Stability(Stable) @NotNull public IResolvable getAttrReadEndpoint()
      The ReadEndpoint return value specifies the reader endpoint for the DB cluster.

      The reader endpoint for a DB cluster load-balances connections across the Aurora Replicas that are available in a DB cluster. As clients request new connections to the reader endpoint, Aurora distributes the connection requests among the Aurora Replicas in the DB cluster. This functionality can help balance your read workload across multiple Aurora Replicas in your DB cluster. If a failover occurs, and the Aurora Replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Aurora Replicas in the cluster, you can then reconnect to the reader endpoint. For more information about Aurora endpoints, see Amazon Aurora connection management in the Amazon Aurora User Guide.

    • getAttrReadEndpointAddress

      @Stability(Stable) @NotNull public String getAttrReadEndpointAddress()
      The reader endpoint for the DB cluster.

      For example: mystack-mydbcluster-ro-123456789012.us-east-2.rds.amazonaws.com

    • getAttrStorageThroughput

      @Stability(Stable) @NotNull public Number getAttrStorageThroughput()
      The storage throughput for the DB cluster.

      The throughput is automatically set based on the IOPS that you provision, and is not configurable.

      This setting is only for non-Aurora Multi-AZ DB clusters.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getDbClusterRef

      @Stability(Stable) @NotNull public DBClusterReference getDbClusterRef()
      A reference to a DBCluster resource.
      Specified by:
      getDbClusterRef in interface IDBClusterRef

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getAllocatedStorage

      @Stability(Stable) @Nullable public Number getAllocatedStorage()
      The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.

    • setAllocatedStorage

      @Stability(Stable) public void setAllocatedStorage(@Nullable Number value)
      The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.

    • getAssociatedRoles

      @Stability(Stable) @Nullable public Object getAssociatedRoles()
      Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster.

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnDBCluster.DBClusterRoleProperty>

    • setAssociatedRoles

      @Stability(Stable) public void setAssociatedRoles(@Nullable IResolvable value)
      Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster.

    • setAssociatedRoles

      @Stability(Stable) public void setAssociatedRoles(@Nullable List<Object> value)
      Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster.

    • getAutoMinorVersionUpgrade

      @Stability(Stable) @Nullable public Object getAutoMinorVersionUpgrade()
      Specifies whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window.

      Returns union: either Boolean or IResolvable

    • setAutoMinorVersionUpgrade

      @Stability(Stable) public void setAutoMinorVersionUpgrade(@Nullable Boolean value)
      Specifies whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window.

    • setAutoMinorVersionUpgrade

      @Stability(Stable) public void setAutoMinorVersionUpgrade(@Nullable IResolvable value)
      Specifies whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window.

    • getAvailabilityZones

      @Stability(Stable) @Nullable public List<String> getAvailabilityZones()
      A list of Availability Zones (AZs) where instances in the DB cluster can be created.

    • setAvailabilityZones

      @Stability(Stable) public void setAvailabilityZones(@Nullable List<String> value)
      A list of Availability Zones (AZs) where instances in the DB cluster can be created.

    • getBacktrackWindow

      @Stability(Stable) @Nullable public Number getBacktrackWindow()
      The target backtrack window, in seconds.

      To disable backtracking, set this value to 0 .

    • setBacktrackWindow

      @Stability(Stable) public void setBacktrackWindow(@Nullable Number value)
      The target backtrack window, in seconds.

      To disable backtracking, set this value to 0 .

    • getBackupRetentionPeriod

      @Stability(Stable) @Nullable public Number getBackupRetentionPeriod()
      The number of days for which automated backups are retained.

    • setBackupRetentionPeriod

      @Stability(Stable) public void setBackupRetentionPeriod(@Nullable Number value)
      The number of days for which automated backups are retained.

    • getClusterScalabilityType

      @Stability(Stable) @Nullable public String getClusterScalabilityType()
      Specifies the scalability mode of the Aurora DB cluster.

    • setClusterScalabilityType

      @Stability(Stable) public void setClusterScalabilityType(@Nullable String value)
      Specifies the scalability mode of the Aurora DB cluster.

    • getCopyTagsToSnapshot

      @Stability(Stable) @Nullable public Object getCopyTagsToSnapshot()
      A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster.

      Returns union: either Boolean or IResolvable

    • setCopyTagsToSnapshot

      @Stability(Stable) public void setCopyTagsToSnapshot(@Nullable Boolean value)
      A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster.

    • setCopyTagsToSnapshot

      @Stability(Stable) public void setCopyTagsToSnapshot(@Nullable IResolvable value)
      A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster.

    • getDatabaseInsightsMode

      @Stability(Stable) @Nullable public String getDatabaseInsightsMode()
      The mode of Database Insights to enable for the DB cluster.

    • setDatabaseInsightsMode

      @Stability(Stable) public void setDatabaseInsightsMode(@Nullable String value)
      The mode of Database Insights to enable for the DB cluster.

    • getDatabaseName

      @Stability(Stable) @Nullable public String getDatabaseName()
      The name of your database.

    • setDatabaseName

      @Stability(Stable) public void setDatabaseName(@Nullable String value)
      The name of your database.

    • getDbClusterIdentifier

      @Stability(Stable) @Nullable public String getDbClusterIdentifier()
      The DB cluster identifier.

      This parameter is stored as a lowercase string.

    • setDbClusterIdentifier

      @Stability(Stable) public void setDbClusterIdentifier(@Nullable String value)
      The DB cluster identifier.

      This parameter is stored as a lowercase string.

    • getDbClusterInstanceClass

      @Stability(Stable) @Nullable public String getDbClusterInstanceClass()
      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.

    • setDbClusterInstanceClass

      @Stability(Stable) public void setDbClusterInstanceClass(@Nullable String value)
      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.

    • getDbClusterParameterGroupName

      @Stability(Stable) @Nullable public String getDbClusterParameterGroupName()
      The name of the DB cluster parameter group to associate with this DB cluster.

    • setDbClusterParameterGroupName

      @Stability(Stable) public void setDbClusterParameterGroupName(@Nullable String value)
      The name of the DB cluster parameter group to associate with this DB cluster.

    • getDbInstanceParameterGroupName

      @Stability(Stable) @Nullable public String getDbInstanceParameterGroupName()
      The name of the DB parameter group to apply to all instances of the DB cluster.

    • setDbInstanceParameterGroupName

      @Stability(Stable) public void setDbInstanceParameterGroupName(@Nullable String value)
      The name of the DB parameter group to apply to all instances of the DB cluster.

    • getDbSubnetGroupName

      @Stability(Stable) @Nullable public String getDbSubnetGroupName()
      A DB subnet group that you want to associate with this DB cluster.

    • setDbSubnetGroupName

      @Stability(Stable) public void setDbSubnetGroupName(@Nullable String value)
      A DB subnet group that you want to associate with this DB cluster.

    • getDbSystemId

      @Stability(Stable) @Nullable public String getDbSystemId()
      Reserved for future use.

    • setDbSystemId

      @Stability(Stable) public void setDbSystemId(@Nullable String value)
      Reserved for future use.

    • getDeleteAutomatedBackups

      @Stability(Stable) @Nullable public Object getDeleteAutomatedBackups()
      Specifies whether to remove automated backups immediately after the DB cluster is deleted.

      Returns union: either Boolean or IResolvable

    • setDeleteAutomatedBackups

      @Stability(Stable) public void setDeleteAutomatedBackups(@Nullable Boolean value)
      Specifies whether to remove automated backups immediately after the DB cluster is deleted.

    • setDeleteAutomatedBackups

      @Stability(Stable) public void setDeleteAutomatedBackups(@Nullable IResolvable value)
      Specifies whether to remove automated backups immediately after the DB cluster is deleted.

    • getDeletionProtection

      @Stability(Stable) @Nullable public Object getDeletionProtection()
      A value that indicates whether the DB cluster has deletion protection enabled.

      Returns union: either Boolean or IResolvable

    • setDeletionProtection

      @Stability(Stable) public void setDeletionProtection(@Nullable Boolean value)
      A value that indicates whether the DB cluster has deletion protection enabled.

    • setDeletionProtection

      @Stability(Stable) public void setDeletionProtection(@Nullable IResolvable value)
      A value that indicates whether the DB cluster has deletion protection enabled.

    • getDomain

      @Stability(Stable) @Nullable public String getDomain()
      Indicates the directory ID of the Active Directory to create the DB cluster.

    • setDomain

      @Stability(Stable) public void setDomain(@Nullable String value)
      Indicates the directory ID of the Active Directory to create the DB cluster.

    • getDomainIamRoleName

      @Stability(Stable) @Nullable public String getDomainIamRoleName()
      Specifies the name of the IAM role to use when making API calls to the Directory Service.

    • setDomainIamRoleName

      @Stability(Stable) public void setDomainIamRoleName(@Nullable String value)
      Specifies the name of the IAM role to use when making API calls to the Directory Service.

    • getEnableCloudwatchLogsExports

      @Stability(Stable) @Nullable public List<String> getEnableCloudwatchLogsExports()
      The list of log types that need to be enabled for exporting to CloudWatch Logs.

    • setEnableCloudwatchLogsExports

      @Stability(Stable) public void setEnableCloudwatchLogsExports(@Nullable List<String> value)
      The list of log types that need to be enabled for exporting to CloudWatch Logs.

    • getEnableGlobalWriteForwarding

      @Stability(Stable) @Nullable public Object getEnableGlobalWriteForwarding()
      Specifies whether to enable this DB cluster to forward write operations to the primary cluster of a global cluster (Aurora global database).

      Returns union: either Boolean or IResolvable

    • setEnableGlobalWriteForwarding

      @Stability(Stable) public void setEnableGlobalWriteForwarding(@Nullable Boolean value)
      Specifies whether to enable this DB cluster to forward write operations to the primary cluster of a global cluster (Aurora global database).

    • setEnableGlobalWriteForwarding

      @Stability(Stable) public void setEnableGlobalWriteForwarding(@Nullable IResolvable value)
      Specifies whether to enable this DB cluster to forward write operations to the primary cluster of a global cluster (Aurora global database).

    • getEnableHttpEndpoint

      @Stability(Stable) @Nullable public Object getEnableHttpEndpoint()
      Specifies whether to enable the HTTP endpoint for the DB cluster.

      By default, the HTTP endpoint isn't enabled.

      Returns union: either Boolean or IResolvable

    • setEnableHttpEndpoint

      @Stability(Stable) public void setEnableHttpEndpoint(@Nullable Boolean value)
      Specifies whether to enable the HTTP endpoint for the DB cluster.

      By default, the HTTP endpoint isn't enabled.

    • setEnableHttpEndpoint

      @Stability(Stable) public void setEnableHttpEndpoint(@Nullable IResolvable value)
      Specifies whether to enable the HTTP endpoint for the DB cluster.

      By default, the HTTP endpoint isn't enabled.

    • getEnableIamDatabaseAuthentication

      @Stability(Stable) @Nullable public Object getEnableIamDatabaseAuthentication()
      A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts.

      Returns union: either Boolean or IResolvable

    • setEnableIamDatabaseAuthentication

      @Stability(Stable) public void setEnableIamDatabaseAuthentication(@Nullable Boolean value)
      A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts.

    • setEnableIamDatabaseAuthentication

      @Stability(Stable) public void setEnableIamDatabaseAuthentication(@Nullable IResolvable value)
      A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts.

    • getEnableLocalWriteForwarding

      @Stability(Stable) @Nullable public Object getEnableLocalWriteForwarding()
      Specifies whether read replicas can forward write operations to the writer DB instance in the DB cluster.

      Returns union: either Boolean or IResolvable

    • setEnableLocalWriteForwarding

      @Stability(Stable) public void setEnableLocalWriteForwarding(@Nullable Boolean value)
      Specifies whether read replicas can forward write operations to the writer DB instance in the DB cluster.

    • setEnableLocalWriteForwarding

      @Stability(Stable) public void setEnableLocalWriteForwarding(@Nullable IResolvable value)
      Specifies whether read replicas can forward write operations to the writer DB instance in the DB cluster.

    • getEngine

      @Stability(Stable) @Nullable public String getEngine()
      The name of the database engine to be used for this DB cluster.

    • setEngine

      @Stability(Stable) public void setEngine(@Nullable String value)
      The name of the database engine to be used for this DB cluster.

    • getEngineLifecycleSupport

      @Stability(Stable) @Nullable public String getEngineLifecycleSupport()
      The life cycle type for this DB cluster.

    • setEngineLifecycleSupport

      @Stability(Stable) public void setEngineLifecycleSupport(@Nullable String value)
      The life cycle type for this DB cluster.

    • getEngineMode

      @Stability(Stable) @Nullable public String getEngineMode()
      The DB engine mode of the DB cluster, either provisioned or serverless .

    • setEngineMode

      @Stability(Stable) public void setEngineMode(@Nullable String value)
      The DB engine mode of the DB cluster, either provisioned or serverless .

    • getEngineVersion

      @Stability(Stable) @Nullable public String getEngineVersion()
      The version number of the database engine to use.

    • setEngineVersion

      @Stability(Stable) public void setEngineVersion(@Nullable String value)
      The version number of the database engine to use.

    • getGlobalClusterIdentifier

      @Stability(Stable) @Nullable public String getGlobalClusterIdentifier()
      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.

    • setGlobalClusterIdentifier

      @Stability(Stable) public void setGlobalClusterIdentifier(@Nullable String value)
      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.

    • getIops

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

    • setIops

      @Stability(Stable) public void setIops(@Nullable Number value)
      The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.

    • getKmsKeyId

      @Stability(Stable) @Nullable public String getKmsKeyId()
      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 .

    • setKmsKeyId

      @Stability(Stable) public void setKmsKeyId(@Nullable String value)
      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 .

    • getManageMasterUserPassword

      @Stability(Stable) @Nullable public Object getManageMasterUserPassword()
      Specifies whether to manage the master user password with AWS Secrets Manager.

      Returns union: either Boolean or IResolvable

    • setManageMasterUserPassword

      @Stability(Stable) public void setManageMasterUserPassword(@Nullable Boolean value)
      Specifies whether to manage the master user password with AWS Secrets Manager.

    • setManageMasterUserPassword

      @Stability(Stable) public void setManageMasterUserPassword(@Nullable IResolvable value)
      Specifies whether to manage the master user password with AWS Secrets Manager.

    • getMasterUserAuthenticationType

      @Stability(Stable) @Nullable public String getMasterUserAuthenticationType()
      Specifies the authentication type for the master user.

    • setMasterUserAuthenticationType

      @Stability(Stable) public void setMasterUserAuthenticationType(@Nullable String value)
      Specifies the authentication type for the master user.

    • getMasterUsername

      @Stability(Stable) @Nullable public String getMasterUsername()
      The name of the master user for the DB cluster.

    • setMasterUsername

      @Stability(Stable) public void setMasterUsername(@Nullable String value)
      The name of the master user for the DB cluster.

    • getMasterUserPassword

      @Stability(Stable) @Nullable public String getMasterUserPassword()
      The master password for the DB instance.

    • setMasterUserPassword

      @Stability(Stable) public void setMasterUserPassword(@Nullable String value)
      The master password for the DB instance.

    • getMasterUserSecret

      @Stability(Stable) @Nullable public Object getMasterUserSecret()
      The secret managed by RDS in AWS Secrets Manager for the master user password.

      Returns union: either IResolvable or CfnDBCluster.MasterUserSecretProperty

    • setMasterUserSecret

      @Stability(Stable) public void setMasterUserSecret(@Nullable IResolvable value)
      The secret managed by RDS in AWS Secrets Manager for the master user password.

    • setMasterUserSecret

      @Stability(Stable) public void setMasterUserSecret(@Nullable CfnDBCluster.MasterUserSecretProperty value)
      The secret managed by RDS in AWS Secrets Manager for the master user password.

    • getMonitoringInterval

      @Stability(Stable) @Nullable public Number getMonitoringInterval()
      The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster.

    • setMonitoringInterval

      @Stability(Stable) public void setMonitoringInterval(@Nullable Number value)
      The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster.

    • getMonitoringRoleArn

      @Stability(Stable) @Nullable public String getMonitoringRoleArn()
      The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.

    • setMonitoringRoleArn

      @Stability(Stable) public void setMonitoringRoleArn(@Nullable String value)
      The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.

    • getNetworkType

      @Stability(Stable) @Nullable public String getNetworkType()
      The network type of the DB cluster.

    • setNetworkType

      @Stability(Stable) public void setNetworkType(@Nullable String value)
      The network type of the DB cluster.

    • getPerformanceInsightsEnabled

      @Stability(Stable) @Nullable public Object getPerformanceInsightsEnabled()
      Specifies whether to turn on Performance Insights for the DB cluster.

      Returns union: either Boolean or IResolvable

    • setPerformanceInsightsEnabled

      @Stability(Stable) public void setPerformanceInsightsEnabled(@Nullable Boolean value)
      Specifies whether to turn on Performance Insights for the DB cluster.

    • setPerformanceInsightsEnabled

      @Stability(Stable) public void setPerformanceInsightsEnabled(@Nullable IResolvable value)
      Specifies whether to turn on Performance Insights for the DB cluster.

    • getPerformanceInsightsKmsKeyId

      @Stability(Stable) @Nullable public String getPerformanceInsightsKmsKeyId()
      The AWS KMS key identifier for encryption of Performance Insights data.

    • setPerformanceInsightsKmsKeyId

      @Stability(Stable) public void setPerformanceInsightsKmsKeyId(@Nullable String value)
      The AWS KMS key identifier for encryption of Performance Insights data.

    • getPerformanceInsightsRetentionPeriod

      @Stability(Stable) @Nullable public Number getPerformanceInsightsRetentionPeriod()
      The number of days to retain Performance Insights data.

    • setPerformanceInsightsRetentionPeriod

      @Stability(Stable) public void setPerformanceInsightsRetentionPeriod(@Nullable Number value)
      The number of days to retain Performance Insights data.

    • getPort

      @Stability(Stable) @Nullable public Number getPort()
      The port number on which the DB instances in the DB cluster accept connections.

    • setPort

      @Stability(Stable) public void setPort(@Nullable Number value)
      The port number on which the DB instances in the DB cluster accept connections.

    • getPreferredBackupWindow

      @Stability(Stable) @Nullable public String getPreferredBackupWindow()
      The daily time range during which automated backups are created.

    • setPreferredBackupWindow

      @Stability(Stable) public void setPreferredBackupWindow(@Nullable String value)
      The daily time range during which automated backups are created.

    • getPreferredMaintenanceWindow

      @Stability(Stable) @Nullable public String getPreferredMaintenanceWindow()
      The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

    • setPreferredMaintenanceWindow

      @Stability(Stable) public void setPreferredMaintenanceWindow(@Nullable String value)
      The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

    • getPubliclyAccessible

      @Stability(Stable) @Nullable public Object getPubliclyAccessible()
      Specifies whether the DB cluster is publicly accessible.

      Returns union: either Boolean or IResolvable

    • setPubliclyAccessible

      @Stability(Stable) public void setPubliclyAccessible(@Nullable Boolean value)
      Specifies whether the DB cluster is publicly accessible.

    • setPubliclyAccessible

      @Stability(Stable) public void setPubliclyAccessible(@Nullable IResolvable value)
      Specifies whether the DB cluster is publicly accessible.

    • getReplicationSourceIdentifier

      @Stability(Stable) @Nullable public String getReplicationSourceIdentifier()
      The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a read replica.

    • setReplicationSourceIdentifier

      @Stability(Stable) public void setReplicationSourceIdentifier(@Nullable String value)
      The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a read replica.

    • getRestoreToTime

      @Stability(Stable) @Nullable public String getRestoreToTime()
      The date and time to restore the DB cluster to.

    • setRestoreToTime

      @Stability(Stable) public void setRestoreToTime(@Nullable String value)
      The date and time to restore the DB cluster to.

    • getRestoreType

      @Stability(Stable) @Nullable public String getRestoreType()
      The type of restore to be performed.

      You can specify one of the following values:.

    • setRestoreType

      @Stability(Stable) public void setRestoreType(@Nullable String value)
      The type of restore to be performed.

      You can specify one of the following values:.

    • getScalingConfiguration

      @Stability(Stable) @Nullable public Object getScalingConfiguration()
      The scaling configuration of an Aurora Serverless v1 DB cluster.

      Returns union: either IResolvable or CfnDBCluster.ScalingConfigurationProperty

    • setScalingConfiguration

      @Stability(Stable) public void setScalingConfiguration(@Nullable IResolvable value)
      The scaling configuration of an Aurora Serverless v1 DB cluster.

    • setScalingConfiguration

      @Stability(Stable) public void setScalingConfiguration(@Nullable CfnDBCluster.ScalingConfigurationProperty value)
      The scaling configuration of an Aurora Serverless v1 DB cluster.

    • getServerlessV2ScalingConfiguration

      @Stability(Stable) @Nullable public Object getServerlessV2ScalingConfiguration()
      The scaling configuration of an Aurora Serverless V2 DB cluster.

      Returns union: either IResolvable or CfnDBCluster.ServerlessV2ScalingConfigurationProperty

    • setServerlessV2ScalingConfiguration

      @Stability(Stable) public void setServerlessV2ScalingConfiguration(@Nullable IResolvable value)
      The scaling configuration of an Aurora Serverless V2 DB cluster.

    • setServerlessV2ScalingConfiguration

      @Stability(Stable) public void setServerlessV2ScalingConfiguration(@Nullable CfnDBCluster.ServerlessV2ScalingConfigurationProperty value)
      The scaling configuration of an Aurora Serverless V2 DB cluster.

    • getSnapshotIdentifier

      @Stability(Stable) @Nullable public String getSnapshotIdentifier()
      The identifier for the DB snapshot or DB cluster snapshot to restore from.

    • setSnapshotIdentifier

      @Stability(Stable) public void setSnapshotIdentifier(@Nullable String value)
      The identifier for the DB snapshot or DB cluster snapshot to restore from.

    • getSourceDbClusterIdentifier

      @Stability(Stable) @Nullable public String getSourceDbClusterIdentifier()
      When restoring a DB cluster to a point in time, the identifier of the source DB cluster from which to restore.

    • setSourceDbClusterIdentifier

      @Stability(Stable) public void setSourceDbClusterIdentifier(@Nullable String value)
      When restoring a DB cluster to a point in time, the identifier of the source DB cluster from which to restore.

    • getSourceDbClusterResourceId

      @Stability(Stable) @Nullable public String getSourceDbClusterResourceId()
      The resource ID of the source DB cluster from which to restore.

    • setSourceDbClusterResourceId

      @Stability(Stable) public void setSourceDbClusterResourceId(@Nullable String value)
      The resource ID of the source DB cluster from which to restore.

    • getSourceRegion

      @Stability(Stable) @Nullable public String getSourceRegion()
      The AWS Region which contains the source DB cluster when replicating a DB cluster.

      For example, us-east-1 .

    • setSourceRegion

      @Stability(Stable) public void setSourceRegion(@Nullable String value)
      The AWS Region which contains the source DB cluster when replicating a DB cluster.

      For example, us-east-1 .

    • getStorageEncrypted

      @Stability(Stable) @Nullable public Object getStorageEncrypted()
      Indicates whether the DB cluster is encrypted.

      Returns union: either Boolean or IResolvable

    • setStorageEncrypted

      @Stability(Stable) public void setStorageEncrypted(@Nullable Boolean value)
      Indicates whether the DB cluster is encrypted.

    • setStorageEncrypted

      @Stability(Stable) public void setStorageEncrypted(@Nullable IResolvable value)
      Indicates whether the DB cluster is encrypted.

    • getStorageType

      @Stability(Stable) @Nullable public String getStorageType()
      The storage type to associate with the DB cluster.

    • setStorageType

      @Stability(Stable) public void setStorageType(@Nullable String value)
      The storage type to associate with the DB cluster.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      Tags to assign to the DB cluster.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      Tags to assign to the DB cluster.

    • getUseLatestRestorableTime

      @Stability(Stable) @Nullable public Object getUseLatestRestorableTime()
      A value that indicates whether to restore the DB cluster to the latest restorable backup time.

      Returns union: either Boolean or IResolvable

    • setUseLatestRestorableTime

      @Stability(Stable) public void setUseLatestRestorableTime(@Nullable Boolean value)
      A value that indicates whether to restore the DB cluster to the latest restorable backup time.

    • setUseLatestRestorableTime

      @Stability(Stable) public void setUseLatestRestorableTime(@Nullable IResolvable value)
      A value that indicates whether to restore the DB cluster to the latest restorable backup time.

    • getVpcSecurityGroupIds

      @Stability(Stable) @Nullable public List<String> getVpcSecurityGroupIds()
      A list of EC2 VPC security groups to associate with this DB cluster.

    • setVpcSecurityGroupIds

      @Stability(Stable) public void setVpcSecurityGroupIds(@Nullable List<String> value)
      A list of EC2 VPC security groups to associate with this DB cluster.