aws-cdk-lib
Version:
Version 2 of the AWS Cloud Development Kit library
870 lines • 335 kB
TypeScript
import * as constructs from 'constructs';
import * as cdk from '../../core';
import * as cfn_parse from '../../core/lib/helpers-internal';
/**
* Properties for defining a `CfnDBCluster`
*
* @struct
* @stability external
*
* @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html
*/
export interface CfnDBClusterProps {
/**
* 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
*
* @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-allocatedstorage
*/
readonly allocatedStorage?: number;
/**
* 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
*
* @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-associatedroles
*/
readonly associatedRoles?: Array<CfnDBCluster.DBClusterRoleProperty | cdk.IResolvable> | cdk.IResolvable;
/**
* 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
*
* @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-autominorversionupgrade
*/
readonly autoMinorVersionUpgrade?: boolean | cdk.IResolvable;
/**
* 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](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.RegionsAndAvailabilityZones.html) in the *Amazon Aurora User Guide* .
*
* Valid for: Aurora DB clusters only
*
* @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-availabilityzones
*/
readonly availabilityZones?: string[];
/**
* 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
*
* @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-backtrackwindow
*/
readonly backtrackWindow?: number;
/**
* 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
*
* @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-backupretentionperiod
*/
readonly backupRetentionPeriod?: number;
/**
* 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
*
* @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-copytagstosnapshot
*/
readonly copyTagsToSnapshot?: boolean | cdk.IResolvable;
/**
* 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](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_Limits.html#RDS_Limits.Constraints) in the *Amazon Aurora User Guide* .
*
* Valid for: Aurora DB clusters and Multi-AZ DB clusters
*
* @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-databasename
*/
readonly databaseName?: string;
/**
* 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
*
* @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-dbclusteridentifier
*/
readonly dbClusterIdentifier?: string;
/**
* 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](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html) in the *Amazon RDS User Guide* .
*
* This setting is required to create a Multi-AZ DB cluster.
*
* Valid for: Multi-AZ DB clusters only
*
* @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-dbclusterinstanceclass
*/
readonly dbClusterInstanceClass?: string;
/**
* 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
*
* @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-dbclusterparametergroupname
*/
readonly dbClusterParameterGroupName?: string;
/**
* 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.
*
* @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-dbinstanceparametergroupname
*/
readonly dbInstanceParameterGroupName?: string;
/**
* 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
*
* @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-dbsubnetgroupname
*/
readonly dbSubnetGroupName?: string;
/**
* Reserved for future use.
*
* @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-dbsystemid
*/
readonly dbSystemId?: string;
/**
* 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
*
* @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-deletionprotection
*/
readonly deletionProtection?: boolean | cdk.IResolvable;
/**
* 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](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html) in the *Amazon Aurora User Guide* .
*
* Valid for: Aurora DB clusters only
*
* @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-domain
*/
readonly domain?: string;
/**
* Specifies the name of the IAM role to use when making API calls to the Directory Service.
*
* Valid for: Aurora DB clusters only
*
* @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-domainiamrolename
*/
readonly domainIamRoleName?: string;
/**
* 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](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) 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
*
* @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-enablecloudwatchlogsexports
*/
readonly enableCloudwatchLogsExports?: string[];
/**
* 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](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html) in the *Amazon Aurora User Guide* .
*
* Valid for: Aurora DB clusters only
*
* @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-enablehttpendpoint
*/
readonly enableHttpEndpoint?: boolean | cdk.IResolvable;
/**
* 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](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html) in the *Amazon Aurora User Guide.*
*
* Valid for: Aurora DB clusters only
*
* @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-enableiamdatabaseauthentication
*/
readonly enableIamDatabaseAuthentication?: boolean | cdk.IResolvable;
/**
* The name of the database engine to be used for this DB cluster.
*
* Valid Values:
*
* - `aurora` (for MySQL 5.6-compatible Aurora)
* - `aurora-mysql` (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)
* - `aurora-postgresql`
* - `mysql`
* - `postgres`
*
* Valid for: Aurora DB clusters and Multi-AZ DB clusters
*
* @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-engine
*/
readonly engine?: string;
/**
* The DB engine mode of the DB cluster, either `provisioned` , `serverless` , `parallelquery` , `global` , or `multimaster` .
*
* The `parallelquery` engine mode isn't required for Aurora MySQL version 1.23 and higher 1.x versions, and version 2.09 and higher 2.x versions.
*
* The `global` engine mode isn't required for Aurora MySQL version 1.22 and higher 1.x versions, and `global` engine mode isn't required for any 2.x versions.
*
* The `multimaster` engine mode only applies for DB clusters created with Aurora MySQL version 5.6.10a.
*
* For Aurora PostgreSQL, the `global` engine mode isn't required, and both the `parallelquery` and the `multimaster` engine modes currently aren't supported.
*
* Limitations and requirements apply to some DB engine modes. For more information, see the following sections in the *Amazon Aurora User Guide* :
*
* - [Limitations of Aurora Serverless](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html#aurora-serverless.limitations)
* - [Limitations of Parallel Query](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-mysql-parallel-query.html#aurora-mysql-parallel-query-limitations)
* - [Limitations of Aurora Global Databases](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-global-database.html#aurora-global-database.limitations)
* - [Limitations of Multi-Master Clusters](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-multi-master.html#aurora-multi-master-limitations)
*
* Valid for: Aurora DB clusters only
*
* @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-enginemode
*/
readonly engineMode?: string;
/**
* The version number of the database engine to use.
*
* To list all of the available engine versions for `aurora` (for MySQL 5.6-compatible Aurora), use the following command:
*
* `aws rds describe-db-engine-versions --engine aurora --query "DBEngineVersions[].EngineVersion"`
*
* To list all of the available engine versions for `aurora-mysql` (for MySQL 5.7-compatible Aurora), use the following command:
*
* `aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"`
*
* To list all of the available engine versions for `aurora-postgresql` , use the following command:
*
* `aws rds describe-db-engine-versions --engine aurora-postgresql --query "DBEngineVersions[].EngineVersion"`
*
* Valid for: Aurora DB clusters and Multi-AZ DB clusters
*
* @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-engineversion
*/
readonly engineVersion?: string;
/**
* 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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-globalcluster.html) 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](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-global-database.html) in the *Amazon Aurora User Guide* .
*
* Valid for: Aurora DB clusters only
*
* @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-globalclusteridentifier
*/
readonly globalClusterIdentifier?: string;
/**
* 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](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS) 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
*
* @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-iops
*/
readonly iops?: number;
/**
* 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
*
* @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-kmskeyid
*/
readonly kmsKeyId?: string;
/**
* 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](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) in the *Amazon RDS User Guide* and [Password management with AWS Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html) 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
*
* @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-managemasteruserpassword
*/
readonly manageMasterUserPassword?: boolean | cdk.IResolvable;
/**
* 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
*
* @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-masterusername
*/
readonly masterUsername?: string;
/**
* 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
*
* @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-masteruserpassword
*/
readonly masterUserPassword?: string;
/**
* 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](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) in the *Amazon RDS User Guide* and [Password management with AWS Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html) in the *Amazon Aurora User Guide.*
*
* @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-masterusersecret
*/
readonly masterUserSecret?: CfnDBCluster.MasterUserSecretProperty | cdk.IResolvable;
/**
* 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
*
* @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-monitoringinterval
*/
readonly monitoringInterval?: number;
/**
* 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](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html#USER_Monitoring.OS.Enabling) 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
*
* @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-monitoringrolearn
*/
readonly monitoringRoleArn?: string;
/**
* 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](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html) in the *Amazon Aurora User Guide.*
*
* Valid for: Aurora DB clusters only
*
* @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-networktype
*/
readonly networkType?: string;
/**
* A value that indicates whether to turn on Performance Insights for the DB cluster.
*
* For more information, see [Using Amazon Performance Insights](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html) in the *Amazon RDS User Guide* .
*
* Valid for: Multi-AZ DB clusters only
*
* @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-performanceinsightsenabled
*/
readonly performanceInsightsEnabled?: boolean | cdk.IResolvable;
/**
* 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
*
* @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-performanceinsightskmskeyid
*/
readonly performanceInsightsKmsKeyId?: string;
/**
* 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
*
* @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-performanceinsightsretentionperiod
*/
readonly performanceInsightsRetentionPeriod?: number;
/**
* 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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-port) for the AWS::RDS::DBInstance resource.
*
* Valid for: Aurora DB clusters and Multi-AZ DB clusters
*
* @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-port
*/
readonly port?: number;
/**
* The daily time range during which automated backups are created. For more information, see [Backup Window](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.Backups.BackupWindow) 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
*
* @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-preferredbackupwindow
*/
readonly preferredBackupWindow?: string;
/**
* 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](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow.Aurora) 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
*
* @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-preferredmaintenancewindow
*/
readonly preferredMaintenanceWindow?: string;
/**
* 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
*
* @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-publiclyaccessible
*/
readonly publiclyAccessible?: boolean | cdk.IResolvable;
/**
* 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
*
* @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-replicationsourceidentifier
*/
readonly replicationSourceIdentifier?: string;
/**
* The type of restore to be performed. You can specify one of the following values:
*
* - `full-copy` - The new DB cluster is restored as a full copy of the source DB cluster.
* - `copy-on-write` - The new DB cluster is restored as a clone of the source DB cluster.
*
* Constraints: You can't specify `copy-on-write` if the engine version of the source DB cluster is earlier than 1.11.
*
* If you don't specify a `RestoreType` value, then the new DB cluster is restored as a full copy of the source DB cluster.
*
* Valid for: Aurora DB clusters and Multi-AZ DB clusters
*
* @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-restoretype
*/
readonly restoreType?: string;
/**
* 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
*
* @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-scalingconfiguration
*/
readonly scalingConfiguration?: CfnDBCluster.ScalingConfigurationProperty | cdk.IResolvable;
/**
* 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
*
* @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-serverlessv2scalingconfiguration
*/
readonly serverlessV2ScalingConfiguration?: CfnDBCluster.ServerlessV2ScalingConfigurationProperty | cdk.IResolvable;
/**
* 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
*
* @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-snapshotidentifier
*/
readonly snapshotIdentifier?: string;
/**
* 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
*
* @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-sourcedbclusteridentifier
*/
readonly sourceDbClusterIdentifier?: string;
/**
* 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
*
* @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-sourceregion
*/
readonly sourceRegion?: string;
/**
* 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
*
* @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-storageencrypted
*/
readonly storageEncrypted?: boolean | cdk.IResolvable;
/**
* Specifies the storage type to be associated with the DB cluster.
*
* This setting is required to create a Multi-AZ DB cluster.
*
* Valid values: `io1`
*
* When specified, a value for the `Iops` parameter is required.
*
* Default: `io1`
*
* Valid for: Multi-AZ DB clusters only
*
* @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-storagetype
*/
readonly storageType?: string;
/**
* An optional array of key-value pairs to apply to this DB cluster.
*
* Valid for: Aurora DB clusters and Multi-AZ DB clusters
*
* @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-tags
*/
readonly tags?: cdk.CfnTag[];
/**
* 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
*
* @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-uselatestrestorabletime
*/
readonly useLatestRestorableTime?: boolean | cdk.IResolvable;
/**
* 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
*
* @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-vpcsecuritygroupids
*/
readonly vpcSecurityGroupIds?: string[];
}
/**
* 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](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.CreateInstance.html) in the *Amazon Aurora User Guide* .
*
* For more information about creating a Multi-AZ DB cluster, see [Creating a Multi-AZ DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/create-multi-az-db-cluster.html) 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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-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](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_CreateSnapshotCluster.html) .
* > - 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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks.html) .
*
* *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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html) .
*
* @cloudformationResource AWS::RDS::DBCluster
* @stability external
*
* @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html
*/
export declare class CfnDBCluster extends cdk.CfnResource implements cdk.IInspectable {
/**
* The CloudFormation resource type name for this resource class.
*/
static readonly CFN_RESOURCE_TYPE_NAME = "AWS::RDS::DBCluster";
/**
* A factory method that creates a new instance of this class from an object
* containing the CloudFormation properties of this resource.
* Used in the @aws-cdk/cloudformation-include module.
*
* @internal
*/
static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnDBCluster;
/**
* The Amazon Resource Name (ARN) for the DB cluster.
* @cloudformationAttribute DBClusterArn
*/
readonly attrDbClusterArn: string;
/**
* 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.
* @cloudformationAttribute DBClusterResourceId
*/
readonly attrDbClusterResourceId: string;
/**
* The connection endpoint for the DB cluster. For example: `mystack-mydbcluster-123456789012.us-east-2.rds.amazonaws.com`
* @cloudformationAttribute Endpoint.Address
*/
readonly attrEndpointAddress: string;
/**
* The port number that will accept connections on this DB cluster. For example: `3306`
* @cloudformationAttribute Endpoint.Port
*/
readonly attrEndpointPort: string;
/**
* The Amazon Resource Name (ARN) of the secret.
* @cloudformationAttribute MasterUserSecret.SecretArn
*/
readonly attrMasterUserSecretSecretArn: string;
/**
* The reader endpoint for the DB cluster. For example: `mystack-mydbcluster-ro-123456789012.us-east-2.rds.amazonaws.com`
* @cloudformationAttribute ReadEndpoint.Address
*/
readonly attrReadEndpointAddress: string;
/**
* 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
*
* @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-allocatedstorage
*/
allocatedStorage: number | undefined;
/**
* 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
*
* @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-associatedroles
*/
associatedRoles: Array<CfnDBCluster.DBClusterRoleProperty | cdk.IResolvable> | cdk.IResolvable | undefined;
/**
* 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
*
* @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-autominorversionupgrade
*/
autoMinorVersionUpgrade: boolean | cdk.IResolvable | undefined;
/**
* 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](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.RegionsAndAvailabilityZones.html) in the *Amazon Aurora User Guide* .
*
* Valid for: Aurora DB clusters only
*
* @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-availabilityzones
*/
availabilityZones: string[] | undefined;
/**
* 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
*
* @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-backtrackwindow
*/
backtrackWindow: number | undefined;
/**
* 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
*
* @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-backupretentionperiod
*/
backupRetentionPeriod: number | undefined;
/**
* 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
*
* @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-copytagstosnapshot
*/
copyTagsToSnapshot: boolean | cdk.IResolvable | undefined;
/**
* 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](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_Limits.html#RDS_Limits.Constraints) in the *Amazon Aurora User Guide* .
*
* Valid for: Aurora DB clusters and Multi-AZ DB clusters
*
* @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-databasename
*/
databaseName: string | undefined;
/**
* 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
*
* @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-dbclusteridentifier
*/
dbClusterIdentifier: string | undefined;
/**
* 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](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html) in the *Amazon RDS User Guide* .
*
* This setting is required to create a Multi-AZ DB cluster.
*
* Valid for: Multi-AZ DB clusters only
*
* @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-dbclusterinstanceclass
*/
dbClusterInstanceClass: string | undefined;
/**
* 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 wit