Docs
Packages
AWS Native v0.63.0, May 25 23
AWS Native v0.63.0, May 25 23
aws-native.iot.getTopicRule
Explore with Pulumi AI
Resource Type definition for AWS::IoT::TopicRule
Using getTopicRule
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getTopicRule(args: GetTopicRuleArgs, opts?: InvokeOptions): Promise<GetTopicRuleResult>
function getTopicRuleOutput(args: GetTopicRuleOutputArgs, opts?: InvokeOptions): Output<GetTopicRuleResult>def get_topic_rule(rule_name: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetTopicRuleResult
def get_topic_rule_output(rule_name: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetTopicRuleResult]func LookupTopicRule(ctx *Context, args *LookupTopicRuleArgs, opts ...InvokeOption) (*LookupTopicRuleResult, error)
func LookupTopicRuleOutput(ctx *Context, args *LookupTopicRuleOutputArgs, opts ...InvokeOption) LookupTopicRuleResultOutput> Note: This function is named LookupTopicRule in the Go SDK.
public static class GetTopicRule
{
public static Task<GetTopicRuleResult> InvokeAsync(GetTopicRuleArgs args, InvokeOptions? opts = null)
public static Output<GetTopicRuleResult> Invoke(GetTopicRuleInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetTopicRuleResult> getTopicRule(GetTopicRuleArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: aws-native:iot:getTopicRule
arguments:
# arguments dictionaryThe following arguments are supported:
- Rule
Name string
- Rule
Name string
- rule
Name String
- rule
Name string
- rule_
name str
- rule
Name String
getTopicRule Result
The following output properties are available:
Supporting Types
TopicRuleAction
- Cloudwatch
Alarm Pulumi.Aws Native. Io T. Inputs. Topic Rule Cloudwatch Alarm Action - Cloudwatch
Logs Pulumi.Aws Native. Io T. Inputs. Topic Rule Cloudwatch Logs Action - Cloudwatch
Metric Pulumi.Aws Native. Io T. Inputs. Topic Rule Cloudwatch Metric Action - Dynamo
DB Pulumi.Aws Native. Io T. Inputs. Topic Rule Dynamo DBAction - Dynamo
DBv2 Pulumi.Aws Native. Io T. Inputs. Topic Rule Dynamo DBv2Action - Elasticsearch
Pulumi.
Aws Native. Io T. Inputs. Topic Rule Elasticsearch Action - Firehose
Pulumi.
Aws Native. Io T. Inputs. Topic Rule Firehose Action - Http
Pulumi.
Aws Native. Io T. Inputs. Topic Rule Http Action - Iot
Analytics Pulumi.Aws Native. Io T. Inputs. Topic Rule Iot Analytics Action - Iot
Events Pulumi.Aws Native. Io T. Inputs. Topic Rule Iot Events Action - Iot
Site Pulumi.Wise Aws Native. Io T. Inputs. Topic Rule Iot Site Wise Action - Kafka
Pulumi.
Aws Native. Io T. Inputs. Topic Rule Kafka Action - Kinesis
Pulumi.
Aws Native. Io T. Inputs. Topic Rule Kinesis Action - Lambda
Pulumi.
Aws Native. Io T. Inputs. Topic Rule Lambda Action - Location
Pulumi.
Aws Native. Io T. Inputs. Topic Rule Location Action - Open
Search Pulumi.Aws Native. Io T. Inputs. Topic Rule Open Search Action - Republish
Pulumi.
Aws Native. Io T. Inputs. Topic Rule Republish Action - S3
Pulumi.
Aws Native. Io T. Inputs. Topic Rule S3Action - Sns
Pulumi.
Aws Native. Io T. Inputs. Topic Rule Sns Action - Sqs
Pulumi.
Aws Native. Io T. Inputs. Topic Rule Sqs Action - Step
Functions Pulumi.Aws Native. Io T. Inputs. Topic Rule Step Functions Action - Timestream
Pulumi.
Aws Native. Io T. Inputs. Topic Rule Timestream Action
- Cloudwatch
Alarm TopicRule Cloudwatch Alarm Action - Cloudwatch
Logs TopicRule Cloudwatch Logs Action - Cloudwatch
Metric TopicRule Cloudwatch Metric Action - Dynamo
DB TopicRule Dynamo DBAction - Dynamo
DBv2 TopicRule Dynamo DBv2Action - Elasticsearch
Topic
Rule Elasticsearch Action - Firehose
Topic
Rule Firehose Action - Http
Topic
Rule Http Action - Iot
Analytics TopicRule Iot Analytics Action - Iot
Events TopicRule Iot Events Action - Iot
Site TopicWise Rule Iot Site Wise Action - Kafka
Topic
Rule Kafka Action - Kinesis
Topic
Rule Kinesis Action - Lambda
Topic
Rule Lambda Action - Location
Topic
Rule Location Action - Open
Search TopicRule Open Search Action - Republish
Topic
Rule Republish Action - S3
Topic
Rule S3Action - Sns
Topic
Rule Sns Action - Sqs
Topic
Rule Sqs Action - Step
Functions TopicRule Step Functions Action - Timestream
Topic
Rule Timestream Action
- cloudwatch
Alarm TopicRule Cloudwatch Alarm Action - cloudwatch
Logs TopicRule Cloudwatch Logs Action - cloudwatch
Metric TopicRule Cloudwatch Metric Action - dynamo
DB TopicRule Dynamo DBAction - dynamo
DBv2 TopicRule Dynamo DBv2Action - elasticsearch
Topic
Rule Elasticsearch Action - firehose
Topic
Rule Firehose Action - http
Topic
Rule Http Action - iot
Analytics TopicRule Iot Analytics Action - iot
Events TopicRule Iot Events Action - iot
Site TopicWise Rule Iot Site Wise Action - kafka
Topic
Rule Kafka Action - kinesis
Topic
Rule Kinesis Action - lambda
Topic
Rule Lambda Action - location
Topic
Rule Location Action - open
Search TopicRule Open Search Action - republish
Topic
Rule Republish Action - s3
Topic
Rule S3Action - sns
Topic
Rule Sns Action - sqs
Topic
Rule Sqs Action - step
Functions TopicRule Step Functions Action - timestream
Topic
Rule Timestream Action
- cloudwatch
Alarm TopicRule Cloudwatch Alarm Action - cloudwatch
Logs TopicRule Cloudwatch Logs Action - cloudwatch
Metric TopicRule Cloudwatch Metric Action - dynamo
DB TopicRule Dynamo DBAction - dynamo
DBv2 TopicRule Dynamo DBv2Action - elasticsearch
Topic
Rule Elasticsearch Action - firehose
Topic
Rule Firehose Action - http
Topic
Rule Http Action - iot
Analytics TopicRule Iot Analytics Action - iot
Events TopicRule Iot Events Action - iot
Site TopicWise Rule Iot Site Wise Action - kafka
Topic
Rule Kafka Action - kinesis
Topic
Rule Kinesis Action - lambda
Topic
Rule Lambda Action - location
Topic
Rule Location Action - open
Search TopicRule Open Search Action - republish
Topic
Rule Republish Action - s3
Topic
Rule S3Action - sns
Topic
Rule Sns Action - sqs
Topic
Rule Sqs Action - step
Functions TopicRule Step Functions Action - timestream
Topic
Rule Timestream Action
- cloudwatch_
alarm TopicRule Cloudwatch Alarm Action - cloudwatch_
logs TopicRule Cloudwatch Logs Action - cloudwatch_
metric TopicRule Cloudwatch Metric Action - dynamo_
d_ Topicbv2 Rule Dynamo DBv2Action - dynamo_
db TopicRule Dynamo DBAction - elasticsearch
Topic
Rule Elasticsearch Action - firehose
Topic
Rule Firehose Action - http
Topic
Rule Http Action - iot_
analytics TopicRule Iot Analytics Action - iot_
events TopicRule Iot Events Action - iot_
site_ Topicwise Rule Iot Site Wise Action - kafka
Topic
Rule Kafka Action - kinesis
Topic
Rule Kinesis Action - lambda_
Topic
Rule Lambda Action - location
Topic
Rule Location Action - open_
search TopicRule Open Search Action - republish
Topic
Rule Republish Action - s3
Topic
Rule S3Action - sns
Topic
Rule Sns Action - sqs
Topic
Rule Sqs Action - step_
functions TopicRule Step Functions Action - timestream
Topic
Rule Timestream Action
- cloudwatch
Alarm Property Map - cloudwatch
Logs Property Map - cloudwatch
Metric Property Map - dynamo
DB Property Map - dynamo
DBv2 Property Map - elasticsearch Property Map
- firehose Property Map
- http Property Map
- iot
Analytics Property Map - iot
Events Property Map - iot
Site Property MapWise - kafka Property Map
- kinesis Property Map
- lambda Property Map
- location Property Map
- open
Search Property Map - republish Property Map
- s3 Property Map
- sns Property Map
- sqs Property Map
- step
Functions Property Map - timestream Property Map
TopicRuleAssetPropertyTimestamp
- Time
In stringSeconds - Offset
In stringNanos
- Time
In stringSeconds - Offset
In stringNanos
- time
In StringSeconds - offset
In StringNanos
- time
In stringSeconds - offset
In stringNanos
- time_
in_ strseconds - offset_
in_ strnanos
- time
In StringSeconds - offset
In StringNanos
TopicRuleAssetPropertyValue
TopicRuleAssetPropertyVariant
- Boolean
Value string - Double
Value string - Integer
Value string - String
Value string
- Boolean
Value string - Double
Value string - Integer
Value string - String
Value string
- boolean
Value String - double
Value String - integer
Value String - string
Value String
- boolean
Value string - double
Value string - integer
Value string - string
Value string
- boolean_
value str - double_
value str - integer_
value str - string_
value str
- boolean
Value String - double
Value String - integer
Value String - string
Value String
TopicRuleCannedAccessControlList
TopicRuleCloudwatchAlarmAction
- Alarm
Name string - Role
Arn string - State
Reason string - State
Value string
- Alarm
Name string - Role
Arn string - State
Reason string - State
Value string
- alarm
Name String - role
Arn String - state
Reason String - state
Value String
- alarm
Name string - role
Arn string - state
Reason string - state
Value string
- alarm_
name str - role_
arn str - state_
reason str - state_
value str
- alarm
Name String - role
Arn String - state
Reason String - state
Value String
TopicRuleCloudwatchLogsAction
- Log
Group stringName - Role
Arn string - Batch
Mode bool
- Log
Group stringName - Role
Arn string - Batch
Mode bool
- log
Group StringName - role
Arn String - batch
Mode Boolean
- log
Group stringName - role
Arn string - batch
Mode boolean
- log_
group_ strname - role_
arn str - batch_
mode bool
- log
Group StringName - role
Arn String - batch
Mode Boolean
TopicRuleCloudwatchMetricAction
- Metric
Name string - Metric
Namespace string - Metric
Unit string - Metric
Value string - Role
Arn string - Metric
Timestamp string
- Metric
Name string - Metric
Namespace string - Metric
Unit string - Metric
Value string - Role
Arn string - Metric
Timestamp string
- metric
Name String - metric
Namespace String - metric
Unit String - metric
Value String - role
Arn String - metric
Timestamp String
- metric
Name string - metric
Namespace string - metric
Unit string - metric
Value string - role
Arn string - metric
Timestamp string
- metric_
name str - metric_
namespace str - metric_
unit str - metric_
value str - role_
arn str - metric_
timestamp str
- metric
Name String - metric
Namespace String - metric
Unit String - metric
Value String - role
Arn String - metric
Timestamp String
TopicRuleDynamoDBAction
- Hash
Key stringField - Hash
Key stringValue - Role
Arn string - Table
Name string - Hash
Key stringType - Payload
Field string - Range
Key stringField - Range
Key stringType - Range
Key stringValue
- Hash
Key stringField - Hash
Key stringValue - Role
Arn string - Table
Name string - Hash
Key stringType - Payload
Field string - Range
Key stringField - Range
Key stringType - Range
Key stringValue
- hash
Key StringField - hash
Key StringValue - role
Arn String - table
Name String - hash
Key StringType - payload
Field String - range
Key StringField - range
Key StringType - range
Key StringValue
- hash
Key stringField - hash
Key stringValue - role
Arn string - table
Name string - hash
Key stringType - payload
Field string - range
Key stringField - range
Key stringType - range
Key stringValue
- hash_
key_ strfield - hash_
key_ strvalue - role_
arn str - table_
name str - hash_
key_ strtype - payload_
field str - range_
key_ strfield - range_
key_ strtype - range_
key_ strvalue
- hash
Key StringField - hash
Key StringValue - role
Arn String - table
Name String - hash
Key StringType - payload
Field String - range
Key StringField - range
Key StringType - range
Key StringValue
TopicRuleDynamoDBv2Action
- put
Item Property Map - role
Arn String
TopicRuleElasticsearchAction
TopicRuleFirehoseAction
- Delivery
Stream stringName - Role
Arn string - Batch
Mode bool - Separator string
- Delivery
Stream stringName - Role
Arn string - Batch
Mode bool - Separator string
- delivery
Stream StringName - role
Arn String - batch
Mode Boolean - separator String
- delivery
Stream stringName - role
Arn string - batch
Mode boolean - separator string
- delivery_
stream_ strname - role_
arn str - batch_
mode bool - separator str
- delivery
Stream StringName - role
Arn String - batch
Mode Boolean - separator String
TopicRuleHttpAction
- url String
- auth Property Map
- confirmation
Url String - headers List<Property Map>
TopicRuleHttpActionHeader
TopicRuleHttpAuthorization
TopicRuleIotAnalyticsAction
- Channel
Name string - Role
Arn string - Batch
Mode bool
- Channel
Name string - Role
Arn string - Batch
Mode bool
- channel
Name String - role
Arn String - batch
Mode Boolean
- channel
Name string - role
Arn string - batch
Mode boolean
- channel_
name str - role_
arn str - batch_
mode bool
- channel
Name String - role
Arn String - batch
Mode Boolean
TopicRuleIotEventsAction
- input_
name str - role_
arn str - batch_
mode bool - message_
id str
TopicRuleIotSiteWiseAction
TopicRuleKafkaAction
- Client
Properties object - Destination
Arn string - Topic string
- Key string
- Partition string
- Client
Properties interface{} - Destination
Arn string - Topic string
- Key string
- Partition string
- client
Properties Object - destination
Arn String - topic String
- key String
- partition String
- client
Properties any - destination
Arn string - topic string
- key string
- partition string
- client_
properties Any - destination_
arn str - topic str
- key str
- partition str
- client
Properties Any - destination
Arn String - topic String
- key String
- partition String
TopicRuleKinesisAction
- Role
Arn string - Stream
Name string - Partition
Key string
- Role
Arn string - Stream
Name string - Partition
Key string
- role
Arn String - stream
Name String - partition
Key String
- role
Arn string - stream
Name string - partition
Key string
- role_
arn str - stream_
name str - partition_
key str
- role
Arn String - stream
Name String - partition
Key String
TopicRuleLambdaAction
- Function
Arn string
- Function
Arn string
- function
Arn String
- function
Arn string
- function_
arn str
- function
Arn String
TopicRuleLocationAction
- Device
Id string - Latitude string
- Longitude string
- Role
Arn string - Tracker
Name string - Timestamp
Pulumi.
Aws Native. Io T. Inputs. Topic Rule Timestamp
- Device
Id string - Latitude string
- Longitude string
- Role
Arn string - Tracker
Name string - Timestamp
Topic
Rule Timestamp
- device
Id String - latitude String
- longitude String
- role
Arn String - tracker
Name String - timestamp
Topic
Rule Timestamp
- device
Id string - latitude string
- longitude string
- role
Arn string - tracker
Name string - timestamp
Topic
Rule Timestamp
- device_
id str - latitude str
- longitude str
- role_
arn str - tracker_
name str - timestamp
Topic
Rule Timestamp
- device
Id String - latitude String
- longitude String
- role
Arn String - tracker
Name String - timestamp Property Map
TopicRuleOpenSearchAction
TopicRulePayload
- Actions
[]Topic
Rule Action - Sql string
- Aws
Iot stringSql Version - Description string
- Error
Action TopicRule Action - Rule
Disabled bool
- actions
List<Topic
Rule Action> - sql String
- aws
Iot StringSql Version - description String
- error
Action TopicRule Action - rule
Disabled Boolean
- actions
Topic
Rule Action[] - sql string
- aws
Iot stringSql Version - description string
- error
Action TopicRule Action - rule
Disabled boolean
- actions List<Property Map>
- sql String
- aws
Iot StringSql Version - description String
- error
Action Property Map - rule
Disabled Boolean
TopicRulePutAssetPropertyValueEntry
- Property
Values List<Pulumi.Aws Native. Io T. Inputs. Topic Rule Asset Property Value> - Asset
Id string - Entry
Id string - Property
Alias string - Property
Id string
- Property
Values []TopicRule Asset Property Value - Asset
Id string - Entry
Id string - Property
Alias string - Property
Id string
- property
Values List<TopicRule Asset Property Value> - asset
Id String - entry
Id String - property
Alias String - property
Id String
- property
Values TopicRule Asset Property Value[] - asset
Id string - entry
Id string - property
Alias string - property
Id string
- property
Values List<Property Map> - asset
Id String - entry
Id String - property
Alias String - property
Id String
TopicRulePutItemInput
- Table
Name string
- Table
Name string
- table
Name String
- table
Name string
- table_
name str
- table
Name String
TopicRuleRepublishAction
- Role
Arn string - Topic string
- Headers
Topic
Rule Republish Action Headers - Qos int
- role
Arn String - topic String
- headers
Topic
Rule Republish Action Headers - qos Integer
- role
Arn string - topic string
- headers
Topic
Rule Republish Action Headers - qos number
- role
Arn String - topic String
- headers Property Map
- qos Number
TopicRuleRepublishActionHeaders
- Content
Type string - Correlation
Data string - Message
Expiry string - Payload
Format stringIndicator - Response
Topic string - User
Properties List<Pulumi.Aws Native. Io T. Inputs. Topic Rule User Property>
- Content
Type string - Correlation
Data string - Message
Expiry string - Payload
Format stringIndicator - Response
Topic string - User
Properties []TopicRule User Property
- content
Type String - correlation
Data String - message
Expiry String - payload
Format StringIndicator - response
Topic String - user
Properties List<TopicRule User Property>
- content
Type string - correlation
Data string - message
Expiry string - payload
Format stringIndicator - response
Topic string - user
Properties TopicRule User Property[]
- content
Type String - correlation
Data String - message
Expiry String - payload
Format StringIndicator - response
Topic String - user
Properties List<Property Map>
TopicRuleS3Action
- Bucket
Name string - Key string
- Role
Arn string - Canned
Acl Pulumi.Aws Native. Io T. Topic Rule Canned Access Control List
- Bucket
Name string - Key string
- Role
Arn string - Canned
Acl TopicRule Canned Access Control List
- bucket
Name String - key String
- role
Arn String - canned
Acl TopicRule Canned Access Control List
- bucket
Name string - key string
- role
Arn string - canned
Acl TopicRule Canned Access Control List
TopicRuleSigV4Authorization
- Role
Arn string - Service
Name string - Signing
Region string
- Role
Arn string - Service
Name string - Signing
Region string
- role
Arn String - service
Name String - signing
Region String
- role
Arn string - service
Name string - signing
Region string
- role_
arn str - service_
name str - signing_
region str
- role
Arn String - service
Name String - signing
Region String
TopicRuleSnsAction
- Role
Arn string - Target
Arn string - Message
Format string
- Role
Arn string - Target
Arn string - Message
Format string
- role
Arn String - target
Arn String - message
Format String
- role
Arn string - target
Arn string - message
Format string
- role_
arn str - target_
arn str - message_
format str
- role
Arn String - target
Arn String - message
Format String
TopicRuleSqsAction
- queue_
url str - role_
arn str - use_
base64 bool
TopicRuleStepFunctionsAction
- Role
Arn string - State
Machine stringName - Execution
Name stringPrefix
- Role
Arn string - State
Machine stringName - Execution
Name stringPrefix
- role
Arn String - state
Machine StringName - execution
Name StringPrefix
- role
Arn string - state
Machine stringName - execution
Name stringPrefix
- role_
arn str - state_
machine_ strname - execution_
name_ strprefix
- role
Arn String - state
Machine StringName - execution
Name StringPrefix
TopicRuleTag
TopicRuleTimestamp
TopicRuleTimestreamAction
- database
Name String - dimensions List<Property Map>
- role
Arn String - table
Name String - timestamp Property Map
TopicRuleTimestreamDimension
TopicRuleTimestreamTimestamp
TopicRuleUserProperty
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0