@propulsionworks/cloudformation 0.1.0 → 0.1.2

package/out/exports/resources.generated/aws-dms-replicationtask.d.ts

@@ -1,7 +1,12 @@
 import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+/**
+ * The `AWS::DMS::ReplicationTask` resource creates an AWS DMS replication task.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html}
+ */
 export type DMSReplicationTask = ResourceDefinitionWithAttributes<"AWS::DMS::ReplicationTask", DMSReplicationTaskProps, DMSReplicationTaskAttribs>;
 /**
  * The `AWS::DMS::ReplicationTask` resource creates an AWS DMS replication task.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html}
  */
 export type DMSReplicationTaskProps = {
     /**
@@ -16,10 +21,12 @@ export type DMSReplicationTaskProps = {
      * Here is an LSN example: `--cdc-start-position “mysql-bin-changelog.000024:373”`
      *
      * > When you use this task setting with a source PostgreSQL database, a logical replication slot should already be created and associated with the source endpoint. You can verify this by setting the `slotName` extra connection attribute to the name of this logical replication slot. For more information, see [Extra Connection Attributes When Using PostgreSQL as a Source for AWS DMS](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.PostgreSQL.html#CHAP_Source.PostgreSQL.ConnectionAttrib) in the *AWS Database Migration Service User Guide* .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-cdcstartposition}
      */
     CdcStartPosition?: string | undefined;
     /**
      * Indicates the start time for a change data capture (CDC) operation.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-cdcstarttime}
      */
     CdcStartTime?: number | undefined;
     /**
@@ -28,14 +35,17 @@ export type DMSReplicationTaskProps = {
      * Here is a server time example: `--cdc-stop-position "server_time:2018-02-09T12:12:12"`
      *
      * Here is a commit time example: `--cdc-stop-position "commit_time: 2018-02-09T12:12:12"`
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-cdcstopposition}
      */
     CdcStopPosition?: string | undefined;
     /**
      * The migration type. Valid values: `full-load` | `cdc` | `full-load-and-cdc`
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-migrationtype}
      */
     MigrationType: string;
     /**
      * The Amazon Resource Name (ARN) of a replication instance.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-replicationinstancearn}
      */
     ReplicationInstanceArn: string;
     /**
@@ -46,40 +56,54 @@ export type DMSReplicationTaskProps = {
      * - Must contain 1-255 alphanumeric characters or hyphens.
      * - First character must be a letter.
      * - Cannot end with a hyphen or contain two consecutive hyphens.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-replicationtaskidentifier}
      */
     ReplicationTaskIdentifier?: string | undefined;
     /**
      * Overall settings for the task, in JSON format. For more information, see [Specifying Task Settings for AWS Database Migration Service Tasks](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.CustomizingTasks.TaskSettings.html) in the *AWS Database Migration Service User Guide* .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-replicationtasksettings}
      */
     ReplicationTaskSettings?: string | undefined;
     /**
      * A display name for the resource identifier at the end of the `EndpointArn` response parameter that is returned in the created `Endpoint` object. The value for this parameter can have up to 31 characters. It can contain only ASCII letters, digits, and hyphen ('-'). Also, it can't end with a hyphen or contain two consecutive hyphens, and can only begin with a letter, such as `Example-App-ARN1` .
      *
      * For example, this value might result in the `EndpointArn` value `arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1` . If you don't specify a `ResourceIdentifier` value, AWS DMS generates a default identifier value for the end of `EndpointArn` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-resourceidentifier}
      */
     ResourceIdentifier?: string | undefined;
     /**
      * An Amazon Resource Name (ARN) that uniquely identifies the source endpoint.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-sourceendpointarn}
      */
     SourceEndpointArn: string;
     /**
      * The table mappings for the task, in JSON format. For more information, see [Using Table Mapping to Specify Task Settings](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.CustomizingTasks.TableMapping.html) in the *AWS Database Migration Service User Guide* .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-tablemappings}
      */
     TableMappings: string;
     /**
      * One or more tags to be assigned to the replication task.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-tags}
      */
     Tags?: Tag[] | undefined;
     /**
      * An Amazon Resource Name (ARN) that uniquely identifies the target endpoint.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-targetendpointarn}
      */
     TargetEndpointArn: string;
     /**
      * Supplemental information that the task requires to migrate the data for certain source and target endpoints. For more information, see [Specifying Supplemental Data for Task Settings](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.TaskData.html) in the *AWS Database Migration Service User Guide.*
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-taskdata}
      */
     TaskData?: string | undefined;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#aws-resource-dms-replicationtask-return-values}
+ */
 export type DMSReplicationTaskAttribs = {
+    /**
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-id}
+     */
     Id: string;
 };
 //# sourceMappingURL=aws-dms-replicationtask.d.ts.map

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

@@ -1,11 +1,17 @@
 import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+/**
+ * The `AWS::DocDB::DBCluster` Amazon DocumentDB (with MongoDB compatibility) resource describes a DBCluster. Amazon DocumentDB is a fully managed, MongoDB-compatible document database engine. For more information, see [DBCluster](https://docs.aws.amazon.com/documentdb/latest/developerguide/API_DBCluster.html) in the *Amazon DocumentDB Developer Guide* .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html}
+ */
 export type DocDBDBCluster = ResourceDefinitionWithAttributes<"AWS::DocDB::DBCluster", DocDBDBClusterProps, DocDBDBClusterAttribs>;
 /**
  * The `AWS::DocDB::DBCluster` Amazon DocumentDB (with MongoDB compatibility) resource describes a DBCluster. Amazon DocumentDB is a fully managed, MongoDB-compatible document database engine. For more information, see [DBCluster](https://docs.aws.amazon.com/documentdb/latest/developerguide/API_DBCluster.html) in the *Amazon DocumentDB Developer Guide* .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html}
  */
 export type DocDBDBClusterProps = {
     /**
      * A list of Amazon EC2 Availability Zones that instances in the cluster can be created in.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-availabilityzones}
      */
     AvailabilityZones?: string[] | undefined;
     /**
@@ -16,10 +22,12 @@ export type DocDBDBClusterProps = {
      * Constraints:
      *
      * - Must be a value from 1 to 35.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-backupretentionperiod}
      */
     BackupRetentionPeriod?: number | undefined;
     /**
      * Set to `true` to copy all tags from the source cluster snapshot to the target cluster snapshot, and otherwise `false` . The default is `false` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-copytagstosnapshot}
      */
     CopyTagsToSnapshot?: boolean | undefined;
     /**
@@ -32,10 +40,12 @@ export type DocDBDBClusterProps = {
      * - Cannot end with a hyphen or contain two consecutive hyphens.
      *
      * Example: `my-cluster`
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-dbclusteridentifier}
      */
     DBClusterIdentifier?: string | undefined;
     /**
      * The name of the cluster parameter group to associate with this cluster.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-dbclusterparametergroupname}
      */
     DBClusterParameterGroupName?: string | undefined;
     /**
@@ -44,20 +54,24 @@ export type DocDBDBClusterProps = {
      * Constraints: Must match the name of an existing `DBSubnetGroup` . Must not be default.
      *
      * Example: `mySubnetgroup`
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-dbsubnetgroupname}
      */
     DBSubnetGroupName?: string | undefined;
     /**
      * Protects clusters from being accidentally deleted. If enabled, the cluster cannot be deleted unless it is modified and `DeletionProtection` is disabled.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-deletionprotection}
      */
     DeletionProtection?: boolean | undefined;
     /**
      * The list of log types that need to be enabled for exporting to Amazon CloudWatch Logs. You can enable audit logs or profiler logs. For more information, see [Auditing Amazon DocumentDB Events](https://docs.aws.amazon.com/documentdb/latest/developerguide/event-auditing.html) and [Profiling Amazon DocumentDB Operations](https://docs.aws.amazon.com/documentdb/latest/developerguide/profiling.html) .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-enablecloudwatchlogsexports}
      */
     EnableCloudwatchLogsExports?: string[] | undefined;
     /**
      * The version number of the database engine to use. The `--engine-version` will default to the latest major engine version. For production workloads, we recommend explicitly declaring this parameter with the intended major engine version.
      *
      * If you intend to trigger an in-place upgrade, please refer to [Amazon DocumentDB in-place major version upgrade](https://docs.aws.amazon.com/documentdb/latest/developerguide/docdb-mvu.html) . Note that for an in-place engine version upgrade, you need to remove other cluster properties changes (e.g. SecurityGroupId) from the CFN template.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-engineversion}
      */
     EngineVersion?: string | undefined;
     /**
@@ -70,18 +84,21 @@ export type DocDBDBClusterProps = {
      * - If the `StorageEncrypted` parameter is `true` , Amazon DocumentDB uses your default encryption key.
      *
      * AWS KMS creates the default encryption key for your AWS account . Your AWS account has a different default encryption key for each AWS Regions .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-kmskeyid}
      */
     KmsKeyId?: string | undefined;
     /**
      * Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.
      *
      * Constraint: You can't manage the master user password with Amazon Web Services Secrets Manager if `MasterUserPassword` is specified.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-managemasteruserpassword}
      */
     ManageMasterUserPassword?: boolean | undefined;
     /**
      * The password for the master database user. This password can contain any printable ASCII character except forward slash (/), double quote ("), or the "at" symbol (@).
      *
      * Constraints: Must contain from 8 to 100 characters.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-masteruserpassword}
      */
     MasterUserPassword?: string | undefined;
     /**
@@ -92,6 +109,7 @@ export type DocDBDBClusterProps = {
      * If you don't specify `MasterUserSecretKmsKeyId` , then the `aws/secretsmanager` KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can't use the `aws/secretsmanager` KMS key to encrypt the secret, and you must use a customer managed KMS key.
      *
      * There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-masterusersecretkmskeyid}
      */
     MasterUserSecretKmsKeyId?: string | undefined;
     /**
@@ -102,10 +120,12 @@ export type DocDBDBClusterProps = {
      * - Must be from 1 to 63 letters or numbers.
      * - The first character must be a letter.
      * - Cannot be a reserved word for the chosen database engine.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-masterusername}
      */
     MasterUsername?: string | undefined;
     /**
      * Specifies the port that the database engine is listening on.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-port}
      */
     Port?: number | undefined;
     /**
@@ -119,6 +139,7 @@ export type DocDBDBClusterProps = {
      * - Must be in Universal Coordinated Time (UTC).
      * - Must not conflict with the preferred maintenance window.
      * - Must be at least 30 minutes.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-preferredbackupwindow}
      */
     PreferredBackupWindow?: string | undefined;
     /**
@@ -131,6 +152,7 @@ export type DocDBDBClusterProps = {
      * Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
      *
      * Constraints: Minimum 30-minute window.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-preferredmaintenancewindow}
      */
     PreferredMaintenanceWindow?: string | undefined;
     /**
@@ -146,6 +168,7 @@ export type DocDBDBClusterProps = {
      * - Cannot be specified if the `RestoreType` parameter is `copy-on-write` .
      *
      * Example: `2015-03-07T23:45:00Z`
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-restoretotime}
      */
     RestoreToTime?: string | undefined;
     /**
@@ -157,6 +180,7 @@ export type DocDBDBClusterProps = {
      * 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.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-restoretype}
      */
     RestoreType?: string | undefined;
     /**
@@ -165,8 +189,12 @@ export type DocDBDBClusterProps = {
      * This setting is valid only if the master user password is managed by Amazon DocumentDB in Amazon Web Services Secrets Manager for the cluster. The secret value contains the updated password.
      *
      * Constraint: You must apply the change immediately when rotating the master user password.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-rotatemasteruserpassword}
      */
     RotateMasterUserPassword?: boolean | undefined;
+    /**
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-serverlessv2scalingconfiguration}
+     */
     ServerlessV2ScalingConfiguration?: ServerlessV2ScalingConfiguration | undefined;
     /**
      * The identifier for the snapshot or cluster snapshot to restore from.
@@ -176,6 +204,7 @@ export type DocDBDBClusterProps = {
      * Constraints:
      *
      * - Must match the identifier of an existing snapshot.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-snapshotidentifier}
      */
     SnapshotIdentifier?: string | undefined;
     /**
@@ -184,12 +213,14 @@ export type DocDBDBClusterProps = {
      * Constraints:
      *
      * - Must match the identifier of an existing `DBCluster` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-sourcedbclusteridentifier}
      */
     SourceDBClusterIdentifier?: string | undefined;
     /**
      * Specifies whether the cluster is encrypted.
      *
      * If you specify `SourceDBClusterIdentifier` or `SnapshotIdentifier` and don’t specify `StorageEncrypted` , the encryption property is inherited from the source cluster or snapshot (unless `KMSKeyId` is specified, in which case the restored cluster will be encrypted with that KMS key). If the source is encrypted and `StorageEncrypted` is specified to be true, the restored cluster will be encrypted (if you want to use a different KMS key, specify the `KMSKeyId` property as well). If the source is unencrypted and `StorageEncrypted` is specified to be true, then the `KMSKeyId` property must be specified. If the source is encrypted, don’t specify `StorageEncrypted` to be false as opting out of encryption is not allowed.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-storageencrypted}
      */
     StorageEncrypted?: boolean | undefined;
     /**
@@ -202,10 +233,12 @@ export type DocDBDBClusterProps = {
      * Default value is `standard`
      *
      * > When you create a DocumentDB DB cluster with the storage type set to `iopt1` , the storage type is returned in the response. The storage type isn't returned when you set it to `standard` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-storagetype}
      */
     StorageType?: string | undefined;
     /**
      * The tags to be assigned to the cluster.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-tags}
      */
     Tags?: Tag[] | undefined;
     /**
@@ -214,34 +247,55 @@ export type DocDBDBClusterProps = {
      * Default: `false`
      *
      * Constraints: Cannot be specified if the `RestoreToTime` parameter is provided.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-uselatestrestorabletime}
      */
     UseLatestRestorableTime?: boolean | undefined;
     /**
      * A list of EC2 VPC security groups to associate with this cluster.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-vpcsecuritygroupids}
      */
     VpcSecurityGroupIds?: string[] | undefined;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#aws-resource-docdb-dbcluster-return-values}
+ */
 export type DocDBDBClusterAttribs = {
     /**
      * The resource id for the cluster; for example: `cluster-ABCD1234EFGH5678IJKL90MNOP` . The cluster ID uniquely identifies the cluster and is used in things like IAM authentication policies.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-clusterresourceid}
      */
     ClusterResourceId: string;
     /**
      * The connection endpoint for the cluster, such as `sample-cluster.cluster-cozrlsfrcjoc.us-east-1.docdb.amazonaws.com` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-endpoint}
      */
     Endpoint: string;
+    /**
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-id}
+     */
     Id: string;
     /**
      * The port number on which the cluster accepts connections. For example: `27017` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-port}
      */
     Port: number;
     /**
      * The reader endpoint for the cluster. For example: `sample-cluster.cluster-ro-cozrlsfrcjoc.us-east-1.docdb.amazonaws.com` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbcluster.html#cfn-docdb-dbcluster-readendpoint}
      */
     ReadEndpoint: string;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-docdb-dbcluster-serverlessv2scalingconfiguration.html}
+ */
 export type ServerlessV2ScalingConfiguration = {
+    /**
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-docdb-dbcluster-serverlessv2scalingconfiguration.html#cfn-docdb-dbcluster-serverlessv2scalingconfiguration-maxcapacity}
+     */
     MaxCapacity: number;
+    /**
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-docdb-dbcluster-serverlessv2scalingconfiguration.html#cfn-docdb-dbcluster-serverlessv2scalingconfiguration-mincapacity}
+     */
     MinCapacity: number;
 };
 //# sourceMappingURL=aws-docdb-dbcluster.d.ts.map

package/out/exports/resources.generated/aws-docdb-dbclusterparametergroup.d.ts

@@ -1,4 +1,14 @@
 import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+/**
+ * The `AWS::DocDB::DBClusterParameterGroup` Amazon DocumentDB (with MongoDB compatibility) resource describes a DBClusterParameterGroup. For more information, see [DBClusterParameterGroup](https://docs.aws.amazon.com/documentdb/latest/developerguide/API_DBClusterParameterGroup.html) in the *Amazon DocumentDB Developer Guide* .
+ *
+ * Parameters in a cluster parameter group apply to all of the instances in a cluster.
+ *
+ * A cluster parameter group is initially created with the default parameters for the database engine used by instances in the cluster. To provide custom values for any of the parameters, you must modify the group after you create it. After you create a DB cluster parameter group, you must associate it with your cluster. For the new cluster parameter group and associated settings to take effect, you must then reboot the DB instances in the cluster without failover.
+ *
+ * > After you create a cluster parameter group, you should wait at least 5 minutes before creating your first cluster that uses that cluster parameter group as the default parameter group. This allows Amazon DocumentDB to fully complete the create action before the cluster parameter group is used as the default for a new cluster. This step is especially important for parameters that are critical when creating the default database for a cluster, such as the character set for the default database defined by the `character_set_database` parameter.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbclusterparametergroup.html}
+ */
 export type DocDBDBClusterParameterGroup = ResourceDefinitionWithAttributes<"AWS::DocDB::DBClusterParameterGroup", DocDBDBClusterParameterGroupProps, DocDBDBClusterParameterGroupAttribs>;
 /**
  * The `AWS::DocDB::DBClusterParameterGroup` Amazon DocumentDB (with MongoDB compatibility) resource describes a DBClusterParameterGroup. For more information, see [DBClusterParameterGroup](https://docs.aws.amazon.com/documentdb/latest/developerguide/API_DBClusterParameterGroup.html) in the *Amazon DocumentDB Developer Guide* .
@@ -8,14 +18,17 @@ export type DocDBDBClusterParameterGroup = ResourceDefinitionWithAttributes<"AWS
  * A cluster parameter group is initially created with the default parameters for the database engine used by instances in the cluster. To provide custom values for any of the parameters, you must modify the group after you create it. After you create a DB cluster parameter group, you must associate it with your cluster. For the new cluster parameter group and associated settings to take effect, you must then reboot the DB instances in the cluster without failover.
  *
  * > After you create a cluster parameter group, you should wait at least 5 minutes before creating your first cluster that uses that cluster parameter group as the default parameter group. This allows Amazon DocumentDB to fully complete the create action before the cluster parameter group is used as the default for a new cluster. This step is especially important for parameters that are critical when creating the default database for a cluster, such as the character set for the default database defined by the `character_set_database` parameter.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbclusterparametergroup.html}
  */
 export type DocDBDBClusterParameterGroupProps = {
     /**
      * The description for the cluster parameter group.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbclusterparametergroup.html#cfn-docdb-dbclusterparametergroup-description}
      */
     Description: string;
     /**
      * The cluster parameter group family name.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbclusterparametergroup.html#cfn-docdb-dbclusterparametergroup-family}
      */
     Family: string;
     /**
@@ -26,18 +39,27 @@ export type DocDBDBClusterParameterGroupProps = {
      * - Must not match the name of an existing `DBClusterParameterGroup` .
      *
      * > This value is stored as a lowercase string.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbclusterparametergroup.html#cfn-docdb-dbclusterparametergroup-name}
      */
     Name?: string | undefined;
     /**
      * Provides a list of parameters for the cluster parameter group.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbclusterparametergroup.html#cfn-docdb-dbclusterparametergroup-parameters}
      */
     Parameters: Record<string, unknown>;
     /**
      * The tags to be assigned to the cluster parameter group.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbclusterparametergroup.html#cfn-docdb-dbclusterparametergroup-tags}
      */
     Tags?: Tag[] | undefined;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbclusterparametergroup.html#aws-resource-docdb-dbclusterparametergroup-return-values}
+ */
 export type DocDBDBClusterParameterGroupAttribs = {
+    /**
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbclusterparametergroup.html#cfn-docdb-dbclusterparametergroup-id}
+     */
     Id: string;
 };
 //# sourceMappingURL=aws-docdb-dbclusterparametergroup.d.ts.map

package/out/exports/resources.generated/aws-docdb-dbinstance.d.ts

@@ -1,13 +1,19 @@
 import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+/**
+ * The `AWS::DocDB::DBInstance` Amazon DocumentDB (with MongoDB compatibility) resource describes a DBInstance. For more information, see [DBInstance](https://docs.aws.amazon.com/documentdb/latest/developerguide/API_DBInstance.html) in the *Amazon DocumentDB Developer Guide* .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbinstance.html}
+ */
 export type DocDBDBInstance = ResourceDefinitionWithAttributes<"AWS::DocDB::DBInstance", DocDBDBInstanceProps, DocDBDBInstanceAttribs>;
 /**
  * The `AWS::DocDB::DBInstance` Amazon DocumentDB (with MongoDB compatibility) resource describes a DBInstance. For more information, see [DBInstance](https://docs.aws.amazon.com/documentdb/latest/developerguide/API_DBInstance.html) in the *Amazon DocumentDB Developer Guide* .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbinstance.html}
  */
 export type DocDBDBInstanceProps = {
     /**
      * This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.
      *
      * Default: `false`
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbinstance.html#cfn-docdb-dbinstance-autominorversionupgrade}
      */
     AutoMinorVersionUpgrade?: boolean | undefined;
     /**
@@ -16,10 +22,12 @@ export type DocDBDBInstanceProps = {
      * Default: A random, system-chosen Availability Zone in the endpoint's AWS Region .
      *
      * Example: `us-east-1d`
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbinstance.html#cfn-docdb-dbinstance-availabilityzone}
      */
     AvailabilityZone?: string | undefined;
     /**
      * The identifier of the CA certificate for this DB instance.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbinstance.html#cfn-docdb-dbinstance-cacertificateidentifier}
      */
     CACertificateIdentifier?: string | undefined;
     /**
@@ -30,14 +38,17 @@ export type DocDBDBInstanceProps = {
      * > Set this parameter only if you are *not* using SSL/TLS to connect to the DB instance.
      *
      * If you are using SSL/TLS to connect to the DB instance, see [Updating Your Amazon DocumentDB TLS Certificates](https://docs.aws.amazon.com/documentdb/latest/developerguide/ca_cert_rotation.html) and [Encrypting Data in Transit](https://docs.aws.amazon.com/documentdb/latest/developerguide/security.encryption.ssl.html) in the *Amazon DocumentDB Developer Guide* .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbinstance.html#cfn-docdb-dbinstance-certificaterotationrestart}
      */
     CertificateRotationRestart?: boolean | undefined;
     /**
      * The identifier of the cluster that the instance will belong to.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbinstance.html#cfn-docdb-dbinstance-dbclusteridentifier}
      */
     DBClusterIdentifier: string;
     /**
      * The compute and memory capacity of the instance; for example, `db.m4.large` . If you change the class of an instance there can be some interruption in the cluster's service.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbinstance.html#cfn-docdb-dbinstance-dbinstanceclass}
      */
     DBInstanceClass: string;
     /**
@@ -50,10 +61,12 @@ export type DocDBDBInstanceProps = {
      * - Cannot end with a hyphen or contain two consecutive hyphens.
      *
      * Example: `mydbinstance`
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbinstance.html#cfn-docdb-dbinstance-dbinstanceidentifier}
      */
     DBInstanceIdentifier?: string | undefined;
     /**
      * A value that indicates whether to enable Performance Insights for the DB Instance. For more information, see [Using Amazon Performance Insights](https://docs.aws.amazon.com/documentdb/latest/developerguide/performance-insights.html) .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbinstance.html#cfn-docdb-dbinstance-enableperformanceinsights}
      */
     EnablePerformanceInsights?: boolean | undefined;
     /**
@@ -66,21 +79,31 @@ export type DocDBDBInstanceProps = {
      * Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
      *
      * Constraints: Minimum 30-minute window.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbinstance.html#cfn-docdb-dbinstance-preferredmaintenancewindow}
      */
     PreferredMaintenanceWindow?: string | undefined;
     /**
      * The tags to be assigned to the instance. You can assign up to 10 tags to an instance.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbinstance.html#cfn-docdb-dbinstance-tags}
      */
     Tags?: Tag[] | undefined;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbinstance.html#aws-resource-docdb-dbinstance-return-values}
+ */
 export type DocDBDBInstanceAttribs = {
     /**
      * The connection endpoint for the instance. For example: `sample-cluster.cluster-abcdefghijkl.us-east-1.docdb.amazonaws.com` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbinstance.html#cfn-docdb-dbinstance-endpoint}
      */
     Endpoint: string;
+    /**
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbinstance.html#cfn-docdb-dbinstance-id}
+     */
     Id: string;
     /**
      * The port number on which the database accepts connections, such as `27017` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbinstance.html#cfn-docdb-dbinstance-port}
      */
     Port: string;
 };

package/out/exports/resources.generated/aws-docdb-dbsubnetgroup.d.ts

@@ -1,11 +1,17 @@
 import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+/**
+ * The `AWS::DocDB::DBSubnetGroup` Amazon DocumentDB (with MongoDB compatibility) resource describes a DBSubnetGroup. subnet groups must contain at least one subnet in at least two Availability Zones in the AWS Region . For more information, see [DBSubnetGroup](https://docs.aws.amazon.com/documentdb/latest/developerguide/API_DBSubnetGroup.html) in the *Amazon DocumentDB Developer Guide* .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbsubnetgroup.html}
+ */
 export type DocDBDBSubnetGroup = ResourceDefinitionWithAttributes<"AWS::DocDB::DBSubnetGroup", DocDBDBSubnetGroupProps, DocDBDBSubnetGroupAttribs>;
 /**
  * The `AWS::DocDB::DBSubnetGroup` Amazon DocumentDB (with MongoDB compatibility) resource describes a DBSubnetGroup. subnet groups must contain at least one subnet in at least two Availability Zones in the AWS Region . For more information, see [DBSubnetGroup](https://docs.aws.amazon.com/documentdb/latest/developerguide/API_DBSubnetGroup.html) in the *Amazon DocumentDB Developer Guide* .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbsubnetgroup.html}
  */
 export type DocDBDBSubnetGroupProps = {
     /**
      * The description for the subnet group.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbsubnetgroup.html#cfn-docdb-dbsubnetgroup-dbsubnetgroupdescription}
      */
     DBSubnetGroupDescription: string;
     /**
@@ -14,18 +20,27 @@ export type DocDBDBSubnetGroupProps = {
      * Constraints: Must contain no more than 255 letters, numbers, periods, underscores, spaces, or hyphens. Must not be default.
      *
      * Example: `mySubnetgroup`
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbsubnetgroup.html#cfn-docdb-dbsubnetgroup-dbsubnetgroupname}
      */
     DBSubnetGroupName?: string | undefined;
     /**
      * The Amazon EC2 subnet IDs for the subnet group.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbsubnetgroup.html#cfn-docdb-dbsubnetgroup-subnetids}
      */
     SubnetIds: string[];
     /**
      * The tags to be assigned to the subnet group.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbsubnetgroup.html#cfn-docdb-dbsubnetgroup-tags}
      */
     Tags?: Tag[] | undefined;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbsubnetgroup.html#aws-resource-docdb-dbsubnetgroup-return-values}
+ */
 export type DocDBDBSubnetGroupAttribs = {
+    /**
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-dbsubnetgroup.html#cfn-docdb-dbsubnetgroup-id}
+     */
     Id: string;
 };
 //# sourceMappingURL=aws-docdb-dbsubnetgroup.d.ts.map

package/out/exports/resources.generated/aws-docdb-eventsubscription.d.ts

@@ -1,4 +1,12 @@
 import type { ResourceDefinitionWithAttributes } from "../main.ts";
+/**
+ * Creates an Amazon DocumentDB event notification subscription. This action requires a topic Amazon Resource Name (ARN) created by using the Amazon DocumentDB console, the Amazon SNS console, or the Amazon SNS API. To obtain an ARN with Amazon SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the Amazon SNS console.
+ *
+ * You can specify the type of source ( `SourceType` ) that you want to be notified of. You can also provide a list of Amazon DocumentDB sources ( `SourceIds` ) that trigger the events, and you can provide a list of event categories ( `EventCategories` ) for events that you want to be notified of. For example, you can specify `SourceType = db-instance` , `SourceIds = mydbinstance1, mydbinstance2` and `EventCategories = Availability, Backup` .
+ *
+ * If you specify both the `SourceType` and `SourceIds` (such as `SourceType = db-instance` and `SourceIdentifier = myDBInstance1` ), you are notified of all the `db-instance` events for the specified source. If you specify a `SourceType` but do not specify a `SourceIdentifier` , you receive notice of the events for that source type for all your Amazon DocumentDB sources. If you do not specify either the `SourceType` or the `SourceIdentifier` , you are notified of events generated from all Amazon DocumentDB sources belonging to your customer account.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-eventsubscription.html}
+ */
 export type DocDBEventSubscription = ResourceDefinitionWithAttributes<"AWS::DocDB::EventSubscription", DocDBEventSubscriptionProps, DocDBEventSubscriptionAttribs>;
 /**
  * Creates an Amazon DocumentDB event notification subscription. This action requires a topic Amazon Resource Name (ARN) created by using the Amazon DocumentDB console, the Amazon SNS console, or the Amazon SNS API. To obtain an ARN with Amazon SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the Amazon SNS console.
@@ -6,18 +14,22 @@ export type DocDBEventSubscription = ResourceDefinitionWithAttributes<"AWS::DocD
  * You can specify the type of source ( `SourceType` ) that you want to be notified of. You can also provide a list of Amazon DocumentDB sources ( `SourceIds` ) that trigger the events, and you can provide a list of event categories ( `EventCategories` ) for events that you want to be notified of. For example, you can specify `SourceType = db-instance` , `SourceIds = mydbinstance1, mydbinstance2` and `EventCategories = Availability, Backup` .
  *
  * If you specify both the `SourceType` and `SourceIds` (such as `SourceType = db-instance` and `SourceIdentifier = myDBInstance1` ), you are notified of all the `db-instance` events for the specified source. If you specify a `SourceType` but do not specify a `SourceIdentifier` , you receive notice of the events for that source type for all your Amazon DocumentDB sources. If you do not specify either the `SourceType` or the `SourceIdentifier` , you are notified of events generated from all Amazon DocumentDB sources belonging to your customer account.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-eventsubscription.html}
  */
 export type DocDBEventSubscriptionProps = {
     /**
      * A Boolean value; set to `true` to activate the subscription, set to `false` to create the subscription but not active it.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-eventsubscription.html#cfn-docdb-eventsubscription-enabled}
      */
     Enabled?: boolean | undefined;
     /**
      * A list of event categories for a `SourceType` that you want to subscribe to.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-eventsubscription.html#cfn-docdb-eventsubscription-eventcategories}
      */
     EventCategories?: string[] | undefined;
     /**
      * The Amazon Resource Name (ARN) of the SNS topic created for event notification. Amazon SNS creates the ARN when you create a topic and subscribe to it.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-eventsubscription.html#cfn-docdb-eventsubscription-snstopicarn}
      */
     SnsTopicArn: string;
     /**
@@ -30,22 +42,31 @@ export type DocDBEventSubscriptionProps = {
      * - If the source type is a security group, a `DBSecurityGroupName` must be provided.
      * - If the source type is a parameter group, a `DBParameterGroupName` must be provided.
      * - If the source type is a snapshot, a `DBSnapshotIdentifier` must be provided.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-eventsubscription.html#cfn-docdb-eventsubscription-sourceids}
      */
     SourceIds?: string[] | undefined;
     /**
      * The type of source that is generating the events. For example, if you want to be notified of events generated by an instance, you would set this parameter to `db-instance` . If this value is not specified, all events are returned.
      *
      * Valid values: `db-instance` , `db-cluster` , `db-parameter-group` , `db-security-group` , `db-cluster-snapshot`
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-eventsubscription.html#cfn-docdb-eventsubscription-sourcetype}
      */
     SourceType?: string | undefined;
     /**
      * The name of the subscription.
      *
      * Constraints: The name must be fewer than 255 characters.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-eventsubscription.html#cfn-docdb-eventsubscription-subscriptionname}
      */
     SubscriptionName?: string | undefined;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-eventsubscription.html#aws-resource-docdb-eventsubscription-return-values}
+ */
 export type DocDBEventSubscriptionAttribs = {
+    /**
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-eventsubscription.html#cfn-docdb-eventsubscription-id}
+     */
     Id: string;
 };
 //# sourceMappingURL=aws-docdb-eventsubscription.d.ts.map