AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the AWS IoT CreateTopicRule API operation.

Syntax

New-IOTTopicRule
-TopicRulePayload_Action <Action[]>
-CloudwatchAlarm_AlarmName <String>
-TopicRulePayload_AwsIotSqlVersion <String>
-CloudwatchLogs_BatchMode <Boolean>
-Firehose_BatchMode <Boolean>
-IotAnalytics_BatchMode <Boolean>
-IotEvents_BatchMode <Boolean>
-S3_BucketName <String>
-S3_CannedAcl <CannedAccessControlList>
-IotAnalytics_ChannelArn <String>
-IotAnalytics_ChannelName <String>
-Kafka_ClientProperty <Hashtable>
-Http_ConfirmationUrl <String>
-Headers_ContentType <String>
-Headers_CorrelationData <String>
-Timestream_DatabaseName <String>
-Firehose_DeliveryStreamName <String>
-TopicRulePayload_Description <String>
-Kafka_DestinationArn <String>
-Location_DeviceId <String>
-Timestream_Dimension <TimestreamDimension[]>
-Elasticsearch_Endpoint <String>
-OpenSearch_Endpoint <String>
-StepFunctions_ExecutionNamePrefix <String>
-Lambda_FunctionArn <String>
-DynamoDB_HashKeyField <String>
-DynamoDB_HashKeyType <DynamoKeyType>
-DynamoDB_HashKeyValue <String>
-Http_Header <HttpActionHeader[]>
-Kafka_Header <KafkaActionHeader[]>
-Elasticsearch_Id <String>
-OpenSearch_Id <String>
-Elasticsearch_Index <String>
-OpenSearch_Index <String>
-IotEvents_InputName <String>
-Kafka_Key <String>
-S3_Key <String>
-Location_Latitude <String>
-CloudwatchLogs_LogGroupName <String>
-Location_Longitude <String>
-Headers_MessageExpiry <String>
-Sns_MessageFormat <MessageFormat>
-IotEvents_MessageId <String>
-CloudwatchMetric_MetricName <String>
-CloudwatchMetric_MetricNamespace <String>
-CloudwatchMetric_MetricTimestamp <String>
-CloudwatchMetric_MetricUnit <String>
-CloudwatchMetric_MetricValue <String>
-DynamoDB_Operation <String>
-Kafka_Partition <String>
-Kinesis_PartitionKey <String>
-DynamoDB_PayloadField <String>
-Headers_PayloadFormatIndicator <String>
-IotSiteWise_PutAssetPropertyValueEntry <PutAssetPropertyValueEntry[]>
-Republish_Qo <Int32>
-Sqs_QueueUrl <String>
-DynamoDB_RangeKeyField <String>
-DynamoDB_RangeKeyType <DynamoKeyType>
-DynamoDB_RangeKeyValue <String>
-Headers_ResponseTopic <String>
-CloudwatchAlarm_RoleArn <String>
-CloudwatchLogs_RoleArn <String>
-CloudwatchMetric_RoleArn <String>
-DynamoDB_RoleArn <String>
-DynamoDBv2_RoleArn <String>
-Elasticsearch_RoleArn <String>
-Firehose_RoleArn <String>
-Sigv4_RoleArn <String>
-IotAnalytics_RoleArn <String>
-IotEvents_RoleArn <String>
-IotSiteWise_RoleArn <String>
-Kinesis_RoleArn <String>
-Location_RoleArn <String>
-OpenSearch_RoleArn <String>
-Republish_RoleArn <String>
-S3_RoleArn <String>
-Sns_RoleArn <String>
-Sqs_RoleArn <String>
-StepFunctions_RoleArn <String>
-Timestream_RoleArn <String>
-TopicRulePayload_RuleDisabled <Boolean>
-RuleName <String>
-Firehose_Separator <String>
-Sigv4_ServiceName <String>
-Sigv4_SigningRegion <String>
-TopicRulePayload_Sql <String>
-StepFunctions_StateMachineName <String>
-CloudwatchAlarm_StateReason <String>
-CloudwatchAlarm_StateValue <String>
-Kinesis_StreamName <String>
-DynamoDB_TableName <String>
-PutItem_TableName <String>
-Timestream_TableName <String>
-Tag <String>
-Sns_TargetArn <String>
-Salesforce_Token <String>
-Kafka_Topic <String>
-Republish_Topic <String>
-Location_TrackerName <String>
-Elasticsearch_Type <String>
-OpenSearch_Type <String>
-TopicRulePayload_ErrorAction_Location_Timestamp_Unit <String>
-Timestamp_Unit <String>
-Http_Url <String>
-Salesforce_Url <String>
-Sqs_UseBase64 <Boolean>
-Headers_UserProperty <UserProperty[]>
-TopicRulePayload_ErrorAction_Location_Timestamp_Value <String>
-Timestamp_Value <String>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonIoTConfig>

Description

Creates a rule. Creating rules is an administrator-level action. Any user who has permission to create rules will be able to access data processed by the rule. Requires permission to access the CreateTopicRule action.

Parameters

-ClientConfig <AmazonIoTConfig>
Amazon.PowerShell.Cmdlets.IOT.AmazonIoTClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CloudwatchAlarm_AlarmName <String>
The CloudWatch alarm name.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTopicRulePayload_ErrorAction_CloudwatchAlarm_AlarmName
-CloudwatchAlarm_RoleArn <String>
The IAM role that allows access to the CloudWatch alarm.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTopicRulePayload_ErrorAction_CloudwatchAlarm_RoleArn
-CloudwatchAlarm_StateReason <String>
The reason for the alarm change.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTopicRulePayload_ErrorAction_CloudwatchAlarm_StateReason
-CloudwatchAlarm_StateValue <String>
The value of the alarm state. Acceptable values are: OK, ALARM, INSUFFICIENT_DATA.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTopicRulePayload_ErrorAction_CloudwatchAlarm_StateValue
-CloudwatchLogs_BatchMode <Boolean>
Indicates whether batches of log records will be extracted and uploaded into CloudWatch. Values include true or false(default).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTopicRulePayload_ErrorAction_CloudwatchLogs_BatchMode
-CloudwatchLogs_LogGroupName <String>
The CloudWatch log group to which the action sends data.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTopicRulePayload_ErrorAction_CloudwatchLogs_LogGroupName
-CloudwatchLogs_RoleArn <String>
The IAM role that allows access to the CloudWatch log.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTopicRulePayload_ErrorAction_CloudwatchLogs_RoleArn
-CloudwatchMetric_MetricName <String>
The CloudWatch metric name.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTopicRulePayload_ErrorAction_CloudwatchMetric_MetricName
-CloudwatchMetric_MetricNamespace <String>
The CloudWatch metric namespace name.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTopicRulePayload_ErrorAction_CloudwatchMetric_MetricNamespace
-CloudwatchMetric_MetricTimestamp <String>
An optional Unix timestamp.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTopicRulePayload_ErrorAction_CloudwatchMetric_MetricTimestamp
-CloudwatchMetric_MetricUnit <String>
The metric unit supported by CloudWatch.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTopicRulePayload_ErrorAction_CloudwatchMetric_MetricUnit
-CloudwatchMetric_MetricValue <String>
The CloudWatch metric value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTopicRulePayload_ErrorAction_CloudwatchMetric_MetricValue
-CloudwatchMetric_RoleArn <String>
The IAM role that allows access to the CloudWatch metric.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTopicRulePayload_ErrorAction_CloudwatchMetric_RoleArn
-DynamoDB_HashKeyField <String>
The hash key name.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTopicRulePayload_ErrorAction_DynamoDB_HashKeyField
-DynamoDB_HashKeyType <DynamoKeyType>
The hash key type. Valid values are "STRING" or "NUMBER"
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTopicRulePayload_ErrorAction_DynamoDB_HashKeyType
-DynamoDB_HashKeyValue <String>
The hash key value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTopicRulePayload_ErrorAction_DynamoDB_HashKeyValue
-DynamoDB_Operation <String>
The type of operation to be performed. This follows the substitution template, so it can be ${operation}, but the substitution must result in one of the following: INSERT, UPDATE, or DELETE.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTopicRulePayload_ErrorAction_DynamoDB_Operation
-DynamoDB_PayloadField <String>
The action payload. This name can be customized.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTopicRulePayload_ErrorAction_DynamoDB_PayloadField
-DynamoDB_RangeKeyField <String>
The range key name.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTopicRulePayload_ErrorAction_DynamoDB_RangeKeyField
-DynamoDB_RangeKeyType <DynamoKeyType>
The range key type. Valid values are "STRING" or "NUMBER"
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTopicRulePayload_ErrorAction_DynamoDB_RangeKeyType
-DynamoDB_RangeKeyValue <String>
The range key value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTopicRulePayload_ErrorAction_DynamoDB_RangeKeyValue
-DynamoDB_RoleArn <String>
The ARN of the IAM role that grants access to the DynamoDB table.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTopicRulePayload_ErrorAction_DynamoDB_RoleArn
-DynamoDB_TableName <String>
The name of the DynamoDB table.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTopicRulePayload_ErrorAction_DynamoDB_TableName
-DynamoDBv2_RoleArn <String>
The ARN of the IAM role that grants access to the DynamoDB table.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTopicRulePayload_ErrorAction_DynamoDBv2_RoleArn
-Elasticsearch_Endpoint <String>
The endpoint of your OpenSearch domain.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTopicRulePayload_ErrorAction_Elasticsearch_Endpoint
-Elasticsearch_Id <String>
The unique identifier for the document you are storing.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTopicRulePayload_ErrorAction_Elasticsearch_Id
-Elasticsearch_Index <String>
The index where you want to store your data.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTopicRulePayload_ErrorAction_Elasticsearch_Index
-Elasticsearch_RoleArn <String>
The IAM role ARN that has access to OpenSearch.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTopicRulePayload_ErrorAction_Elasticsearch_RoleArn
-Elasticsearch_Type <String>
The type of document you are storing.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTopicRulePayload_ErrorAction_Elasticsearch_Type
-Firehose_BatchMode <Boolean>
Whether to deliver the Kinesis Data Firehose stream as a batch by using PutRecordBatch. 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 request. The resulting array can't have more than 500 records.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTopicRulePayload_ErrorAction_Firehose_BatchMode
-Firehose_DeliveryStreamName <String>
The delivery stream name.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTopicRulePayload_ErrorAction_Firehose_DeliveryStreamName
-Firehose_RoleArn <String>
The IAM role that grants access to the Amazon Kinesis Firehose stream.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTopicRulePayload_ErrorAction_Firehose_RoleArn
-Firehose_Separator <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).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTopicRulePayload_ErrorAction_Firehose_Separator
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Headers_ContentType <String>
A UTF-8 encoded string that describes the content of the publishing message.For more information, see Content Type from the MQTT Version 5.0 specification.Supports substitution templates.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTopicRulePayload_ErrorAction_Republish_Headers_ContentType
-Headers_CorrelationData <String>
The base64-encoded binary data used by the sender of the request message to identify which request the response message is for when it's received.For more information, see Correlation Data from the MQTT Version 5.0 specification. This binary data must be based64-encoded. Supports substitution templates.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTopicRulePayload_ErrorAction_Republish_Headers_CorrelationData
-Headers_MessageExpiry <String>
A user-defined integer value that will persist a message at the message broker for a specified amount of time to ensure that the message will expire if it's no longer relevant to the subscriber. The value of messageExpiry represents the number of seconds before it expires. For more information about the limits of messageExpiry, see Amazon Web Services IoT Core message broker and protocol limits and quotas from the Amazon Web Services Reference Guide.Supports substitution templates.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTopicRulePayload_ErrorAction_Republish_Headers_MessageExpiry
-Headers_PayloadFormatIndicator <String>
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 from the MQTT Version 5.0 specification.Supports substitution templates.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTopicRulePayload_ErrorAction_Republish_Headers_PayloadFormatIndicator
-Headers_ResponseTopic <String>
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 which the receiver should publish to as part of the request-response flow. The topic must not contain wildcard characters.For more information, see Response Topic from the MQTT Version 5.0 specification.Supports substitution templates.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTopicRulePayload_ErrorAction_Republish_Headers_ResponseTopic
-Headers_UserProperty <UserProperty[]>
An array of key-value pairs that you define in the MQTT5 header.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTopicRulePayload_ErrorAction_Republish_Headers_UserProperties
-Http_ConfirmationUrl <String>
The URL to which 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 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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTopicRulePayload_ErrorAction_Http_ConfirmationUrl
-Http_Header <HttpActionHeader[]>
The HTTP headers to send with the message data.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTopicRulePayload_ErrorAction_Http_Headers
-Http_Url <String>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTopicRulePayload_ErrorAction_Http_Url
-IotAnalytics_BatchMode <Boolean>
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 to the IoT Analytics channel. The resulting array can't have more than 100 messages.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTopicRulePayload_ErrorAction_IotAnalytics_BatchMode
-IotAnalytics_ChannelArn <String>
(deprecated) The ARN of the IoT Analytics channel to which message data will be sent.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTopicRulePayload_ErrorAction_IotAnalytics_ChannelArn
-IotAnalytics_ChannelName <String>
The name of the IoT Analytics channel to which message data will be sent.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTopicRulePayload_ErrorAction_IotAnalytics_ChannelName
-IotAnalytics_RoleArn <String>
The ARN of the role which has a policy that grants IoT Analytics permission to send message data via IoT Analytics (iotanalytics:BatchPutMessage).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTopicRulePayload_ErrorAction_IotAnalytics_RoleArn
-IotEvents_BatchMode <Boolean>
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 it's sent to IoT Events by calling BatchPutMessage. The resulting array can't have more than 10 messages.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTopicRulePayload_ErrorAction_IotEvents_BatchMode
-IotEvents_InputName <String>
The name of the IoT Events input.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTopicRulePayload_ErrorAction_IotEvents_InputName
-IotEvents_MessageId <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 IoT Events detector.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTopicRulePayload_ErrorAction_IotEvents_MessageId
-IotEvents_RoleArn <String>
The ARN of the role that grants IoT permission to send an input to an IoT Events detector. ("Action":"iotevents:BatchPutMessage").
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTopicRulePayload_ErrorAction_IotEvents_RoleArn
-IotSiteWise_PutAssetPropertyValueEntry <PutAssetPropertyValueEntry[]>
A list of asset property value entries.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTopicRulePayload_ErrorAction_IotSiteWise_PutAssetPropertyValueEntries
-IotSiteWise_RoleArn <String>
The ARN of the role that grants IoT permission to send an asset property value to IoT SiteWise. ("Action": "iotsitewise:BatchPutAssetPropertyValue"). The trust policy can restrict access to specific asset hierarchy paths.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTopicRulePayload_ErrorAction_IotSiteWise_RoleArn
-Kafka_ClientProperty <Hashtable>
Properties of the Apache Kafka producer client.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTopicRulePayload_ErrorAction_Kafka_ClientProperties
-Kafka_DestinationArn <String>
The ARN of Kafka action's VPC TopicRuleDestination.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTopicRulePayload_ErrorAction_Kafka_DestinationArn
-Kafka_Header <KafkaActionHeader[]>
The list of Kafka headers that you specify.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTopicRulePayload_ErrorAction_Kafka_Headers
-Kafka_Key <String>
The Kafka message key.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTopicRulePayload_ErrorAction_Kafka_Key
-Kafka_Partition <String>
The Kafka message partition.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTopicRulePayload_ErrorAction_Kafka_Partition
-Kafka_Topic <String>
The Kafka topic for messages to be sent to the Kafka broker.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTopicRulePayload_ErrorAction_Kafka_Topic
-Kinesis_PartitionKey <String>
The partition key.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTopicRulePayload_ErrorAction_Kinesis_PartitionKey
-Kinesis_RoleArn <String>
The ARN of the IAM role that grants access to the Amazon Kinesis stream.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTopicRulePayload_ErrorAction_Kinesis_RoleArn
-Kinesis_StreamName <String>
The name of the Amazon Kinesis stream.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTopicRulePayload_ErrorAction_Kinesis_StreamName
-Lambda_FunctionArn <String>
The ARN of the Lambda function.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTopicRulePayload_ErrorAction_Lambda_FunctionArn
-Location_DeviceId <String>
The unique ID of the device providing the location data.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTopicRulePayload_ErrorAction_Location_DeviceId
-Location_Latitude <String>
A string that evaluates to a double value that represents the latitude of the device's location.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTopicRulePayload_ErrorAction_Location_Latitude
-Location_Longitude <String>
A string that evaluates to a double value that represents the longitude of the device's location.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTopicRulePayload_ErrorAction_Location_Longitude
-Location_RoleArn <String>
The IAM role that grants permission to write to the Amazon Location resource.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTopicRulePayload_ErrorAction_Location_RoleArn
-Location_TrackerName <String>
The name of the tracker resource in Amazon Location in which the location is updated.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTopicRulePayload_ErrorAction_Location_TrackerName
-OpenSearch_Endpoint <String>
The endpoint of your OpenSearch domain.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTopicRulePayload_ErrorAction_OpenSearch_Endpoint
-OpenSearch_Id <String>
The unique identifier for the document you are storing.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTopicRulePayload_ErrorAction_OpenSearch_Id
-OpenSearch_Index <String>
The OpenSearch index where you want to store your data.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTopicRulePayload_ErrorAction_OpenSearch_Index
-OpenSearch_RoleArn <String>
The IAM role ARN that has access to OpenSearch.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTopicRulePayload_ErrorAction_OpenSearch_RoleArn
-OpenSearch_Type <String>
The type of document you are storing.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTopicRulePayload_ErrorAction_OpenSearch_Type
-PutItem_TableName <String>
The table where the message data will be written.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTopicRulePayload_ErrorAction_DynamoDBv2_PutItem_TableName
-Republish_Qo <Int32>
The Quality of Service (QoS) level to use when republishing messages. The default value is 0.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTopicRulePayload_ErrorAction_Republish_Qos
-Republish_RoleArn <String>
The ARN of the IAM role that grants access.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTopicRulePayload_ErrorAction_Republish_RoleArn
-Republish_Topic <String>
The name of the MQTT topic.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTopicRulePayload_ErrorAction_Republish_Topic
-RuleName <String>
The name of the rule.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-S3_BucketName <String>
The Amazon S3 bucket.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTopicRulePayload_ErrorAction_S3_BucketName
-S3_CannedAcl <CannedAccessControlList>
The Amazon S3 canned ACL that controls access to the object identified by the object key. For more information, see S3 canned ACLs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTopicRulePayload_ErrorAction_S3_CannedAcl
-S3_Key <String>
The object key. For more information, see Actions, resources, and condition keys for Amazon S3.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTopicRulePayload_ErrorAction_S3_Key
-S3_RoleArn <String>
The ARN of the IAM role that grants access.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTopicRulePayload_ErrorAction_S3_RoleArn
-Salesforce_Token <String>
The token used to authenticate access to the Salesforce IoT Cloud Input Stream. The token is available from the Salesforce IoT Cloud platform after creation of the Input Stream.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTopicRulePayload_ErrorAction_Salesforce_Token
-Salesforce_Url <String>
The URL exposed by the Salesforce IoT Cloud Input Stream. The URL is available from the Salesforce IoT Cloud platform after creation of the Input Stream.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTopicRulePayload_ErrorAction_Salesforce_Url
-Select <String>
Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IoT.Model.CreateTopicRuleResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Sigv4_RoleArn <String>
The ARN of the signing role.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTopicRulePayload_ErrorAction_Http_Auth_Sigv4_RoleArn
-Sigv4_ServiceName <String>
The service name to use while signing with Sig V4.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTopicRulePayload_ErrorAction_Http_Auth_Sigv4_ServiceName
-Sigv4_SigningRegion <String>
The signing region.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTopicRulePayload_ErrorAction_Http_Auth_Sigv4_SigningRegion
-Sns_MessageFormat <MessageFormat>
(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. To read more about SNS message formats, see https://docs.aws.amazon.com/sns/latest/dg/json-formats.html refer to their official documentation.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTopicRulePayload_ErrorAction_Sns_MessageFormat
-Sns_RoleArn <String>
The ARN of the IAM role that grants access.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTopicRulePayload_ErrorAction_Sns_RoleArn
-Sns_TargetArn <String>
The ARN of the SNS topic.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTopicRulePayload_ErrorAction_Sns_TargetArn
-Sqs_QueueUrl <String>
The URL of the Amazon SQS queue.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTopicRulePayload_ErrorAction_Sqs_QueueUrl
-Sqs_RoleArn <String>
The ARN of the IAM role that grants access.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTopicRulePayload_ErrorAction_Sqs_RoleArn
-Sqs_UseBase64 <Boolean>
Specifies whether to use Base64 encoding.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTopicRulePayload_ErrorAction_Sqs_UseBase64
-StepFunctions_ExecutionNamePrefix <String>
(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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTopicRulePayload_ErrorAction_StepFunctions_ExecutionNamePrefix
-StepFunctions_RoleArn <String>
The ARN of the role that grants IoT permission to start execution of a state machine ("Action":"states:StartExecution").
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTopicRulePayload_ErrorAction_StepFunctions_RoleArn
-StepFunctions_StateMachineName <String>
The name of the Step Functions state machine whose execution will be started.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTopicRulePayload_ErrorAction_StepFunctions_StateMachineName
-Tag <String>
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..."
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags
-Timestamp_Unit <String>
The precision of the timestamp value that results from the expression described in value.Valid values: SECONDS | MILLISECONDS | MICROSECONDS | NANOSECONDS. The default is MILLISECONDS.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTopicRulePayload_ErrorAction_Timestream_Timestamp_Unit
-Timestamp_Value <String>
An expression that returns a long epoch time value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTopicRulePayload_ErrorAction_Timestream_Timestamp_Value
-Timestream_DatabaseName <String>
The name of an Amazon Timestream database.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTopicRulePayload_ErrorAction_Timestream_DatabaseName
-Timestream_Dimension <TimestreamDimension[]>
Metadata attributes of the time series that are written in each measure record.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTopicRulePayload_ErrorAction_Timestream_Dimensions
-Timestream_RoleArn <String>
The ARN of the role that grants permission to write to the Amazon Timestream database table.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTopicRulePayload_ErrorAction_Timestream_RoleArn
-Timestream_TableName <String>
The name of the database table into which to write the measure records.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTopicRulePayload_ErrorAction_Timestream_TableName
-TopicRulePayload_Action <Action[]>
The actions associated with the rule.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTopicRulePayload_Actions
-TopicRulePayload_AwsIotSqlVersion <String>
The version of the SQL rules engine to use when evaluating the rule.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TopicRulePayload_Description <String>
The description of the rule.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TopicRulePayload_ErrorAction_Location_Timestamp_Unit <String>
The precision of the timestamp value that results from the expression described in value.Valid values: SECONDS | MILLISECONDS | MICROSECONDS | NANOSECONDS. The default is MILLISECONDS.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TopicRulePayload_ErrorAction_Location_Timestamp_Value <String>
An expression that returns a long epoch time value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TopicRulePayload_RuleDisabled <Boolean>
Specifies whether the rule is disabled.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TopicRulePayload_Sql <String>
The SQL statement used to query the topic. For more information, see IoT SQL Reference in the IoT Developer Guide.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

None or Amazon.IoT.Model.CreateTopicRuleResponse
This cmdlet does not generate any output.The service response (type Amazon.IoT.Model.CreateTopicRuleResponse) can be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.
Developer Guide
Service API Reference
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z