Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/serverless-framework-configuration/_shared/latest--aws-iot-topicrule.json
Parent schema serverless-framework-configuration
Type: object

Resource Type definition for AWS::IoT::TopicRule. Source:- https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git

Properties

TopicRulePayload object required
6 nested properties
Actions Action[] required
Sql string | Aws_CF_FunctionString required
RuleDisabled boolean
ErrorAction object
22 nested properties
S3 object
4 nested properties
BucketName string | Aws_CF_FunctionString required
Key string | Aws_CF_FunctionString required
RoleArn string | Aws_CF_FunctionString required
CannedAcl string | Aws_CF_FunctionString
CloudwatchAlarm object
4 nested properties
StateValue string | Aws_CF_FunctionString required
AlarmName string | Aws_CF_FunctionString required
StateReason string | Aws_CF_FunctionString required
RoleArn string | Aws_CF_FunctionString required
CloudwatchLogs object
3 nested properties
LogGroupName string | Aws_CF_FunctionString required
RoleArn string | Aws_CF_FunctionString required
BatchMode boolean
IotEvents object
4 nested properties
InputName string | Aws_CF_FunctionString required
RoleArn string | Aws_CF_FunctionString required
MessageId string | Aws_CF_FunctionString
BatchMode boolean
Firehose object
4 nested properties
DeliveryStreamName string | Aws_CF_FunctionString required
RoleArn string | Aws_CF_FunctionString required
Separator string | Aws_CF_FunctionString
BatchMode boolean
Republish object
4 nested properties
Topic string | Aws_CF_FunctionString required
RoleArn string | Aws_CF_FunctionString required
Qos integer
Headers object
StepFunctions object
3 nested properties
StateMachineName string | Aws_CF_FunctionString required
RoleArn string | Aws_CF_FunctionString required
ExecutionNamePrefix string | Aws_CF_FunctionString
DynamoDB object
9 nested properties
TableName string | Aws_CF_FunctionString required
HashKeyField string | Aws_CF_FunctionString required
HashKeyValue string | Aws_CF_FunctionString required
RoleArn string | Aws_CF_FunctionString required
PayloadField string | Aws_CF_FunctionString
RangeKeyField string | Aws_CF_FunctionString
RangeKeyValue string | Aws_CF_FunctionString
RangeKeyType string | Aws_CF_FunctionString
HashKeyType string | Aws_CF_FunctionString
Http object
4 nested properties
Url string | Aws_CF_FunctionString required
ConfirmationUrl string | Aws_CF_FunctionString
uniqueItems=true
Auth object
DynamoDBv2 object
2 nested properties
PutItem object
RoleArn string | Aws_CF_FunctionString
CloudwatchMetric object
6 nested properties
MetricName string | Aws_CF_FunctionString required
MetricValue string | Aws_CF_FunctionString required
MetricNamespace string | Aws_CF_FunctionString required
MetricUnit string | Aws_CF_FunctionString required
RoleArn string | Aws_CF_FunctionString required
MetricTimestamp string | Aws_CF_FunctionString
IotSiteWise object
2 nested properties
RoleArn string | Aws_CF_FunctionString required
PutAssetPropertyValueEntries PutAssetPropertyValueEntry[] required
uniqueItems=true
Elasticsearch object
5 nested properties
Type string | Aws_CF_FunctionString required
Index string | Aws_CF_FunctionString required
Id string | Aws_CF_FunctionString required
Endpoint string | Aws_CF_FunctionString required
RoleArn string | Aws_CF_FunctionString required
Sqs object
3 nested properties
RoleArn string | Aws_CF_FunctionString required
QueueUrl string | Aws_CF_FunctionString required
UseBase64 boolean
Kinesis object
3 nested properties
StreamName string | Aws_CF_FunctionString required
RoleArn string | Aws_CF_FunctionString required
PartitionKey string | Aws_CF_FunctionString
IotAnalytics object
3 nested properties
RoleArn string | Aws_CF_FunctionString required
ChannelName string | Aws_CF_FunctionString required
BatchMode boolean
Sns object
3 nested properties
TargetArn string | Aws_CF_FunctionString required
RoleArn string | Aws_CF_FunctionString required
MessageFormat string | Aws_CF_FunctionString
Lambda object
1 nested properties
FunctionArn string | Aws_CF_FunctionString
Timestream object
5 nested properties
RoleArn string | Aws_CF_FunctionString required
DatabaseName string | Aws_CF_FunctionString required
TableName string | Aws_CF_FunctionString required
Dimensions TimestreamDimension[] required
minItems=1maxItems=128
Timestamp object
Kafka object
5 nested properties
DestinationArn string | Aws_CF_FunctionString required
Topic string | Aws_CF_FunctionString required
ClientProperties object required
Key string | Aws_CF_FunctionString
Partition string | Aws_CF_FunctionString
OpenSearch object
5 nested properties
Type string | Aws_CF_FunctionString required
Index string | Aws_CF_FunctionString required
Id string | Aws_CF_FunctionString required
Endpoint string | Aws_CF_FunctionString required
RoleArn string | Aws_CF_FunctionString required
Location object
6 nested properties
RoleArn string | Aws_CF_FunctionString required
TrackerName string | Aws_CF_FunctionString required
DeviceId string | Aws_CF_FunctionString required
Latitude string | Aws_CF_FunctionString required
Longitude string | Aws_CF_FunctionString required
Timestamp object
Description string | Aws_CF_FunctionString
AwsIotSqlVersion string | Aws_CF_FunctionString
RuleName string | Aws_CF_FunctionString
Tags Tag[]

Definitions

Action object
S3 object
4 nested properties
BucketName string | Aws_CF_FunctionString required
Key string | Aws_CF_FunctionString required
RoleArn string | Aws_CF_FunctionString required
CannedAcl string | Aws_CF_FunctionString
CloudwatchAlarm object
4 nested properties
StateValue string | Aws_CF_FunctionString required
AlarmName string | Aws_CF_FunctionString required
StateReason string | Aws_CF_FunctionString required
RoleArn string | Aws_CF_FunctionString required
CloudwatchLogs object
3 nested properties
LogGroupName string | Aws_CF_FunctionString required
RoleArn string | Aws_CF_FunctionString required
BatchMode boolean
IotEvents object
4 nested properties
InputName string | Aws_CF_FunctionString required
RoleArn string | Aws_CF_FunctionString required
MessageId string | Aws_CF_FunctionString
BatchMode boolean
Firehose object
4 nested properties
DeliveryStreamName string | Aws_CF_FunctionString required
RoleArn string | Aws_CF_FunctionString required
Separator string | Aws_CF_FunctionString
BatchMode boolean
Republish object
4 nested properties
Topic string | Aws_CF_FunctionString required
RoleArn string | Aws_CF_FunctionString required
Qos integer
Headers object
6 nested properties
PayloadFormatIndicator string | Aws_CF_FunctionString
ContentType string | Aws_CF_FunctionString
ResponseTopic string | Aws_CF_FunctionString
CorrelationData string | Aws_CF_FunctionString
MessageExpiry string | Aws_CF_FunctionString
UserProperties UserProperty[]
minItems=1maxItems=100
StepFunctions object
3 nested properties
StateMachineName string | Aws_CF_FunctionString required
RoleArn string | Aws_CF_FunctionString required
ExecutionNamePrefix string | Aws_CF_FunctionString
DynamoDB object
9 nested properties
TableName string | Aws_CF_FunctionString required
HashKeyField string | Aws_CF_FunctionString required
HashKeyValue string | Aws_CF_FunctionString required
RoleArn string | Aws_CF_FunctionString required
PayloadField string | Aws_CF_FunctionString
RangeKeyField string | Aws_CF_FunctionString
RangeKeyValue string | Aws_CF_FunctionString
RangeKeyType string | Aws_CF_FunctionString
HashKeyType string | Aws_CF_FunctionString
Http object
4 nested properties
Url string | Aws_CF_FunctionString required
ConfirmationUrl string | Aws_CF_FunctionString
uniqueItems=true
Auth object
1 nested properties
Sigv4 object
DynamoDBv2 object
2 nested properties
PutItem object
1 nested properties
TableName string | Aws_CF_FunctionString required
RoleArn string | Aws_CF_FunctionString
CloudwatchMetric object
6 nested properties
MetricName string | Aws_CF_FunctionString required
MetricValue string | Aws_CF_FunctionString required
MetricNamespace string | Aws_CF_FunctionString required
MetricUnit string | Aws_CF_FunctionString required
RoleArn string | Aws_CF_FunctionString required
MetricTimestamp string | Aws_CF_FunctionString
IotSiteWise object
2 nested properties
RoleArn string | Aws_CF_FunctionString required
PutAssetPropertyValueEntries PutAssetPropertyValueEntry[] required
uniqueItems=true
Elasticsearch object
5 nested properties
Type string | Aws_CF_FunctionString required
Index string | Aws_CF_FunctionString required
Id string | Aws_CF_FunctionString required
Endpoint string | Aws_CF_FunctionString required
RoleArn string | Aws_CF_FunctionString required
Sqs object
3 nested properties
RoleArn string | Aws_CF_FunctionString required
QueueUrl string | Aws_CF_FunctionString required
UseBase64 boolean
Kinesis object
3 nested properties
StreamName string | Aws_CF_FunctionString required
RoleArn string | Aws_CF_FunctionString required
PartitionKey string | Aws_CF_FunctionString
IotAnalytics object
3 nested properties
RoleArn string | Aws_CF_FunctionString required
ChannelName string | Aws_CF_FunctionString required
BatchMode boolean
Sns object
3 nested properties
TargetArn string | Aws_CF_FunctionString required
RoleArn string | Aws_CF_FunctionString required
MessageFormat string | Aws_CF_FunctionString
Lambda object
1 nested properties
FunctionArn string | Aws_CF_FunctionString
Timestream object
5 nested properties
RoleArn string | Aws_CF_FunctionString required
DatabaseName string | Aws_CF_FunctionString required
TableName string | Aws_CF_FunctionString required
Dimensions TimestreamDimension[] required
minItems=1maxItems=128
Timestamp object
2 nested properties
Value string | Aws_CF_FunctionString required
Unit string | Aws_CF_FunctionString required
Kafka object
5 nested properties
DestinationArn string | Aws_CF_FunctionString required
Topic string | Aws_CF_FunctionString required
ClientProperties object required
Key string | Aws_CF_FunctionString
Partition string | Aws_CF_FunctionString
OpenSearch object
5 nested properties
Type string | Aws_CF_FunctionString required
Index string | Aws_CF_FunctionString required
Id string | Aws_CF_FunctionString required
Endpoint string | Aws_CF_FunctionString required
RoleArn string | Aws_CF_FunctionString required
Location object
6 nested properties
RoleArn string | Aws_CF_FunctionString required
TrackerName string | Aws_CF_FunctionString required
DeviceId string | Aws_CF_FunctionString required
Latitude string | Aws_CF_FunctionString required
Longitude string | Aws_CF_FunctionString required
Timestamp object
2 nested properties
Value string | Aws_CF_FunctionString required
Unit string | Aws_CF_FunctionString
ElasticsearchAction object
Type string | Aws_CF_FunctionString required
Index string | Aws_CF_FunctionString required
Id string | Aws_CF_FunctionString required
Endpoint string | Aws_CF_FunctionString required
RoleArn string | Aws_CF_FunctionString required
KinesisAction object
StreamName string | Aws_CF_FunctionString required
RoleArn string | Aws_CF_FunctionString required
PartitionKey string | Aws_CF_FunctionString
FirehoseAction object
DeliveryStreamName string | Aws_CF_FunctionString required
RoleArn string | Aws_CF_FunctionString required
Separator string | Aws_CF_FunctionString
BatchMode boolean
AssetPropertyTimestamp object
TimeInSeconds string | Aws_CF_FunctionString required
OffsetInNanos string | Aws_CF_FunctionString
CloudwatchMetricAction object
MetricName string | Aws_CF_FunctionString required
MetricValue string | Aws_CF_FunctionString required
MetricNamespace string | Aws_CF_FunctionString required
MetricUnit string | Aws_CF_FunctionString required
RoleArn string | Aws_CF_FunctionString required
MetricTimestamp string | Aws_CF_FunctionString
AssetPropertyVariant object
StringValue string | Aws_CF_FunctionString
DoubleValue string | Aws_CF_FunctionString
BooleanValue string | Aws_CF_FunctionString
IntegerValue string | Aws_CF_FunctionString
DynamoDBAction object
TableName string | Aws_CF_FunctionString required
HashKeyField string | Aws_CF_FunctionString required
HashKeyValue string | Aws_CF_FunctionString required
RoleArn string | Aws_CF_FunctionString required
PayloadField string | Aws_CF_FunctionString
RangeKeyField string | Aws_CF_FunctionString
RangeKeyValue string | Aws_CF_FunctionString
RangeKeyType string | Aws_CF_FunctionString
HashKeyType string | Aws_CF_FunctionString
UserProperty object
Key string | Aws_CF_FunctionString required
Value string | Aws_CF_FunctionString required
UserProperties UserProperty[]
RepublishActionHeaders object
PayloadFormatIndicator string | Aws_CF_FunctionString
ContentType string | Aws_CF_FunctionString
ResponseTopic string | Aws_CF_FunctionString
CorrelationData string | Aws_CF_FunctionString
MessageExpiry string | Aws_CF_FunctionString
UserProperties UserProperty[]
minItems=1maxItems=100
RepublishAction object
Topic string | Aws_CF_FunctionString required
RoleArn string | Aws_CF_FunctionString required
Qos integer
Headers object
6 nested properties
PayloadFormatIndicator string | Aws_CF_FunctionString
ContentType string | Aws_CF_FunctionString
ResponseTopic string | Aws_CF_FunctionString
CorrelationData string | Aws_CF_FunctionString
MessageExpiry string | Aws_CF_FunctionString
UserProperties UserProperty[]
minItems=1maxItems=100
SnsAction object
TargetArn string | Aws_CF_FunctionString required
RoleArn string | Aws_CF_FunctionString required
MessageFormat string | Aws_CF_FunctionString
StepFunctionsAction object
StateMachineName string | Aws_CF_FunctionString required
RoleArn string | Aws_CF_FunctionString required
ExecutionNamePrefix string | Aws_CF_FunctionString
SqsAction object
RoleArn string | Aws_CF_FunctionString required
QueueUrl string | Aws_CF_FunctionString required
UseBase64 boolean
SigV4Authorization object
ServiceName string | Aws_CF_FunctionString required
SigningRegion string | Aws_CF_FunctionString required
RoleArn string | Aws_CF_FunctionString required
LambdaAction object
FunctionArn string | Aws_CF_FunctionString
PutAssetPropertyValueEntry object
PropertyValues AssetPropertyValue[] required
uniqueItems=true
PropertyAlias string | Aws_CF_FunctionString
AssetId string | Aws_CF_FunctionString
EntryId string | Aws_CF_FunctionString
PropertyId string | Aws_CF_FunctionString
PutItemInput object
TableName string | Aws_CF_FunctionString required
S3Action object
BucketName string | Aws_CF_FunctionString required
Key string | Aws_CF_FunctionString required
RoleArn string | Aws_CF_FunctionString required
CannedAcl string | Aws_CF_FunctionString
AssetPropertyValue object
Value object required
4 nested properties
StringValue string | Aws_CF_FunctionString
DoubleValue string | Aws_CF_FunctionString
BooleanValue string | Aws_CF_FunctionString
IntegerValue string | Aws_CF_FunctionString
Timestamp object required
2 nested properties
TimeInSeconds string | Aws_CF_FunctionString required
OffsetInNanos string | Aws_CF_FunctionString
Quality string | Aws_CF_FunctionString
DynamoDBv2Action object
PutItem object
1 nested properties
TableName string | Aws_CF_FunctionString required
RoleArn string | Aws_CF_FunctionString
IotEventsAction object
InputName string | Aws_CF_FunctionString required
RoleArn string | Aws_CF_FunctionString required
MessageId string | Aws_CF_FunctionString
BatchMode boolean
HttpAuthorization object
Sigv4 object
3 nested properties
ServiceName string | Aws_CF_FunctionString required
SigningRegion string | Aws_CF_FunctionString required
RoleArn string | Aws_CF_FunctionString required
TopicRulePayload object
Actions Action[] required
Sql string | Aws_CF_FunctionString required
RuleDisabled boolean
ErrorAction object
22 nested properties
S3 object
4 nested properties
BucketName string | Aws_CF_FunctionString required
Key string | Aws_CF_FunctionString required
RoleArn string | Aws_CF_FunctionString required
CannedAcl string | Aws_CF_FunctionString
CloudwatchAlarm object
4 nested properties
StateValue string | Aws_CF_FunctionString required
AlarmName string | Aws_CF_FunctionString required
StateReason string | Aws_CF_FunctionString required
RoleArn string | Aws_CF_FunctionString required
CloudwatchLogs object
3 nested properties
LogGroupName string | Aws_CF_FunctionString required
RoleArn string | Aws_CF_FunctionString required
BatchMode boolean
IotEvents object
4 nested properties
InputName string | Aws_CF_FunctionString required
RoleArn string | Aws_CF_FunctionString required
MessageId string | Aws_CF_FunctionString
BatchMode boolean
Firehose object
4 nested properties
DeliveryStreamName string | Aws_CF_FunctionString required
RoleArn string | Aws_CF_FunctionString required
Separator string | Aws_CF_FunctionString
BatchMode boolean
Republish object
4 nested properties
Topic string | Aws_CF_FunctionString required
RoleArn string | Aws_CF_FunctionString required
Qos integer
Headers object
StepFunctions object
3 nested properties
StateMachineName string | Aws_CF_FunctionString required
RoleArn string | Aws_CF_FunctionString required
ExecutionNamePrefix string | Aws_CF_FunctionString
DynamoDB object
9 nested properties
TableName string | Aws_CF_FunctionString required
HashKeyField string | Aws_CF_FunctionString required
HashKeyValue string | Aws_CF_FunctionString required
RoleArn string | Aws_CF_FunctionString required
PayloadField string | Aws_CF_FunctionString
RangeKeyField string | Aws_CF_FunctionString
RangeKeyValue string | Aws_CF_FunctionString
RangeKeyType string | Aws_CF_FunctionString
HashKeyType string | Aws_CF_FunctionString
Http object
4 nested properties
Url string | Aws_CF_FunctionString required
ConfirmationUrl string | Aws_CF_FunctionString
uniqueItems=true
Auth object
DynamoDBv2 object
2 nested properties
PutItem object
RoleArn string | Aws_CF_FunctionString
CloudwatchMetric object
6 nested properties
MetricName string | Aws_CF_FunctionString required
MetricValue string | Aws_CF_FunctionString required
MetricNamespace string | Aws_CF_FunctionString required
MetricUnit string | Aws_CF_FunctionString required
RoleArn string | Aws_CF_FunctionString required
MetricTimestamp string | Aws_CF_FunctionString
IotSiteWise object
2 nested properties
RoleArn string | Aws_CF_FunctionString required
PutAssetPropertyValueEntries PutAssetPropertyValueEntry[] required
uniqueItems=true
Elasticsearch object
5 nested properties
Type string | Aws_CF_FunctionString required
Index string | Aws_CF_FunctionString required
Id string | Aws_CF_FunctionString required
Endpoint string | Aws_CF_FunctionString required
RoleArn string | Aws_CF_FunctionString required
Sqs object
3 nested properties
RoleArn string | Aws_CF_FunctionString required
QueueUrl string | Aws_CF_FunctionString required
UseBase64 boolean
Kinesis object
3 nested properties
StreamName string | Aws_CF_FunctionString required
RoleArn string | Aws_CF_FunctionString required
PartitionKey string | Aws_CF_FunctionString
IotAnalytics object
3 nested properties
RoleArn string | Aws_CF_FunctionString required
ChannelName string | Aws_CF_FunctionString required
BatchMode boolean
Sns object
3 nested properties
TargetArn string | Aws_CF_FunctionString required
RoleArn string | Aws_CF_FunctionString required
MessageFormat string | Aws_CF_FunctionString
Lambda object
1 nested properties
FunctionArn string | Aws_CF_FunctionString
Timestream object
5 nested properties
RoleArn string | Aws_CF_FunctionString required
DatabaseName string | Aws_CF_FunctionString required
TableName string | Aws_CF_FunctionString required
Dimensions TimestreamDimension[] required
minItems=1maxItems=128
Timestamp object
Kafka object
5 nested properties
DestinationArn string | Aws_CF_FunctionString required
Topic string | Aws_CF_FunctionString required
ClientProperties object required
Key string | Aws_CF_FunctionString
Partition string | Aws_CF_FunctionString
OpenSearch object
5 nested properties
Type string | Aws_CF_FunctionString required
Index string | Aws_CF_FunctionString required
Id string | Aws_CF_FunctionString required
Endpoint string | Aws_CF_FunctionString required
RoleArn string | Aws_CF_FunctionString required
Location object
6 nested properties
RoleArn string | Aws_CF_FunctionString required
TrackerName string | Aws_CF_FunctionString required
DeviceId string | Aws_CF_FunctionString required
Latitude string | Aws_CF_FunctionString required
Longitude string | Aws_CF_FunctionString required
Timestamp object
Description string | Aws_CF_FunctionString
AwsIotSqlVersion string | Aws_CF_FunctionString
CloudwatchAlarmAction object
StateValue string | Aws_CF_FunctionString required
AlarmName string | Aws_CF_FunctionString required
StateReason string | Aws_CF_FunctionString required
RoleArn string | Aws_CF_FunctionString required
CloudwatchLogsAction object
LogGroupName string | Aws_CF_FunctionString required
RoleArn string | Aws_CF_FunctionString required
BatchMode boolean
IotAnalyticsAction object
RoleArn string | Aws_CF_FunctionString required
ChannelName string | Aws_CF_FunctionString required
BatchMode boolean
HttpActionHeader object
Value string | Aws_CF_FunctionString required
Key string | Aws_CF_FunctionString required
IotSiteWiseAction object
RoleArn string | Aws_CF_FunctionString required
PutAssetPropertyValueEntries PutAssetPropertyValueEntry[] required
uniqueItems=true
HttpAction object
Url string | Aws_CF_FunctionString required
ConfirmationUrl string | Aws_CF_FunctionString
uniqueItems=true
Auth object
1 nested properties
Sigv4 object
3 nested properties
ServiceName string | Aws_CF_FunctionString required
SigningRegion string | Aws_CF_FunctionString required
RoleArn string | Aws_CF_FunctionString required
TimestreamAction object
RoleArn string | Aws_CF_FunctionString required
DatabaseName string | Aws_CF_FunctionString required
TableName string | Aws_CF_FunctionString required
Dimensions TimestreamDimension[] required
minItems=1maxItems=128
Timestamp object
2 nested properties
Value string | Aws_CF_FunctionString required
Unit string | Aws_CF_FunctionString required
KafkaAction object
DestinationArn string | Aws_CF_FunctionString required
Topic string | Aws_CF_FunctionString required
ClientProperties object required
Key string | Aws_CF_FunctionString
Partition string | Aws_CF_FunctionString
OpenSearchAction object
Type string | Aws_CF_FunctionString required
Index string | Aws_CF_FunctionString required
Id string | Aws_CF_FunctionString required
Endpoint string | Aws_CF_FunctionString required
RoleArn string | Aws_CF_FunctionString required
LocationAction object
RoleArn string | Aws_CF_FunctionString required
TrackerName string | Aws_CF_FunctionString required
DeviceId string | Aws_CF_FunctionString required
Latitude string | Aws_CF_FunctionString required
Longitude string | Aws_CF_FunctionString required
Timestamp object
2 nested properties
Value string | Aws_CF_FunctionString required
Unit string | Aws_CF_FunctionString
CannedAccessControlList string | Aws_CF_FunctionString
RoleArn string | Aws_CF_FunctionString
Tag object
Key string | Aws_CF_FunctionString required
Value string | Aws_CF_FunctionString required
TimestreamDimensionsList TimestreamDimension[]
TimestreamDimension object
Name string | Aws_CF_FunctionString required
Value string | Aws_CF_FunctionString required
TimestreamTimestamp object
Value string | Aws_CF_FunctionString required
Unit string | Aws_CF_FunctionString required
Timestamp object
Value string | Aws_CF_FunctionString required
Unit string | Aws_CF_FunctionString