@propulsionworks/cloudformation 0.1.0 → 0.1.2

package/out/exports/resources.generated/aws-backup-backupvault.d.ts

@@ -1,4 +1,12 @@
 import type { ResourceDefinitionWithAttributes, TemplatePolicyDocument } from "../main.ts";
+/**
+ * Creates a logical container where backups are stored. A `CreateBackupVault` request includes a name, optionally one or more resource tags, an encryption key, and a request ID.
+ *
+ * Do not include sensitive data, such as passport numbers, in the name of a backup vault.
+ *
+ * For a sample AWS CloudFormation template, see the [AWS Backup Developer Guide](https://docs.aws.amazon.com/aws-backup/latest/devguide/assigning-resources.html#assigning-resources-cfn) .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-backupvault.html}
+ */
 export type BackupBackupVault = ResourceDefinitionWithAttributes<"AWS::Backup::BackupVault", BackupBackupVaultProps, BackupBackupVaultAttribs>;
 /**
  * Creates a logical container where backups are stored. A `CreateBackupVault` request includes a name, optionally one or more resource tags, an encryption key, and a request ID.
@@ -6,48 +14,60 @@ export type BackupBackupVault = ResourceDefinitionWithAttributes<"AWS::Backup::B
  * Do not include sensitive data, such as passport numbers, in the name of a backup vault.
  *
  * For a sample AWS CloudFormation template, see the [AWS Backup Developer Guide](https://docs.aws.amazon.com/aws-backup/latest/devguide/assigning-resources.html#assigning-resources-cfn) .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-backupvault.html}
  */
 export type BackupBackupVaultProps = {
     /**
      * A resource-based policy that is used to manage access permissions on the target backup vault.
-     * @policy
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-backupvault.html#cfn-backup-backupvault-accesspolicy}
      */
     AccessPolicy?: TemplatePolicyDocument | undefined;
     /**
      * The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-backupvault.html#cfn-backup-backupvault-backupvaultname}
      */
     BackupVaultName: string;
     /**
      * The tags to assign to the backup vault.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-backupvault.html#cfn-backup-backupvault-backupvaulttags}
      */
     BackupVaultTags?: Record<string, string> | undefined;
     /**
      * A server-side encryption key you can specify to encrypt your backups from services that support full AWS Backup management; for example, `arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab` . If you specify a key, you must specify its ARN, not its alias. If you do not specify a key, AWS Backup creates a KMS key for you by default.
      *
      * To learn which AWS Backup services support full AWS Backup management and how AWS Backup handles encryption for backups from services that do not yet support full AWS Backup , see [Encryption for backups in AWS Backup](https://docs.aws.amazon.com/aws-backup/latest/devguide/encryption.html)
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-backupvault.html#cfn-backup-backupvault-encryptionkeyarn}
      */
     EncryptionKeyArn?: string | undefined;
     /**
      * Configuration for [AWS Backup Vault Lock](https://docs.aws.amazon.com/aws-backup/latest/devguide/vault-lock.html) .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-backupvault.html#cfn-backup-backupvault-lockconfiguration}
      */
     LockConfiguration?: LockConfigurationType | undefined;
     /**
      * The SNS event notifications for the specified backup vault.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-backupvault.html#cfn-backup-backupvault-notifications}
      */
     Notifications?: NotificationObjectType | undefined;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-backupvault.html#aws-resource-backup-backupvault-return-values}
+ */
 export type BackupBackupVaultAttribs = {
     /**
      * An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, `arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-backupvault.html#cfn-backup-backupvault-backupvaultarn}
      */
     BackupVaultArn: string;
     /**
      * The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created. They consist of lowercase and uppercase letters, numbers, and hyphens.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-backupvault.html#cfn-backup-backupvault-backupvaultname}
      */
     BackupVaultName: string;
 };
 /**
  * The `LockConfigurationType` property type specifies configuration for [AWS Backup Vault Lock](https://docs.aws.amazon.com/aws-backup/latest/devguide/vault-lock.html) .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupvault-lockconfigurationtype.html}
  */
 export type LockConfigurationType = {
     /**
@@ -58,6 +78,7 @@ export type LockConfigurationType = {
      * Before the lock date, you can delete Vault Lock from the vault using `DeleteBackupVaultLockConfiguration` or change the Vault Lock configuration using `PutBackupVaultLockConfiguration` . On and after the lock date, the Vault Lock becomes immutable and cannot be changed or deleted.
      *
      * If this parameter is not specified, you can delete Vault Lock from the vault using `DeleteBackupVaultLockConfiguration` or change the Vault Lock configuration using `PutBackupVaultLockConfiguration` at any time.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupvault-lockconfigurationtype.html#cfn-backup-backupvault-lockconfigurationtype-changeablefordays}
      */
     ChangeableForDays?: number | undefined;
     /**
@@ -66,6 +87,7 @@ export type LockConfigurationType = {
      * If this parameter is not included, Vault Lock does not enforce a maximum retention period on the recovery points in the vault. If this parameter is included without a value, Vault Lock will not enforce a maximum retention period.
      *
      * If this parameter is specified, any backup or copy job to the vault must have a lifecycle policy with a retention period equal to or shorter than the maximum retention period. If the job's retention period is longer than that maximum retention period, then the vault fails the backup or copy job, and you should either modify your lifecycle settings or use a different vault. Recovery points already saved in the vault prior to Vault Lock are not affected.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupvault-lockconfigurationtype.html#cfn-backup-backupvault-lockconfigurationtype-maxretentiondays}
      */
     MaxRetentionDays?: number | undefined;
     /**
@@ -74,19 +96,23 @@ export type LockConfigurationType = {
      * If this parameter is not specified, Vault Lock will not enforce a minimum retention period.
      *
      * If this parameter is specified, any backup or copy job to the vault must have a lifecycle policy with a retention period equal to or longer than the minimum retention period. If the job's retention period is shorter than that minimum retention period, then the vault fails that backup or copy job, and you should either modify your lifecycle settings or use a different vault. Recovery points already saved in the vault prior to Vault Lock are not affected.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupvault-lockconfigurationtype.html#cfn-backup-backupvault-lockconfigurationtype-minretentiondays}
      */
     MinRetentionDays: number;
 };
 /**
  * Specifies an object containing SNS event notification properties for the target backup vault.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupvault-notificationobjecttype.html}
  */
 export type NotificationObjectType = {
     /**
      * An array of events that indicate the status of jobs to back up resources to the backup vault. For valid events, see [BackupVaultEvents](https://docs.aws.amazon.com/aws-backup/latest/devguide/API_PutBackupVaultNotifications.html#API_PutBackupVaultNotifications_RequestSyntax) in the *AWS Backup API Guide* .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupvault-notificationobjecttype.html#cfn-backup-backupvault-notificationobjecttype-backupvaultevents}
      */
     BackupVaultEvents: string[];
     /**
      * An ARN that uniquely identifies an Amazon Simple Notification Service (Amazon SNS) topic; for example, `arn:aws:sns:us-west-2:111122223333:MyTopic` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-backupvault-notificationobjecttype.html#cfn-backup-backupvault-notificationobjecttype-snstopicarn}
      */
     SNSTopicArn: string;
 };

package/out/exports/resources.generated/aws-backup-framework.d.ts

@@ -1,19 +1,28 @@
 import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+/**
+ * Creates a framework with one or more controls. A framework is a collection of controls that you can use to evaluate your backup practices. By using pre-built customizable controls to define your policies, you can evaluate whether your backup practices comply with your policies and which resources are not yet in compliance.
+ *
+ * For a sample AWS CloudFormation template, see the [AWS Backup Developer Guide](https://docs.aws.amazon.com/aws-backup/latest/devguide/bam-cfn-integration.html#bam-cfn-frameworks-template) .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-framework.html}
+ */
 export type BackupFramework = ResourceDefinitionWithAttributes<"AWS::Backup::Framework", BackupFrameworkProps, BackupFrameworkAttribs>;
 /**
  * Creates a framework with one or more controls. A framework is a collection of controls that you can use to evaluate your backup practices. By using pre-built customizable controls to define your policies, you can evaluate whether your backup practices comply with your policies and which resources are not yet in compliance.
  *
  * For a sample AWS CloudFormation template, see the [AWS Backup Developer Guide](https://docs.aws.amazon.com/aws-backup/latest/devguide/bam-cfn-integration.html#bam-cfn-frameworks-template) .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-framework.html}
  */
 export type BackupFrameworkProps = {
     /**
      * Contains detailed information about all of the controls of a framework. Each framework must contain at least one control.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-framework.html#cfn-backup-framework-frameworkcontrols}
      */
     FrameworkControls: FrameworkControl[];
     /**
      * An optional description of the framework with a maximum 1,024 characters.
      * @minLength 0
      * @maxLength 1024
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-framework.html#cfn-backup-framework-frameworkdescription}
      */
     FrameworkDescription?: string | undefined;
     /**
@@ -21,60 +30,76 @@ export type BackupFrameworkProps = {
      * @minLength 1
      * @maxLength 256
      * @pattern [a-zA-Z][_a-zA-Z0-9]*
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-framework.html#cfn-backup-framework-frameworkname}
      */
     FrameworkName?: string | undefined;
     /**
      * The tags to assign to your framework.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-framework.html#cfn-backup-framework-frameworktags}
      */
     FrameworkTags?: Tag[] | undefined;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-framework.html#aws-resource-backup-framework-return-values}
+ */
 export type BackupFrameworkAttribs = {
     /**
      * The UTC time when you created your framework.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-framework.html#cfn-backup-framework-creationtime}
      */
     CreationTime: string;
     /**
      * Depolyment status refers to whether your framework has completed deployment. This status is usually `Completed` , but might also be `Create in progress` or another status. For a list of statuses, see [Framework compliance status](https://docs.aws.amazon.com/aws-backup/latest/devguide/viewing-frameworks.html) in the *Developer Guide* .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-framework.html#cfn-backup-framework-deploymentstatus}
      */
     DeploymentStatus: string;
     /**
      * The Amazon Resource Name (ARN) of your framework.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-framework.html#cfn-backup-framework-frameworkarn}
      */
     FrameworkArn: string;
     /**
      * Framework status refers to whether you have turned on resource tracking for all of your resources. This status is `Active` when you turn on all resources the framework evaluates. For other statuses and steps to correct them, see [Framework compliance status](https://docs.aws.amazon.com/aws-backup/latest/devguide/viewing-frameworks.html) in the *Developer Guide* .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-framework.html#cfn-backup-framework-frameworkstatus}
      */
     FrameworkStatus: string;
 };
 /**
  * The parameters for a control. A control can have zero, one, or more than one parameter. An example of a control with two parameters is: "backup plan frequency is at least `daily` and the retention period is at least `1 year` ". The first parameter is `daily` . The second parameter is `1 year` .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-framework-controlinputparameter.html}
  */
 export type ControlInputParameter = {
     /**
      * The name of a parameter, for example, `BackupPlanFrequency` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-framework-controlinputparameter.html#cfn-backup-framework-controlinputparameter-parametername}
      */
     ParameterName: string;
     /**
      * The value of parameter, for example, `hourly` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-framework-controlinputparameter.html#cfn-backup-framework-controlinputparameter-parametervalue}
      */
     ParameterValue: string;
 };
 /**
  * Contains detailed information about all of the controls of a framework. Each framework must contain at least one control.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-framework-frameworkcontrol.html}
  */
 export type FrameworkControl = {
     /**
      * The name/value pairs.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-framework-frameworkcontrol.html#cfn-backup-framework-frameworkcontrol-controlinputparameters}
      */
     ControlInputParameters?: ControlInputParameter[] | undefined;
     /**
      * The name of a control. This name is between 1 and 256 characters.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-framework-frameworkcontrol.html#cfn-backup-framework-frameworkcontrol-controlname}
      */
     ControlName: string;
     /**
      * The scope of a control. The control scope defines what the control will evaluate. Three examples of control scopes are: a specific backup plan, all backup plans with a specific tag, or all backup plans.
      *
      * For more information, see [`ControlScope` .](https://docs.aws.amazon.com/aws-backup/latest/devguide/API_ControlScope.html)
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-framework-frameworkcontrol.html#cfn-backup-framework-frameworkcontrol-controlscope}
      */
     ControlScope?: {
         /**

package/out/exports/resources.generated/aws-backup-logicallyairgappedbackupvault.d.ts

@@ -1,4 +1,12 @@
 import type { ResourceDefinitionWithAttributes, TemplatePolicyDocument } from "../main.ts";
+/**
+ * Creates a logical container to where backups may be copied.
+ *
+ * This request includes a name, the Region, the maximum number of retention days, the minimum number of retention days, and optionally can include tags and a creator request ID.
+ *
+ * > Do not include sensitive data, such as passport numbers, in the name of a backup vault.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-logicallyairgappedbackupvault.html}
+ */
 export type BackupLogicallyAirGappedBackupVault = ResourceDefinitionWithAttributes<"AWS::Backup::LogicallyAirGappedBackupVault", BackupLogicallyAirGappedBackupVaultProps, BackupLogicallyAirGappedBackupVaultAttribs>;
 /**
  * Creates a logical container to where backups may be copied.
@@ -6,61 +14,79 @@ export type BackupLogicallyAirGappedBackupVault = ResourceDefinitionWithAttribut
  * This request includes a name, the Region, the maximum number of retention days, the minimum number of retention days, and optionally can include tags and a creator request ID.
  *
  * > Do not include sensitive data, such as passport numbers, in the name of a backup vault.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-logicallyairgappedbackupvault.html}
  */
 export type BackupLogicallyAirGappedBackupVaultProps = {
     /**
      * The backup vault access policy document in JSON format.
-     * @policy
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-logicallyairgappedbackupvault.html#cfn-backup-logicallyairgappedbackupvault-accesspolicy}
      */
     AccessPolicy?: TemplatePolicyDocument | undefined;
     /**
      * The name of a logical container where backups are stored. Logically air-gapped backup vaults are identified by names that are unique to the account used to create them and the Region where they are created.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-logicallyairgappedbackupvault.html#cfn-backup-logicallyairgappedbackupvault-backupvaultname}
      */
     BackupVaultName: string;
     /**
      * The tags to assign to the vault.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-logicallyairgappedbackupvault.html#cfn-backup-logicallyairgappedbackupvault-backupvaulttags}
      */
     BackupVaultTags?: Record<string, string> | undefined;
     /**
      * The maximum retention period that the vault retains its recovery points.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-logicallyairgappedbackupvault.html#cfn-backup-logicallyairgappedbackupvault-maxretentiondays}
      */
     MaxRetentionDays: number;
     /**
      * This setting specifies the minimum retention period that the vault retains its recovery points.
      *
      * The minimum value accepted is 7 days.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-logicallyairgappedbackupvault.html#cfn-backup-logicallyairgappedbackupvault-minretentiondays}
      */
     MinRetentionDays: number;
     /**
      * Returns event notifications for the specified backup vault.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-logicallyairgappedbackupvault.html#cfn-backup-logicallyairgappedbackupvault-notifications}
      */
     Notifications?: NotificationObjectType | undefined;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-logicallyairgappedbackupvault.html#aws-resource-backup-logicallyairgappedbackupvault-return-values}
+ */
 export type BackupLogicallyAirGappedBackupVaultAttribs = {
     /**
      * The ARN of the backup vault.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-logicallyairgappedbackupvault.html#cfn-backup-logicallyairgappedbackupvault-backupvaultarn}
      */
     BackupVaultArn: string;
     /**
      * The ARN of the server-side encryption key.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-logicallyairgappedbackupvault.html#cfn-backup-logicallyairgappedbackupvault-encryptionkeyarn}
      */
     EncryptionKeyArn: string;
     /**
      * The vault state. The possible values are `CREATING` , `AVAILABLE` , and `FAILED` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-logicallyairgappedbackupvault.html#cfn-backup-logicallyairgappedbackupvault-vaultstate}
      */
     VaultState: string;
     /**
      * The vault type. The possible values are `BACKUP_VAULT` and `LOGICALLY_AIR_GAPPED_BACKUP_VAULT` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-logicallyairgappedbackupvault.html#cfn-backup-logicallyairgappedbackupvault-vaulttype}
      */
     VaultType: string;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-logicallyairgappedbackupvault-notificationobjecttype.html}
+ */
 export type NotificationObjectType = {
     /**
      * An array of events that indicate the status of jobs to back up resources to the backup vault.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-logicallyairgappedbackupvault-notificationobjecttype.html#cfn-backup-logicallyairgappedbackupvault-notificationobjecttype-backupvaultevents}
      */
     BackupVaultEvents: string[];
     /**
      * The Amazon Resource Name (ARN) that specifies the topic for a backup vault’s events; for example, `arn:aws:sns:us-west-2:111122223333:MyVaultTopic` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-logicallyairgappedbackupvault-notificationobjecttype.html#cfn-backup-logicallyairgappedbackupvault-notificationobjecttype-snstopicarn}
      */
     SNSTopicArn: string;
 };

package/out/exports/resources.generated/aws-backup-reportplan.d.ts

@@ -1,4 +1,12 @@
 import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+/**
+ * Creates a report plan. A report plan is a document that contains information about the contents of the report and where AWS Backup will deliver it.
+ *
+ * If you call `CreateReportPlan` with a plan that already exists, you receive an `AlreadyExistsException` exception.
+ *
+ * For a sample AWS CloudFormation template, see the [AWS Backup Developer Guide](https://docs.aws.amazon.com/aws-backup/latest/devguide/assigning-resources.html#assigning-resources-cfn) .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-reportplan.html}
+ */
 export type BackupReportPlan = ResourceDefinitionWithAttributes<"AWS::Backup::ReportPlan", BackupReportPlanProps, BackupReportPlanAttribs>;
 /**
  * Creates a report plan. A report plan is a document that contains information about the contents of the report and where AWS Backup will deliver it.
@@ -6,10 +14,12 @@ export type BackupReportPlan = ResourceDefinitionWithAttributes<"AWS::Backup::Re
  * If you call `CreateReportPlan` with a plan that already exists, you receive an `AlreadyExistsException` exception.
  *
  * For a sample AWS CloudFormation template, see the [AWS Backup Developer Guide](https://docs.aws.amazon.com/aws-backup/latest/devguide/assigning-resources.html#assigning-resources-cfn) .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-reportplan.html}
  */
 export type BackupReportPlanProps = {
     /**
      * Contains information about where and how to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-reportplan.html#cfn-backup-reportplan-reportdeliverychannel}
      */
     ReportDeliveryChannel: {
         /**
@@ -30,6 +40,7 @@ export type BackupReportPlanProps = {
      * @minLength 0
      * @maxLength 1024
      * @pattern .*\S.*
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-reportplan.html#cfn-backup-reportplan-reportplandescription}
      */
     ReportPlanDescription?: string | undefined;
     /**
@@ -37,10 +48,12 @@ export type BackupReportPlanProps = {
      * @minLength 1
      * @maxLength 256
      * @pattern [a-zA-Z][_a-zA-Z0-9]*
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-reportplan.html#cfn-backup-reportplan-reportplanname}
      */
     ReportPlanName?: string | undefined;
     /**
      * The tags to assign to your report plan.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-reportplan.html#cfn-backup-reportplan-reportplantags}
      */
     ReportPlanTags?: Tag[] | undefined;
     /**
@@ -49,6 +62,7 @@ export type BackupReportPlanProps = {
      * `RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT`
      *
      * If the report template is `RESOURCE_COMPLIANCE_REPORT` or `CONTROL_COMPLIANCE_REPORT` , this API resource also describes the report coverage by AWS Regions and frameworks.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-reportplan.html#cfn-backup-reportplan-reportsetting}
      */
     ReportSetting: {
         /**
@@ -73,9 +87,13 @@ export type BackupReportPlanProps = {
         ReportTemplate: string;
     };
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-reportplan.html#aws-resource-backup-reportplan-return-values}
+ */
 export type BackupReportPlanAttribs = {
     /**
      * The Amazon Resource Name (ARN) of your report plan.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-reportplan.html#cfn-backup-reportplan-reportplanarn}
      */
     ReportPlanArn: string;
 };

package/out/exports/resources.generated/aws-backup-restoretestingplan.d.ts

@@ -1,41 +1,58 @@
 import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+/**
+ * Creates a restore testing plan.
+ *
+ * The first of two steps to create a restore testing plan. After this request is successful, finish the procedure using CreateRestoreTestingSelection.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-restoretestingplan.html}
+ */
 export type BackupRestoreTestingPlan = ResourceDefinitionWithAttributes<"AWS::Backup::RestoreTestingPlan", BackupRestoreTestingPlanProps, BackupRestoreTestingPlanAttribs>;
 /**
  * Creates a restore testing plan.
  *
  * The first of two steps to create a restore testing plan. After this request is successful, finish the procedure using CreateRestoreTestingSelection.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-restoretestingplan.html}
  */
 export type BackupRestoreTestingPlanProps = {
     /**
      * The specified criteria to assign a set of resources, such as recovery point types or backup vaults.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-restoretestingplan.html#cfn-backup-restoretestingplan-recoverypointselection}
      */
     RecoveryPointSelection: RestoreTestingRecoveryPointSelection;
     /**
      * The RestoreTestingPlanName is a unique string that is the name of the restore testing plan. This cannot be changed after creation, and it must consist of only alphanumeric characters and underscores.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-restoretestingplan.html#cfn-backup-restoretestingplan-restoretestingplanname}
      */
     RestoreTestingPlanName: string;
     /**
      * A CRON expression in specified timezone when a restore testing plan is executed. When no CRON expression is provided, AWS Backup will use the default expression `cron(0 5 ? * * *)` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-restoretestingplan.html#cfn-backup-restoretestingplan-scheduleexpression}
      */
     ScheduleExpression: string;
     /**
      * Optional. This is the timezone in which the schedule expression is set. By default, ScheduleExpressions are in UTC. You can modify this to a specified timezone.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-restoretestingplan.html#cfn-backup-restoretestingplan-scheduleexpressiontimezone}
      */
     ScheduleExpressionTimezone?: string | undefined;
     /**
      * Defaults to 24 hours.
      *
      * A value in hours after a restore test is scheduled before a job will be canceled if it doesn't start successfully. This value is optional. If this value is included, this parameter has a maximum value of 168 hours (one week).
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-restoretestingplan.html#cfn-backup-restoretestingplan-startwindowhours}
      */
     StartWindowHours?: number | undefined;
     /**
      * Optional tags to include. A tag is a key-value pair you can use to manage, filter, and search for your resources. Allowed characters include UTF-8 letters,numbers, spaces, and the following characters: `+ - = . _ : /.`
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-restoretestingplan.html#cfn-backup-restoretestingplan-tags}
      */
     Tags?: Tag[] | undefined;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-restoretestingplan.html#aws-resource-backup-restoretestingplan-return-values}
+ */
 export type BackupRestoreTestingPlanAttribs = {
     /**
      * An Amazon Resource Name (ARN) that uniquely identifies a restore testing plan.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-restoretestingplan.html#cfn-backup-restoretestingplan-restoretestingplanarn}
      */
     RestoreTestingPlanArn: string;
 };
@@ -51,31 +68,43 @@ export type BackupRestoreTestingPlanAttribs = {
  * `SelectionWindowDays` ( *optional* ) Value must be an integer (in days) from 1 to 365. If not included, the value defaults to `30` .
  *
  * `ExcludeVaults` ( *optional* ). You can choose to input one or more specific backup vault ARNs to exclude those vaults' contents from restore eligibility. Or, you can include a list of selectors. If this parameter and its value are not included, it defaults to empty list.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-restoretestingplan-restoretestingrecoverypointselection.html}
  */
 export type RestoreTestingRecoveryPointSelection = {
     /**
      * Acceptable values include "LATEST_WITHIN_WINDOW" or "RANDOM_WITHIN_WINDOW"
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-restoretestingplan-restoretestingrecoverypointselection.html#cfn-backup-restoretestingplan-restoretestingrecoverypointselection-algorithm}
      */
     Algorithm: RestoreTestingRecoveryPointSelectionAlgorithm;
     /**
      * Accepted values include specific ARNs or list of selectors. Defaults to empty list if not listed.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-restoretestingplan-restoretestingrecoverypointselection.html#cfn-backup-restoretestingplan-restoretestingrecoverypointselection-excludevaults}
      */
     ExcludeVaults?: string[] | undefined;
     /**
      * Accepted values include wildcard ["*"] or by specific ARNs or ARN wilcard replacement ["arn:aws:backup:us-west-2:123456789012:backup-vault:asdf", ...] ["arn:aws:backup:*:*:backup-vault:asdf-*", ...]
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-restoretestingplan-restoretestingrecoverypointselection.html#cfn-backup-restoretestingplan-restoretestingrecoverypointselection-includevaults}
      */
     IncludeVaults: string[];
     /**
      * These are the types of recovery points.
      *
      * Include `SNAPSHOT` to restore only snapshot recovery points; include `CONTINUOUS` to restore continuous recovery points (point in time restore / PITR); use both to restore either a snapshot or a continuous recovery point. The recovery point will be determined by the value for `Algorithm` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-restoretestingplan-restoretestingrecoverypointselection.html#cfn-backup-restoretestingplan-restoretestingrecoverypointselection-recoverypointtypes}
      */
     RecoveryPointTypes: RestoreTestingRecoveryPointType[];
     /**
      * Accepted values are integers from 1 to 365.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-restoretestingplan-restoretestingrecoverypointselection.html#cfn-backup-restoretestingplan-restoretestingrecoverypointselection-selectionwindowdays}
      */
     SelectionWindowDays?: number | undefined;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-restoretestingplan-restoretestingrecoverypointselectionalgorithm.html}
+ */
 export type RestoreTestingRecoveryPointSelectionAlgorithm = "LATEST_WITHIN_WINDOW" | "RANDOM_WITHIN_WINDOW";
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-restoretestingplan-restoretestingrecoverypointtype.html}
+ */
 export type RestoreTestingRecoveryPointType = "SNAPSHOT" | "CONTINUOUS";
 //# sourceMappingURL=aws-backup-restoretestingplan.d.ts.map

package/out/exports/resources.generated/aws-backup-restoretestingselection.d.ts

@@ -1,4 +1,19 @@
 import type { ResourceDefinition } from "../main.ts";
+/**
+ * This request can be sent after CreateRestoreTestingPlan request returns successfully. This is the second part of creating a resource testing plan, and it must be completed sequentially.
+ *
+ * This consists of `RestoreTestingSelectionName` , `ProtectedResourceType` , and one of the following:
+ *
+ * - `ProtectedResourceArns`
+ * - `ProtectedResourceConditions`
+ *
+ * Each protected resource type can have one single value.
+ *
+ * A restore testing selection can include a wildcard value ("*") for `ProtectedResourceArns` along with `ProtectedResourceConditions` . Alternatively, you can include up to 30 specific protected resource ARNs in `ProtectedResourceArns` .
+ *
+ * Cannot select by both protected resource types AND specific ARNs. Request will fail if both are included.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-restoretestingselection.html}
+ */
 export type BackupRestoreTestingSelection = ResourceDefinition<"AWS::Backup::RestoreTestingSelection", BackupRestoreTestingSelectionProps>;
 /**
  * This request can be sent after CreateRestoreTestingPlan request returns successfully. This is the second part of creating a resource testing plan, and it must be completed sequentially.
@@ -13,68 +28,83 @@ export type BackupRestoreTestingSelection = ResourceDefinition<"AWS::Backup::Res
  * A restore testing selection can include a wildcard value ("*") for `ProtectedResourceArns` along with `ProtectedResourceConditions` . Alternatively, you can include up to 30 specific protected resource ARNs in `ProtectedResourceArns` .
  *
  * Cannot select by both protected resource types AND specific ARNs. Request will fail if both are included.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-restoretestingselection.html}
  */
 export type BackupRestoreTestingSelectionProps = {
     /**
      * The Amazon Resource Name (ARN) of the IAM role that AWS Backup uses to create the target resource; for example: `arn:aws:iam::123456789012:role/S3Access` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-restoretestingselection.html#cfn-backup-restoretestingselection-iamrolearn}
      */
     IamRoleArn: string;
     /**
      * You can include specific ARNs, such as `ProtectedResourceArns: ["arn:aws:...", "arn:aws:..."]` or you can include a wildcard: `ProtectedResourceArns: ["*"]` , but not both.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-restoretestingselection.html#cfn-backup-restoretestingselection-protectedresourcearns}
      */
     ProtectedResourceArns?: string[] | undefined;
     /**
      * In a resource testing selection, this parameter filters by specific conditions such as `StringEquals` or `StringNotEquals` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-restoretestingselection.html#cfn-backup-restoretestingselection-protectedresourceconditions}
      */
     ProtectedResourceConditions?: ProtectedResourceConditions | undefined;
     /**
      * The type of AWS resource included in a resource testing selection; for example, an Amazon EBS volume or an Amazon RDS database.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-restoretestingselection.html#cfn-backup-restoretestingselection-protectedresourcetype}
      */
     ProtectedResourceType: string;
     /**
      * You can override certain restore metadata keys by including the parameter `RestoreMetadataOverrides` in the body of `RestoreTestingSelection` . Key values are not case sensitive.
      *
      * See the complete list of [restore testing inferred metadata](https://docs.aws.amazon.com/aws-backup/latest/devguide/restore-testing-inferred-metadata.html) .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-restoretestingselection.html#cfn-backup-restoretestingselection-restoremetadataoverrides}
      */
     RestoreMetadataOverrides?: Record<string, string> | undefined;
     /**
      * Unique string that is the name of the restore testing plan.
      *
      * The name cannot be changed after creation. The name must consist of only alphanumeric characters and underscores. Maximum length is 50.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-restoretestingselection.html#cfn-backup-restoretestingselection-restoretestingplanname}
      */
     RestoreTestingPlanName: string;
     /**
      * The unique name of the restore testing selection that belongs to the related restore testing plan.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-restoretestingselection.html#cfn-backup-restoretestingselection-restoretestingselectionname}
      */
     RestoreTestingSelectionName: string;
     /**
      * This is amount of hours (1 to 168) available to run a validation script on the data. The data will be deleted upon the completion of the validation script or the end of the specified retention period, whichever comes first.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-backup-restoretestingselection.html#cfn-backup-restoretestingselection-validationwindowhours}
      */
     ValidationWindowHours?: number | undefined;
 };
 /**
  * Pair of two related strings. Allowed characters are letters, white space, and numbers that can be represented in UTF-8 and the following characters: `+ - = . _ : /`
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-restoretestingselection-keyvalue.html}
  */
 export type KeyValue = {
     /**
      * The tag key.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-restoretestingselection-keyvalue.html#cfn-backup-restoretestingselection-keyvalue-key}
      */
     Key: string;
     /**
      * The tag value.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-restoretestingselection-keyvalue.html#cfn-backup-restoretestingselection-keyvalue-value}
      */
     Value: string;
 };
 /**
  * The conditions that you define for resources in your restore testing plan using tags.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-restoretestingselection-protectedresourceconditions.html}
  */
 export type ProtectedResourceConditions = {
     /**
      * Filters the values of your tagged resources for only those resources that you tagged with the same value. Also called "exact matching."
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-restoretestingselection-protectedresourceconditions.html#cfn-backup-restoretestingselection-protectedresourceconditions-stringequals}
      */
     StringEquals?: KeyValue[] | undefined;
     /**
      * Filters the values of your tagged resources for only those resources that you tagged that do not have the same value. Also called "negated matching."
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-backup-restoretestingselection-protectedresourceconditions.html#cfn-backup-restoretestingselection-protectedresourceconditions-stringnotequals}
      */
     StringNotEquals?: KeyValue[] | undefined;
 };