@propulsionworks/cloudformation 0.1.0 → 0.1.2

package/out/exports/resources.generated/aws-iot-securityprofile.d.ts

@@ -1,23 +1,32 @@
 import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+/**
+ * Use the `AWS::IoT::SecurityProfile` resource to create a Device Defender security profile. For API reference, see [CreateSecurityProfile](https://docs.aws.amazon.com/iot/latest/apireference/API_CreateSecurityProfile.html) and for general information, see [Detect](https://docs.aws.amazon.com/iot/latest/developerguide/device-defender-detect.html) .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-securityprofile.html}
+ */
 export type IoTSecurityProfile = ResourceDefinitionWithAttributes<"AWS::IoT::SecurityProfile", IoTSecurityProfileProps, IoTSecurityProfileAttribs>;
 /**
  * Use the `AWS::IoT::SecurityProfile` resource to create a Device Defender security profile. For API reference, see [CreateSecurityProfile](https://docs.aws.amazon.com/iot/latest/apireference/API_CreateSecurityProfile.html) and for general information, see [Detect](https://docs.aws.amazon.com/iot/latest/developerguide/device-defender-detect.html) .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-securityprofile.html}
  */
 export type IoTSecurityProfileProps = {
     /**
      * A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's `behaviors` , but it's also retained for any metric specified here. Can be used with custom metrics; can't be used with dimensions.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-securityprofile.html#cfn-iot-securityprofile-additionalmetricstoretainv2}
      */
     AdditionalMetricsToRetainV2?: MetricToRetain[] | undefined;
     /**
      * Specifies the destinations to which alerts are sent. (Alerts are always sent to the console.) Alerts are generated when a device (thing) violates a behavior.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-securityprofile.html#cfn-iot-securityprofile-alerttargets}
      */
     AlertTargets?: Record<string, AlertTarget> | undefined;
     /**
      * Specifies the behaviors that, when violated by a device (thing), cause an alert.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-securityprofile.html#cfn-iot-securityprofile-behaviors}
      */
     Behaviors?: Behavior[] | undefined;
     /**
      * Specifies the MQTT topic and role ARN required for metric export.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-securityprofile.html#cfn-iot-securityprofile-metricsexportconfig}
      */
     MetricsExportConfig?: {
         /**
@@ -36,6 +45,7 @@ export type IoTSecurityProfileProps = {
     /**
      * A description of the security profile.
      * @maxLength 1000
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-securityprofile.html#cfn-iot-securityprofile-securityprofiledescription}
      */
     SecurityProfileDescription?: string | undefined;
     /**
@@ -43,51 +53,64 @@ export type IoTSecurityProfileProps = {
      * @minLength 1
      * @maxLength 128
      * @pattern [a-zA-Z0-9:_-]+
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-securityprofile.html#cfn-iot-securityprofile-securityprofilename}
      */
     SecurityProfileName?: string | undefined;
     /**
      * Metadata that can be used to manage the security profile.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-securityprofile.html#cfn-iot-securityprofile-tags}
      */
     Tags?: Tag[] | undefined;
     /**
      * The ARN of the target (thing group) to which the security profile is attached.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-securityprofile.html#cfn-iot-securityprofile-targetarns}
      */
     TargetArns?: string[] | undefined;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-securityprofile.html#aws-resource-iot-securityprofile-return-values}
+ */
 export type IoTSecurityProfileAttribs = {
     /**
      * The Amazon Resource Name (ARN) of the security profile.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-securityprofile.html#cfn-iot-securityprofile-securityprofilearn}
      */
     SecurityProfileArn: string;
 };
 /**
  * A structure containing the alert target ARN and the role ARN.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-securityprofile-alerttarget.html}
  */
 export type AlertTarget = {
     /**
      * The Amazon Resource Name (ARN) of the notification target to which alerts are sent.
      * @maxLength 2048
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-securityprofile-alerttarget.html#cfn-iot-securityprofile-alerttarget-alerttargetarn}
      */
     AlertTargetArn: string;
     /**
      * The ARN of the role that grants permission to send alerts to the notification target.
      * @minLength 20
      * @maxLength 2048
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-securityprofile-alerttarget.html#cfn-iot-securityprofile-alerttarget-rolearn}
      */
     RoleArn: string;
 };
 /**
  * A Device Defender security profile behavior.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-securityprofile-behavior.html}
  */
 export type Behavior = {
     /**
      * The criteria that determine if a device is behaving normally in regard to the `metric` .
      *
      * > In the AWS IoT console, you can choose to be sent an alert through Amazon SNS when AWS IoT Device Defender detects that a device is behaving anomalously.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-securityprofile-behavior.html#cfn-iot-securityprofile-behavior-criteria}
      */
     Criteria?: BehaviorCriteria | undefined;
     /**
      * Value indicates exporting metrics related to the behavior when it is true.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-securityprofile-behavior.html#cfn-iot-securityprofile-behavior-exportmetric}
      */
     ExportMetric?: boolean | undefined;
     /**
@@ -95,10 +118,12 @@ export type Behavior = {
      * @minLength 1
      * @maxLength 128
      * @pattern [a-zA-Z0-9:_-]+
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-securityprofile-behavior.html#cfn-iot-securityprofile-behavior-metric}
      */
     Metric?: string | undefined;
     /**
      * The dimension of the metric.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-securityprofile-behavior.html#cfn-iot-securityprofile-behavior-metricdimension}
      */
     MetricDimension?: MetricDimension | undefined;
     /**
@@ -106,15 +131,18 @@ export type Behavior = {
      * @minLength 1
      * @maxLength 128
      * @pattern [a-zA-Z0-9:_-]+
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-securityprofile-behavior.html#cfn-iot-securityprofile-behavior-name}
      */
     Name: string;
     /**
      * The alert status. If you set the value to `true` , alerts will be suppressed.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-securityprofile-behavior.html#cfn-iot-securityprofile-behavior-suppressalerts}
      */
     SuppressAlerts?: boolean | undefined;
 };
 /**
  * The criteria by which the behavior is determined to be normal.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-securityprofile-behaviorcriteria.html}
  */
 export type BehaviorCriteria = {
     /**
@@ -124,39 +152,47 @@ export type BehaviorCriteria = {
      * - `number-list` : `in-set` and `not-in-set`
      * - `ip-address-list` : `in-cidr-set` and `not-in-cidr-set`
      * - `number` : `less-than` , `less-than-equals` , `greater-than` , and `greater-than-equals`
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-securityprofile-behaviorcriteria.html#cfn-iot-securityprofile-behaviorcriteria-comparisonoperator}
      */
     ComparisonOperator?: "less-than" | "less-than-equals" | "greater-than" | "greater-than-equals" | "in-cidr-set" | "not-in-cidr-set" | "in-port-set" | "not-in-port-set" | "in-set" | "not-in-set" | undefined;
     /**
      * If a device is in violation of the behavior for the specified number of consecutive datapoints, an alarm occurs. If not specified, the default is 1.
      * @min 1
      * @max 10
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-securityprofile-behaviorcriteria.html#cfn-iot-securityprofile-behaviorcriteria-consecutivedatapointstoalarm}
      */
     ConsecutiveDatapointsToAlarm?: number | undefined;
     /**
      * If an alarm has occurred and the offending device is no longer in violation of the behavior for the specified number of consecutive datapoints, the alarm is cleared. If not specified, the default is 1.
      * @min 1
      * @max 10
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-securityprofile-behaviorcriteria.html#cfn-iot-securityprofile-behaviorcriteria-consecutivedatapointstoclear}
      */
     ConsecutiveDatapointsToClear?: number | undefined;
     /**
      * Use this to specify the time duration over which the behavior is evaluated, for those criteria that have a time dimension (for example, `NUM_MESSAGES_SENT` ). For a `statisticalThreshhold` metric comparison, measurements from all devices are accumulated over this time duration before being used to calculate percentiles, and later, measurements from an individual device are also accumulated over this time duration before being given a percentile rank. Cannot be used with list-based metric datatypes.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-securityprofile-behaviorcriteria.html#cfn-iot-securityprofile-behaviorcriteria-durationseconds}
      */
     DurationSeconds?: number | undefined;
     /**
      * The confidence level of the detection model.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-securityprofile-behaviorcriteria.html#cfn-iot-securityprofile-behaviorcriteria-mldetectionconfig}
      */
     MlDetectionConfig?: MachineLearningDetectionConfig | undefined;
     /**
      * A statistical ranking (percentile)that indicates a threshold value by which a behavior is determined to be in compliance or in violation of the behavior.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-securityprofile-behaviorcriteria.html#cfn-iot-securityprofile-behaviorcriteria-statisticalthreshold}
      */
     StatisticalThreshold?: StatisticalThreshold | undefined;
     /**
      * The value to be compared with the `metric` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-securityprofile-behaviorcriteria.html#cfn-iot-securityprofile-behaviorcriteria-value}
      */
     Value?: MetricValue | undefined;
 };
 /**
  * The `MachineLearningDetectionConfig` property type controls confidence of the machine learning model.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-securityprofile-machinelearningdetectionconfig.html}
  */
 export type MachineLearningDetectionConfig = {
     /**
@@ -165,11 +201,13 @@ export type MachineLearningDetectionConfig = {
      * There are three levels of confidence, `"high"` , `"medium"` , and `"low"` .
      *
      * The higher the confidence level, the lower the sensitivity, and the lower the alarm frequency will be.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-securityprofile-machinelearningdetectionconfig.html#cfn-iot-securityprofile-machinelearningdetectionconfig-confidencelevel}
      */
     ConfidenceLevel?: "LOW" | "MEDIUM" | "HIGH" | undefined;
 };
 /**
  * The dimension of the metric.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-securityprofile-metricdimension.html}
  */
 export type MetricDimension = {
     /**
@@ -177,19 +215,23 @@ export type MetricDimension = {
      * @minLength 1
      * @maxLength 128
      * @pattern [a-zA-Z0-9:_-]+
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-securityprofile-metricdimension.html#cfn-iot-securityprofile-metricdimension-dimensionname}
      */
     DimensionName: string;
     /**
      * Operators are constructs that perform logical operations. Valid values are `IN` and `NOT_IN` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-securityprofile-metricdimension.html#cfn-iot-securityprofile-metricdimension-operator}
      */
     Operator?: "IN" | "NOT_IN" | undefined;
 };
 /**
  * The metric you want to retain. Dimensions are optional.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-securityprofile-metrictoretain.html}
  */
 export type MetricToRetain = {
     /**
      * The value indicates exporting metrics related to the `MetricToRetain` when it's true.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-securityprofile-metrictoretain.html#cfn-iot-securityprofile-metrictoretain-exportmetric}
      */
     ExportMetric?: boolean | undefined;
     /**
@@ -197,49 +239,60 @@ export type MetricToRetain = {
      * @minLength 1
      * @maxLength 128
      * @pattern [a-zA-Z0-9:_-]+
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-securityprofile-metrictoretain.html#cfn-iot-securityprofile-metrictoretain-metric}
      */
     Metric: string;
     /**
      * The dimension of the metric.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-securityprofile-metrictoretain.html#cfn-iot-securityprofile-metrictoretain-metricdimension}
      */
     MetricDimension?: MetricDimension | undefined;
 };
 /**
  * The value to be compared with the `metric` .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-securityprofile-metricvalue.html}
  */
 export type MetricValue = {
     /**
      * If the `comparisonOperator` calls for a set of CIDRs, use this to specify that set to be compared with the `metric` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-securityprofile-metricvalue.html#cfn-iot-securityprofile-metricvalue-cidrs}
      */
     Cidrs?: string[] | undefined;
     /**
      * If the `comparisonOperator` calls for a numeric value, use this to specify that numeric value to be compared with the `metric` .
      * @min 0
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-securityprofile-metricvalue.html#cfn-iot-securityprofile-metricvalue-count}
      */
     Count?: string | undefined;
     /**
      * The numeric values of a metric.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-securityprofile-metricvalue.html#cfn-iot-securityprofile-metricvalue-number}
      */
     Number?: number | undefined;
     /**
      * The numeric value of a metric.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-securityprofile-metricvalue.html#cfn-iot-securityprofile-metricvalue-numbers}
      */
     Numbers?: number[] | undefined;
     /**
      * If the `comparisonOperator` calls for a set of ports, use this to specify that set to be compared with the `metric` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-securityprofile-metricvalue.html#cfn-iot-securityprofile-metricvalue-ports}
      */
     Ports?: number[] | undefined;
     /**
      * The string values of a metric.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-securityprofile-metricvalue.html#cfn-iot-securityprofile-metricvalue-strings}
      */
     Strings?: string[] | undefined;
 };
 /**
  * A statistical ranking (percentile) that indicates a threshold value by which a behavior is determined to be in compliance or in violation of the behavior.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-securityprofile-statisticalthreshold.html}
  */
 export type StatisticalThreshold = {
     /**
      * The percentile that resolves to a threshold value by which compliance with a behavior is determined. Metrics are collected over the specified period ( `durationSeconds` ) from all reporting devices in your account and statistical ranks are calculated. Then, the measurements from a device are collected over the same period. If the accumulated measurements from the device fall above or below ( `comparisonOperator` ) the value associated with the percentile specified, then the device is considered to be in compliance with the behavior, otherwise a violation occurs.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-securityprofile-statisticalthreshold.html#cfn-iot-securityprofile-statisticalthreshold-statistic}
      */
     Statistic?: "Average" | "p0" | "p0.1" | "p0.01" | "p1" | "p10" | "p50" | "p90" | "p99" | "p99.9" | "p99.99" | "p100" | undefined;
 };

package/out/exports/resources.generated/aws-iot-softwarepackage.d.ts

@@ -1,9 +1,16 @@
 import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+/**
+ * Use the `AWS::IoT::SoftwarePackage` resource to create a software package.
+ *
+ * For information about working with software packages, see [AWS IoT Device Management Software Package Catalog](https://docs.aws.amazon.com/iot/latest/developerguide/software-package-catalog.html) and [Creating a software package and package version](https://docs.aws.amazon.com/iot/latest/developerguide/creating-package-and-version.html) in the *AWS IoT Developer Guide* . See also, [CreatePackage](https://docs.aws.amazon.com/iot/latest/apireference/API_CreatePackage.html) in the *API Guide* .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-softwarepackage.html}
+ */
 export type IoTSoftwarePackage = ResourceDefinitionWithAttributes<"AWS::IoT::SoftwarePackage", IoTSoftwarePackageProps, IoTSoftwarePackageAttribs>;
 /**
  * Use the `AWS::IoT::SoftwarePackage` resource to create a software package.
  *
  * For information about working with software packages, see [AWS IoT Device Management Software Package Catalog](https://docs.aws.amazon.com/iot/latest/developerguide/software-package-catalog.html) and [Creating a software package and package version](https://docs.aws.amazon.com/iot/latest/developerguide/creating-package-and-version.html) in the *AWS IoT Developer Guide* . See also, [CreatePackage](https://docs.aws.amazon.com/iot/latest/apireference/API_CreatePackage.html) in the *API Guide* .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-softwarepackage.html}
  */
 export type IoTSoftwarePackageProps = {
     /**
@@ -11,6 +18,7 @@ export type IoTSoftwarePackageProps = {
      * @minLength 0
      * @maxLength 1024
      * @pattern ^[^\p{C}]+$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-softwarepackage.html#cfn-iot-softwarepackage-description}
      */
     Description?: string | undefined;
     /**
@@ -18,16 +26,22 @@ export type IoTSoftwarePackageProps = {
      * @minLength 1
      * @maxLength 128
      * @pattern ^[a-zA-Z0-9-_.]+$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-softwarepackage.html#cfn-iot-softwarepackage-packagename}
      */
     PackageName?: string | undefined;
     /**
      * Metadata that can be used to manage the package.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-softwarepackage.html#cfn-iot-softwarepackage-tags}
      */
     Tags?: Tag[] | undefined;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-softwarepackage.html#aws-resource-iot-softwarepackage-return-values}
+ */
 export type IoTSoftwarePackageAttribs = {
     /**
      * The Amazon Resource Name (ARN) for the package.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-softwarepackage.html#cfn-iot-softwarepackage-packagearn}
      */
     PackageArn: string;
 };

package/out/exports/resources.generated/aws-iot-softwarepackageversion.d.ts

@@ -1,4 +1,14 @@
 import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+/**
+ * Use the `AWS::IoT::SoftwarePackageVersion` resource to create a software package version.
+ *
+ * For information about working with software package versions, see [AWS IoT Device Management Software Package Catalog](https://docs.aws.amazon.com/iot/latest/developerguide/software-package-catalog.html) and [Creating a software package and package version](https://docs.aws.amazon.com/iot/latest/developerguide/creating-package-and-version.html) in the *AWS IoT Developer Guide* . See also, [CreatePackageVersion](https://docs.aws.amazon.com/iot/latest/apireference/API_CreatePackageVersion.html) in the *API Guide* .
+ *
+ * > The associated software package must exist before the package version is created. If you create a software package and package version in the same CloudFormation template, set the software package as a [dependency](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html) of the package version. If they are created out of sequence, you will receive an error.
+ * >
+ * > Package versions and created in a `draft` state, for more information, see [Package version lifecycle](https://docs.aws.amazon.com/iot/latest/developerguide/preparing-to-use-software-package-catalog.html#package-version-lifecycle) . To change the package version state after it’s created, use the [UpdatePackageVersionAPI](https://docs.aws.amazon.com/iot/latest/apireference/API_UpdatePackageVersion.html) command.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-softwarepackageversion.html}
+ */
 export type IoTSoftwarePackageVersion = ResourceDefinitionWithAttributes<"AWS::IoT::SoftwarePackageVersion", IoTSoftwarePackageVersionProps, IoTSoftwarePackageVersionAttribs>;
 /**
  * Use the `AWS::IoT::SoftwarePackageVersion` resource to create a software package version.
@@ -8,16 +18,19 @@ export type IoTSoftwarePackageVersion = ResourceDefinitionWithAttributes<"AWS::I
  * > The associated software package must exist before the package version is created. If you create a software package and package version in the same CloudFormation template, set the software package as a [dependency](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html) of the package version. If they are created out of sequence, you will receive an error.
  * >
  * > Package versions and created in a `draft` state, for more information, see [Package version lifecycle](https://docs.aws.amazon.com/iot/latest/developerguide/preparing-to-use-software-package-catalog.html#package-version-lifecycle) . To change the package version state after it’s created, use the [UpdatePackageVersionAPI](https://docs.aws.amazon.com/iot/latest/apireference/API_UpdatePackageVersion.html) command.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-softwarepackageversion.html}
  */
 export type IoTSoftwarePackageVersionProps = {
     /**
      * The artifact location of the package version
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-softwarepackageversion.html#cfn-iot-softwarepackageversion-artifact}
      */
     Artifact?: PackageVersionArtifact | undefined;
     /**
      * Metadata that can be used to define a package version’s configuration. For example, the S3 file location, configuration options that are being sent to the device or fleet.
      *
      * The combined size of all the attributes on a package version is limited to 3KB.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-softwarepackageversion.html#cfn-iot-softwarepackageversion-attributes}
      */
     Attributes?: Record<string, string> | undefined;
     /**
@@ -25,6 +38,7 @@ export type IoTSoftwarePackageVersionProps = {
      * @minLength 0
      * @maxLength 1024
      * @pattern ^[^\p{C}]+$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-softwarepackageversion.html#cfn-iot-softwarepackageversion-description}
      */
     Description?: string | undefined;
     /**
@@ -32,18 +46,22 @@ export type IoTSoftwarePackageVersionProps = {
      * @minLength 1
      * @maxLength 128
      * @pattern ^[a-zA-Z0-9-_.]+$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-softwarepackageversion.html#cfn-iot-softwarepackageversion-packagename}
      */
     PackageName: string;
     /**
      * The inline json job document associated with a software package version
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-softwarepackageversion.html#cfn-iot-softwarepackageversion-recipe}
      */
     Recipe?: string | undefined;
     /**
      * The sbom zip archive location of the package version
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-softwarepackageversion.html#cfn-iot-softwarepackageversion-sbom}
      */
     Sbom?: Sbom | undefined;
     /**
      * Metadata that can be used to manage the package version.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-softwarepackageversion.html#cfn-iot-softwarepackageversion-tags}
      */
     Tags?: Tag[] | undefined;
     /**
@@ -51,68 +69,88 @@ export type IoTSoftwarePackageVersionProps = {
      * @minLength 1
      * @maxLength 64
      * @pattern ^[a-zA-Z0-9-_.]+$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-softwarepackageversion.html#cfn-iot-softwarepackageversion-versionname}
      */
     VersionName?: string | undefined;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-softwarepackageversion.html#aws-resource-iot-softwarepackageversion-return-values}
+ */
 export type IoTSoftwarePackageVersionAttribs = {
     /**
      * Error reason for a package version failure during creation or update.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-softwarepackageversion.html#cfn-iot-softwarepackageversion-errorreason}
      */
     ErrorReason: string;
     /**
      * The Amazon Resource Name (ARN) for the package.
      * @pattern ^arn:[!-~]+$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-softwarepackageversion.html#cfn-iot-softwarepackageversion-packageversionarn}
      */
     PackageVersionArn: string;
     /**
      * The validation status of the Sbom file
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-softwarepackageversion.html#cfn-iot-softwarepackageversion-sbomvalidationstatus}
      */
     SbomValidationStatus: SbomValidationStatus;
     /**
      * The status of the package version. For more information, see [Package version lifecycle](https://docs.aws.amazon.com/iot/latest/developerguide/preparing-to-use-software-package-catalog.html#package-version-lifecycle) .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-softwarepackageversion.html#cfn-iot-softwarepackageversion-status}
      */
     Status: PackageVersionStatus;
 };
 /**
  * The artifact location of the package version
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-softwarepackageversion-packageversionartifact.html}
  */
 export type PackageVersionArtifact = {
     /**
      * The Amazon S3 location
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-softwarepackageversion-packageversionartifact.html#cfn-iot-softwarepackageversion-packageversionartifact-s3location}
      */
     S3Location: S3Location;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-softwarepackageversion-packageversionstatus.html}
+ */
 export type PackageVersionStatus = "DRAFT" | "PUBLISHED" | "DEPRECATED";
 /**
  * The Amazon S3 location
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-softwarepackageversion-s3location.html}
  */
 export type S3Location = {
     /**
      * The S3 bucket
      * @minLength 1
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-softwarepackageversion-s3location.html#cfn-iot-softwarepackageversion-s3location-bucket}
      */
     Bucket: string;
     /**
      * The S3 key
      * @minLength 1
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-softwarepackageversion-s3location.html#cfn-iot-softwarepackageversion-s3location-key}
      */
     Key: string;
     /**
      * The S3 version
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-softwarepackageversion-s3location.html#cfn-iot-softwarepackageversion-s3location-version}
      */
     Version: string;
 };
 /**
  * The sbom zip archive location of the package version
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-softwarepackageversion-sbom.html}
  */
 export type Sbom = {
     /**
      * The Amazon S3 location
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-softwarepackageversion-sbom.html#cfn-iot-softwarepackageversion-sbom-s3location}
      */
     S3Location: S3Location;
 };
 /**
  * The validation status of the Sbom file
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-softwarepackageversion-sbomvalidationstatus.html}
  */
 export type SbomValidationStatus = "IN_PROGRESS" | "FAILED" | "SUCCEEDED" | "";
 //# sourceMappingURL=aws-iot-softwarepackageversion.d.ts.map

package/out/exports/resources.generated/aws-iot-thing.d.ts

@@ -1,13 +1,21 @@
 import type { ResourceDefinitionWithAttributes } from "../main.ts";
+/**
+ * Use the `AWS::IoT::Thing` resource to declare an AWS IoT thing.
+ *
+ * For information about working with things, see [How AWS IoT Works](https://docs.aws.amazon.com/iot/latest/developerguide/aws-iot-how-it-works.html) and [Device Registry for AWS IoT](https://docs.aws.amazon.com/iot/latest/developerguide/thing-registry.html) in the *AWS IoT Developer Guide* .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-thing.html}
+ */
 export type IoTThing = ResourceDefinitionWithAttributes<"AWS::IoT::Thing", IoTThingProps, IoTThingAttribs>;
 /**
  * Use the `AWS::IoT::Thing` resource to declare an AWS IoT thing.
  *
  * For information about working with things, see [How AWS IoT Works](https://docs.aws.amazon.com/iot/latest/developerguide/aws-iot-how-it-works.html) and [Device Registry for AWS IoT](https://docs.aws.amazon.com/iot/latest/developerguide/thing-registry.html) in the *AWS IoT Developer Guide* .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-thing.html}
  */
 export type IoTThingProps = {
     /**
      * A string that contains up to three key value pairs. Maximum length of 800. Duplicates not allowed.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-thing.html#cfn-iot-thing-attributepayload}
      */
     AttributePayload?: AttributePayload | undefined;
     /**
@@ -17,27 +25,35 @@ export type IoTThingProps = {
      * @minLength 1
      * @maxLength 128
      * @pattern [a-zA-Z0-9:_-]+
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-thing.html#cfn-iot-thing-thingname}
      */
     ThingName?: string | undefined;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-thing.html#aws-resource-iot-thing-return-values}
+ */
 export type IoTThingAttribs = {
     /**
      * The Amazon Resource Name (ARN) of the AWS IoT thing, such as `arn:aws:iot:us-east-2:123456789012:thing/MyThing` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-thing.html#cfn-iot-thing-arn}
      */
     Arn: string;
     /**
      * The Id of this thing.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-thing.html#cfn-iot-thing-id}
      */
     Id: string;
 };
 /**
  * The AttributePayload property specifies up to three attributes for an AWS IoT as key-value pairs. AttributePayload is a property of the [AWS::IoT::Thing](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-thing.html) resource.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-thing-attributepayload.html}
  */
 export type AttributePayload = {
     /**
      * A JSON string containing up to three key-value pair in JSON format. For example:
      *
      * `{\"attributes\":{\"string1\":\"string2\"}}`
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-thing-attributepayload.html#cfn-iot-thing-attributepayload-attributes}
      */
     Attributes?: Record<string, string> | undefined;
 };

package/out/exports/resources.generated/aws-iot-thinggroup.d.ts

@@ -1,4 +1,12 @@
 import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+/**
+ * Creates a new thing group. A dynamic thing group is created if the resource template contains the `QueryString` attribute. A dynamic thing group will not contain the `ParentGroupName` attribute. A static thing group and dynamic thing group can't be converted to each other via the addition or removal of the `QueryString` attribute.
+ *
+ * > This is a control plane operation. See [Authorization](https://docs.aws.amazon.com/iot/latest/developerguide/iot-authorization.html) for information about authorizing control plane actions.
+ *
+ * Requires permission to access the [CreateThingGroup](https://docs.aws.amazon.com//service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-thinggroup.html}
+ */
 export type IoTThingGroup = ResourceDefinitionWithAttributes<"AWS::IoT::ThingGroup", IoTThingGroupProps, IoTThingGroupAttribs>;
 /**
  * Creates a new thing group. A dynamic thing group is created if the resource template contains the `QueryString` attribute. A dynamic thing group will not contain the `ParentGroupName` attribute. A static thing group and dynamic thing group can't be converted to each other via the addition or removal of the `QueryString` attribute.
@@ -6,6 +14,7 @@ export type IoTThingGroup = ResourceDefinitionWithAttributes<"AWS::IoT::ThingGro
  * > This is a control plane operation. See [Authorization](https://docs.aws.amazon.com/iot/latest/developerguide/iot-authorization.html) for information about authorizing control plane actions.
  *
  * Requires permission to access the [CreateThingGroup](https://docs.aws.amazon.com//service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-thinggroup.html}
  */
 export type IoTThingGroupProps = {
     /**
@@ -15,6 +24,7 @@ export type IoTThingGroupProps = {
      * @minLength 1
      * @maxLength 128
      * @pattern [a-zA-Z0-9:_-]+
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-thinggroup.html#cfn-iot-thinggroup-parentgroupname}
      */
     ParentGroupName?: string | undefined;
     /**
@@ -23,10 +33,12 @@ export type IoTThingGroupProps = {
      * The `queryString` attribute *is* required for `CreateDynamicThingGroup` . The `queryString` attribute *is not* required for `CreateThingGroup` .
      * @minLength 1
      * @maxLength 1000
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-thinggroup.html#cfn-iot-thinggroup-querystring}
      */
     QueryString?: string | undefined;
     /**
      * Metadata which can be used to manage the thing group or dynamic thing group.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-thinggroup.html#cfn-iot-thinggroup-tags}
      */
     Tags?: Tag[] | undefined;
     /**
@@ -34,10 +46,12 @@ export type IoTThingGroupProps = {
      * @minLength 1
      * @maxLength 128
      * @pattern [a-zA-Z0-9:_-]+
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-thinggroup.html#cfn-iot-thinggroup-thinggroupname}
      */
     ThingGroupName?: string | undefined;
     /**
      * Thing group properties.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-thinggroup.html#cfn-iot-thinggroup-thinggroupproperties}
      */
     ThingGroupProperties?: {
         AttributePayload?: AttributePayload | undefined;
@@ -48,24 +62,31 @@ export type IoTThingGroupProps = {
         ThingGroupDescription?: string | undefined;
     } | undefined;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-thinggroup.html#aws-resource-iot-thinggroup-return-values}
+ */
 export type IoTThingGroupAttribs = {
     /**
      * The thing group ARN.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-thinggroup.html#cfn-iot-thinggroup-arn}
      */
     Arn: string;
     /**
      * The thing group ID.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iot-thinggroup.html#cfn-iot-thinggroup-id}
      */
     Id: string;
 };
 /**
  * The attribute payload.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-thinggroup-attributepayload.html}
  */
 export type AttributePayload = {
     /**
      * A JSON string containing up to three key-value pair in JSON format. For example:
      *
      * `{\"attributes\":{\"string1\":\"string2\"}}`
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-thinggroup-attributepayload.html#cfn-iot-thinggroup-attributepayload-attributes}
      */
     Attributes?: Record<string, string> | undefined;
 };