1. Packages
  2. AWS Native
  3. API Docs
  4. iot
  5. getTopicRule

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.96.0 published on Friday, Feb 9, 2024 by Pulumi

aws-native.iot.getTopicRule

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.96.0 published on Friday, Feb 9, 2024 by Pulumi

    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 dictionary

    The following arguments are supported:

    RuleName string
    RuleName string
    ruleName String
    ruleName string
    ruleName String

    getTopicRule Result

    The following output properties are available:

    Supporting Types

    TopicRuleAction

    CloudwatchAlarm Pulumi.AwsNative.IoT.Inputs.TopicRuleCloudwatchAlarmAction
    CloudwatchLogs Pulumi.AwsNative.IoT.Inputs.TopicRuleCloudwatchLogsAction
    CloudwatchMetric Pulumi.AwsNative.IoT.Inputs.TopicRuleCloudwatchMetricAction
    DynamoDBv2 Pulumi.AwsNative.IoT.Inputs.TopicRuleDynamoDBv2Action
    DynamoDb Pulumi.AwsNative.IoT.Inputs.TopicRuleDynamoDbAction
    Elasticsearch Pulumi.AwsNative.IoT.Inputs.TopicRuleElasticsearchAction
    Firehose Pulumi.AwsNative.IoT.Inputs.TopicRuleFirehoseAction
    Http Pulumi.AwsNative.IoT.Inputs.TopicRuleHttpAction
    IotAnalytics Pulumi.AwsNative.IoT.Inputs.TopicRuleIotAnalyticsAction
    IotEvents Pulumi.AwsNative.IoT.Inputs.TopicRuleIotEventsAction
    IotSiteWise Pulumi.AwsNative.IoT.Inputs.TopicRuleIotSiteWiseAction
    Kafka Pulumi.AwsNative.IoT.Inputs.TopicRuleKafkaAction
    Kinesis Pulumi.AwsNative.IoT.Inputs.TopicRuleKinesisAction
    Lambda Pulumi.AwsNative.IoT.Inputs.TopicRuleLambdaAction
    Location Pulumi.AwsNative.IoT.Inputs.TopicRuleLocationAction
    OpenSearch Pulumi.AwsNative.IoT.Inputs.TopicRuleOpenSearchAction
    Republish Pulumi.AwsNative.IoT.Inputs.TopicRuleRepublishAction
    S3 Pulumi.AwsNative.IoT.Inputs.TopicRuleS3Action
    Sns Pulumi.AwsNative.IoT.Inputs.TopicRuleSnsAction
    Sqs Pulumi.AwsNative.IoT.Inputs.TopicRuleSqsAction
    StepFunctions Pulumi.AwsNative.IoT.Inputs.TopicRuleStepFunctionsAction
    Timestream Pulumi.AwsNative.IoT.Inputs.TopicRuleTimestreamAction

    TopicRuleAssetPropertyTimestamp

    TopicRuleAssetPropertyValue

    TopicRuleAssetPropertyVariant

    TopicRuleCannedAccessControlList

    TopicRuleCloudwatchAlarmAction

    AlarmName string
    RoleArn string
    StateReason string
    StateValue string
    AlarmName string
    RoleArn string
    StateReason string
    StateValue string
    alarmName String
    roleArn String
    stateReason String
    stateValue String
    alarmName string
    roleArn string
    stateReason string
    stateValue string
    alarmName String
    roleArn String
    stateReason String
    stateValue String

    TopicRuleCloudwatchLogsAction

    LogGroupName string
    RoleArn string
    BatchMode bool
    LogGroupName string
    RoleArn string
    BatchMode bool
    logGroupName String
    roleArn String
    batchMode Boolean
    logGroupName string
    roleArn string
    batchMode boolean
    logGroupName String
    roleArn String
    batchMode Boolean

    TopicRuleCloudwatchMetricAction

    TopicRuleDynamoDBv2Action

    TopicRuleDynamoDbAction

    TopicRuleElasticsearchAction

    Endpoint string
    Id string
    Index string
    RoleArn string
    Type string
    Endpoint string
    Id string
    Index string
    RoleArn string
    Type string
    endpoint String
    id String
    index String
    roleArn String
    type String
    endpoint string
    id string
    index string
    roleArn string
    type string
    endpoint str
    id str
    index str
    role_arn str
    type str
    endpoint String
    id String
    index String
    roleArn String
    type String

    TopicRuleFirehoseAction

    deliveryStreamName String
    roleArn String
    batchMode Boolean
    separator String
    deliveryStreamName string
    roleArn string
    batchMode boolean
    separator string
    deliveryStreamName String
    roleArn String
    batchMode Boolean
    separator String

    TopicRuleHttpAction

    TopicRuleHttpActionHeader

    Key string
    Value string
    Key string
    Value string
    key String
    value String
    key string
    value string
    key str
    value str
    key String
    value String

    TopicRuleHttpAuthorization

    TopicRuleIotAnalyticsAction

    ChannelName string
    RoleArn string
    BatchMode bool
    ChannelName string
    RoleArn string
    BatchMode bool
    channelName String
    roleArn String
    batchMode Boolean
    channelName string
    roleArn string
    batchMode boolean
    channelName String
    roleArn String
    batchMode Boolean

    TopicRuleIotEventsAction

    InputName string
    RoleArn string
    BatchMode bool
    MessageId string
    InputName string
    RoleArn string
    BatchMode bool
    MessageId string
    inputName String
    roleArn String
    batchMode Boolean
    messageId String
    inputName string
    roleArn string
    batchMode boolean
    messageId string
    inputName String
    roleArn String
    batchMode Boolean
    messageId String

    TopicRuleIotSiteWiseAction

    TopicRuleKafkaAction

    TopicRuleKafkaActionHeader

    Key string
    Value string
    Key string
    Value string
    key String
    value String
    key string
    value string
    key str
    value str
    key String
    value String

    TopicRuleKinesisAction

    RoleArn string
    StreamName string
    PartitionKey string
    RoleArn string
    StreamName string
    PartitionKey string
    roleArn String
    streamName String
    partitionKey String
    roleArn string
    streamName string
    partitionKey string
    roleArn String
    streamName String
    partitionKey String

    TopicRuleLambdaAction

    TopicRuleLocationAction

    TopicRuleOpenSearchAction

    Endpoint string
    Id string
    Index string
    RoleArn string
    Type string
    Endpoint string
    Id string
    Index string
    RoleArn string
    Type string
    endpoint String
    id String
    index String
    roleArn String
    type String
    endpoint string
    id string
    index string
    roleArn string
    type string
    endpoint str
    id str
    index str
    role_arn str
    type str
    endpoint String
    id String
    index String
    roleArn String
    type String

    TopicRulePayload

    TopicRulePutAssetPropertyValueEntry

    TopicRulePutItemInput

    TableName string
    TableName string
    tableName String
    tableName string
    tableName String

    TopicRuleRepublishAction

    TopicRuleRepublishActionHeaders

    TopicRuleS3Action

    TopicRuleSigV4Authorization

    RoleArn string
    ServiceName string
    SigningRegion string
    RoleArn string
    ServiceName string
    SigningRegion string
    roleArn String
    serviceName String
    signingRegion String
    roleArn string
    serviceName string
    signingRegion string
    roleArn String
    serviceName String
    signingRegion String

    TopicRuleSnsAction

    RoleArn string
    TargetArn string
    MessageFormat string
    RoleArn string
    TargetArn string
    MessageFormat string
    roleArn String
    targetArn String
    messageFormat String
    roleArn string
    targetArn string
    messageFormat string
    roleArn String
    targetArn String
    messageFormat String

    TopicRuleSqsAction

    QueueUrl string
    RoleArn string
    UseBase64 bool
    QueueUrl string
    RoleArn string
    UseBase64 bool
    queueUrl String
    roleArn String
    useBase64 Boolean
    queueUrl string
    roleArn string
    useBase64 boolean
    queueUrl String
    roleArn String
    useBase64 Boolean

    TopicRuleStepFunctionsAction

    TopicRuleTag

    Key string
    Value string
    Key string
    Value string
    key String
    value String
    key string
    value string
    key str
    value str
    key String
    value String

    TopicRuleTimestamp

    Value string
    Unit string
    Value string
    Unit string
    value String
    unit String
    value string
    unit string
    value str
    unit str
    value String
    unit String

    TopicRuleTimestreamAction

    TopicRuleTimestreamDimension

    Name string
    Value string
    Name string
    Value string
    name String
    value String
    name string
    value string
    name str
    value str
    name String
    value String

    TopicRuleTimestreamTimestamp

    Unit string
    Value string
    Unit string
    Value string
    unit String
    value String
    unit string
    value string
    unit str
    value str
    unit String
    value String

    TopicRuleUserProperty

    Key string
    Value string
    Key string
    Value string
    key String
    value String
    key string
    value string
    key str
    value str
    key String
    value String

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.96.0 published on Friday, Feb 9, 2024 by Pulumi