Package software.amazon.awscdk.services.rds

Class CfnDBCluster

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.rds.CfnDBCluster
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:48.894Z") @Stability(Stable) public class CfnDBCluster extends CfnResource implements IInspectable
A CloudFormation AWS::RDS::DBCluster.

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)
         .copyTagsToSnapshot(false)
         .databaseName("databaseName")
         .dbClusterIdentifier("dbClusterIdentifier")
         .dbClusterInstanceClass("dbClusterInstanceClass")
         .dbClusterParameterGroupName("dbClusterParameterGroupName")
         .dbInstanceParameterGroupName("dbInstanceParameterGroupName")
         .dbSubnetGroupName("dbSubnetGroupName")
         .dbSystemId("dbSystemId")
         .deletionProtection(false)
         .domain("domain")
         .domainIamRoleName("domainIamRoleName")
         .enableCloudwatchLogsExports(List.of("enableCloudwatchLogsExports"))
         .enableHttpEndpoint(false)
         .enableIamDatabaseAuthentication(false)
         .engine("engine")
         .engineMode("engineMode")
         .engineVersion("engineVersion")
         .globalClusterIdentifier("globalClusterIdentifier")
         .iops(123)
         .kmsKeyId("kmsKeyId")
         .manageMasterUserPassword(false)
         .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)
                 .build())
         .snapshotIdentifier("snapshotIdentifier")
         .sourceDbClusterIdentifier("sourceDbClusterIdentifier")
         .sourceRegion("sourceRegion")
         .storageEncrypted(false)
         .storageType("storageType")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .useLatestRestorableTime(false)
         .vpcSecurityGroupIds(List.of("vpcSecurityGroupIds"))
         .build();

  • 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 Construct scope, @NotNull String id, @Nullable CfnDBClusterProps props)
      Create a new AWS::RDS::DBCluster.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.

    • CfnDBCluster

      @Stability(Stable) public CfnDBCluster(@NotNull Construct scope, @NotNull String id)
      Create a new AWS::RDS::DBCluster.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      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.

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

    • 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

    • getCfnProperties

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

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      An optional array of key-value pairs to apply to this DB cluster.

      Valid for: Aurora DB clusters and Multi-AZ DB clusters

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

      This setting is required to create a Multi-AZ DB cluster.

      Valid for: Multi-AZ DB clusters only

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

      This setting is required to create a Multi-AZ DB cluster.

      Valid for: Multi-AZ DB clusters only

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

      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

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

      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

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

      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

    • getAutoMinorVersionUpgrade

      @Stability(Stable) @Nullable public Object getAutoMinorVersionUpgrade()
      A value that indicates 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: Multi-AZ DB clusters only

    • setAutoMinorVersionUpgrade

      @Stability(Stable) public void setAutoMinorVersionUpgrade(@Nullable Boolean value)
      A value that indicates 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: Multi-AZ DB clusters only

    • setAutoMinorVersionUpgrade

      @Stability(Stable) public void setAutoMinorVersionUpgrade(@Nullable IResolvable value)
      A value that indicates 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: Multi-AZ DB clusters only

    • getAvailabilityZones

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

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

      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

    • getBacktrackWindow

      @Stability(Stable) @Nullable public Number getBacktrackWindow()
      The target backtrack window, in seconds. To disable backtracking, set this value to 0.

      Currently, Backtrack is only supported for Aurora MySQL DB clusters.

      Default: 0

      Constraints:

      • If specified, this value must be set to a number from 0 to 259,200 (72 hours).

      Valid for: Aurora MySQL DB clusters only

    • setBacktrackWindow

      @Stability(Stable) public void setBacktrackWindow(@Nullable Number value)
      The target backtrack window, in seconds. To disable backtracking, set this value to 0.

      Currently, Backtrack is only supported for Aurora MySQL DB clusters.

      Default: 0

      Constraints:

      • If specified, this value must be set to a number from 0 to 259,200 (72 hours).

      Valid for: Aurora MySQL DB clusters only

    • getBackupRetentionPeriod

      @Stability(Stable) @Nullable public Number getBackupRetentionPeriod()
      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

    • setBackupRetentionPeriod

      @Stability(Stable) public void setBackupRetentionPeriod(@Nullable Number value)
      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

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

      The default is not to copy them.

      Valid for: Aurora DB clusters and Multi-AZ DB clusters

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

      The default is not to copy them.

      Valid for: Aurora DB clusters and Multi-AZ DB clusters

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

      The default is not to copy them.

      Valid for: Aurora DB clusters and Multi-AZ DB clusters

    • getDatabaseName

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

    • setDatabaseName

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

    • getDbClusterIdentifier

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

    • setDbClusterIdentifier

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

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

      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: Multi-AZ DB clusters only

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

      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: Multi-AZ DB clusters only

    • getDbClusterParameterGroupName

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

    • setDbClusterParameterGroupName

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

    • getDbInstanceParameterGroupName

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

      Default: The existing name setting

      Constraints:

      • The DB parameter group must be in the same DB parameter group family as this 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.

      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.

      Default: The existing name setting

      Constraints:

      • The DB parameter group must be in the same DB parameter group family as this DB cluster.

    • getDbSubnetGroupName

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

    • setDbSubnetGroupName

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

    • getDbSystemId

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

    • setDbSystemId

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

    • getDeletionProtection

      @Stability(Stable) @Nullable public Object getDeletionProtection()
      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

    • setDeletionProtection

      @Stability(Stable) public void setDeletionProtection(@Nullable Boolean value)
      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

    • setDeletionProtection

      @Stability(Stable) public void setDeletionProtection(@Nullable IResolvable value)
      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

    • getDomain

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

    • setDomain

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

    • getDomainIamRoleName

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

      Valid for: Aurora DB clusters only

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

      Valid for: Aurora DB clusters only

    • getEnableCloudwatchLogsExports

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

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

      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

    • getEnableHttpEndpoint

      @Stability(Stable) @Nullable public Object getEnableHttpEndpoint()
      A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster.

      By default, the HTTP endpoint is disabled.

      When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor.

      For more information, see Using the Data API for Aurora Serverless in the Amazon Aurora User Guide .

      Valid for: Aurora DB clusters only

    • setEnableHttpEndpoint

      @Stability(Stable) public void setEnableHttpEndpoint(@Nullable Boolean value)
      A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster.

      By default, the HTTP endpoint is disabled.

      When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor.

      For more information, see Using the Data API for Aurora Serverless in the Amazon Aurora User Guide .

      Valid for: Aurora DB clusters only

    • setEnableHttpEndpoint

      @Stability(Stable) public void setEnableHttpEndpoint(@Nullable IResolvable value)
      A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster.

      By default, the HTTP endpoint is disabled.

      When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor.

      For more information, see Using the Data API for Aurora Serverless in the Amazon Aurora User Guide .

      Valid for: Aurora DB clusters only

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

      By default, mapping is disabled.

      For more information, see IAM Database Authentication in the Amazon Aurora User Guide.

      Valid for: Aurora DB clusters only

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

      By default, mapping is disabled.

      For more information, see IAM Database Authentication in the Amazon Aurora User Guide.

      Valid for: Aurora DB clusters only

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

      By default, mapping is disabled.

      For more information, see IAM Database Authentication in the Amazon Aurora User Guide.

      Valid for: Aurora DB clusters only

    • getEngine

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

    • setEngine

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

    • getEngineMode

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

      The serverless engine mode only supports Aurora Serverless v1. Currently, AWS CloudFormation doesn't support Aurora Serverless v2.

      Limitations and requirements apply to some DB engine modes. For more information, see the following sections in the Amazon Aurora User Guide :

      Valid for: Aurora DB clusters only

    • setEngineMode

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

      The serverless engine mode only supports Aurora Serverless v1. Currently, AWS CloudFormation doesn't support Aurora Serverless v2.

      Limitations and requirements apply to some DB engine modes. For more information, see the following sections in the Amazon Aurora User Guide :

      Valid for: Aurora DB clusters only

    • getEngineVersion

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

    • setEngineVersion

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

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

      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

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

      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

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

      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.

      Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB cluster.

      Valid for: Multi-AZ DB clusters only

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

      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.

      Constraints: Must be a multiple between .5 and 50 of the storage amount for the DB cluster.

      Valid for: Multi-AZ DB clusters only

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

      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.

      Valid for: Aurora DB clusters and Multi-AZ DB clusters

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

      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.

      Valid for: Aurora DB clusters and Multi-AZ DB clusters

    • getManageMasterUserPassword

      @Stability(Stable) @Nullable public Object getManageMasterUserPassword()
      A value that indicates 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.

      Constraints:

      • Can't manage the master user password with AWS Secrets Manager if MasterUserPassword is specified.

      Valid for: Aurora DB clusters and Multi-AZ DB clusters

    • setManageMasterUserPassword

      @Stability(Stable) public void setManageMasterUserPassword(@Nullable Boolean value)
      A value that indicates 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.

      Constraints:

      • Can't manage the master user password with AWS Secrets Manager if MasterUserPassword is specified.

      Valid for: Aurora DB clusters and Multi-AZ DB clusters

    • setManageMasterUserPassword

      @Stability(Stable) public void setManageMasterUserPassword(@Nullable IResolvable value)
      A value that indicates 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.

      Constraints:

      • Can't manage the master user password with AWS Secrets Manager if MasterUserPassword is specified.

      Valid for: Aurora DB clusters and Multi-AZ DB clusters

    • getMasterUsername

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

    • setMasterUsername

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

    • getMasterUserPassword

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

    • setMasterUserPassword

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

    • getMasterUserSecret

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

      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.

    • setMasterUserSecret

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

      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.

    • setMasterUserSecret

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

      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.

    • getMonitoringInterval

      @Stability(Stable) @Nullable public Number getMonitoringInterval()
      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. The default is 0.

      If MonitoringRoleArn is specified, also set MonitoringInterval to a value other than 0.

      Valid Values: 0, 1, 5, 10, 15, 30, 60

      Valid for: Multi-AZ DB clusters only

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

      To turn off collecting Enhanced Monitoring metrics, specify 0. The default is 0.

      If MonitoringRoleArn is specified, also set MonitoringInterval to a value other than 0.

      Valid Values: 0, 1, 5, 10, 15, 30, 60

      Valid for: Multi-AZ DB clusters only

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

      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: Multi-AZ DB clusters only

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

      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: Multi-AZ DB clusters only

    • getNetworkType

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

    • setNetworkType

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

    • getPerformanceInsightsEnabled

      @Stability(Stable) @Nullable public Object getPerformanceInsightsEnabled()
      A value that indicates 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: Multi-AZ DB clusters only

    • setPerformanceInsightsEnabled

      @Stability(Stable) public void setPerformanceInsightsEnabled(@Nullable Boolean value)
      A value that indicates 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: Multi-AZ DB clusters only

    • setPerformanceInsightsEnabled

      @Stability(Stable) public void setPerformanceInsightsEnabled(@Nullable IResolvable value)
      A value that indicates 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: Multi-AZ DB clusters only

    • getPerformanceInsightsKmsKeyId

      @Stability(Stable) @Nullable public String getPerformanceInsightsKmsKeyId()
      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: Multi-AZ DB clusters only

    • setPerformanceInsightsKmsKeyId

      @Stability(Stable) public void setPerformanceInsightsKmsKeyId(@Nullable String value)
      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: Multi-AZ DB clusters only

    • getPerformanceInsightsRetentionPeriod

      @Stability(Stable) @Nullable public Number getPerformanceInsightsRetentionPeriod()
      The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:.

      • 7
      • month * 31, where month is a number of months from 1-23
      • 731

      For example, the following values are valid:

      • 93 (3 months * 31)
      • 341 (11 months * 31)
      • 589 (19 months * 31)
      • 731

      If you specify a retention period such as 94, which isn't a valid value, RDS issues an error.

      Valid for: Multi-AZ DB clusters only

    • setPerformanceInsightsRetentionPeriod

      @Stability(Stable) public void setPerformanceInsightsRetentionPeriod(@Nullable Number value)
      The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:.

      • 7
      • month * 31, where month is a number of months from 1-23
      • 731

      For example, the following values are valid:

      • 93 (3 months * 31)
      • 341 (11 months * 31)
      • 589 (19 months * 31)
      • 731

      If you specify a retention period such as 94, which isn't a valid value, RDS issues an error.

      Valid for: Multi-AZ DB clusters only

    • getPort

      @Stability(Stable) @Nullable public Number getPort()
      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

    • setPort

      @Stability(Stable) public void setPort(@Nullable Number value)
      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

    • getPreferredBackupWindow

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

    • setPreferredBackupWindow

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

    • getPreferredMaintenanceWindow

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

      Format: ddd:hh24:mi-ddd:hh24:mi

      The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.

      Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

      Constraints: Minimum 30-minute window.

      Valid for: Aurora DB clusters and Multi-AZ DB clusters

    • setPreferredMaintenanceWindow

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

      Format: ddd:hh24:mi-ddd:hh24:mi

      The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide.

      Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

      Constraints: Minimum 30-minute window.

      Valid for: Aurora DB clusters and Multi-AZ DB clusters

    • getPubliclyAccessible

      @Stability(Stable) @Nullable public Object getPubliclyAccessible()
      A value that indicates whether the DB cluster is publicly accessible.

      When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.

      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.

      Default: The default behavior varies depending on whether DBSubnetGroupName is specified.

      If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:

      • If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private.
      • If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.

      If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:

      • If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private.
      • If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.

      Valid for: Multi-AZ DB clusters only

    • setPubliclyAccessible

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

      When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.

      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.

      Default: The default behavior varies depending on whether DBSubnetGroupName is specified.

      If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:

      • If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private.
      • If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.

      If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:

      • If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private.
      • If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.

      Valid for: Multi-AZ DB clusters only

    • setPubliclyAccessible

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

      When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.

      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.

      Default: The default behavior varies depending on whether DBSubnetGroupName is specified.

      If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified, the following applies:

      • If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private.
      • If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.

      If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the following applies:

      • If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private.
      • If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.

      Valid for: Multi-AZ DB clusters only

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

      Valid for: Aurora DB clusters only

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

      Valid for: Aurora DB clusters only

    • getRestoreToTime

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

      Example: 2015-03-07T23:45:00Z

      Valid for: Aurora DB clusters and Multi-AZ DB clusters

    • setRestoreToTime

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

      Example: 2015-03-07T23:45:00Z

      Valid for: Aurora DB clusters and Multi-AZ DB clusters

    • getRestoreType

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

    • setRestoreType

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

    • getScalingConfiguration

      @Stability(Stable) @Nullable public Object getScalingConfiguration()
      The ScalingConfiguration property type specifies the scaling configuration of an Aurora Serverless DB cluster.

      This property is only supported for Aurora Serverless v1. For Aurora Serverless v2, use ServerlessV2ScalingConfiguration property.

      Valid for: Aurora DB clusters only

    • setScalingConfiguration

      @Stability(Stable) public void setScalingConfiguration(@Nullable IResolvable value)
      The ScalingConfiguration property type specifies the scaling configuration of an Aurora Serverless DB cluster.

      This property is only supported for Aurora Serverless v1. For Aurora Serverless v2, use ServerlessV2ScalingConfiguration property.

      Valid for: Aurora DB clusters only

    • setScalingConfiguration

      @Stability(Stable) public void setScalingConfiguration(@Nullable CfnDBCluster.ScalingConfigurationProperty value)
      The ScalingConfiguration property type specifies the scaling configuration of an Aurora Serverless DB cluster.

      This property is only supported for Aurora Serverless v1. For Aurora Serverless v2, use ServerlessV2ScalingConfiguration property.

      Valid for: Aurora DB clusters only

    • getServerlessV2ScalingConfiguration

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

      This property is only supported for Aurora Serverless v2. For Aurora Serverless v1, use ScalingConfiguration property.

      Valid for: Aurora DB clusters only

    • setServerlessV2ScalingConfiguration

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

      This property is only supported for Aurora Serverless v2. For Aurora Serverless v1, use ScalingConfiguration property.

      Valid for: Aurora DB clusters only

    • setServerlessV2ScalingConfiguration

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

      This property is only supported for Aurora Serverless v2. For Aurora Serverless v1, use ScalingConfiguration property.

      Valid for: Aurora DB clusters only

    • getSnapshotIdentifier

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

    • setSnapshotIdentifier

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

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

      Constraints:

      • Must match the identifier of an existing DBCluster.

      Valid for: Aurora DB clusters and Multi-AZ DB clusters

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

      Constraints:

      • Must match the identifier of an existing DBCluster.

      Valid for: Aurora DB clusters and Multi-AZ DB clusters

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

      Valid for: Aurora DB clusters only

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

      Valid for: Aurora DB clusters only

    • getStorageEncrypted

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

      Valid for: Aurora DB clusters and Multi-AZ DB clusters

    • setStorageEncrypted

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

      Valid for: Aurora DB clusters and Multi-AZ DB clusters

    • setStorageEncrypted

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

      Valid for: Aurora DB clusters and Multi-AZ DB clusters

    • getStorageType

      @Stability(Stable) @Nullable public String getStorageType()
      Specifies the storage type to be associated with the DB cluster.

      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 values: aurora , aurora-iopt1 (Aurora DB clusters); io1 (Multi-AZ DB clusters)

      Default: aurora (Aurora DB clusters); io1 (Multi-AZ DB clusters)

      Valid for: Aurora DB clusters and Multi-AZ DB clusters

      For more information on storage types for Aurora DB clusters, see Storage configurations for Amazon Aurora DB clusters . For more information on storage types for Multi-AZ DB clusters, see Settings for creating Multi-AZ DB clusters .

    • setStorageType

      @Stability(Stable) public void setStorageType(@Nullable String value)
      Specifies the storage type to be associated with the DB cluster.

      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 values: aurora , aurora-iopt1 (Aurora DB clusters); io1 (Multi-AZ DB clusters)

      Default: aurora (Aurora DB clusters); io1 (Multi-AZ DB clusters)

      Valid for: Aurora DB clusters and Multi-AZ DB clusters

      For more information on storage types for Aurora DB clusters, see Storage configurations for Amazon Aurora DB clusters . For more information on storage types for Multi-AZ DB clusters, see Settings for creating Multi-AZ DB clusters .

    • getUseLatestRestorableTime

      @Stability(Stable) @Nullable public Object getUseLatestRestorableTime()
      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

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

      By default, the DB cluster is not restored to the latest restorable backup time.

      Valid for: Aurora DB clusters and Multi-AZ DB clusters

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

      By default, the DB cluster is not restored to the latest restorable backup time.

      Valid for: Aurora DB clusters and Multi-AZ DB clusters

    • getVpcSecurityGroupIds

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

    • setVpcSecurityGroupIds

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