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

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

AWS Native v0.100.0 published on Wednesday, Mar 27, 2024 by Pulumi

aws-native.iot.TopicRule

Explore with Pulumi AI

aws-native logo

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

AWS Native v0.100.0 published on Wednesday, Mar 27, 2024 by Pulumi

    Resource Type definition for AWS::IoT::TopicRule

    Create TopicRule Resource

    new TopicRule(name: string, args: TopicRuleArgs, opts?: CustomResourceOptions);
    @overload
    def TopicRule(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  rule_name: Optional[str] = None,
                  tags: Optional[Sequence[_root_inputs.TagArgs]] = None,
                  topic_rule_payload: Optional[TopicRulePayloadArgs] = None)
    @overload
    def TopicRule(resource_name: str,
                  args: TopicRuleArgs,
                  opts: Optional[ResourceOptions] = None)
    func NewTopicRule(ctx *Context, name string, args TopicRuleArgs, opts ...ResourceOption) (*TopicRule, error)
    public TopicRule(string name, TopicRuleArgs args, CustomResourceOptions? opts = null)
    public TopicRule(String name, TopicRuleArgs args)
    public TopicRule(String name, TopicRuleArgs args, CustomResourceOptions options)
    
    type: aws-native:iot:TopicRule
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args TopicRuleArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args TopicRuleArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args TopicRuleArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args TopicRuleArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args TopicRuleArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    TopicRule Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The TopicRule resource accepts the following input properties:

    Outputs

    All input properties are implicitly available as output properties. Additionally, the TopicRule resource produces the following output properties:

    Arn string
    Id string
    The provider-assigned unique ID for this managed resource.
    Arn string
    Id string
    The provider-assigned unique ID for this managed resource.
    arn String
    id String
    The provider-assigned unique ID for this managed resource.
    arn string
    id string
    The provider-assigned unique ID for this managed resource.
    arn str
    id str
    The provider-assigned unique ID for this managed resource.
    arn String
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    Tag, TagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    TopicRuleAction, TopicRuleActionArgs

    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, TopicRuleAssetPropertyTimestampArgs

    TopicRuleAssetPropertyValue, TopicRuleAssetPropertyValueArgs

    TopicRuleAssetPropertyVariant, TopicRuleAssetPropertyVariantArgs

    TopicRuleCannedAccessControlList, TopicRuleCannedAccessControlListArgs

    Private
    private
    PublicRead
    public-read
    PublicReadWrite
    public-read-write
    AwsExecRead
    aws-exec-read
    AuthenticatedRead
    authenticated-read
    BucketOwnerRead
    bucket-owner-read
    BucketOwnerFullControl
    bucket-owner-full-control
    LogDeliveryWrite
    log-delivery-write
    TopicRuleCannedAccessControlListPrivate
    private
    TopicRuleCannedAccessControlListPublicRead
    public-read
    TopicRuleCannedAccessControlListPublicReadWrite
    public-read-write
    TopicRuleCannedAccessControlListAwsExecRead
    aws-exec-read
    TopicRuleCannedAccessControlListAuthenticatedRead
    authenticated-read
    TopicRuleCannedAccessControlListBucketOwnerRead
    bucket-owner-read
    TopicRuleCannedAccessControlListBucketOwnerFullControl
    bucket-owner-full-control
    TopicRuleCannedAccessControlListLogDeliveryWrite
    log-delivery-write
    Private
    private
    PublicRead
    public-read
    PublicReadWrite
    public-read-write
    AwsExecRead
    aws-exec-read
    AuthenticatedRead
    authenticated-read
    BucketOwnerRead
    bucket-owner-read
    BucketOwnerFullControl
    bucket-owner-full-control
    LogDeliveryWrite
    log-delivery-write
    Private
    private
    PublicRead
    public-read
    PublicReadWrite
    public-read-write
    AwsExecRead
    aws-exec-read
    AuthenticatedRead
    authenticated-read
    BucketOwnerRead
    bucket-owner-read
    BucketOwnerFullControl
    bucket-owner-full-control
    LogDeliveryWrite
    log-delivery-write
    PRIVATE
    private
    PUBLIC_READ
    public-read
    PUBLIC_READ_WRITE
    public-read-write
    AWS_EXEC_READ
    aws-exec-read
    AUTHENTICATED_READ
    authenticated-read
    BUCKET_OWNER_READ
    bucket-owner-read
    BUCKET_OWNER_FULL_CONTROL
    bucket-owner-full-control
    LOG_DELIVERY_WRITE
    log-delivery-write
    "private"
    private
    "public-read"
    public-read
    "public-read-write"
    public-read-write
    "aws-exec-read"
    aws-exec-read
    "authenticated-read"
    authenticated-read
    "bucket-owner-read"
    bucket-owner-read
    "bucket-owner-full-control"
    bucket-owner-full-control
    "log-delivery-write"
    log-delivery-write

    TopicRuleCloudwatchAlarmAction, TopicRuleCloudwatchAlarmActionArgs

    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, TopicRuleCloudwatchLogsActionArgs

    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, TopicRuleCloudwatchMetricActionArgs

    TopicRuleDynamoDBv2Action, TopicRuleDynamoDBv2ActionArgs

    TopicRuleDynamoDbAction, TopicRuleDynamoDbActionArgs

    TopicRuleElasticsearchAction, TopicRuleElasticsearchActionArgs

    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, TopicRuleFirehoseActionArgs

    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, TopicRuleHttpActionArgs

    TopicRuleHttpActionHeader, TopicRuleHttpActionHeaderArgs

    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, TopicRuleHttpAuthorizationArgs

    TopicRuleIotAnalyticsAction, TopicRuleIotAnalyticsActionArgs

    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, TopicRuleIotEventsActionArgs

    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, TopicRuleIotSiteWiseActionArgs

    TopicRuleKafkaAction, TopicRuleKafkaActionArgs

    TopicRuleKafkaActionHeader, TopicRuleKafkaActionHeaderArgs

    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, TopicRuleKinesisActionArgs

    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, TopicRuleLambdaActionArgs

    TopicRuleLocationAction, TopicRuleLocationActionArgs

    TopicRuleOpenSearchAction, TopicRuleOpenSearchActionArgs

    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, TopicRulePayloadArgs

    TopicRulePutAssetPropertyValueEntry, TopicRulePutAssetPropertyValueEntryArgs

    TopicRulePutItemInput, TopicRulePutItemInputArgs

    TableName string
    TableName string
    tableName String
    tableName string
    tableName String

    TopicRuleRepublishAction, TopicRuleRepublishActionArgs

    TopicRuleRepublishActionHeaders, TopicRuleRepublishActionHeadersArgs

    TopicRuleS3Action, TopicRuleS3ActionArgs

    TopicRuleSigV4Authorization, TopicRuleSigV4AuthorizationArgs

    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, TopicRuleSnsActionArgs

    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, TopicRuleSqsActionArgs

    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, TopicRuleStepFunctionsActionArgs

    TopicRuleTimestamp, TopicRuleTimestampArgs

    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, TopicRuleTimestreamActionArgs

    TopicRuleTimestreamDimension, TopicRuleTimestreamDimensionArgs

    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, TopicRuleTimestreamTimestampArgs

    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, TopicRuleUserPropertyArgs

    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.100.0 published on Wednesday, Mar 27, 2024 by Pulumi