@propulsionworks/cloudformation 0.1.0 → 0.1.2

package/out/exports/resources.generated/aws-iotevents-alarmmodel.d.ts

@@ -1,20 +1,28 @@
 import type { ResourceDefinition, Tag } from "../main.ts";
+/**
+ * Represents an alarm model to monitor an AWS IoT Events input attribute. You can use the alarm to get notified when the value is outside a specified range. For more information, see [Create an alarm model](https://docs.aws.amazon.com/iotevents/latest/developerguide/create-alarms.html) in the *AWS IoT Events Developer Guide* .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-alarmmodel.html}
+ */
 export type IoTEventsAlarmModel = ResourceDefinition<"AWS::IoTEvents::AlarmModel", IoTEventsAlarmModelProps>;
 /**
  * Represents an alarm model to monitor an AWS IoT Events input attribute. You can use the alarm to get notified when the value is outside a specified range. For more information, see [Create an alarm model](https://docs.aws.amazon.com/iotevents/latest/developerguide/create-alarms.html) in the *AWS IoT Events Developer Guide* .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-alarmmodel.html}
  */
 export type IoTEventsAlarmModelProps = {
     /**
      * Contains the configuration information of alarm state changes.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-alarmmodel.html#cfn-iotevents-alarmmodel-alarmcapabilities}
      */
     AlarmCapabilities?: AlarmCapabilities | undefined;
     /**
      * Contains information about one or more alarm actions.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-alarmmodel.html#cfn-iotevents-alarmmodel-alarmeventactions}
      */
     AlarmEventActions?: AlarmEventActions | undefined;
     /**
      * The description of the alarm model.
      * @maxLength 1024
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-alarmmodel.html#cfn-iotevents-alarmmodel-alarmmodeldescription}
      */
     AlarmModelDescription?: string | undefined;
     /**
@@ -22,10 +30,12 @@ export type IoTEventsAlarmModelProps = {
      * @minLength 1
      * @maxLength 128
      * @pattern ^[a-zA-Z0-9_-]+$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-alarmmodel.html#cfn-iotevents-alarmmodel-alarmmodelname}
      */
     AlarmModelName?: string | undefined;
     /**
      * Defines when your alarm is invoked.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-alarmmodel.html#cfn-iotevents-alarmmodel-alarmrule}
      */
     AlarmRule: AlarmRule;
     /**
@@ -33,39 +43,46 @@ export type IoTEventsAlarmModelProps = {
      * @minLength 1
      * @maxLength 128
      * @pattern ^((`[\w\- ]+`)|([\w\-]+))(\.((`[\w\- ]+`)|([\w\-]+)))*$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-alarmmodel.html#cfn-iotevents-alarmmodel-key}
      */
     Key?: string | undefined;
     /**
      * The ARN of the IAM role that allows the alarm to perform actions and access AWS resources. For more information, see [Amazon Resource Names (ARNs)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the *AWS General Reference* .
      * @minLength 1
      * @maxLength 2048
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-alarmmodel.html#cfn-iotevents-alarmmodel-rolearn}
      */
     RoleArn: string;
     /**
      * A non-negative integer that reflects the severity level of the alarm.
      * @min 0
      * @max 2147483647
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-alarmmodel.html#cfn-iotevents-alarmmodel-severity}
      */
     Severity?: number | undefined;
     /**
      * A list of key-value pairs that contain metadata for the alarm model. The tags help you manage the alarm model. For more information, see [Tagging your AWS IoT Events resources](https://docs.aws.amazon.com/iotevents/latest/developerguide/tagging-iotevents.html) in the *AWS IoT Events Developer Guide* .
      *
      * You can create up to 50 tags for one alarm model.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotevents-alarmmodel.html#cfn-iotevents-alarmmodel-tags}
      */
     Tags?: Tag[] | undefined;
 };
 /**
  * Specifies whether to get notified for alarm state changes.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-acknowledgeflow.html}
  */
 export type AcknowledgeFlow = {
     /**
      * The value must be `TRUE` or `FALSE` . If `TRUE` , you receive a notification when the alarm state changes. You must choose to acknowledge the notification before the alarm state can return to `NORMAL` . If `FALSE` , you won't receive notifications. The alarm automatically changes to the `NORMAL` state when the input property value returns to the specified range.
      * @default "true"
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-acknowledgeflow.html#cfn-iotevents-alarmmodel-acknowledgeflow-enabled}
      */
     Enabled?: boolean | undefined;
 };
 /**
  * Specifies one of the following actions to receive notifications when the alarm state changes.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-alarmaction.html}
  */
 export type AlarmAction = {
     /**
@@ -89,6 +106,7 @@ export type AlarmAction = {
      * For more information, see [Expressions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) in the *AWS IoT Events Developer Guide* .
      *
      * If the defined payload type is a string, `DynamoDBAction` writes non-JSON data to the DynamoDB table as binary data. The DynamoDB console displays the data as Base64-encoded text. The value for the `payloadField` parameter is `<payload-field>_raw` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-alarmaction.html#cfn-iotevents-alarmmodel-alarmaction-dynamodb}
      */
     DynamoDB?: DynamoDB | undefined;
     /**
@@ -112,14 +130,17 @@ export type AlarmAction = {
      * For more information, see [Expressions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) in the *AWS IoT Events Developer Guide* .
      *
      * The value for the `type` parameter in `Payload` must be `JSON` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-alarmaction.html#cfn-iotevents-alarmmodel-alarmaction-dynamodbv2}
      */
     DynamoDBv2?: DynamoDBv2 | undefined;
     /**
      * Sends information about the detector model instance and the event that triggered the action to an Amazon Kinesis Data Firehose delivery stream.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-alarmaction.html#cfn-iotevents-alarmmodel-alarmaction-firehose}
      */
     Firehose?: Firehose | undefined;
     /**
      * Sends an AWS IoT Events input, passing in information about the detector model instance and the event that triggered the action.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-alarmaction.html#cfn-iotevents-alarmmodel-alarmaction-iotevents}
      */
     IotEvents?: IotEvents | undefined;
     /**
@@ -138,53 +159,65 @@ export type AlarmAction = {
      * You must specify either `propertyAlias` or both `assetId` and `propertyId` to identify the target asset property in AWS IoT SiteWise .
      *
      * For more information, see [Expressions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) in the *AWS IoT Events Developer Guide* .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-alarmaction.html#cfn-iotevents-alarmmodel-alarmaction-iotsitewise}
      */
     IotSiteWise?: IotSiteWise | undefined;
     /**
      * Information required to publish the MQTT message through the AWS IoT message broker.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-alarmaction.html#cfn-iotevents-alarmmodel-alarmaction-iottopicpublish}
      */
     IotTopicPublish?: IotTopicPublish | undefined;
     /**
      * Calls a Lambda function, passing in information about the detector model instance and the event that triggered the action.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-alarmaction.html#cfn-iotevents-alarmmodel-alarmaction-lambda}
      */
     Lambda?: Lambda | undefined;
     /**
      * Information required to publish the Amazon SNS message.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-alarmaction.html#cfn-iotevents-alarmmodel-alarmaction-sns}
      */
     Sns?: Sns | undefined;
     /**
      * Sends information about the detector model instance and the event that triggered the action to an Amazon SQS queue.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-alarmaction.html#cfn-iotevents-alarmmodel-alarmaction-sqs}
      */
     Sqs?: Sqs | undefined;
 };
 /**
  * Contains the configuration information of alarm state changes.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-alarmcapabilities.html}
  */
 export type AlarmCapabilities = {
     /**
      * Specifies whether to get notified for alarm state changes.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-alarmcapabilities.html#cfn-iotevents-alarmmodel-alarmcapabilities-acknowledgeflow}
      */
     AcknowledgeFlow?: AcknowledgeFlow | undefined;
     /**
      * Specifies the default alarm state. The configuration applies to all alarms that were created based on this alarm model.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-alarmcapabilities.html#cfn-iotevents-alarmmodel-alarmcapabilities-initializationconfiguration}
      */
     InitializationConfiguration?: InitializationConfiguration | undefined;
 };
 /**
  * Contains information about one or more alarm actions.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-alarmeventactions.html}
  */
 export type AlarmEventActions = {
     /**
      * Specifies one or more supported actions to receive notifications when the alarm state changes.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-alarmeventactions.html#cfn-iotevents-alarmmodel-alarmeventactions-alarmactions}
      */
     AlarmActions?: AlarmAction[] | undefined;
 };
 /**
  * Defines when your alarm is invoked.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-alarmrule.html}
  */
 export type AlarmRule = {
     /**
      * A rule that compares an input property value to a threshold value with a comparison operator.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-alarmrule.html#cfn-iotevents-alarmmodel-alarmrule-simplerule}
      */
     SimpleRule?: SimpleRule | undefined;
 };
@@ -202,14 +235,17 @@ export type AlarmRule = {
  * `'${$input.TemperatureInput.sensorData.timestamp / 1000}'`
  *
  * For more information, see [Expressions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) in the *AWS IoT Events Developer Guide* .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-assetpropertytimestamp.html}
  */
 export type AssetPropertyTimestamp = {
     /**
      * The nanosecond offset converted from `timeInSeconds` . The valid range is between 0-999999999.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-assetpropertytimestamp.html#cfn-iotevents-alarmmodel-assetpropertytimestamp-offsetinnanos}
      */
     OffsetInNanos?: string | undefined;
     /**
      * The timestamp, in seconds, in the Unix epoch format. The valid range is between 1-31556889864403199.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-assetpropertytimestamp.html#cfn-iotevents-alarmmodel-assetpropertytimestamp-timeinseconds}
      */
     TimeInSeconds: string;
 };
@@ -222,18 +258,22 @@ export type AssetPropertyTimestamp = {
  * - For references, you must specify either variables or input values. For example, the value for the `quality` parameter can be `$input.TemperatureInput.sensorData.quality` .
  *
  * For more information, see [Expressions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) in the *AWS IoT Events Developer Guide* .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-assetpropertyvalue.html}
  */
 export type AssetPropertyValue = {
     /**
      * The quality of the asset property value. The value must be `'GOOD'` , `'BAD'` , or `'UNCERTAIN'` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-assetpropertyvalue.html#cfn-iotevents-alarmmodel-assetpropertyvalue-quality}
      */
     Quality?: string | undefined;
     /**
      * The timestamp associated with the asset property value. The default is the current event time.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-assetpropertyvalue.html#cfn-iotevents-alarmmodel-assetpropertyvalue-timestamp}
      */
     Timestamp?: AssetPropertyTimestamp | undefined;
     /**
      * The value to send to an asset property.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-assetpropertyvalue.html#cfn-iotevents-alarmmodel-assetpropertyvalue-value}
      */
     Value: AssetPropertyVariant;
 };
@@ -253,22 +293,27 @@ export type AssetPropertyValue = {
  * For more information, see [Expressions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) in the *AWS IoT Events Developer Guide* .
  *
  * You must specify one of the following value types, depending on the `dataType` of the specified asset property. For more information, see [AssetProperty](https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_AssetProperty.html) in the *AWS IoT SiteWise API Reference* .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-assetpropertyvariant.html}
  */
 export type AssetPropertyVariant = {
     /**
      * The asset property value is a Boolean value that must be `'TRUE'` or `'FALSE'` . You must use an expression, and the evaluated result should be a Boolean value.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-assetpropertyvariant.html#cfn-iotevents-alarmmodel-assetpropertyvariant-booleanvalue}
      */
     BooleanValue?: string | undefined;
     /**
      * The asset property value is a double. You must use an expression, and the evaluated result should be a double.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-assetpropertyvariant.html#cfn-iotevents-alarmmodel-assetpropertyvariant-doublevalue}
      */
     DoubleValue?: string | undefined;
     /**
      * The asset property value is an integer. You must use an expression, and the evaluated result should be an integer.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-assetpropertyvariant.html#cfn-iotevents-alarmmodel-assetpropertyvariant-integervalue}
      */
     IntegerValue?: string | undefined;
     /**
      * The asset property value is a string. You must use an expression, and the evaluated result should be a string.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-assetpropertyvariant.html#cfn-iotevents-alarmmodel-assetpropertyvariant-stringvalue}
      */
     StringValue?: string | undefined;
 };
@@ -293,10 +338,12 @@ export type AssetPropertyVariant = {
  * For more information, see [Expressions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) in the *AWS IoT Events Developer Guide* .
  *
  * If the defined payload type is a string, `DynamoDBAction` writes non-JSON data to the DynamoDB table as binary data. The DynamoDB console displays the data as Base64-encoded text. The value for the `payloadField` parameter is `<payload-field>_raw` .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-dynamodb.html}
  */
 export type DynamoDB = {
     /**
      * The name of the hash key (also called the partition key). The `hashKeyField` value must match the partition key of the target DynamoDB table.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-dynamodb.html#cfn-iotevents-alarmmodel-dynamodb-hashkeyfield}
      */
     HashKeyField: string;
     /**
@@ -306,10 +353,12 @@ export type DynamoDB = {
      * - `'NUMBER'` - The hash key is a number.
      *
      * If you don't specify `hashKeyType` , the default value is `'STRING'` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-dynamodb.html#cfn-iotevents-alarmmodel-dynamodb-hashkeytype}
      */
     HashKeyType?: string | undefined;
     /**
      * The value of the hash key (also called the partition key).
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-dynamodb.html#cfn-iotevents-alarmmodel-dynamodb-hashkeyvalue}
      */
     HashKeyValue: string;
     /**
@@ -320,22 +369,26 @@ export type DynamoDB = {
      * - `'DELETE'` - Delete an existing item of the DynamoDB table. This item's partition key must match the specified hash key. If you specified a range key, the range key must match the item's sort key.
      *
      * If you don't specify this parameter, AWS IoT Events triggers the `'INSERT'` operation.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-dynamodb.html#cfn-iotevents-alarmmodel-dynamodb-operation}
      */
     Operation?: string | undefined;
     /**
      * Information needed to configure the payload.
      *
      * By default, AWS IoT Events generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the detector model instance and the event triggered the action. To configure the action payload, you can use `contentExpression` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-dynamodb.html#cfn-iotevents-alarmmodel-dynamodb-payload}
      */
     Payload?: Payload | undefined;
     /**
      * The name of the DynamoDB column that receives the action payload.
      *
      * If you don't specify this parameter, the name of the DynamoDB column is `payload` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-dynamodb.html#cfn-iotevents-alarmmodel-dynamodb-payloadfield}
      */
     PayloadField?: string | undefined;
     /**
      * The name of the range key (also called the sort key). The `rangeKeyField` value must match the sort key of the target DynamoDB table.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-dynamodb.html#cfn-iotevents-alarmmodel-dynamodb-rangekeyfield}
      */
     RangeKeyField?: string | undefined;
     /**
@@ -345,14 +398,17 @@ export type DynamoDB = {
      * - `'NUMBER'` - The range key is number.
      *
      * If you don't specify `rangeKeyField` , the default value is `'STRING'` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-dynamodb.html#cfn-iotevents-alarmmodel-dynamodb-rangekeytype}
      */
     RangeKeyType?: string | undefined;
     /**
      * The value of the range key (also called the sort key).
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-dynamodb.html#cfn-iotevents-alarmmodel-dynamodb-rangekeyvalue}
      */
     RangeKeyValue?: string | undefined;
     /**
      * The name of the DynamoDB table. The `tableName` value must match the table name of the target DynamoDB table.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-dynamodb.html#cfn-iotevents-alarmmodel-dynamodb-tablename}
      */
     TableName: string;
 };
@@ -377,49 +433,59 @@ export type DynamoDB = {
  * For more information, see [Expressions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) in the *AWS IoT Events Developer Guide* .
  *
  * The value for the `type` parameter in `Payload` must be `JSON` .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-dynamodbv2.html}
  */
 export type DynamoDBv2 = {
     /**
      * Information needed to configure the payload.
      *
      * By default, AWS IoT Events generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the detector model instance and the event triggered the action. To configure the action payload, you can use `contentExpression` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-dynamodbv2.html#cfn-iotevents-alarmmodel-dynamodbv2-payload}
      */
     Payload?: Payload | undefined;
     /**
      * The name of the DynamoDB table.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-dynamodbv2.html#cfn-iotevents-alarmmodel-dynamodbv2-tablename}
      */
     TableName: string;
 };
 /**
  * Sends information about the detector model instance and the event that triggered the action to an Amazon Kinesis Data Firehose delivery stream.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-firehose.html}
  */
 export type Firehose = {
     /**
      * The name of the Kinesis Data Firehose delivery stream where the data is written.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-firehose.html#cfn-iotevents-alarmmodel-firehose-deliverystreamname}
      */
     DeliveryStreamName: string;
     /**
      * You can configure the action payload when you send a message to an Amazon Data Firehose delivery stream.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-firehose.html#cfn-iotevents-alarmmodel-firehose-payload}
      */
     Payload?: Payload | undefined;
     /**
      * A character separator that is used to separate records written to the Kinesis Data Firehose delivery stream. Valid values are: '\n' (newline), '\t' (tab), '\r\n' (Windows newline), ',' (comma).
      * @pattern ([\n\t])|(\r\n)|(,)
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-firehose.html#cfn-iotevents-alarmmodel-firehose-separator}
      */
     Separator?: string | undefined;
 };
 /**
  * Specifies the default alarm state. The configuration applies to all alarms that were created based on this alarm model.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-initializationconfiguration.html}
  */
 export type InitializationConfiguration = {
     /**
      * The value must be `TRUE` or `FALSE` . If `FALSE` , all alarm instances created based on the alarm model are activated. The default value is `TRUE` .
      * @default "true"
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-initializationconfiguration.html#cfn-iotevents-alarmmodel-initializationconfiguration-disabledoninitialization}
      */
     DisabledOnInitialization: boolean;
 };
 /**
  * Sends an AWS IoT Events input, passing in information about the detector model instance and the event that triggered the action.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-iotevents.html}
  */
 export type IotEvents = {
     /**
@@ -427,10 +493,12 @@ export type IotEvents = {
      * @minLength 1
      * @maxLength 128
      * @pattern ^[a-zA-Z][a-zA-Z0-9_]*$
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-iotevents.html#cfn-iotevents-alarmmodel-iotevents-inputname}
      */
     InputName: string;
     /**
      * You can configure the action payload when you send a message to an AWS IoT Events input.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-iotevents.html#cfn-iotevents-alarmmodel-iotevents-payload}
      */
     Payload?: Payload | undefined;
 };
@@ -450,56 +518,68 @@ export type IotEvents = {
  * You must specify either `propertyAlias` or both `assetId` and `propertyId` to identify the target asset property in AWS IoT SiteWise .
  *
  * For more information, see [Expressions](https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html) in the *AWS IoT Events Developer Guide* .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-iotsitewise.html}
  */
 export type IotSiteWise = {
     /**
      * The ID of the asset that has the specified property.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-iotsitewise.html#cfn-iotevents-alarmmodel-iotsitewise-assetid}
      */
     AssetId?: string | undefined;
     /**
      * A unique identifier for this entry. You can use the entry ID to track which data entry causes an error in case of failure. The default is a new unique identifier.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-iotsitewise.html#cfn-iotevents-alarmmodel-iotsitewise-entryid}
      */
     EntryId?: string | undefined;
     /**
      * The alias of the asset property.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-iotsitewise.html#cfn-iotevents-alarmmodel-iotsitewise-propertyalias}
      */
     PropertyAlias?: string | undefined;
     /**
      * The ID of the asset property.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-iotsitewise.html#cfn-iotevents-alarmmodel-iotsitewise-propertyid}
      */
     PropertyId?: string | undefined;
     /**
      * The value to send to the asset property. This value contains timestamp, quality, and value (TQV) information.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-iotsitewise.html#cfn-iotevents-alarmmodel-iotsitewise-propertyvalue}
      */
     PropertyValue?: AssetPropertyValue | undefined;
 };
 /**
  * Information required to publish the MQTT message through the AWS IoT message broker.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-iottopicpublish.html}
  */
 export type IotTopicPublish = {
     /**
      * The MQTT topic of the message. You can use a string expression that includes variables ( `$variable.<variable-name>` ) and input values ( `$input.<input-name>.<path-to-datum>` ) as the topic string.
      * @minLength 1
      * @maxLength 128
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-iottopicpublish.html#cfn-iotevents-alarmmodel-iottopicpublish-mqtttopic}
      */
     MqttTopic: string;
     /**
      * You can configure the action payload when you publish a message to an AWS IoT Core topic.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-iottopicpublish.html#cfn-iotevents-alarmmodel-iottopicpublish-payload}
      */
     Payload?: Payload | undefined;
 };
 /**
  * Calls a Lambda function, passing in information about the detector model instance and the event that triggered the action.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-lambda.html}
  */
 export type Lambda = {
     /**
      * The ARN of the Lambda function that is executed.
      * @minLength 1
      * @maxLength 2048
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-lambda.html#cfn-iotevents-alarmmodel-lambda-functionarn}
      */
     FunctionArn: string;
     /**
      * You can configure the action payload when you send a message to a Lambda function.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-lambda.html#cfn-iotevents-alarmmodel-lambda-payload}
      */
     Payload?: Payload | undefined;
 };
@@ -507,68 +587,82 @@ export type Lambda = {
  * Information needed to configure the payload.
  *
  * By default, AWS IoT Events generates a standard payload in JSON for any action. This action payload contains all attribute-value pairs that have the information about the detector model instance and the event triggered the action. To configure the action payload, you can use `contentExpression` .
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-payload.html}
  */
 export type Payload = {
     /**
      * The content of the payload. You can use a string expression that includes quoted strings ( `'<string>'` ), variables ( `$variable.<variable-name>` ), input values ( `$input.<input-name>.<path-to-datum>` ), string concatenations, and quoted strings that contain `${}` as the content. The recommended maximum size of a content expression is 1 KB.
      * @minLength 1
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-payload.html#cfn-iotevents-alarmmodel-payload-contentexpression}
      */
     ContentExpression: string;
     /**
      * The value of the payload type can be either `STRING` or `JSON` .
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-payload.html#cfn-iotevents-alarmmodel-payload-type}
      */
     Type: string;
 };
 /**
  * A rule that compares an input property value to a threshold value with a comparison operator.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-simplerule.html}
  */
 export type SimpleRule = {
     /**
      * The comparison operator.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-simplerule.html#cfn-iotevents-alarmmodel-simplerule-comparisonoperator}
      */
     ComparisonOperator: "GREATER" | "GREATER_OR_EQUAL" | "LESS" | "LESS_OR_EQUAL" | "EQUAL" | "NOT_EQUAL";
     /**
      * The value on the left side of the comparison operator. You can specify an AWS IoT Events input attribute as an input property.
      * @minLength 1
      * @maxLength 512
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-simplerule.html#cfn-iotevents-alarmmodel-simplerule-inputproperty}
      */
     InputProperty: string;
     /**
      * The value on the right side of the comparison operator. You can enter a number or specify an AWS IoT Events input attribute.
      * @minLength 1
      * @maxLength 512
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-simplerule.html#cfn-iotevents-alarmmodel-simplerule-threshold}
      */
     Threshold: string;
 };
 /**
  * Information required to publish the Amazon SNS message.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-sns.html}
  */
 export type Sns = {
     /**
      * You can configure the action payload when you send a message as an Amazon SNS push notification.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-sns.html#cfn-iotevents-alarmmodel-sns-payload}
      */
     Payload?: Payload | undefined;
     /**
      * The ARN of the Amazon SNS target where the message is sent.
      * @minLength 1
      * @maxLength 2048
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-sns.html#cfn-iotevents-alarmmodel-sns-targetarn}
      */
     TargetArn: string;
 };
 /**
  * Sends information about the detector model instance and the event that triggered the action to an Amazon SQS queue.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-sqs.html}
  */
 export type Sqs = {
     /**
      * You can configure the action payload when you send a message to an Amazon SQS queue.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-sqs.html#cfn-iotevents-alarmmodel-sqs-payload}
      */
     Payload?: Payload | undefined;
     /**
      * The URL of the SQS queue where the data is written.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-sqs.html#cfn-iotevents-alarmmodel-sqs-queueurl}
      */
     QueueUrl: string;
     /**
      * Set this to TRUE if you want the data to be base-64 encoded before it is written to the queue. Otherwise, set this to FALSE.
+     * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotevents-alarmmodel-sqs.html#cfn-iotevents-alarmmodel-sqs-usebase64}
      */
     UseBase64?: boolean | undefined;
 };