@propulsionworks/cloudformation 0.0.1 → 0.1.0

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

@@ -0,0 +1,913 @@
+import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+export type IoTTopicRule = ResourceDefinitionWithAttributes<"AWS::IoT::TopicRule", IoTTopicRuleProps, IoTTopicRuleAttribs>;
+/**
+ * Use the `AWS::IoT::TopicRule` resource to declare an AWS IoT rule. For information about working with AWS IoT rules, see [Rules for AWS IoT](https://docs.aws.amazon.com/iot/latest/developerguide/iot-rules.html) in the *AWS IoT Developer Guide* .
+ */
+export type IoTTopicRuleProps = {
+    /**
+     * The name of the rule.
+     */
+    RuleName?: string | undefined;
+    /**
+     * Metadata which can be used to manage the topic rule.
+     *
+     * > For URI Request parameters use format: ...key1=value1&key2=value2...
+     * >
+     * > For the CLI command-line parameter use format: --tags "key1=value1&key2=value2..."
+     * >
+     * > For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."
+     */
+    Tags?: Tag[] | undefined;
+    /**
+     * The rule payload.
+     */
+    TopicRulePayload: TopicRulePayload;
+};
+export type IoTTopicRuleAttribs = {
+    /**
+     * The Amazon Resource Name (ARN) of the AWS IoT rule, such as `arn:aws:iot:us-east-2:123456789012:rule/MyIoTRule` .
+     */
+    Arn: string;
+};
+/**
+ * Describes the actions associated with a rule.
+ */
+export type Action = {
+    /**
+     * Change the state of a CloudWatch alarm.
+     */
+    CloudwatchAlarm?: CloudwatchAlarmAction | undefined;
+    /**
+     * Sends data to CloudWatch.
+     */
+    CloudwatchLogs?: CloudwatchLogsAction | undefined;
+    /**
+     * Capture a CloudWatch metric.
+     */
+    CloudwatchMetric?: CloudwatchMetricAction | undefined;
+    /**
+     * Write to a DynamoDB table.
+     */
+    DynamoDB?: DynamoDBAction | undefined;
+    /**
+     * Write to a DynamoDB table. This is a new version of the DynamoDB action. It allows you to write each attribute in an MQTT message payload into a separate DynamoDB column.
+     */
+    DynamoDBv2?: DynamoDBv2Action | undefined;
+    /**
+     * Write data to an Amazon OpenSearch Service domain.
+     *
+     * > The `Elasticsearch` action can only be used by existing rule actions. To create a new rule action or to update an existing rule action, use the `OpenSearch` rule action instead. For more information, see [OpenSearchAction](https://docs.aws.amazon.com//iot/latest/apireference/API_OpenSearchAction.html) .
+     */
+    Elasticsearch?: ElasticsearchAction | undefined;
+    /**
+     * Write to an Amazon Kinesis Firehose stream.
+     */
+    Firehose?: FirehoseAction | undefined;
+    /**
+     * Send data to an HTTPS endpoint.
+     */
+    Http?: HttpAction | undefined;
+    /**
+     * Sends message data to an AWS IoT Analytics channel.
+     */
+    IotAnalytics?: IotAnalyticsAction | undefined;
+    /**
+     * Sends an input to an AWS IoT Events detector.
+     */
+    IotEvents?: IotEventsAction | undefined;
+    /**
+     * Sends data from the MQTT message that triggered the rule to AWS IoT SiteWise asset properties.
+     */
+    IotSiteWise?: IotSiteWiseAction | undefined;
+    /**
+     * Send messages to an Amazon Managed Streaming for Apache Kafka (Amazon MSK) or self-managed Apache Kafka cluster.
+     */
+    Kafka?: KafkaAction | undefined;
+    /**
+     * Write data to an Amazon Kinesis stream.
+     */
+    Kinesis?: KinesisAction | undefined;
+    /**
+     * Invoke a Lambda function.
+     */
+    Lambda?: LambdaAction | undefined;
+    /**
+     * Sends device location data to [Amazon Location Service](https://docs.aws.amazon.com//location/latest/developerguide/welcome.html) .
+     */
+    Location?: LocationAction | undefined;
+    /**
+     * Write data to an Amazon OpenSearch Service domain.
+     */
+    OpenSearch?: OpenSearchAction | undefined;
+    /**
+     * Publish to another MQTT topic.
+     */
+    Republish?: RepublishAction | undefined;
+    /**
+     * Write to an Amazon S3 bucket.
+     */
+    S3?: S3Action | undefined;
+    /**
+     * Publish to an Amazon SNS topic.
+     */
+    Sns?: SnsAction | undefined;
+    /**
+     * Publish to an Amazon SQS queue.
+     */
+    Sqs?: SqsAction | undefined;
+    /**
+     * Starts execution of a Step Functions state machine.
+     */
+    StepFunctions?: StepFunctionsAction | undefined;
+    /**
+     * Writes attributes from an MQTT message.
+     */
+    Timestream?: TimestreamAction | undefined;
+};
+/**
+ * An asset property timestamp entry containing the following information.
+ */
+export type AssetPropertyTimestamp = {
+    /**
+     * Optional. A string that contains the nanosecond time offset. Accepts substitution templates.
+     */
+    OffsetInNanos?: string | undefined;
+    /**
+     * A string that contains the time in seconds since epoch. Accepts substitution templates.
+     */
+    TimeInSeconds: string;
+};
+/**
+ * An asset property value entry containing the following information.
+ */
+export type AssetPropertyValue = {
+    /**
+     * Optional. A string that describes the quality of the value. Accepts substitution templates. Must be `GOOD` , `BAD` , or `UNCERTAIN` .
+     */
+    Quality?: string | undefined;
+    /**
+     * The asset property value timestamp.
+     */
+    Timestamp: AssetPropertyTimestamp;
+    /**
+     * The value of the asset property.
+     */
+    Value: AssetPropertyVariant;
+};
+/**
+ * Contains an asset property value (of a single type).
+ */
+export type AssetPropertyVariant = {
+    /**
+     * Optional. A string that contains the boolean value ( `true` or `false` ) of the value entry. Accepts substitution templates.
+     */
+    BooleanValue?: string | undefined;
+    /**
+     * Optional. A string that contains the double value of the value entry. Accepts substitution templates.
+     */
+    DoubleValue?: string | undefined;
+    /**
+     * Optional. A string that contains the integer value of the value entry. Accepts substitution templates.
+     */
+    IntegerValue?: string | undefined;
+    /**
+     * Optional. The string value of the value entry. Accepts substitution templates.
+     */
+    StringValue?: string | undefined;
+};
+export type CannedAccessControlList = "private" | "public-read" | "public-read-write" | "aws-exec-read" | "authenticated-read" | "bucket-owner-read" | "bucket-owner-full-control" | "log-delivery-write";
+/**
+ * Describes an action that updates a CloudWatch alarm.
+ */
+export type CloudwatchAlarmAction = {
+    /**
+     * The CloudWatch alarm name.
+     */
+    AlarmName: string;
+    /**
+     * The IAM role that allows access to the CloudWatch alarm.
+     */
+    RoleArn: string;
+    /**
+     * The reason for the alarm change.
+     */
+    StateReason: string;
+    /**
+     * The value of the alarm state. Acceptable values are: OK, ALARM, INSUFFICIENT_DATA.
+     */
+    StateValue: string;
+};
+/**
+ * Describes an action that updates a CloudWatch log.
+ */
+export type CloudwatchLogsAction = {
+    /**
+     * Indicates whether batches of log records will be extracted and uploaded into CloudWatch.
+     */
+    BatchMode?: boolean | undefined;
+    /**
+     * The CloudWatch log name.
+     */
+    LogGroupName: string;
+    /**
+     * The IAM role that allows access to the CloudWatch log.
+     */
+    RoleArn: string;
+};
+/**
+ * Describes an action that captures a CloudWatch metric.
+ */
+export type CloudwatchMetricAction = {
+    /**
+     * The CloudWatch metric name.
+     */
+    MetricName: string;
+    /**
+     * The CloudWatch metric namespace name.
+     */
+    MetricNamespace: string;
+    /**
+     * An optional [Unix timestamp](https://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/cloudwatch_concepts.html#about_timestamp) .
+     */
+    MetricTimestamp?: string | undefined;
+    /**
+     * The [metric unit](https://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/cloudwatch_concepts.html#Unit) supported by CloudWatch.
+     */
+    MetricUnit: string;
+    /**
+     * The CloudWatch metric value.
+     */
+    MetricValue: string;
+    /**
+     * The IAM role that allows access to the CloudWatch metric.
+     */
+    RoleArn: string;
+};
+/**
+ * Describes an action to write to a DynamoDB table.
+ *
+ * The `tableName` , `hashKeyField` , and `rangeKeyField` values must match the values used when you created the table.
+ *
+ * The `hashKeyValue` and `rangeKeyvalue` fields use a substitution template syntax. These templates provide data at runtime. The syntax is as follows: ${ *sql-expression* }.
+ *
+ * You can specify any valid expression in a WHERE or SELECT clause, including JSON properties, comparisons, calculations, and functions. For example, the following field uses the third level of the topic:
+ *
+ * `"hashKeyValue": "${topic(3)}"`
+ *
+ * The following field uses the timestamp:
+ *
+ * `"rangeKeyValue": "${timestamp()}"`
+ *
+ * For more information, see [DynamoDBv2 Action](https://docs.aws.amazon.com/iot/latest/developerguide/iot-rule-actions.html) in the *AWS IoT Developer Guide* .
+ */
+export type DynamoDBAction = {
+    /**
+     * The hash key name.
+     */
+    HashKeyField: string;
+    /**
+     * The hash key type. Valid values are "STRING" or "NUMBER"
+     */
+    HashKeyType?: string | undefined;
+    /**
+     * The hash key value.
+     */
+    HashKeyValue: string;
+    /**
+     * The action payload. This name can be customized.
+     */
+    PayloadField?: string | undefined;
+    /**
+     * The range key name.
+     */
+    RangeKeyField?: string | undefined;
+    /**
+     * The range key type. Valid values are "STRING" or "NUMBER"
+     */
+    RangeKeyType?: string | undefined;
+    /**
+     * The range key value.
+     */
+    RangeKeyValue?: string | undefined;
+    /**
+     * The ARN of the IAM role that grants access to the DynamoDB table.
+     */
+    RoleArn: string;
+    /**
+     * The name of the DynamoDB table.
+     */
+    TableName: string;
+};
+/**
+ * Describes an action to write to a DynamoDB table.
+ *
+ * This DynamoDB action writes each attribute in the message payload into it's own column in the DynamoDB table.
+ */
+export type DynamoDBv2Action = {
+    /**
+     * Specifies the DynamoDB table to which the message data will be written. For example:
+     *
+     * `{ "dynamoDBv2": { "roleArn": "aws:iam:12341251:my-role" "putItem": { "tableName": "my-table" } } }`
+     *
+     * Each attribute in the message payload will be written to a separate column in the DynamoDB database.
+     */
+    PutItem?: PutItemInput | undefined;
+    /**
+     * The ARN of the IAM role that grants access to the DynamoDB table.
+     */
+    RoleArn?: string | undefined;
+};
+/**
+ * Describes an action that writes data to an Amazon OpenSearch Service domain.
+ *
+ * > The `Elasticsearch` action can only be used by existing rule actions. To create a new rule action or to update an existing rule action, use the `OpenSearch` rule action instead. For more information, see [OpenSearchAction](https://docs.aws.amazon.com//iot/latest/apireference/API_OpenSearchAction.html) .
+ */
+export type ElasticsearchAction = {
+    /**
+     * The endpoint of your OpenSearch domain.
+     */
+    Endpoint: string;
+    /**
+     * The unique identifier for the document you are storing.
+     */
+    Id: string;
+    /**
+     * The index where you want to store your data.
+     */
+    Index: string;
+    /**
+     * The IAM role ARN that has access to OpenSearch.
+     */
+    RoleArn: string;
+    /**
+     * The type of document you are storing.
+     */
+    Type: string;
+};
+/**
+ * Describes an action that writes data to an Amazon Kinesis Firehose stream.
+ */
+export type FirehoseAction = {
+    /**
+     * Whether to deliver the Kinesis Data Firehose stream as a batch by using [`PutRecordBatch`](https://docs.aws.amazon.com/firehose/latest/APIReference/API_PutRecordBatch.html) . The default value is `false` .
+     *
+     * When `batchMode` is `true` and the rule's SQL statement evaluates to an Array, each Array element forms one record in the [`PutRecordBatch`](https://docs.aws.amazon.com/firehose/latest/APIReference/API_PutRecordBatch.html) request. The resulting array can't have more than 500 records.
+     */
+    BatchMode?: boolean | undefined;
+    /**
+     * The delivery stream name.
+     */
+    DeliveryStreamName: string;
+    /**
+     * The IAM role that grants access to the Amazon Kinesis Firehose stream.
+     */
+    RoleArn: string;
+    /**
+     * A character separator that will be used to separate records written to the Firehose stream. Valid values are: '\n' (newline), '\t' (tab), '\r\n' (Windows newline), ',' (comma).
+     */
+    Separator?: string | undefined;
+};
+/**
+ * Send data to an HTTPS endpoint.
+ */
+export type HttpAction = {
+    /**
+     * The authentication method to use when sending data to an HTTPS endpoint.
+     */
+    Auth?: HttpAuthorization | undefined;
+    /**
+     * The URL to which AWS IoT sends a confirmation message. The value of the confirmation URL must be a prefix of the endpoint URL. If you do not specify a confirmation URL AWS IoT uses the endpoint URL as the confirmation URL. If you use substitution templates in the confirmationUrl, you must create and enable topic rule destinations that match each possible value of the substitution template before traffic is allowed to your endpoint URL.
+     */
+    ConfirmationUrl?: string | undefined;
+    /**
+     * The HTTP headers to send with the message data.
+     */
+    Headers?: HttpActionHeader[] | undefined;
+    /**
+     * The endpoint URL. If substitution templates are used in the URL, you must also specify a `confirmationUrl` . If this is a new destination, a new `TopicRuleDestination` is created if possible.
+     */
+    Url: string;
+};
+/**
+ * The HTTP action header.
+ */
+export type HttpActionHeader = {
+    /**
+     * The HTTP header key.
+     */
+    Key: string;
+    /**
+     * The HTTP header value. Substitution templates are supported.
+     */
+    Value: string;
+};
+/**
+ * The authorization method used to send messages.
+ */
+export type HttpAuthorization = {
+    /**
+     * Use Sig V4 authorization. For more information, see [Signature Version 4 Signing Process](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) .
+     */
+    Sigv4?: SigV4Authorization | undefined;
+};
+/**
+ * Sends message data to an AWS IoT Analytics channel.
+ */
+export type IotAnalyticsAction = {
+    /**
+     * Whether to process the action as a batch. The default value is `false` .
+     *
+     * When `batchMode` is `true` and the rule SQL statement evaluates to an Array, each Array element is delivered as a separate message when passed by [`BatchPutMessage`](https://docs.aws.amazon.com/iotanalytics/latest/APIReference/API_BatchPutMessage.html) The resulting array can't have more than 100 messages.
+     */
+    BatchMode?: boolean | undefined;
+    /**
+     * The name of the IoT Analytics channel to which message data will be sent.
+     */
+    ChannelName: string;
+    /**
+     * The ARN of the role which has a policy that grants IoT Analytics permission to send message data via IoT Analytics (iotanalytics:BatchPutMessage).
+     */
+    RoleArn: string;
+};
+/**
+ * Sends an input to an AWS IoT Events detector.
+ */
+export type IotEventsAction = {
+    /**
+     * Whether to process the event actions as a batch. The default value is `false` .
+     *
+     * When `batchMode` is `true` , you can't specify a `messageId` .
+     *
+     * When `batchMode` is `true` and the rule SQL statement evaluates to an Array, each Array element is treated as a separate message when Events by calling [`BatchPutMessage`](https://docs.aws.amazon.com/iotevents/latest/apireference/API_iotevents-data_BatchPutMessage.html) . The resulting array can't have more than 10 messages.
+     */
+    BatchMode?: boolean | undefined;
+    /**
+     * The name of the AWS IoT Events input.
+     */
+    InputName: string;
+    /**
+     * The ID of the message. The default `messageId` is a new UUID value.
+     *
+     * When `batchMode` is `true` , you can't specify a `messageId` --a new UUID value will be assigned.
+     *
+     * Assign a value to this property to ensure that only one input (message) with a given `messageId` will be processed by an AWS IoT Events detector.
+     */
+    MessageId?: string | undefined;
+    /**
+     * The ARN of the role that grants AWS IoT permission to send an input to an AWS IoT Events detector. ("Action":"iotevents:BatchPutMessage").
+     */
+    RoleArn: string;
+};
+/**
+ * Describes an action to send data from an MQTT message that triggered the rule to AWS IoT SiteWise asset properties.
+ */
+export type IotSiteWiseAction = {
+    /**
+     * A list of asset property value entries.
+     */
+    PutAssetPropertyValueEntries: PutAssetPropertyValueEntry[];
+    /**
+     * The ARN of the role that grants AWS IoT permission to send an asset property value to AWS IoT SiteWise. ( `"Action": "iotsitewise:BatchPutAssetPropertyValue"` ). The trust policy can restrict access to specific asset hierarchy paths.
+     */
+    RoleArn: string;
+};
+/**
+ * Send messages to an Amazon Managed Streaming for Apache Kafka (Amazon MSK) or self-managed Apache Kafka cluster.
+ */
+export type KafkaAction = {
+    /**
+     * Properties of the Apache Kafka producer client.
+     */
+    ClientProperties: Record<string, string>;
+    /**
+     * The ARN of Kafka action's VPC `TopicRuleDestination` .
+     */
+    DestinationArn: string;
+    /**
+     * The list of Kafka headers that you specify.
+     */
+    Headers?: KafkaActionHeader[] | undefined;
+    /**
+     * The Kafka message key.
+     */
+    Key?: string | undefined;
+    /**
+     * The Kafka message partition.
+     */
+    Partition?: string | undefined;
+    /**
+     * The Kafka topic for messages to be sent to the Kafka broker.
+     */
+    Topic: string;
+};
+/**
+ * Specifies a Kafka header using key-value pairs when you create a Rule’s Kafka Action. You can use these headers to route data from IoT clients to downstream Kafka clusters without modifying your message payload.
+ */
+export type KafkaActionHeader = {
+    /**
+     * The key of the Kafka header.
+     */
+    Key: string;
+    /**
+     * The value of the Kafka header.
+     */
+    Value: string;
+};
+/**
+ * Describes an action to write data to an Amazon Kinesis stream.
+ */
+export type KinesisAction = {
+    /**
+     * The partition key.
+     */
+    PartitionKey?: string | undefined;
+    /**
+     * The ARN of the IAM role that grants access to the Amazon Kinesis stream.
+     */
+    RoleArn: string;
+    /**
+     * The name of the Amazon Kinesis stream.
+     */
+    StreamName: string;
+};
+/**
+ * Describes an action to invoke a Lambda function.
+ */
+export type LambdaAction = {
+    /**
+     * The ARN of the Lambda function.
+     */
+    FunctionArn?: string | undefined;
+};
+/**
+ * Describes an action to send device location updates from an MQTT message to an Amazon Location tracker resource.
+ */
+export type LocationAction = {
+    /**
+     * The unique ID of the device providing the location data.
+     */
+    DeviceId: string;
+    /**
+     * A string that evaluates to a double value that represents the latitude of the device's location.
+     */
+    Latitude: string;
+    /**
+     * A string that evaluates to a double value that represents the longitude of the device's location.
+     */
+    Longitude: string;
+    /**
+     * The IAM role that grants permission to write to the Amazon Location resource.
+     */
+    RoleArn: string;
+    /**
+     * The time that the location data was sampled. The default value is the time the MQTT message was processed.
+     */
+    Timestamp?: Timestamp | undefined;
+    /**
+     * The name of the tracker resource in Amazon Location in which the location is updated.
+     */
+    TrackerName: string;
+};
+/**
+ * Describes an action that writes data to an Amazon OpenSearch Service domain.
+ */
+export type OpenSearchAction = {
+    /**
+     * The endpoint of your OpenSearch domain.
+     */
+    Endpoint: string;
+    /**
+     * The unique identifier for the document you are storing.
+     */
+    Id: string;
+    /**
+     * The OpenSearch index where you want to store your data.
+     */
+    Index: string;
+    /**
+     * The IAM role ARN that has access to OpenSearch.
+     */
+    RoleArn: string;
+    /**
+     * The type of document you are storing.
+     */
+    Type: string;
+};
+/**
+ * An asset property value entry containing the following information.
+ */
+export type PutAssetPropertyValueEntry = {
+    /**
+     * The ID of the AWS IoT SiteWise asset. You must specify either a `propertyAlias` or both an `aliasId` and a `propertyId` . Accepts substitution templates.
+     */
+    AssetId?: string | undefined;
+    /**
+     * Optional. A unique identifier for this entry that you can define to better track which message caused an error in case of failure. Accepts substitution templates. Defaults to a new UUID.
+     */
+    EntryId?: string | undefined;
+    /**
+     * The name of the property alias associated with your asset property. You must specify either a `propertyAlias` or both an `aliasId` and a `propertyId` . Accepts substitution templates.
+     */
+    PropertyAlias?: string | undefined;
+    /**
+     * The ID of the asset's property. You must specify either a `propertyAlias` or both an `aliasId` and a `propertyId` . Accepts substitution templates.
+     */
+    PropertyId?: string | undefined;
+    /**
+     * A list of property values to insert that each contain timestamp, quality, and value (TQV) information.
+     */
+    PropertyValues: AssetPropertyValue[];
+};
+/**
+ * The input for the DynamoActionVS action that specifies the DynamoDB table to which the message data will be written.
+ */
+export type PutItemInput = {
+    /**
+     * The table where the message data will be written.
+     */
+    TableName: string;
+};
+/**
+ * Describes an action to republish to another topic.
+ */
+export type RepublishAction = {
+    /**
+     * MQTT Version 5.0 headers information. For more information, see [MQTT](https://docs.aws.amazon.com//iot/latest/developerguide/mqtt.html) in the IoT Core Developer Guide.
+     */
+    Headers?: RepublishActionHeaders | undefined;
+    /**
+     * The Quality of Service (QoS) level to use when republishing messages. The default value is 0.
+     */
+    Qos?: number | undefined;
+    /**
+     * The ARN of the IAM role that grants access.
+     */
+    RoleArn: string;
+    /**
+     * The name of the MQTT topic.
+     */
+    Topic: string;
+};
+/**
+ * Specifies MQTT Version 5.0 headers information. For more information, see [MQTT](https://docs.aws.amazon.com//iot/latest/developerguide/mqtt.html) in the IoT Core Developer Guide.
+ */
+export type RepublishActionHeaders = {
+    /**
+     * A UTF-8 encoded string that describes the content of the publishing message.
+     *
+     * For more information, see [Content Type](https://docs.aws.amazon.com/https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901118) in the MQTT Version 5.0 specification.
+     *
+     * Supports [substitution templates](https://docs.aws.amazon.com//iot/latest/developerguide/iot-substitution-templates.html) .
+     * @minLength 0
+     * @maxLength 1024
+     */
+    ContentType?: string | undefined;
+    /**
+     * The base64-encoded binary data used by the sender of the request message to identify which request the response message is for.
+     *
+     * For more information, see [Correlation Data](https://docs.aws.amazon.com/https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901115) in the MQTT Version 5.0 specification.
+     *
+     * Supports [substitution templates](https://docs.aws.amazon.com//iot/latest/developerguide/iot-substitution-templates.html) .
+     *
+     * > This binary data must be base64-encoded.
+     * @minLength 0
+     * @maxLength 1024
+     */
+    CorrelationData?: string | undefined;
+    /**
+     * A user-defined integer value that represents the message expiry interval at the broker. If the messages haven't been sent to the subscribers within that interval, the message expires and is removed. The value of `messageExpiry` represents the number of seconds before it expires. For more information about the limits of `messageExpiry` , see [Message broker and protocol limits and quotas](https://docs.aws.amazon.com//general/latest/gr/iot-core.html#limits_iot) in the IoT Core Reference Guide.
+     *
+     * Supports [substitution templates](https://docs.aws.amazon.com//iot/latest/developerguide/iot-substitution-templates.html) .
+     * @minLength 0
+     * @maxLength 1024
+     */
+    MessageExpiry?: string | undefined;
+    /**
+     * An `Enum` string value that indicates whether the payload is formatted as UTF-8.
+     *
+     * Valid values are `UNSPECIFIED_BYTES` and `UTF8_DATA` .
+     *
+     * For more information, see [Payload Format Indicator](https://docs.aws.amazon.com/https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901111) from the MQTT Version 5.0 specification.
+     *
+     * Supports [substitution templates](https://docs.aws.amazon.com//iot/latest/developerguide/iot-substitution-templates.html) .
+     * @minLength 0
+     * @maxLength 1024
+     */
+    PayloadFormatIndicator?: string | undefined;
+    /**
+     * A UTF-8 encoded string that's used as the topic name for a response message. The response topic is used to describe the topic to which the receiver should publish as part of the request-response flow. The topic must not contain wildcard characters.
+     *
+     * For more information, see [Response Topic](https://docs.aws.amazon.com/https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901114) in the MQTT Version 5.0 specification.
+     *
+     * Supports [substitution templates](https://docs.aws.amazon.com//iot/latest/developerguide/iot-substitution-templates.html) .
+     * @minLength 0
+     * @maxLength 1024
+     */
+    ResponseTopic?: string | undefined;
+    /**
+     * An array of key-value pairs that you define in the MQTT5 header.
+     */
+    UserProperties?: UserProperty[] | undefined;
+};
+/**
+ * Describes an action to write data to an Amazon S3 bucket.
+ */
+export type S3Action = {
+    /**
+     * The Amazon S3 bucket.
+     */
+    BucketName: string;
+    /**
+     * The Amazon S3 canned ACL that controls access to the object identified by the object key. For more information, see [S3 canned ACLs](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl) .
+     */
+    CannedAcl?: CannedAccessControlList | undefined;
+    /**
+     * The object key. For more information, see [Actions, resources, and condition keys for Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/list_amazons3.html) .
+     */
+    Key: string;
+    /**
+     * The ARN of the IAM role that grants access.
+     */
+    RoleArn: string;
+};
+/**
+ * For more information, see [Signature Version 4 signing process](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) .
+ */
+export type SigV4Authorization = {
+    /**
+     * The ARN of the signing role.
+     */
+    RoleArn: string;
+    /**
+     * The service name to use while signing with Sig V4.
+     */
+    ServiceName: string;
+    /**
+     * The signing region.
+     */
+    SigningRegion: string;
+};
+/**
+ * Describes an action to publish to an Amazon SNS topic.
+ */
+export type SnsAction = {
+    /**
+     * (Optional) The message format of the message to publish. Accepted values are "JSON" and "RAW". The default value of the attribute is "RAW". SNS uses this setting to determine if the payload should be parsed and relevant platform-specific bits of the payload should be extracted. For more information, see [Amazon SNS Message and JSON Formats](https://docs.aws.amazon.com/sns/latest/dg/json-formats.html) in the *Amazon Simple Notification Service Developer Guide* .
+     */
+    MessageFormat?: string | undefined;
+    /**
+     * The ARN of the IAM role that grants access.
+     */
+    RoleArn: string;
+    /**
+     * The ARN of the SNS topic.
+     */
+    TargetArn: string;
+};
+/**
+ * Describes an action to publish data to an Amazon SQS queue.
+ */
+export type SqsAction = {
+    /**
+     * The URL of the Amazon SQS queue.
+     */
+    QueueUrl: string;
+    /**
+     * The ARN of the IAM role that grants access.
+     */
+    RoleArn: string;
+    /**
+     * Specifies whether to use Base64 encoding.
+     */
+    UseBase64?: boolean | undefined;
+};
+/**
+ * Starts execution of a Step Functions state machine.
+ */
+export type StepFunctionsAction = {
+    /**
+     * (Optional) A name will be given to the state machine execution consisting of this prefix followed by a UUID. Step Functions automatically creates a unique name for each state machine execution if one is not provided.
+     */
+    ExecutionNamePrefix?: string | undefined;
+    /**
+     * The ARN of the role that grants IoT permission to start execution of a state machine ("Action":"states:StartExecution").
+     */
+    RoleArn: string;
+    /**
+     * The name of the Step Functions state machine whose execution will be started.
+     */
+    StateMachineName: string;
+};
+/**
+ * Describes how to interpret an application-defined timestamp value from an MQTT message payload and the precision of that value.
+ */
+export type Timestamp = {
+    /**
+     * The precision of the timestamp value that results from the expression described in `value` .
+     */
+    Unit?: string | undefined;
+    /**
+     * An expression that returns a long epoch time value.
+     */
+    Value: string;
+};
+/**
+ * Describes an action that writes records into an Amazon Timestream table.
+ */
+export type TimestreamAction = {
+    /**
+     * The name of an Amazon Timestream database that has the table to write records into.
+     */
+    DatabaseName: string;
+    /**
+     * Metadata attributes of the time series that are written in each measure record.
+     */
+    Dimensions: TimestreamDimension[];
+    /**
+     * The Amazon Resource Name (ARN) of the role that grants AWS IoT permission to write to the Timestream database table.
+     */
+    RoleArn: string;
+    /**
+     * The table where the message data will be written.
+     */
+    TableName: string;
+    /**
+     * The value to use for the entry's timestamp. If blank, the time that the entry was processed is used.
+     */
+    Timestamp?: TimestreamTimestamp | undefined;
+};
+/**
+ * Metadata attributes of the time series that are written in each measure record.
+ */
+export type TimestreamDimension = {
+    /**
+     * The metadata dimension name. This is the name of the column in the Amazon Timestream database table record.
+     */
+    Name: string;
+    /**
+     * The value to write in this column of the database record.
+     */
+    Value: string;
+};
+/**
+ * The value to use for the entry's timestamp. If blank, the time that the entry was processed is used.
+ */
+export type TimestreamTimestamp = {
+    /**
+     * The precision of the timestamp value that results from the expression described in `value` .
+     */
+    Unit: string;
+    /**
+     * An expression that returns a long epoch time value.
+     */
+    Value: string;
+};
+/**
+ * Describes a rule.
+ */
+export type TopicRulePayload = {
+    /**
+     * The actions associated with the rule.
+     */
+    Actions: Action[];
+    /**
+     * The version of the SQL rules engine to use when evaluating the rule.
+     *
+     * The default value is 2015-10-08.
+     */
+    AwsIotSqlVersion?: string | undefined;
+    /**
+     * The description of the rule.
+     */
+    Description?: string | undefined;
+    /**
+     * The action to take when an error occurs.
+     */
+    ErrorAction?: Action | undefined;
+    /**
+     * Specifies whether the rule is disabled.
+     */
+    RuleDisabled?: boolean | undefined;
+    /**
+     * The SQL statement used to query the topic. For more information, see [AWS IoT SQL Reference](https://docs.aws.amazon.com/iot/latest/developerguide/iot-sql-reference.html) in the *AWS IoT Developer Guide* .
+     */
+    Sql: string;
+};
+/**
+ * A key-value pair that you define in the header.
+ */
+export type UserProperty = {
+    /**
+     * A key to be specified in `UserProperty` .
+     * @minLength 0
+     * @maxLength 1024
+     */
+    Key: string;
+    /**
+     * A value to be specified in `UserProperty` .
+     * @minLength 0
+     * @maxLength 1024
+     */
+    Value: string;
+};
+//# sourceMappingURL=aws-iot-topicrule.d.ts.map