@propulsionworks/cloudformation 0.1.0 → 0.1.2

package/out/exports/resources.generated/aws-iotfleetwise-signalcatalog.d.ts

@@ -1,9 +1,16 @@
 import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+/**
+ * Creates a collection of standardized signals that can be reused to create vehicle models.
+ *
+ * For more information, see [Signal catalogs](https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/signal-catalogs.html) in the *AWS IoT FleetWise Developer Guide* .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-signalcatalog.html}
+ */
 export type IoTFleetWiseSignalCatalog = ResourceDefinitionWithAttributes<"AWS::IoTFleetWise::SignalCatalog", IoTFleetWiseSignalCatalogProps, IoTFleetWiseSignalCatalogAttribs>;
 /**
  * Creates a collection of standardized signals that can be reused to create vehicle models.
  *
  * For more information, see [Signal catalogs](https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/signal-catalogs.html) in the *AWS IoT FleetWise Developer Guide* .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-signalcatalog.html}
  */
 export type IoTFleetWiseSignalCatalogProps = {
     /**
@@ -11,6 +18,7 @@ export type IoTFleetWiseSignalCatalogProps = {
      * @minLength 1
      * @maxLength 2048
      * @pattern ^[^\u0000-\u001F\u007F]+$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-signalcatalog.html#cfn-iotfleetwise-signalcatalog-description}
      */
     Description?: string | undefined;
     /**
@@ -18,50 +26,64 @@ export type IoTFleetWiseSignalCatalogProps = {
      * @minLength 1
      * @maxLength 100
      * @pattern ^[a-zA-Z\d\-_:]+$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-signalcatalog.html#cfn-iotfleetwise-signalcatalog-name}
      */
     Name?: string | undefined;
     /**
      * A list of information about nodes, which are a general abstraction of signals.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-signalcatalog.html#cfn-iotfleetwise-signalcatalog-nodes}
      */
     Nodes?: Node[] | undefined;
     /**
      * Metadata that can be used to manage the signal catalog.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-signalcatalog.html#cfn-iotfleetwise-signalcatalog-tags}
      */
     Tags?: Tag[] | undefined;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-signalcatalog.html#aws-resource-iotfleetwise-signalcatalog-return-values}
+ */
 export type IoTFleetWiseSignalCatalogAttribs = {
     /**
      * The Amazon Resource Name (ARN) of the signal catalog.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-signalcatalog.html#cfn-iotfleetwise-signalcatalog-arn}
      */
     Arn: string;
     /**
      * The time the signal catalog was created in seconds since epoch (January 1, 1970 at midnight UTC time).
      * @format date-time
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-signalcatalog.html#cfn-iotfleetwise-signalcatalog-creationtime}
      */
     CreationTime: string;
     /**
      * The time the signal catalog was last updated in seconds since epoch (January 1, 1970 at midnight UTC time).
      * @format date-time
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-signalcatalog.html#cfn-iotfleetwise-signalcatalog-lastmodificationtime}
      */
     LastModificationTime: string;
     /**
      * The total number of nodes in a vehicle network that represent actuators.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-nodecounts.html#cfn-iotfleetwise-signalcatalog-nodecounts-totalactuators}
      */
     "NodeCounts.TotalActuators": number;
     /**
      * The total number of nodes in a vehicle network that represent attributes.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-nodecounts.html#cfn-iotfleetwise-signalcatalog-nodecounts-totalattributes}
      */
     "NodeCounts.TotalAttributes": number;
     /**
      * The total number of nodes in a vehicle network that represent branches.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-nodecounts.html#cfn-iotfleetwise-signalcatalog-nodecounts-totalbranches}
      */
     "NodeCounts.TotalBranches": number;
     /**
      * The total number of nodes in a vehicle network.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-nodecounts.html#cfn-iotfleetwise-signalcatalog-nodecounts-totalnodes}
      */
     "NodeCounts.TotalNodes": number;
     /**
      * The total number of nodes in a vehicle network that represent sensors.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-nodecounts.html#cfn-iotfleetwise-signalcatalog-nodecounts-totalsensors}
      */
     "NodeCounts.TotalSensors": number;
 };
@@ -69,18 +91,22 @@ export type IoTFleetWiseSignalCatalogAttribs = {
  * A signal that represents a vehicle device such as the engine, heater, and door locks. Data from an actuator reports the state of a certain vehicle device.
  *
  * > Updating actuator data can change the state of a device. For example, you can turn on or off the heater by updating its actuator data.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-actuator.html}
  */
 export type Actuator = {
     /**
      * A list of possible values an actuator can take.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-actuator.html#cfn-iotfleetwise-signalcatalog-actuator-allowedvalues}
      */
     AllowedValues?: string[] | undefined;
     /**
      * A specified value for the actuator.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-actuator.html#cfn-iotfleetwise-signalcatalog-actuator-assignedvalue}
      */
     AssignedValue?: string | undefined;
     /**
      * The specified data type of the actuator.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-actuator.html#cfn-iotfleetwise-signalcatalog-actuator-datatype}
      */
     DataType: NodeDataType;
     /**
@@ -88,43 +114,53 @@ export type Actuator = {
      * @minLength 1
      * @maxLength 2048
      * @pattern ^[^\u0000-\u001F\u007F]+$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-actuator.html#cfn-iotfleetwise-signalcatalog-actuator-description}
      */
     Description?: string | undefined;
     /**
      * The fully qualified name of the actuator. For example, the fully qualified name of an actuator might be `Vehicle.Front.Left.Door.Lock` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-actuator.html#cfn-iotfleetwise-signalcatalog-actuator-fullyqualifiedname}
      */
     FullyQualifiedName: string;
     /**
      * The specified possible maximum value of an actuator.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-actuator.html#cfn-iotfleetwise-signalcatalog-actuator-max}
      */
     Max?: number | undefined;
     /**
      * The specified possible minimum value of an actuator.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-actuator.html#cfn-iotfleetwise-signalcatalog-actuator-min}
      */
     Min?: number | undefined;
     /**
      * The scientific unit for the actuator.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-actuator.html#cfn-iotfleetwise-signalcatalog-actuator-unit}
      */
     Unit?: string | undefined;
 };
 /**
  * A signal that represents static information about the vehicle, such as engine type or manufacturing date.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-attribute.html}
  */
 export type Attribute = {
     /**
      * A list of possible values an attribute can be assigned.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-attribute.html#cfn-iotfleetwise-signalcatalog-attribute-allowedvalues}
      */
     AllowedValues?: string[] | undefined;
     /**
      * A specified value for the attribute.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-attribute.html#cfn-iotfleetwise-signalcatalog-attribute-assignedvalue}
      */
     AssignedValue?: string | undefined;
     /**
      * The specified data type of the attribute.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-attribute.html#cfn-iotfleetwise-signalcatalog-attribute-datatype}
      */
     DataType: NodeDataType;
     /**
      * The default value of the attribute.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-attribute.html#cfn-iotfleetwise-signalcatalog-attribute-defaultvalue}
      */
     DefaultValue?: string | undefined;
     /**
@@ -132,27 +168,33 @@ export type Attribute = {
      * @minLength 1
      * @maxLength 2048
      * @pattern ^[^\u0000-\u001F\u007F]+$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-attribute.html#cfn-iotfleetwise-signalcatalog-attribute-description}
      */
     Description?: string | undefined;
     /**
      * The fully qualified name of the attribute. For example, the fully qualified name of an attribute might be `Vehicle.Body.Engine.Type` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-attribute.html#cfn-iotfleetwise-signalcatalog-attribute-fullyqualifiedname}
      */
     FullyQualifiedName: string;
     /**
      * The specified possible maximum value of the attribute.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-attribute.html#cfn-iotfleetwise-signalcatalog-attribute-max}
      */
     Max?: number | undefined;
     /**
      * The specified possible minimum value of the attribute.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-attribute.html#cfn-iotfleetwise-signalcatalog-attribute-min}
      */
     Min?: number | undefined;
     /**
      * The scientific unit for the attribute.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-attribute.html#cfn-iotfleetwise-signalcatalog-attribute-unit}
      */
     Unit?: string | undefined;
 };
 /**
  * A group of signals that are defined in a hierarchical structure.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-branch.html}
  */
 export type Branch = {
     /**
@@ -160,15 +202,18 @@ export type Branch = {
      * @minLength 1
      * @maxLength 2048
      * @pattern ^[^\u0000-\u001F\u007F]+$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-branch.html#cfn-iotfleetwise-signalcatalog-branch-description}
      */
     Description?: string | undefined;
     /**
      * The fully qualified name of the branch. For example, the fully qualified name of a branch might be `Vehicle.Body.Engine` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-branch.html#cfn-iotfleetwise-signalcatalog-branch-fullyqualifiedname}
      */
     FullyQualifiedName: string;
 };
 /**
  * A general abstraction of a signal. A node can be specified as an actuator, attribute, branch, or sensor.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-node.html}
  */
 export type Node = {
     Branch?: Branch | undefined;
@@ -179,19 +224,25 @@ export type Node = {
 } | {
     Attribute?: Attribute | undefined;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-nodedatatype.html}
+ */
 export type NodeDataType = "INT8" | "UINT8" | "INT16" | "UINT16" | "INT32" | "UINT32" | "INT64" | "UINT64" | "BOOLEAN" | "FLOAT" | "DOUBLE" | "STRING" | "UNIX_TIMESTAMP" | "INT8_ARRAY" | "UINT8_ARRAY" | "INT16_ARRAY" | "UINT16_ARRAY" | "INT32_ARRAY" | "UINT32_ARRAY" | "INT64_ARRAY" | "UINT64_ARRAY" | "BOOLEAN_ARRAY" | "FLOAT_ARRAY" | "DOUBLE_ARRAY" | "STRING_ARRAY" | "UNIX_TIMESTAMP_ARRAY" | "UNKNOWN";
 /**
  * An input component that reports the environmental condition of a vehicle.
  *
  * > You can collect data about fluid levels, temperatures, vibrations, or battery voltage from sensors.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-sensor.html}
  */
 export type Sensor = {
     /**
      * A list of possible values a sensor can take.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-sensor.html#cfn-iotfleetwise-signalcatalog-sensor-allowedvalues}
      */
     AllowedValues?: string[] | undefined;
     /**
      * The specified data type of the sensor.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-sensor.html#cfn-iotfleetwise-signalcatalog-sensor-datatype}
      */
     DataType: NodeDataType;
     /**
@@ -199,22 +250,27 @@ export type Sensor = {
      * @minLength 1
      * @maxLength 2048
      * @pattern ^[^\u0000-\u001F\u007F]+$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-sensor.html#cfn-iotfleetwise-signalcatalog-sensor-description}
      */
     Description?: string | undefined;
     /**
      * The fully qualified name of the sensor. For example, the fully qualified name of a sensor might be `Vehicle.Body.Engine.Battery` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-sensor.html#cfn-iotfleetwise-signalcatalog-sensor-fullyqualifiedname}
      */
     FullyQualifiedName: string;
     /**
      * The specified possible maximum value of the sensor.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-sensor.html#cfn-iotfleetwise-signalcatalog-sensor-max}
      */
     Max?: number | undefined;
     /**
      * The specified possible minimum value of the sensor.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-sensor.html#cfn-iotfleetwise-signalcatalog-sensor-min}
      */
     Min?: number | undefined;
     /**
      * The scientific unit of measurement for data collected by the sensor.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-sensor.html#cfn-iotfleetwise-signalcatalog-sensor-unit}
      */
     Unit?: string | undefined;
 };

package/out/exports/resources.generated/aws-iotfleetwise-statetemplate.d.ts

@@ -1,4 +1,12 @@
 import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+/**
+ * Creates a mechanism for vehicle owners to track the state of their vehicles. State templates determine which signal updates the vehicle sends to the cloud.
+ *
+ * For more information, see [State templates](https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/state-templates.html) in the *AWS IoT FleetWise Developer Guide* .
+ *
+ * > Access to certain AWS IoT FleetWise features is currently gated. For more information, see [AWS Region and feature availability](https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/fleetwise-regions.html) in the *AWS IoT FleetWise Developer Guide* .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-statetemplate.html}
+ */
 export type IoTFleetWiseStateTemplate = ResourceDefinitionWithAttributes<"AWS::IoTFleetWise::StateTemplate", IoTFleetWiseStateTemplateProps, IoTFleetWiseStateTemplateAttribs>;
 /**
  * Creates a mechanism for vehicle owners to track the state of their vehicles. State templates determine which signal updates the vehicle sends to the cloud.
@@ -6,10 +14,12 @@ export type IoTFleetWiseStateTemplate = ResourceDefinitionWithAttributes<"AWS::I
  * For more information, see [State templates](https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/state-templates.html) in the *AWS IoT FleetWise Developer Guide* .
  *
  * > Access to certain AWS IoT FleetWise features is currently gated. For more information, see [AWS Region and feature availability](https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/fleetwise-regions.html) in the *AWS IoT FleetWise Developer Guide* .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-statetemplate.html}
  */
 export type IoTFleetWiseStateTemplateProps = {
     /**
      * A list of vehicle attributes associated with the payload published on the state template's MQTT topic.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-statetemplate.html#cfn-iotfleetwise-statetemplate-dataextradimensions}
      */
     DataExtraDimensions?: string[] | undefined;
     /**
@@ -17,10 +27,12 @@ export type IoTFleetWiseStateTemplateProps = {
      * @minLength 1
      * @maxLength 2048
      * @pattern ^[^\u0000-\u001F\u007F]+$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-statetemplate.html#cfn-iotfleetwise-statetemplate-description}
      */
     Description?: string | undefined;
     /**
      * A list of vehicle attributes to associate with the user properties of the messages published on the state template's MQTT topic. For example, if you add `Vehicle.Attributes.Make` and `Vehicle.Attributes.Model` attributes, these attributes are included as user properties with the MQTT message.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-statetemplate.html#cfn-iotfleetwise-statetemplate-metadataextradimensions}
      */
     MetadataExtraDimensions?: string[] | undefined;
     /**
@@ -28,29 +40,38 @@ export type IoTFleetWiseStateTemplateProps = {
      * @minLength 1
      * @maxLength 100
      * @pattern ^[a-zA-Z\d\-_:]+$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-statetemplate.html#cfn-iotfleetwise-statetemplate-name}
      */
     Name: string;
     /**
      * The Amazon Resource Name (ARN) of the signal catalog associated with the state template.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-statetemplate.html#cfn-iotfleetwise-statetemplate-signalcatalogarn}
      */
     SignalCatalogArn: string;
     /**
      * A list of signals from which data is collected. The state template properties contain the fully qualified names of the signals.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-statetemplate.html#cfn-iotfleetwise-statetemplate-statetemplateproperties}
      */
     StateTemplateProperties: string[];
     /**
      * Metadata that can be used to manage the state template.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-statetemplate.html#cfn-iotfleetwise-statetemplate-tags}
      */
     Tags?: Tag[] | undefined;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-statetemplate.html#aws-resource-iotfleetwise-statetemplate-return-values}
+ */
 export type IoTFleetWiseStateTemplateAttribs = {
     /**
      * The Amazon Resource Name (ARN) of the state template.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-statetemplate.html#cfn-iotfleetwise-statetemplate-arn}
      */
     Arn: string;
     /**
      * The time the state template was created, in seconds since epoch (January 1, 1970 at midnight UTC time).
      * @format date-time
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-statetemplate.html#cfn-iotfleetwise-statetemplate-creationtime}
      */
     CreationTime: string;
     /**
@@ -58,11 +79,13 @@ export type IoTFleetWiseStateTemplateAttribs = {
      * @minLength 26
      * @maxLength 26
      * @pattern ^[A-Z0-9]+$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-statetemplate.html#cfn-iotfleetwise-statetemplate-id}
      */
     Id: string;
     /**
      * The time the state template was last updated, in seconds since epoch (January 1, 1970 at midnight UTC time).
      * @format date-time
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-statetemplate.html#cfn-iotfleetwise-statetemplate-lastmodificationtime}
      */
     LastModificationTime: string;
 };

package/out/exports/resources.generated/aws-iotfleetwise-vehicle.d.ts

@@ -1,4 +1,12 @@
 import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+/**
+ * Creates a vehicle, which is an instance of a vehicle model (model manifest). Vehicles created from the same vehicle model consist of the same signals inherited from the vehicle model.
+ *
+ * > If you have an existing AWS IoT thing, you can use AWS IoT FleetWise to create a vehicle and collect data from your thing.
+ *
+ * For more information, see [Vehicles](https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/vehicles.html) in the *AWS IoT FleetWise Developer Guide* .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-vehicle.html}
+ */
 export type IoTFleetWiseVehicle = ResourceDefinitionWithAttributes<"AWS::IoTFleetWise::Vehicle", IoTFleetWiseVehicleProps, IoTFleetWiseVehicleAttribs>;
 /**
  * Creates a vehicle, which is an instance of a vehicle model (model manifest). Vehicles created from the same vehicle model consist of the same signals inherited from the vehicle model.
@@ -6,22 +14,27 @@ export type IoTFleetWiseVehicle = ResourceDefinitionWithAttributes<"AWS::IoTFlee
  * > If you have an existing AWS IoT thing, you can use AWS IoT FleetWise to create a vehicle and collect data from your thing.
  *
  * For more information, see [Vehicles](https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/vehicles.html) in the *AWS IoT FleetWise Developer Guide* .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-vehicle.html}
  */
 export type IoTFleetWiseVehicleProps = {
     /**
      * An option to create a new AWS IoT thing when creating a vehicle, or to validate an existing thing as a vehicle.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-vehicle.html#cfn-iotfleetwise-vehicle-associationbehavior}
      */
     AssociationBehavior?: VehicleAssociationBehavior | undefined;
     /**
      * Static information about a vehicle in a key-value pair. For example: `"engine Type"` : `"v6"`
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-vehicle.html#cfn-iotfleetwise-vehicle-attributes}
      */
     Attributes?: Record<string, string> | undefined;
     /**
      * The Amazon Resource Name (ARN) of a decoder manifest associated with the vehicle to create.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-vehicle.html#cfn-iotfleetwise-vehicle-decodermanifestarn}
      */
     DecoderManifestArn: string;
     /**
      * The Amazon Resource Name (ARN) of the vehicle model (model manifest) to create the vehicle from.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-vehicle.html#cfn-iotfleetwise-vehicle-modelmanifestarn}
      */
     ModelManifestArn: string;
     /**
@@ -29,57 +42,76 @@ export type IoTFleetWiseVehicleProps = {
      * @minLength 1
      * @maxLength 100
      * @pattern ^[a-zA-Z\d\-_:]+$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-vehicle.html#cfn-iotfleetwise-vehicle-name}
      */
     Name: string;
     /**
      * Associate state templates to track the state of the vehicle. State templates determine which signal updates the vehicle sends to the cloud.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-vehicle.html#cfn-iotfleetwise-vehicle-statetemplates}
      */
     StateTemplates?: StateTemplateAssociation[] | undefined;
     /**
      * Metadata which can be used to manage the vehicle.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-vehicle.html#cfn-iotfleetwise-vehicle-tags}
      */
     Tags?: Tag[] | undefined;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-vehicle.html#aws-resource-iotfleetwise-vehicle-return-values}
+ */
 export type IoTFleetWiseVehicleAttribs = {
     /**
      * The Amazon Resource Name (ARN) of the vehicle.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-vehicle.html#cfn-iotfleetwise-vehicle-arn}
      */
     Arn: string;
     /**
      * The time the vehicle was created in seconds since epoch (January 1, 1970 at midnight UTC time).
      * @format date-time
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-vehicle.html#cfn-iotfleetwise-vehicle-creationtime}
      */
     CreationTime: string;
     /**
      * The time the vehicle was last updated in seconds since epoch (January 1, 1970 at midnight UTC time).
      * @format date-time
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-vehicle.html#cfn-iotfleetwise-vehicle-lastmodificationtime}
      */
     LastModificationTime: string;
 };
 /**
  * Vehicles associated with the state template will stream telemetry data during a specified time period.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-vehicle-periodicstatetemplateupdatestrategy.html}
  */
 export type PeriodicStateTemplateUpdateStrategy = {
+    /**
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-vehicle-periodicstatetemplateupdatestrategy.html#cfn-iotfleetwise-vehicle-periodicstatetemplateupdatestrategy-statetemplateupdaterate}
+     */
     StateTemplateUpdateRate: TimePeriod;
 };
 /**
  * The state template associated with a vehicle. State templates contain state properties, which are signals that belong to a signal catalog that is synchronized between the AWS IoT FleetWise Edge and the AWS Cloud .
  *
  * > Access to certain AWS IoT FleetWise features is currently gated. For more information, see [AWS Region and feature availability](https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/fleetwise-regions.html) in the *AWS IoT FleetWise Developer Guide* .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-vehicle-statetemplateassociation.html}
  */
 export type StateTemplateAssociation = {
     /**
      * The unique ID of the state template.
      * @minLength 1
      * @maxLength 100
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-vehicle-statetemplateassociation.html#cfn-iotfleetwise-vehicle-statetemplateassociation-identifier}
      */
     Identifier: string;
+    /**
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-vehicle-statetemplateassociation.html#cfn-iotfleetwise-vehicle-statetemplateassociation-statetemplateupdatestrategy}
+     */
     StateTemplateUpdateStrategy: StateTemplateUpdateStrategy;
 };
 /**
  * The update strategy for the state template. Vehicles associated with the state template can stream telemetry data with either an `onChange` or `periodic` update strategy.
  *
  * > Access to certain AWS IoT FleetWise features is currently gated. For more information, see [AWS Region and feature availability](https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/fleetwise-regions.html) in the *AWS IoT FleetWise Developer Guide* .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-vehicle-statetemplateupdatestrategy.html}
  */
 export type StateTemplateUpdateStrategy = {
     Periodic: PeriodicStateTemplateUpdateStrategy;
@@ -88,18 +120,27 @@ export type StateTemplateUpdateStrategy = {
 };
 /**
  * The length of time between state template updates.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-vehicle-timeperiod.html}
  */
 export type TimePeriod = {
     /**
      * A unit of time.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-vehicle-timeperiod.html#cfn-iotfleetwise-vehicle-timeperiod-unit}
      */
     Unit: TimeUnit;
     /**
      * A number of time units.
      * @min 1
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-vehicle-timeperiod.html#cfn-iotfleetwise-vehicle-timeperiod-value}
      */
     Value: number;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-vehicle-timeunit.html}
+ */
 export type TimeUnit = "MILLISECOND" | "SECOND" | "MINUTE" | "HOUR";
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-vehicle-vehicleassociationbehavior.html}
+ */
 export type VehicleAssociationBehavior = "CreateIotThing" | "ValidateIotThingExists";
 //# sourceMappingURL=aws-iotfleetwise-vehicle.d.ts.map

package/out/exports/resources.generated/aws-iotsitewise-accesspolicy.d.ts

@@ -1,108 +1,138 @@
 import type { ResourceDefinitionWithAttributes } from "../main.ts";
+/**
+ * Creates an access policy that grants the specified identity (IAM Identity Center user, IAM Identity Center group, or IAM user) access to the specified AWS IoT SiteWise Monitor portal or project resource.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-accesspolicy.html}
+ */
 export type IoTSiteWiseAccessPolicy = ResourceDefinitionWithAttributes<"AWS::IoTSiteWise::AccessPolicy", IoTSiteWiseAccessPolicyProps, IoTSiteWiseAccessPolicyAttribs>;
 /**
  * Creates an access policy that grants the specified identity (IAM Identity Center user, IAM Identity Center group, or IAM user) access to the specified AWS IoT SiteWise Monitor portal or project resource.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-accesspolicy.html}
  */
 export type IoTSiteWiseAccessPolicyProps = {
     /**
      * The identity for this access policy. Choose an IAM Identity Center user, an IAM Identity Center group, or an IAM user.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-accesspolicy.html#cfn-iotsitewise-accesspolicy-accesspolicyidentity}
      */
     AccessPolicyIdentity: AccessPolicyIdentity;
     /**
      * The permission level for this access policy. Note that a project `ADMINISTRATOR` is also known as a project owner.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-accesspolicy.html#cfn-iotsitewise-accesspolicy-accesspolicypermission}
      */
     AccessPolicyPermission: string;
     /**
      * The AWS IoT SiteWise Monitor resource for this access policy. Choose either a portal or a project.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-accesspolicy.html#cfn-iotsitewise-accesspolicy-accesspolicyresource}
      */
     AccessPolicyResource: AccessPolicyResource;
 };
+/**
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-accesspolicy.html#aws-resource-iotsitewise-accesspolicy-return-values}
+ */
 export type IoTSiteWiseAccessPolicyAttribs = {
     /**
      * The [ARN](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of the access policy, which has the following format.
      *
      * `arn:${Partition}:iotsitewise:${Region}:${Account}:access-policy/${AccessPolicyId}`
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-accesspolicy.html#cfn-iotsitewise-accesspolicy-accesspolicyarn}
      */
     AccessPolicyArn: string;
     /**
      * The ID of the access policy.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-accesspolicy.html#cfn-iotsitewise-accesspolicy-accesspolicyid}
      */
     AccessPolicyId: string;
 };
 /**
  * The identity (IAM Identity Center user, IAM Identity Center group, or IAM user) to which this access policy applies.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-accesspolicy-accesspolicyidentity.html}
  */
 export type AccessPolicyIdentity = {
     /**
      * An IAM role identity.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-accesspolicy-accesspolicyidentity.html#cfn-iotsitewise-accesspolicy-accesspolicyidentity-iamrole}
      */
     IamRole?: IamRole | undefined;
     /**
      * An IAM user identity.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-accesspolicy-accesspolicyidentity.html#cfn-iotsitewise-accesspolicy-accesspolicyidentity-iamuser}
      */
     IamUser?: IamUser | undefined;
     /**
      * An IAM Identity Center user identity.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-accesspolicy-accesspolicyidentity.html#cfn-iotsitewise-accesspolicy-accesspolicyidentity-user}
      */
     User?: User | undefined;
 };
 /**
  * The AWS IoT SiteWise Monitor resource for this access policy. Choose either a portal or a project.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-accesspolicy-accesspolicyresource.html}
  */
 export type AccessPolicyResource = {
     /**
      * Identifies an AWS IoT SiteWise Monitor portal.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-accesspolicy-accesspolicyresource.html#cfn-iotsitewise-accesspolicy-accesspolicyresource-portal}
      */
     Portal?: Portal | undefined;
     /**
      * Identifies a specific AWS IoT SiteWise Monitor project.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-accesspolicy-accesspolicyresource.html#cfn-iotsitewise-accesspolicy-accesspolicyresource-project}
      */
     Project?: Project | undefined;
 };
 /**
  * Contains information about an AWS Identity and Access Management role. For more information, see [IAM roles](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html) in the *IAM User Guide* .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-accesspolicy-iamrole.html}
  */
 export type IamRole = {
     /**
      * The ARN of the IAM role. For more information, see [IAM ARNs](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html) in the *IAM User Guide* .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-accesspolicy-iamrole.html#cfn-iotsitewise-accesspolicy-iamrole-arn}
      */
     arn?: string | undefined;
 };
 /**
  * Contains information about an AWS Identity and Access Management user.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-accesspolicy-iamuser.html}
  */
 export type IamUser = {
     /**
      * The ARN of the IAM user. For more information, see [IAM ARNs](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html) in the *IAM User Guide* .
      *
      * > If you delete the IAM user, access policies that contain this identity include an empty `arn` . You can delete the access policy for the IAM user that no longer exists.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-accesspolicy-iamuser.html#cfn-iotsitewise-accesspolicy-iamuser-arn}
      */
     arn?: string | undefined;
 };
 /**
  * Identifies an AWS IoT SiteWise Monitor portal.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-accesspolicy-portal.html}
  */
 export type Portal = {
     /**
      * The ID of the portal.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-accesspolicy-portal.html#cfn-iotsitewise-accesspolicy-portal-id}
      */
     id?: string | undefined;
 };
 /**
  * Identifies a specific AWS IoT SiteWise Monitor project.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-accesspolicy-project.html}
  */
 export type Project = {
     /**
      * The ID of the project.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-accesspolicy-project.html#cfn-iotsitewise-accesspolicy-project-id}
      */
     id?: string | undefined;
 };
 /**
  * Contains information for a user identity in an access policy.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-accesspolicy-user.html}
  */
 export type User = {
     /**
      * The IAM Identity Center ID of the user.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-accesspolicy-user.html#cfn-iotsitewise-accesspolicy-user-id}
      */
     id?: string | undefined;
 };