@propulsionworks/cloudformation 0.1.0 → 0.1.2

package/out/exports/resources.generated/aws-rds-dbcluster.d.ts

@@ -1,4 +1,35 @@
 import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+/**
+ * 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) .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html}
+ */
 export type RDSDBCluster = ResourceDefinitionWithAttributes<"AWS::RDS::DBCluster", RDSDBClusterProps, RDSDBClusterAttribs>;
 /**
  * The `AWS::RDS::DBCluster` resource creates an Amazon Aurora DB cluster or Multi-AZ DB cluster.
@@ -29,6 +60,7 @@ export type RDSDBCluster = ResourceDefinitionWithAttributes<"AWS::RDS::DBCluster
  * *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) .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html}
  */
 export type RDSDBClusterProps = {
     /**
@@ -37,12 +69,14 @@ export type RDSDBClusterProps = {
      * Valid for Cluster Type: Multi-AZ DB clusters only
      *
      * This setting is required to create a Multi-AZ DB cluster.
+     * @see {@link https://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
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-associatedroles}
      */
     AssociatedRoles?: DBClusterRole[] | undefined;
     /**
@@ -51,12 +85,14 @@ export type RDSDBClusterProps = {
      * Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB cluster.
      *
      * For more information about automatic minor version upgrades, see [Automatically upgrading the minor engine version](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Upgrading.html#USER_UpgradeDBInstance.Upgrading.AutoMinorVersionUpgrades) .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-autominorversionupgrade}
      */
     AutoMinorVersionUpgrade?: boolean | 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
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-availabilityzones}
      */
     AvailabilityZones?: string[] | undefined;
     /**
@@ -70,6 +106,7 @@ export type RDSDBClusterProps = {
      *
      * - If specified, this value must be set to a number from 0 to 259,200 (72 hours).
      * @min 0
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-backtrackwindow}
      */
     BacktrackWindow?: number | undefined;
     /**
@@ -84,16 +121,19 @@ export type RDSDBClusterProps = {
      * Valid for: Aurora DB clusters and Multi-AZ DB clusters
      * @min 1
      * @default 1
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-backupretentionperiod}
      */
     BackupRetentionPeriod?: number | undefined;
     /**
      * Specifies the scalability mode of the Aurora DB cluster. When set to `limitless` , the cluster operates as an Aurora Limitless Database, allowing you to create a DB shard group for horizontal scaling (sharding) capabilities. When set to `standard` (the default), the cluster uses normal DB instance creation.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-clusterscalabilitytype}
      */
     ClusterScalabilityType?: string | 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
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-copytagstosnapshot}
      */
     CopyTagsToSnapshot?: boolean | undefined;
     /**
@@ -111,6 +151,7 @@ export type RDSDBClusterProps = {
      * @minLength 1
      * @maxLength 63
      * @pattern ^[a-zA-Z]{1}(?:-?[a-zA-Z0-9]){0,62}$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-dbclusteridentifier}
      */
     DBClusterIdentifier?: string | undefined;
     /**
@@ -121,6 +162,7 @@ export type RDSDBClusterProps = {
      * This setting is required to create a Multi-AZ DB cluster.
      *
      * Valid for Cluster Type: Multi-AZ DB clusters only
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-dbclusterinstanceclass}
      */
     DBClusterInstanceClass?: string | undefined;
     /**
@@ -135,6 +177,7 @@ export type RDSDBClusterProps = {
      * `aws rds describe-db-cluster-parameter-groups --query "DBClusterParameterGroups[].DBClusterParameterGroupName" --output text`
      *
      * Valid for: Aurora DB clusters and Multi-AZ DB clusters
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-dbclusterparametergroupname}
      */
     DBClusterParameterGroupName?: string | undefined;
     /**
@@ -150,6 +193,7 @@ export type RDSDBClusterProps = {
      *
      * - The DB parameter group must be in the same DB parameter group family as this DB cluster.
      * - The `DBInstanceParameterGroupName` parameter is valid in combination with the `AllowMajorVersionUpgrade` parameter for a major version upgrade only.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-dbinstanceparametergroupname}
      */
     DBInstanceParameterGroupName?: string | undefined;
     /**
@@ -158,10 +202,12 @@ export type RDSDBClusterProps = {
      * 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
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-dbsubnetgroupname}
      */
     DBSubnetGroupName?: string | undefined;
     /**
      * Reserved for future use.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-dbsystemid}
      */
     DBSystemId?: string | undefined;
     /**
@@ -170,18 +216,21 @@ export type RDSDBClusterProps = {
      * If you set this value to `advanced` , you must also set the `PerformanceInsightsEnabled` parameter to `true` and the `PerformanceInsightsRetentionPeriod` parameter to 465.
      *
      * Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-databaseinsightsmode}
      */
     DatabaseInsightsMode?: string | 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
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-databasename}
      */
     DatabaseName?: string | undefined;
     /**
      * 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
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-deletionprotection}
      */
     DeletionProtection?: boolean | undefined;
     /**
@@ -192,12 +241,14 @@ export type RDSDBClusterProps = {
      * 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
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-domain}
      */
     Domain?: string | undefined;
     /**
      * Specifies the name of the IAM role to use when making API calls to the Directory Service.
      *
      * Valid for: Aurora DB clusters only
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-domainiamrolename}
      */
     DomainIAMRoleName?: string | undefined;
     /**
@@ -212,6 +263,7 @@ export type RDSDBClusterProps = {
      * Valid values: `postgresql`
      *
      * Valid for: Aurora DB clusters and Multi-AZ DB clusters
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-enablecloudwatchlogsexports}
      */
     EnableCloudwatchLogsExports?: string[] | undefined;
     /**
@@ -220,6 +272,7 @@ export type RDSDBClusterProps = {
      * You can set this value only on Aurora DB clusters that are members of an Aurora global database. With this parameter enabled, a secondary cluster can forward writes to the current primary cluster, and the resulting changes are replicated back to this cluster. For the primary DB cluster of an Aurora global database, this value is used immediately if the primary is demoted by a global cluster API operation, but it does nothing until then.
      *
      * Valid for Cluster Type: Aurora DB clusters only
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-enableglobalwriteforwarding}
      */
     EnableGlobalWriteForwarding?: boolean | undefined;
     /**
@@ -230,6 +283,7 @@ export type RDSDBClusterProps = {
      * For more information, see [Using RDS Data API](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html) in the *Amazon Aurora User Guide* .
      *
      * Valid for Cluster Type: Aurora DB clusters only
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-enablehttpendpoint}
      */
     EnableHttpEndpoint?: boolean | undefined;
     /**
@@ -238,12 +292,14 @@ export type RDSDBClusterProps = {
      * 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
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-enableiamdatabaseauthentication}
      */
     EnableIAMDatabaseAuthentication?: boolean | undefined;
     /**
      * Specifies whether read replicas can forward write operations to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances.
      *
      * Valid for: Aurora DB clusters only
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-enablelocalwriteforwarding}
      */
     EnableLocalWriteForwarding?: boolean | undefined;
     /**
@@ -257,6 +313,7 @@ export type RDSDBClusterProps = {
      * - `postgres`
      *
      * Valid for: Aurora DB clusters and Multi-AZ DB clusters
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-engine}
      */
     Engine?: string | undefined;
     /**
@@ -274,6 +331,7 @@ export type RDSDBClusterProps = {
      * Valid Values: `open-source-rds-extended-support | open-source-rds-extended-support-disabled`
      *
      * Default: `open-source-rds-extended-support`
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-enginelifecyclesupport}
      */
     EngineLifecycleSupport?: string | undefined;
     /**
@@ -287,6 +345,7 @@ export type RDSDBClusterProps = {
      * - [Requirements for Aurora Serverless v2](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.requirements.html)
      *
      * Valid for Cluster Type: Aurora DB clusters only
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-enginemode}
      */
     EngineMode?: string | undefined;
     /**
@@ -327,6 +386,7 @@ export type RDSDBClusterProps = {
      * For information, see [Amazon RDS for PostgreSQL](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts) in the *Amazon RDS User Guide* .
      *
      * Valid for: Aurora DB clusters and Multi-AZ DB clusters
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-engineversion}
      */
     EngineVersion?: string | undefined;
     /**
@@ -342,6 +402,7 @@ export type RDSDBClusterProps = {
      * @minLength 0
      * @maxLength 63
      * @pattern ^$|^[a-zA-Z]{1}(?:-?[a-zA-Z0-9]){0,62}$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-globalclusteridentifier}
      */
     GlobalClusterIdentifier?: string | undefined;
     /**
@@ -356,6 +417,7 @@ export type RDSDBClusterProps = {
      * Constraints:
      *
      * - Must be a multiple between .5 and 50 of the storage amount for the DB cluster.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-iops}
      */
     Iops?: number | undefined;
     /**
@@ -366,6 +428,7 @@ export type RDSDBClusterProps = {
      * If you create a read replica of an encrypted DB cluster in another AWS Region, make sure to set `KmsKeyId` to a KMS key identifier that is valid in the destination AWS Region. This KMS key is used to encrypt the read replica in that AWS Region.
      *
      * Valid for: Aurora DB clusters and Multi-AZ DB clusters
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-kmskeyid}
      */
     KmsKeyId?: string | undefined;
     /**
@@ -378,6 +441,7 @@ export type RDSDBClusterProps = {
      * Constraints:
      *
      * - Can't manage the master user password with AWS Secrets Manager if `MasterUserPassword` is specified.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-managemasteruserpassword}
      */
     ManageMasterUserPassword?: boolean | undefined;
     /**
@@ -386,6 +450,7 @@ export type RDSDBClusterProps = {
      * > 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
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-masteruserpassword}
      */
     MasterUserPassword?: string | undefined;
     /**
@@ -394,6 +459,7 @@ export type RDSDBClusterProps = {
      * > When you restore a DB cluster from a snapshot, Amazon RDS generates a new secret instead of reusing the secret specified in the `SecretArn` property. This ensures that the restored DB cluster is securely managed with a dedicated secret. To maintain consistent integration with your application, you might need to update resource configurations to reference the newly created secret.
      *
      * For more information, see [Password management with AWS Secrets Manager](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.*
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-masterusersecret}
      */
     MasterUserSecret?: MasterUserSecret | undefined;
     /**
@@ -404,6 +470,7 @@ export type RDSDBClusterProps = {
      * Valid for: Aurora DB clusters and Multi-AZ DB clusters
      * @minLength 1
      * @pattern ^[a-zA-Z]{1}[a-zA-Z0-9_]*$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-masterusername}
      */
     MasterUsername?: string | undefined;
     /**
@@ -416,6 +483,7 @@ export type RDSDBClusterProps = {
      * Valid Values: `0 | 1 | 5 | 10 | 15 | 30 | 60`
      *
      * Default: `0`
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-monitoringinterval}
      */
     MonitoringInterval?: number | undefined;
     /**
@@ -424,6 +492,7 @@ export type RDSDBClusterProps = {
      * If `MonitoringInterval` is set to a value other than `0` , supply a `MonitoringRoleArn` value.
      *
      * Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-monitoringrolearn}
      */
     MonitoringRoleArn?: string | undefined;
     /**
@@ -439,6 +508,7 @@ export type RDSDBClusterProps = {
      * 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
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-networktype}
      */
     NetworkType?: string | undefined;
     /**
@@ -447,6 +517,7 @@ export type RDSDBClusterProps = {
      * 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 Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-performanceinsightsenabled}
      */
     PerformanceInsightsEnabled?: boolean | undefined;
     /**
@@ -457,6 +528,7 @@ export type RDSDBClusterProps = {
      * If you don't specify a value for `PerformanceInsightsKMSKeyId` , then Amazon RDS uses your default KMS key. There is a default KMS key for your AWS account . Your AWS account has a different default KMS key for each AWS Region .
      *
      * Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-performanceinsightskmskeyid}
      */
     PerformanceInsightsKmsKeyId?: string | undefined;
     /**
@@ -473,6 +545,7 @@ export type RDSDBClusterProps = {
      * Default: `7` days
      *
      * If you specify a retention period that isn't valid, such as `94` , Amazon RDS issues an error.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-performanceinsightsretentionperiod}
      */
     PerformanceInsightsRetentionPeriod?: number | undefined;
     /**
@@ -489,6 +562,7 @@ export type RDSDBClusterProps = {
      * > 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
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-port}
      */
     Port?: number | undefined;
     /**
@@ -502,6 +576,7 @@ export type RDSDBClusterProps = {
      * - Must be at least 30 minutes.
      *
      * Valid for: Aurora DB clusters and Multi-AZ DB clusters
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-preferredbackupwindow}
      */
     PreferredBackupWindow?: string | undefined;
     /**
@@ -516,6 +591,7 @@ export type RDSDBClusterProps = {
      * Constraints: Minimum 30-minute window.
      *
      * Valid for: Aurora DB clusters and Multi-AZ DB clusters
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-preferredmaintenancewindow}
      */
     PreferredMaintenanceWindow?: string | undefined;
     /**
@@ -538,12 +614,14 @@ export type RDSDBClusterProps = {
      *
      * - 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.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-publiclyaccessible}
      */
     PubliclyAccessible?: boolean | undefined;
     /**
      * 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
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-replicationsourceidentifier}
      */
     ReplicationSourceIdentifier?: string | undefined;
     /**
@@ -563,6 +641,7 @@ export type RDSDBClusterProps = {
      * Example: `2015-03-07T23:45:00Z`
      *
      * Valid for: Aurora DB clusters and Multi-AZ DB clusters
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-restoretotime}
      */
     RestoreToTime?: string | undefined;
     /**
@@ -574,6 +653,7 @@ export type RDSDBClusterProps = {
      * 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
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-restoretype}
      */
     RestoreType?: string | undefined;
     /**
@@ -582,6 +662,7 @@ export type RDSDBClusterProps = {
      * This property is only supported for Aurora Serverless v1. For Aurora Serverless v2, Use the `ServerlessV2ScalingConfiguration` property.
      *
      * Valid for: Aurora Serverless v1 DB clusters only
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-scalingconfiguration}
      */
     ScalingConfiguration?: ScalingConfiguration | undefined;
     /**
@@ -590,6 +671,7 @@ export type RDSDBClusterProps = {
      * This property is only supported for Aurora Serverless v2. For Aurora Serverless v1, Use the `ScalingConfiguration` property.
      *
      * Valid for: Aurora Serverless v2 DB clusters only
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-serverlessv2scalingconfiguration}
      */
     ServerlessV2ScalingConfiguration?: ServerlessV2ScalingConfiguration | undefined;
     /**
@@ -616,6 +698,7 @@ export type RDSDBClusterProps = {
      * - Must match the identifier of an existing Snapshot.
      *
      * Valid for: Aurora DB clusters and Multi-AZ DB clusters
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-snapshotidentifier}
      */
     SnapshotIdentifier?: string | undefined;
     /**
@@ -626,12 +709,14 @@ export type RDSDBClusterProps = {
      * - Must match the identifier of an existing DBCluster.
      *
      * Valid for: Aurora DB clusters and Multi-AZ DB clusters
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-sourcedbclusteridentifier}
      */
     SourceDBClusterIdentifier?: string | undefined;
     /**
      * 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
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-sourceregion}
      */
     SourceRegion?: string | undefined;
     /**
@@ -648,6 +733,7 @@ export type RDSDBClusterProps = {
      * > If you specify both the `StorageEncrypted` and `SnapshotIdentifier` properties without specifying the `KmsKeyId` property, then the restored DB cluster inherits the encryption settings from the DB snapshot that provide.
      *
      * Valid for: Aurora DB clusters and Multi-AZ DB clusters
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-storageencrypted}
      */
     StorageEncrypted?: boolean | undefined;
     /**
@@ -672,18 +758,21 @@ export type RDSDBClusterProps = {
      * - Multi-AZ DB clusters - `io1`
      *
      * > When you create an Aurora DB cluster with the storage type set to `aurora-iopt1` , the storage type is returned in the response. The storage type isn't returned when you set it to `aurora` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-storagetype}
      */
     StorageType?: string | undefined;
     /**
      * Tags to assign to the DB cluster.
      *
      * Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-tags}
      */
     Tags?: Tag[] | undefined;
     /**
      * 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
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-uselatestrestorabletime}
      */
     UseLatestRestorableTime?: boolean | undefined;
     /**
@@ -692,51 +781,65 @@ export type RDSDBClusterProps = {
      * 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
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-vpcsecuritygroupids}
      */
     VpcSecurityGroupIds?: string[] | undefined;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#aws-resource-rds-dbcluster-return-values}
+ */
 export type RDSDBClusterAttribs = {
     /**
      * The Amazon Resource Name (ARN) for the DB cluster.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-dbclusterarn}
      */
     DBClusterArn: 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.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-dbclusterresourceid}
      */
     DBClusterResourceId: string;
     /**
      * The connection endpoint for the DB cluster. For example: `mystack-mydbcluster-123456789012.us-east-2.rds.amazonaws.com`
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-endpoint.html#cfn-rds-dbcluster-endpoint-address}
      */
     "Endpoint.Address": string;
     /**
      * The port number that will accept connections on this DB cluster. For example: `3306`
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-endpoint.html#cfn-rds-dbcluster-endpoint-port}
      */
     "Endpoint.Port": string;
     /**
      * The Amazon Resource Name (ARN) of the secret.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-masterusersecret.html#cfn-rds-dbcluster-masterusersecret-secretarn}
      */
     "MasterUserSecret.SecretArn": string;
     /**
      * The reader endpoint for the DB cluster. For example: `mystack-mydbcluster-ro-123456789012.us-east-2.rds.amazonaws.com`
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-readendpoint.html#cfn-rds-dbcluster-readendpoint-address}
      */
     "ReadEndpoint.Address": string;
     /**
      * The storage throughput for the DB cluster. The throughput is automatically set based on the IOPS that you provision, and is not configurable.
      *
      * This setting is only for non-Aurora Multi-AZ DB clusters.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-storagethroughput}
      */
     StorageThroughput: number;
 };
 /**
  * Describes an AWS Identity and Access Management (IAM) role that is associated with a DB cluster.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-dbclusterrole.html}
  */
 export type DBClusterRole = {
     /**
      * The name of the feature associated with the AWS Identity and Access Management (IAM) role. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS services on your behalf. For the list of supported feature names, see the `SupportedFeatureNames` description in [DBEngineVersion](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DBEngineVersion.html) in the *Amazon RDS API Reference* .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-dbclusterrole.html#cfn-rds-dbcluster-dbclusterrole-featurename}
      */
     FeatureName?: string | undefined;
     /**
      * The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-dbclusterrole.html#cfn-rds-dbcluster-dbclusterrole-rolearn}
      */
     RoleArn: string;
 };
@@ -744,10 +847,12 @@ export type DBClusterRole = {
  * The `MasterUserSecret` return value specifies 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.*
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-masterusersecret.html}
  */
 export type MasterUserSecret = {
     /**
      * The AWS KMS key identifier that is used to encrypt the secret.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-masterusersecret.html#cfn-rds-dbcluster-masterusersecret-kmskeyid}
      */
     KmsKeyId?: string | undefined;
 };
@@ -759,12 +864,14 @@ export type MasterUserSecret = {
  * This property is only supported for Aurora Serverless v1. For Aurora Serverless v2, Use the `ServerlessV2ScalingConfiguration` property.
  *
  * Valid for: Aurora Serverless v1 DB clusters only
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-scalingconfiguration.html}
  */
 export type ScalingConfiguration = {
     /**
      * Indicates whether to allow or disallow automatic pause for an Aurora DB cluster in `serverless` DB engine mode. A DB cluster can be paused only when it's idle (it has no connections).
      *
      * > If a DB cluster is paused for more than seven days, the DB cluster might be backed up with a snapshot. In this case, the DB cluster is restored when there is a request to connect to it.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-scalingconfiguration.html#cfn-rds-dbcluster-scalingconfiguration-autopause}
      */
     AutoPause?: boolean | undefined;
     /**
@@ -775,6 +882,7 @@ export type ScalingConfiguration = {
      * For Aurora PostgreSQL, valid capacity values are `2` , `4` , `8` , `16` , `32` , `64` , `192` , and `384` .
      *
      * The maximum capacity must be greater than or equal to the minimum capacity.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-scalingconfiguration.html#cfn-rds-dbcluster-scalingconfiguration-maxcapacity}
      */
     MaxCapacity?: number | undefined;
     /**
@@ -785,18 +893,21 @@ export type ScalingConfiguration = {
      * For Aurora PostgreSQL, valid capacity values are `2` , `4` , `8` , `16` , `32` , `64` , `192` , and `384` .
      *
      * The minimum capacity must be less than or equal to the maximum capacity.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-scalingconfiguration.html#cfn-rds-dbcluster-scalingconfiguration-mincapacity}
      */
     MinCapacity?: number | undefined;
     /**
      * The amount of time, in seconds, that Aurora Serverless v1 tries to find a scaling point to perform seamless scaling before enforcing the timeout action. The default is 300.
      *
      * Specify a value between 60 and 600 seconds.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-scalingconfiguration.html#cfn-rds-dbcluster-scalingconfiguration-secondsbeforetimeout}
      */
     SecondsBeforeTimeout?: number | undefined;
     /**
      * The time, in seconds, before an Aurora DB cluster in `serverless` mode is paused.
      *
      * Specify a value between 300 and 86,400 seconds.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-scalingconfiguration.html#cfn-rds-dbcluster-scalingconfiguration-secondsuntilautopause}
      */
     SecondsUntilAutoPause?: number | undefined;
     /**
@@ -809,6 +920,7 @@ export type ScalingConfiguration = {
      * > If you specify `ForceApplyCapacityChange` , connections that prevent Aurora Serverless v1 from finding a scaling point might be dropped.
      *
      * For more information, see [Autoscaling for Aurora Serverless v1](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.how-it-works.html#aurora-serverless.how-it-works.auto-scaling) in the *Amazon Aurora User Guide* .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-scalingconfiguration.html#cfn-rds-dbcluster-scalingconfiguration-timeoutaction}
      */
     TimeoutAction?: string | undefined;
 };
@@ -820,6 +932,7 @@ export type ScalingConfiguration = {
  * This property is only supported for Aurora Serverless v2. For Aurora Serverless v1, use the `ScalingConfiguration` property.
  *
  * Valid for: Aurora Serverless v2 DB clusters
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-serverlessv2scalingconfiguration.html}
  */
 export type ServerlessV2ScalingConfiguration = {
     /**
@@ -828,16 +941,19 @@ export type ServerlessV2ScalingConfiguration = {
      * The maximum capacity must be higher than 0.5 ACUs. For more information, see [Choosing the maximum Aurora Serverless v2 capacity setting for a cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.setting-capacity.html#aurora-serverless-v2.max_capacity_considerations) in the *Amazon Aurora User Guide* .
      *
      * Aurora automatically sets certain parameters for Aurora Serverless V2 DB instances to values that depend on the maximum ACU value in the capacity range. When you update the maximum capacity value, the `ParameterApplyStatus` value for the DB instance changes to `pending-reboot` . You can update the parameter values by rebooting the DB instance after changing the capacity range.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-serverlessv2scalingconfiguration.html#cfn-rds-dbcluster-serverlessv2scalingconfiguration-maxcapacity}
      */
     MaxCapacity?: number | undefined;
     /**
      * The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. For Aurora versions that support the Aurora Serverless v2 auto-pause feature, the smallest value that you can use is 0. For versions that don't support Aurora Serverless v2 auto-pause, the smallest value that you can use is 0.5.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-serverlessv2scalingconfiguration.html#cfn-rds-dbcluster-serverlessv2scalingconfiguration-mincapacity}
      */
     MinCapacity?: number | undefined;
     /**
      * Specifies the number of seconds an Aurora Serverless v2 DB instance must be idle before Aurora attempts to automatically pause it.
      *
      * Specify a value between 300 seconds (five minutes) and 86,400 seconds (one day). The default is 300 seconds.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-serverlessv2scalingconfiguration.html#cfn-rds-dbcluster-serverlessv2scalingconfiguration-secondsuntilautopause}
      */
     SecondsUntilAutoPause?: number | undefined;
 };