Docs Home
AWS v6.77.1 published on Friday, Apr 18, 2025 by Pulumi
aws.iot.TopicRule
Explore with Pulumi AI
Creates and manages an AWS IoT topic rule.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const mytopic = new aws.sns.Topic("mytopic", {name: "mytopic"});
const myerrortopic = new aws.sns.Topic("myerrortopic", {name: "myerrortopic"});
const rule = new aws.iot.TopicRule("rule", {
name: "MyRule",
description: "Example rule",
enabled: true,
sql: "SELECT * FROM 'topic/test'",
sqlVersion: "2016-03-23",
sns: [{
messageFormat: "RAW",
roleArn: role.arn,
targetArn: mytopic.arn,
}],
errorAction: {
sns: {
messageFormat: "RAW",
roleArn: role.arn,
targetArn: myerrortopic.arn,
},
},
});
const assumeRole = aws.iam.getPolicyDocument({
statements: [{
effect: "Allow",
principals: [{
type: "Service",
identifiers: ["iot.amazonaws.com"],
}],
actions: ["sts:AssumeRole"],
}],
});
const myrole = new aws.iam.Role("myrole", {
name: "myrole",
assumeRolePolicy: assumeRole.then(assumeRole => assumeRole.json),
});
const mypolicy = mytopic.arn.apply(arn => aws.iam.getPolicyDocumentOutput({
statements: [{
effect: "Allow",
actions: ["sns:Publish"],
resources: [arn],
}],
}));
const mypolicyRolePolicy = new aws.iam.RolePolicy("mypolicy", {
name: "mypolicy",
role: myrole.id,
policy: mypolicy.apply(mypolicy => mypolicy.json),
});
import pulumi
import pulumi_aws as aws
mytopic = aws.sns.Topic("mytopic", name="mytopic")
myerrortopic = aws.sns.Topic("myerrortopic", name="myerrortopic")
rule = aws.iot.TopicRule("rule",
name="MyRule",
description="Example rule",
enabled=True,
sql="SELECT * FROM 'topic/test'",
sql_version="2016-03-23",
sns=[{
"message_format": "RAW",
"role_arn": role["arn"],
"target_arn": mytopic.arn,
}],
error_action={
"sns": {
"message_format": "RAW",
"role_arn": role["arn"],
"target_arn": myerrortopic.arn,
},
})
assume_role = aws.iam.get_policy_document(statements=[{
"effect": "Allow",
"principals": [{
"type": "Service",
"identifiers": ["iot.amazonaws.com"],
}],
"actions": ["sts:AssumeRole"],
}])
myrole = aws.iam.Role("myrole",
name="myrole",
assume_role_policy=assume_role.json)
mypolicy = mytopic.arn.apply(lambda arn: aws.iam.get_policy_document_output(statements=[{
"effect": "Allow",
"actions": ["sns:Publish"],
"resources": [arn],
}]))
mypolicy_role_policy = aws.iam.RolePolicy("mypolicy",
name="mypolicy",
role=myrole.id,
policy=mypolicy.json)
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/iam"
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/iot"
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/sns"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
mytopic, err := sns.NewTopic(ctx, "mytopic", &sns.TopicArgs{
Name: pulumi.String("mytopic"),
})
if err != nil {
return err
}
myerrortopic, err := sns.NewTopic(ctx, "myerrortopic", &sns.TopicArgs{
Name: pulumi.String("myerrortopic"),
})
if err != nil {
return err
}
_, err = iot.NewTopicRule(ctx, "rule", &iot.TopicRuleArgs{
Name: pulumi.String("MyRule"),
Description: pulumi.String("Example rule"),
Enabled: pulumi.Bool(true),
Sql: pulumi.String("SELECT * FROM 'topic/test'"),
SqlVersion: pulumi.String("2016-03-23"),
Sns: iot.TopicRuleSnsArray{
&iot.TopicRuleSnsArgs{
MessageFormat: pulumi.String("RAW"),
RoleArn: pulumi.Any(role.Arn),
TargetArn: mytopic.Arn,
},
},
ErrorAction: &iot.TopicRuleErrorActionArgs{
Sns: &iot.TopicRuleErrorActionSnsArgs{
MessageFormat: pulumi.String("RAW"),
RoleArn: pulumi.Any(role.Arn),
TargetArn: myerrortopic.Arn,
},
},
})
if err != nil {
return err
}
assumeRole, err := iam.GetPolicyDocument(ctx, &iam.GetPolicyDocumentArgs{
Statements: []iam.GetPolicyDocumentStatement{
{
Effect: pulumi.StringRef("Allow"),
Principals: []iam.GetPolicyDocumentStatementPrincipal{
{
Type: "Service",
Identifiers: []string{
"iot.amazonaws.com",
},
},
},
Actions: []string{
"sts:AssumeRole",
},
},
},
}, nil);
if err != nil {
return err
}
myrole, err := iam.NewRole(ctx, "myrole", &iam.RoleArgs{
Name: pulumi.String("myrole"),
AssumeRolePolicy: pulumi.String(assumeRole.Json),
})
if err != nil {
return err
}
mypolicy := mytopic.Arn.ApplyT(func(arn string) (iam.GetPolicyDocumentResult, error) {
return iam.GetPolicyDocumentResult(interface{}(iam.GetPolicyDocumentOutput(ctx, iam.GetPolicyDocumentOutputArgs{
Statements: []iam.GetPolicyDocumentStatement{
{
Effect: "Allow",
Actions: []string{
"sns:Publish",
},
Resources: interface{}{
arn,
},
},
},
}, nil))), nil
}).(iam.GetPolicyDocumentResultOutput)
_, err = iam.NewRolePolicy(ctx, "mypolicy", &iam.RolePolicyArgs{
Name: pulumi.String("mypolicy"),
Role: myrole.ID(),
Policy: pulumi.String(mypolicy.ApplyT(func(mypolicy iam.GetPolicyDocumentResult) (*string, error) {
return &mypolicy.Json, nil
}).(pulumi.StringPtrOutput)),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var mytopic = new Aws.Sns.Topic("mytopic", new()
{
Name = "mytopic",
});
var myerrortopic = new Aws.Sns.Topic("myerrortopic", new()
{
Name = "myerrortopic",
});
var rule = new Aws.Iot.TopicRule("rule", new()
{
Name = "MyRule",
Description = "Example rule",
Enabled = true,
Sql = "SELECT * FROM 'topic/test'",
SqlVersion = "2016-03-23",
Sns = new[]
{
new Aws.Iot.Inputs.TopicRuleSnsArgs
{
MessageFormat = "RAW",
RoleArn = role.Arn,
TargetArn = mytopic.Arn,
},
},
ErrorAction = new Aws.Iot.Inputs.TopicRuleErrorActionArgs
{
Sns = new Aws.Iot.Inputs.TopicRuleErrorActionSnsArgs
{
MessageFormat = "RAW",
RoleArn = role.Arn,
TargetArn = myerrortopic.Arn,
},
},
});
var assumeRole = Aws.Iam.GetPolicyDocument.Invoke(new()
{
Statements = new[]
{
new Aws.Iam.Inputs.GetPolicyDocumentStatementInputArgs
{
Effect = "Allow",
Principals = new[]
{
new Aws.Iam.Inputs.GetPolicyDocumentStatementPrincipalInputArgs
{
Type = "Service",
Identifiers = new[]
{
"iot.amazonaws.com",
},
},
},
Actions = new[]
{
"sts:AssumeRole",
},
},
},
});
var myrole = new Aws.Iam.Role("myrole", new()
{
Name = "myrole",
AssumeRolePolicy = assumeRole.Apply(getPolicyDocumentResult => getPolicyDocumentResult.Json),
});
var mypolicy = Aws.Iam.GetPolicyDocument.Invoke(new()
{
Statements = new[]
{
new Aws.Iam.Inputs.GetPolicyDocumentStatementInputArgs
{
Effect = "Allow",
Actions = new[]
{
"sns:Publish",
},
Resources = new[]
{
mytopic.Arn,
},
},
},
});
var mypolicyRolePolicy = new Aws.Iam.RolePolicy("mypolicy", new()
{
Name = "mypolicy",
Role = myrole.Id,
Policy = mypolicy.Apply(getPolicyDocumentResult => getPolicyDocumentResult.Json),
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.sns.Topic;
import com.pulumi.aws.sns.TopicArgs;
import com.pulumi.aws.iot.TopicRule;
import com.pulumi.aws.iot.TopicRuleArgs;
import com.pulumi.aws.iot.inputs.TopicRuleSnsArgs;
import com.pulumi.aws.iot.inputs.TopicRuleErrorActionArgs;
import com.pulumi.aws.iot.inputs.TopicRuleErrorActionSnsArgs;
import com.pulumi.aws.iam.IamFunctions;
import com.pulumi.aws.iam.inputs.GetPolicyDocumentArgs;
import com.pulumi.aws.iam.Role;
import com.pulumi.aws.iam.RoleArgs;
import com.pulumi.aws.iam.RolePolicy;
import com.pulumi.aws.iam.RolePolicyArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var mytopic = new Topic("mytopic", TopicArgs.builder()
.name("mytopic")
.build());
var myerrortopic = new Topic("myerrortopic", TopicArgs.builder()
.name("myerrortopic")
.build());
var rule = new TopicRule("rule", TopicRuleArgs.builder()
.name("MyRule")
.description("Example rule")
.enabled(true)
.sql("SELECT * FROM 'topic/test'")
.sqlVersion("2016-03-23")
.sns(TopicRuleSnsArgs.builder()
.messageFormat("RAW")
.roleArn(role.arn())
.targetArn(mytopic.arn())
.build())
.errorAction(TopicRuleErrorActionArgs.builder()
.sns(TopicRuleErrorActionSnsArgs.builder()
.messageFormat("RAW")
.roleArn(role.arn())
.targetArn(myerrortopic.arn())
.build())
.build())
.build());
final var assumeRole = IamFunctions.getPolicyDocument(GetPolicyDocumentArgs.builder()
.statements(GetPolicyDocumentStatementArgs.builder()
.effect("Allow")
.principals(GetPolicyDocumentStatementPrincipalArgs.builder()
.type("Service")
.identifiers("iot.amazonaws.com")
.build())
.actions("sts:AssumeRole")
.build())
.build());
var myrole = new Role("myrole", RoleArgs.builder()
.name("myrole")
.assumeRolePolicy(assumeRole.json())
.build());
final var mypolicy = mytopic.arn().applyValue(_arn -> IamFunctions.getPolicyDocument(GetPolicyDocumentArgs.builder()
.statements(GetPolicyDocumentStatementArgs.builder()
.effect("Allow")
.actions("sns:Publish")
.resources(_arn)
.build())
.build()));
var mypolicyRolePolicy = new RolePolicy("mypolicyRolePolicy", RolePolicyArgs.builder()
.name("mypolicy")
.role(myrole.id())
.policy(mypolicy.applyValue(_mypolicy -> _mypolicy.json()))
.build());
}
}
resources:
rule:
type: aws:iot:TopicRule
properties:
name: MyRule
description: Example rule
enabled: true
sql: SELECT * FROM 'topic/test'
sqlVersion: 2016-03-23
sns:
- messageFormat: RAW
roleArn: ${role.arn}
targetArn: ${mytopic.arn}
errorAction:
sns:
messageFormat: RAW
roleArn: ${role.arn}
targetArn: ${myerrortopic.arn}
mytopic:
type: aws:sns:Topic
properties:
name: mytopic
myerrortopic:
type: aws:sns:Topic
properties:
name: myerrortopic
myrole:
type: aws:iam:Role
properties:
name: myrole
assumeRolePolicy: ${assumeRole.json}
mypolicyRolePolicy:
type: aws:iam:RolePolicy
name: mypolicy
properties:
name: mypolicy
role: ${myrole.id}
policy: ${mypolicy.json}
variables:
assumeRole:
fn::invoke:
function: aws:iam:getPolicyDocument
arguments:
statements:
- effect: Allow
principals:
- type: Service
identifiers:
- iot.amazonaws.com
actions:
- sts:AssumeRole
mypolicy:
fn::invoke:
function: aws:iam:getPolicyDocument
arguments:
statements:
- effect: Allow
actions:
- sns:Publish
resources:
- ${mytopic.arn}
Create TopicRule Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new TopicRule(name: string, args: TopicRuleArgs, opts?: CustomResourceOptions);@overload
def TopicRule(resource_name: str,
args: TopicRuleArgs,
opts: Optional[ResourceOptions] = None)
@overload
def TopicRule(resource_name: str,
opts: Optional[ResourceOptions] = None,
enabled: Optional[bool] = None,
sql_version: Optional[str] = None,
sql: Optional[str] = None,
iot_events: Optional[Sequence[TopicRuleIotEventArgs]] = None,
kineses: Optional[Sequence[TopicRuleKinesisArgs]] = None,
dynamodbv2s: Optional[Sequence[TopicRuleDynamodbv2Args]] = None,
elasticsearch: Optional[Sequence[TopicRuleElasticsearchArgs]] = None,
description: Optional[str] = None,
error_action: Optional[TopicRuleErrorActionArgs] = None,
firehoses: Optional[Sequence[TopicRuleFirehoseArgs]] = None,
https: Optional[Sequence[TopicRuleHttpArgs]] = None,
iot_analytics: Optional[Sequence[TopicRuleIotAnalyticArgs]] = None,
cloudwatch_alarms: Optional[Sequence[TopicRuleCloudwatchAlarmArgs]] = None,
kafkas: Optional[Sequence[TopicRuleKafkaArgs]] = None,
dynamodbs: Optional[Sequence[TopicRuleDynamodbArgs]] = None,
lambdas: Optional[Sequence[TopicRuleLambdaArgs]] = None,
name: Optional[str] = None,
republishes: Optional[Sequence[TopicRuleRepublishArgs]] = None,
s3: Optional[Sequence[TopicRuleS3Args]] = None,
sns: Optional[Sequence[TopicRuleSnsArgs]] = None,
cloudwatch_metrics: Optional[Sequence[TopicRuleCloudwatchMetricArgs]] = None,
cloudwatch_logs: Optional[Sequence[TopicRuleCloudwatchLogArgs]] = None,
sqs: Optional[Sequence[TopicRuleSqsArgs]] = None,
step_functions: Optional[Sequence[TopicRuleStepFunctionArgs]] = None,
tags: Optional[Mapping[str, str]] = None,
timestreams: Optional[Sequence[TopicRuleTimestreamArgs]] = 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:iot:TopicRule
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- 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.
Constructor example
The following reference example uses placeholder values for all input properties.
var topicRuleResource = new Aws.Iot.TopicRule("topicRuleResource", new()
{
Enabled = false,
SqlVersion = "string",
Sql = "string",
IotEvents = new[]
{
new Aws.Iot.Inputs.TopicRuleIotEventArgs
{
InputName = "string",
RoleArn = "string",
BatchMode = false,
MessageId = "string",
},
},
Kineses = new[]
{
new Aws.Iot.Inputs.TopicRuleKinesisArgs
{
RoleArn = "string",
StreamName = "string",
PartitionKey = "string",
},
},
Dynamodbv2s = new[]
{
new Aws.Iot.Inputs.TopicRuleDynamodbv2Args
{
RoleArn = "string",
PutItem = new Aws.Iot.Inputs.TopicRuleDynamodbv2PutItemArgs
{
TableName = "string",
},
},
},
Elasticsearch = new[]
{
new Aws.Iot.Inputs.TopicRuleElasticsearchArgs
{
Endpoint = "string",
Id = "string",
Index = "string",
RoleArn = "string",
Type = "string",
},
},
Description = "string",
ErrorAction = new Aws.Iot.Inputs.TopicRuleErrorActionArgs
{
CloudwatchAlarm = new Aws.Iot.Inputs.TopicRuleErrorActionCloudwatchAlarmArgs
{
AlarmName = "string",
RoleArn = "string",
StateReason = "string",
StateValue = "string",
},
CloudwatchLogs = new Aws.Iot.Inputs.TopicRuleErrorActionCloudwatchLogsArgs
{
LogGroupName = "string",
RoleArn = "string",
BatchMode = false,
},
CloudwatchMetric = new Aws.Iot.Inputs.TopicRuleErrorActionCloudwatchMetricArgs
{
MetricName = "string",
MetricNamespace = "string",
MetricUnit = "string",
MetricValue = "string",
RoleArn = "string",
MetricTimestamp = "string",
},
Dynamodb = new Aws.Iot.Inputs.TopicRuleErrorActionDynamodbArgs
{
HashKeyField = "string",
HashKeyValue = "string",
RoleArn = "string",
TableName = "string",
HashKeyType = "string",
Operation = "string",
PayloadField = "string",
RangeKeyField = "string",
RangeKeyType = "string",
RangeKeyValue = "string",
},
Dynamodbv2 = new Aws.Iot.Inputs.TopicRuleErrorActionDynamodbv2Args
{
RoleArn = "string",
PutItem = new Aws.Iot.Inputs.TopicRuleErrorActionDynamodbv2PutItemArgs
{
TableName = "string",
},
},
Elasticsearch = new Aws.Iot.Inputs.TopicRuleErrorActionElasticsearchArgs
{
Endpoint = "string",
Id = "string",
Index = "string",
RoleArn = "string",
Type = "string",
},
Firehose = new Aws.Iot.Inputs.TopicRuleErrorActionFirehoseArgs
{
DeliveryStreamName = "string",
RoleArn = "string",
BatchMode = false,
Separator = "string",
},
Http = new Aws.Iot.Inputs.TopicRuleErrorActionHttpArgs
{
Url = "string",
ConfirmationUrl = "string",
HttpHeaders = new[]
{
new Aws.Iot.Inputs.TopicRuleErrorActionHttpHttpHeaderArgs
{
Key = "string",
Value = "string",
},
},
},
IotAnalytics = new Aws.Iot.Inputs.TopicRuleErrorActionIotAnalyticsArgs
{
ChannelName = "string",
RoleArn = "string",
BatchMode = false,
},
IotEvents = new Aws.Iot.Inputs.TopicRuleErrorActionIotEventsArgs
{
InputName = "string",
RoleArn = "string",
BatchMode = false,
MessageId = "string",
},
Kafka = new Aws.Iot.Inputs.TopicRuleErrorActionKafkaArgs
{
ClientProperties =
{
{ "string", "string" },
},
DestinationArn = "string",
Topic = "string",
Headers = new[]
{
new Aws.Iot.Inputs.TopicRuleErrorActionKafkaHeaderArgs
{
Key = "string",
Value = "string",
},
},
Key = "string",
Partition = "string",
},
Kinesis = new Aws.Iot.Inputs.TopicRuleErrorActionKinesisArgs
{
RoleArn = "string",
StreamName = "string",
PartitionKey = "string",
},
Lambda = new Aws.Iot.Inputs.TopicRuleErrorActionLambdaArgs
{
FunctionArn = "string",
},
Republish = new Aws.Iot.Inputs.TopicRuleErrorActionRepublishArgs
{
RoleArn = "string",
Topic = "string",
Qos = 0,
},
S3 = new Aws.Iot.Inputs.TopicRuleErrorActionS3Args
{
BucketName = "string",
Key = "string",
RoleArn = "string",
CannedAcl = "string",
},
Sns = new Aws.Iot.Inputs.TopicRuleErrorActionSnsArgs
{
RoleArn = "string",
TargetArn = "string",
MessageFormat = "string",
},
Sqs = new Aws.Iot.Inputs.TopicRuleErrorActionSqsArgs
{
QueueUrl = "string",
RoleArn = "string",
UseBase64 = false,
},
StepFunctions = new Aws.Iot.Inputs.TopicRuleErrorActionStepFunctionsArgs
{
RoleArn = "string",
StateMachineName = "string",
ExecutionNamePrefix = "string",
},
Timestream = new Aws.Iot.Inputs.TopicRuleErrorActionTimestreamArgs
{
DatabaseName = "string",
Dimensions = new[]
{
new Aws.Iot.Inputs.TopicRuleErrorActionTimestreamDimensionArgs
{
Name = "string",
Value = "string",
},
},
RoleArn = "string",
TableName = "string",
Timestamp = new Aws.Iot.Inputs.TopicRuleErrorActionTimestreamTimestampArgs
{
Unit = "string",
Value = "string",
},
},
},
Firehoses = new[]
{
new Aws.Iot.Inputs.TopicRuleFirehoseArgs
{
DeliveryStreamName = "string",
RoleArn = "string",
BatchMode = false,
Separator = "string",
},
},
Https = new[]
{
new Aws.Iot.Inputs.TopicRuleHttpArgs
{
Url = "string",
ConfirmationUrl = "string",
HttpHeaders = new[]
{
new Aws.Iot.Inputs.TopicRuleHttpHttpHeaderArgs
{
Key = "string",
Value = "string",
},
},
},
},
IotAnalytics = new[]
{
new Aws.Iot.Inputs.TopicRuleIotAnalyticArgs
{
ChannelName = "string",
RoleArn = "string",
BatchMode = false,
},
},
CloudwatchAlarms = new[]
{
new Aws.Iot.Inputs.TopicRuleCloudwatchAlarmArgs
{
AlarmName = "string",
RoleArn = "string",
StateReason = "string",
StateValue = "string",
},
},
Kafkas = new[]
{
new Aws.Iot.Inputs.TopicRuleKafkaArgs
{
ClientProperties =
{
{ "string", "string" },
},
DestinationArn = "string",
Topic = "string",
Headers = new[]
{
new Aws.Iot.Inputs.TopicRuleKafkaHeaderArgs
{
Key = "string",
Value = "string",
},
},
Key = "string",
Partition = "string",
},
},
Dynamodbs = new[]
{
new Aws.Iot.Inputs.TopicRuleDynamodbArgs
{
HashKeyField = "string",
HashKeyValue = "string",
RoleArn = "string",
TableName = "string",
HashKeyType = "string",
Operation = "string",
PayloadField = "string",
RangeKeyField = "string",
RangeKeyType = "string",
RangeKeyValue = "string",
},
},
Lambdas = new[]
{
new Aws.Iot.Inputs.TopicRuleLambdaArgs
{
FunctionArn = "string",
},
},
Name = "string",
Republishes = new[]
{
new Aws.Iot.Inputs.TopicRuleRepublishArgs
{
RoleArn = "string",
Topic = "string",
Qos = 0,
},
},
S3 = new[]
{
new Aws.Iot.Inputs.TopicRuleS3Args
{
BucketName = "string",
Key = "string",
RoleArn = "string",
CannedAcl = "string",
},
},
Sns = new[]
{
new Aws.Iot.Inputs.TopicRuleSnsArgs
{
RoleArn = "string",
TargetArn = "string",
MessageFormat = "string",
},
},
CloudwatchMetrics = new[]
{
new Aws.Iot.Inputs.TopicRuleCloudwatchMetricArgs
{
MetricName = "string",
MetricNamespace = "string",
MetricUnit = "string",
MetricValue = "string",
RoleArn = "string",
MetricTimestamp = "string",
},
},
CloudwatchLogs = new[]
{
new Aws.Iot.Inputs.TopicRuleCloudwatchLogArgs
{
LogGroupName = "string",
RoleArn = "string",
BatchMode = false,
},
},
Sqs = new[]
{
new Aws.Iot.Inputs.TopicRuleSqsArgs
{
QueueUrl = "string",
RoleArn = "string",
UseBase64 = false,
},
},
StepFunctions = new[]
{
new Aws.Iot.Inputs.TopicRuleStepFunctionArgs
{
RoleArn = "string",
StateMachineName = "string",
ExecutionNamePrefix = "string",
},
},
Tags =
{
{ "string", "string" },
},
Timestreams = new[]
{
new Aws.Iot.Inputs.TopicRuleTimestreamArgs
{
DatabaseName = "string",
Dimensions = new[]
{
new Aws.Iot.Inputs.TopicRuleTimestreamDimensionArgs
{
Name = "string",
Value = "string",
},
},
RoleArn = "string",
TableName = "string",
Timestamp = new Aws.Iot.Inputs.TopicRuleTimestreamTimestampArgs
{
Unit = "string",
Value = "string",
},
},
},
});
example, err := iot.NewTopicRule(ctx, "topicRuleResource", &iot.TopicRuleArgs{
Enabled: pulumi.Bool(false),
SqlVersion: pulumi.String("string"),
Sql: pulumi.String("string"),
IotEvents: iot.TopicRuleIotEventArray{
&iot.TopicRuleIotEventArgs{
InputName: pulumi.String("string"),
RoleArn: pulumi.String("string"),
BatchMode: pulumi.Bool(false),
MessageId: pulumi.String("string"),
},
},
Kineses: iot.TopicRuleKinesisArray{
&iot.TopicRuleKinesisArgs{
RoleArn: pulumi.String("string"),
StreamName: pulumi.String("string"),
PartitionKey: pulumi.String("string"),
},
},
Dynamodbv2s: iot.TopicRuleDynamodbv2Array{
&iot.TopicRuleDynamodbv2Args{
RoleArn: pulumi.String("string"),
PutItem: &iot.TopicRuleDynamodbv2PutItemArgs{
TableName: pulumi.String("string"),
},
},
},
Elasticsearch: iot.TopicRuleElasticsearchArray{
&iot.TopicRuleElasticsearchArgs{
Endpoint: pulumi.String("string"),
Id: pulumi.String("string"),
Index: pulumi.String("string"),
RoleArn: pulumi.String("string"),
Type: pulumi.String("string"),
},
},
Description: pulumi.String("string"),
ErrorAction: &iot.TopicRuleErrorActionArgs{
CloudwatchAlarm: &iot.TopicRuleErrorActionCloudwatchAlarmArgs{
AlarmName: pulumi.String("string"),
RoleArn: pulumi.String("string"),
StateReason: pulumi.String("string"),
StateValue: pulumi.String("string"),
},
CloudwatchLogs: &iot.TopicRuleErrorActionCloudwatchLogsArgs{
LogGroupName: pulumi.String("string"),
RoleArn: pulumi.String("string"),
BatchMode: pulumi.Bool(false),
},
CloudwatchMetric: &iot.TopicRuleErrorActionCloudwatchMetricArgs{
MetricName: pulumi.String("string"),
MetricNamespace: pulumi.String("string"),
MetricUnit: pulumi.String("string"),
MetricValue: pulumi.String("string"),
RoleArn: pulumi.String("string"),
MetricTimestamp: pulumi.String("string"),
},
Dynamodb: &iot.TopicRuleErrorActionDynamodbArgs{
HashKeyField: pulumi.String("string"),
HashKeyValue: pulumi.String("string"),
RoleArn: pulumi.String("string"),
TableName: pulumi.String("string"),
HashKeyType: pulumi.String("string"),
Operation: pulumi.String("string"),
PayloadField: pulumi.String("string"),
RangeKeyField: pulumi.String("string"),
RangeKeyType: pulumi.String("string"),
RangeKeyValue: pulumi.String("string"),
},
Dynamodbv2: &iot.TopicRuleErrorActionDynamodbv2Args{
RoleArn: pulumi.String("string"),
PutItem: &iot.TopicRuleErrorActionDynamodbv2PutItemArgs{
TableName: pulumi.String("string"),
},
},
Elasticsearch: &iot.TopicRuleErrorActionElasticsearchArgs{
Endpoint: pulumi.String("string"),
Id: pulumi.String("string"),
Index: pulumi.String("string"),
RoleArn: pulumi.String("string"),
Type: pulumi.String("string"),
},
Firehose: &iot.TopicRuleErrorActionFirehoseArgs{
DeliveryStreamName: pulumi.String("string"),
RoleArn: pulumi.String("string"),
BatchMode: pulumi.Bool(false),
Separator: pulumi.String("string"),
},
Http: &iot.TopicRuleErrorActionHttpArgs{
Url: pulumi.String("string"),
ConfirmationUrl: pulumi.String("string"),
HttpHeaders: iot.TopicRuleErrorActionHttpHttpHeaderArray{
&iot.TopicRuleErrorActionHttpHttpHeaderArgs{
Key: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
},
IotAnalytics: &iot.TopicRuleErrorActionIotAnalyticsArgs{
ChannelName: pulumi.String("string"),
RoleArn: pulumi.String("string"),
BatchMode: pulumi.Bool(false),
},
IotEvents: &iot.TopicRuleErrorActionIotEventsArgs{
InputName: pulumi.String("string"),
RoleArn: pulumi.String("string"),
BatchMode: pulumi.Bool(false),
MessageId: pulumi.String("string"),
},
Kafka: &iot.TopicRuleErrorActionKafkaArgs{
ClientProperties: pulumi.StringMap{
"string": pulumi.String("string"),
},
DestinationArn: pulumi.String("string"),
Topic: pulumi.String("string"),
Headers: iot.TopicRuleErrorActionKafkaHeaderArray{
&iot.TopicRuleErrorActionKafkaHeaderArgs{
Key: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
Key: pulumi.String("string"),
Partition: pulumi.String("string"),
},
Kinesis: &iot.TopicRuleErrorActionKinesisArgs{
RoleArn: pulumi.String("string"),
StreamName: pulumi.String("string"),
PartitionKey: pulumi.String("string"),
},
Lambda: &iot.TopicRuleErrorActionLambdaArgs{
FunctionArn: pulumi.String("string"),
},
Republish: &iot.TopicRuleErrorActionRepublishArgs{
RoleArn: pulumi.String("string"),
Topic: pulumi.String("string"),
Qos: pulumi.Int(0),
},
S3: &iot.TopicRuleErrorActionS3Args{
BucketName: pulumi.String("string"),
Key: pulumi.String("string"),
RoleArn: pulumi.String("string"),
CannedAcl: pulumi.String("string"),
},
Sns: &iot.TopicRuleErrorActionSnsArgs{
RoleArn: pulumi.String("string"),
TargetArn: pulumi.String("string"),
MessageFormat: pulumi.String("string"),
},
Sqs: &iot.TopicRuleErrorActionSqsArgs{
QueueUrl: pulumi.String("string"),
RoleArn: pulumi.String("string"),
UseBase64: pulumi.Bool(false),
},
StepFunctions: &iot.TopicRuleErrorActionStepFunctionsArgs{
RoleArn: pulumi.String("string"),
StateMachineName: pulumi.String("string"),
ExecutionNamePrefix: pulumi.String("string"),
},
Timestream: &iot.TopicRuleErrorActionTimestreamArgs{
DatabaseName: pulumi.String("string"),
Dimensions: iot.TopicRuleErrorActionTimestreamDimensionArray{
&iot.TopicRuleErrorActionTimestreamDimensionArgs{
Name: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
RoleArn: pulumi.String("string"),
TableName: pulumi.String("string"),
Timestamp: &iot.TopicRuleErrorActionTimestreamTimestampArgs{
Unit: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
},
Firehoses: iot.TopicRuleFirehoseArray{
&iot.TopicRuleFirehoseArgs{
DeliveryStreamName: pulumi.String("string"),
RoleArn: pulumi.String("string"),
BatchMode: pulumi.Bool(false),
Separator: pulumi.String("string"),
},
},
Https: iot.TopicRuleHttpArray{
&iot.TopicRuleHttpArgs{
Url: pulumi.String("string"),
ConfirmationUrl: pulumi.String("string"),
HttpHeaders: iot.TopicRuleHttpHttpHeaderArray{
&iot.TopicRuleHttpHttpHeaderArgs{
Key: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
},
},
IotAnalytics: iot.TopicRuleIotAnalyticArray{
&iot.TopicRuleIotAnalyticArgs{
ChannelName: pulumi.String("string"),
RoleArn: pulumi.String("string"),
BatchMode: pulumi.Bool(false),
},
},
CloudwatchAlarms: iot.TopicRuleCloudwatchAlarmArray{
&iot.TopicRuleCloudwatchAlarmArgs{
AlarmName: pulumi.String("string"),
RoleArn: pulumi.String("string"),
StateReason: pulumi.String("string"),
StateValue: pulumi.String("string"),
},
},
Kafkas: iot.TopicRuleKafkaArray{
&iot.TopicRuleKafkaArgs{
ClientProperties: pulumi.StringMap{
"string": pulumi.String("string"),
},
DestinationArn: pulumi.String("string"),
Topic: pulumi.String("string"),
Headers: iot.TopicRuleKafkaHeaderArray{
&iot.TopicRuleKafkaHeaderArgs{
Key: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
Key: pulumi.String("string"),
Partition: pulumi.String("string"),
},
},
Dynamodbs: iot.TopicRuleDynamodbArray{
&iot.TopicRuleDynamodbArgs{
HashKeyField: pulumi.String("string"),
HashKeyValue: pulumi.String("string"),
RoleArn: pulumi.String("string"),
TableName: pulumi.String("string"),
HashKeyType: pulumi.String("string"),
Operation: pulumi.String("string"),
PayloadField: pulumi.String("string"),
RangeKeyField: pulumi.String("string"),
RangeKeyType: pulumi.String("string"),
RangeKeyValue: pulumi.String("string"),
},
},
Lambdas: iot.TopicRuleLambdaArray{
&iot.TopicRuleLambdaArgs{
FunctionArn: pulumi.String("string"),
},
},
Name: pulumi.String("string"),
Republishes: iot.TopicRuleRepublishArray{
&iot.TopicRuleRepublishArgs{
RoleArn: pulumi.String("string"),
Topic: pulumi.String("string"),
Qos: pulumi.Int(0),
},
},
S3: iot.TopicRuleS3Array{
&iot.TopicRuleS3Args{
BucketName: pulumi.String("string"),
Key: pulumi.String("string"),
RoleArn: pulumi.String("string"),
CannedAcl: pulumi.String("string"),
},
},
Sns: iot.TopicRuleSnsArray{
&iot.TopicRuleSnsArgs{
RoleArn: pulumi.String("string"),
TargetArn: pulumi.String("string"),
MessageFormat: pulumi.String("string"),
},
},
CloudwatchMetrics: iot.TopicRuleCloudwatchMetricArray{
&iot.TopicRuleCloudwatchMetricArgs{
MetricName: pulumi.String("string"),
MetricNamespace: pulumi.String("string"),
MetricUnit: pulumi.String("string"),
MetricValue: pulumi.String("string"),
RoleArn: pulumi.String("string"),
MetricTimestamp: pulumi.String("string"),
},
},
CloudwatchLogs: iot.TopicRuleCloudwatchLogArray{
&iot.TopicRuleCloudwatchLogArgs{
LogGroupName: pulumi.String("string"),
RoleArn: pulumi.String("string"),
BatchMode: pulumi.Bool(false),
},
},
Sqs: iot.TopicRuleSqsArray{
&iot.TopicRuleSqsArgs{
QueueUrl: pulumi.String("string"),
RoleArn: pulumi.String("string"),
UseBase64: pulumi.Bool(false),
},
},
StepFunctions: iot.TopicRuleStepFunctionArray{
&iot.TopicRuleStepFunctionArgs{
RoleArn: pulumi.String("string"),
StateMachineName: pulumi.String("string"),
ExecutionNamePrefix: pulumi.String("string"),
},
},
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
Timestreams: iot.TopicRuleTimestreamArray{
&iot.TopicRuleTimestreamArgs{
DatabaseName: pulumi.String("string"),
Dimensions: iot.TopicRuleTimestreamDimensionArray{
&iot.TopicRuleTimestreamDimensionArgs{
Name: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
RoleArn: pulumi.String("string"),
TableName: pulumi.String("string"),
Timestamp: &iot.TopicRuleTimestreamTimestampArgs{
Unit: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
},
})
var topicRuleResource = new TopicRule("topicRuleResource", TopicRuleArgs.builder()
.enabled(false)
.sqlVersion("string")
.sql("string")
.iotEvents(TopicRuleIotEventArgs.builder()
.inputName("string")
.roleArn("string")
.batchMode(false)
.messageId("string")
.build())
.kineses(TopicRuleKinesisArgs.builder()
.roleArn("string")
.streamName("string")
.partitionKey("string")
.build())
.dynamodbv2s(TopicRuleDynamodbv2Args.builder()
.roleArn("string")
.putItem(TopicRuleDynamodbv2PutItemArgs.builder()
.tableName("string")
.build())
.build())
.elasticsearch(TopicRuleElasticsearchArgs.builder()
.endpoint("string")
.id("string")
.index("string")
.roleArn("string")
.type("string")
.build())
.description("string")
.errorAction(TopicRuleErrorActionArgs.builder()
.cloudwatchAlarm(TopicRuleErrorActionCloudwatchAlarmArgs.builder()
.alarmName("string")
.roleArn("string")
.stateReason("string")
.stateValue("string")
.build())
.cloudwatchLogs(TopicRuleErrorActionCloudwatchLogsArgs.builder()
.logGroupName("string")
.roleArn("string")
.batchMode(false)
.build())
.cloudwatchMetric(TopicRuleErrorActionCloudwatchMetricArgs.builder()
.metricName("string")
.metricNamespace("string")
.metricUnit("string")
.metricValue("string")
.roleArn("string")
.metricTimestamp("string")
.build())
.dynamodb(TopicRuleErrorActionDynamodbArgs.builder()
.hashKeyField("string")
.hashKeyValue("string")
.roleArn("string")
.tableName("string")
.hashKeyType("string")
.operation("string")
.payloadField("string")
.rangeKeyField("string")
.rangeKeyType("string")
.rangeKeyValue("string")
.build())
.dynamodbv2(TopicRuleErrorActionDynamodbv2Args.builder()
.roleArn("string")
.putItem(TopicRuleErrorActionDynamodbv2PutItemArgs.builder()
.tableName("string")
.build())
.build())
.elasticsearch(TopicRuleErrorActionElasticsearchArgs.builder()
.endpoint("string")
.id("string")
.index("string")
.roleArn("string")
.type("string")
.build())
.firehose(TopicRuleErrorActionFirehoseArgs.builder()
.deliveryStreamName("string")
.roleArn("string")
.batchMode(false)
.separator("string")
.build())
.http(TopicRuleErrorActionHttpArgs.builder()
.url("string")
.confirmationUrl("string")
.httpHeaders(TopicRuleErrorActionHttpHttpHeaderArgs.builder()
.key("string")
.value("string")
.build())
.build())
.iotAnalytics(TopicRuleErrorActionIotAnalyticsArgs.builder()
.channelName("string")
.roleArn("string")
.batchMode(false)
.build())
.iotEvents(TopicRuleErrorActionIotEventsArgs.builder()
.inputName("string")
.roleArn("string")
.batchMode(false)
.messageId("string")
.build())
.kafka(TopicRuleErrorActionKafkaArgs.builder()
.clientProperties(Map.of("string", "string"))
.destinationArn("string")
.topic("string")
.headers(TopicRuleErrorActionKafkaHeaderArgs.builder()
.key("string")
.value("string")
.build())
.key("string")
.partition("string")
.build())
.kinesis(TopicRuleErrorActionKinesisArgs.builder()
.roleArn("string")
.streamName("string")
.partitionKey("string")
.build())
.lambda(TopicRuleErrorActionLambdaArgs.builder()
.functionArn("string")
.build())
.republish(TopicRuleErrorActionRepublishArgs.builder()
.roleArn("string")
.topic("string")
.qos(0)
.build())
.s3(TopicRuleErrorActionS3Args.builder()
.bucketName("string")
.key("string")
.roleArn("string")
.cannedAcl("string")
.build())
.sns(TopicRuleErrorActionSnsArgs.builder()
.roleArn("string")
.targetArn("string")
.messageFormat("string")
.build())
.sqs(TopicRuleErrorActionSqsArgs.builder()
.queueUrl("string")
.roleArn("string")
.useBase64(false)
.build())
.stepFunctions(TopicRuleErrorActionStepFunctionsArgs.builder()
.roleArn("string")
.stateMachineName("string")
.executionNamePrefix("string")
.build())
.timestream(TopicRuleErrorActionTimestreamArgs.builder()
.databaseName("string")
.dimensions(TopicRuleErrorActionTimestreamDimensionArgs.builder()
.name("string")
.value("string")
.build())
.roleArn("string")
.tableName("string")
.timestamp(TopicRuleErrorActionTimestreamTimestampArgs.builder()
.unit("string")
.value("string")
.build())
.build())
.build())
.firehoses(TopicRuleFirehoseArgs.builder()
.deliveryStreamName("string")
.roleArn("string")
.batchMode(false)
.separator("string")
.build())
.https(TopicRuleHttpArgs.builder()
.url("string")
.confirmationUrl("string")
.httpHeaders(TopicRuleHttpHttpHeaderArgs.builder()
.key("string")
.value("string")
.build())
.build())
.iotAnalytics(TopicRuleIotAnalyticArgs.builder()
.channelName("string")
.roleArn("string")
.batchMode(false)
.build())
.cloudwatchAlarms(TopicRuleCloudwatchAlarmArgs.builder()
.alarmName("string")
.roleArn("string")
.stateReason("string")
.stateValue("string")
.build())
.kafkas(TopicRuleKafkaArgs.builder()
.clientProperties(Map.of("string", "string"))
.destinationArn("string")
.topic("string")
.headers(TopicRuleKafkaHeaderArgs.builder()
.key("string")
.value("string")
.build())
.key("string")
.partition("string")
.build())
.dynamodbs(TopicRuleDynamodbArgs.builder()
.hashKeyField("string")
.hashKeyValue("string")
.roleArn("string")
.tableName("string")
.hashKeyType("string")
.operation("string")
.payloadField("string")
.rangeKeyField("string")
.rangeKeyType("string")
.rangeKeyValue("string")
.build())
.lambdas(TopicRuleLambdaArgs.builder()
.functionArn("string")
.build())
.name("string")
.republishes(TopicRuleRepublishArgs.builder()
.roleArn("string")
.topic("string")
.qos(0)
.build())
.s3(TopicRuleS3Args.builder()
.bucketName("string")
.key("string")
.roleArn("string")
.cannedAcl("string")
.build())
.sns(TopicRuleSnsArgs.builder()
.roleArn("string")
.targetArn("string")
.messageFormat("string")
.build())
.cloudwatchMetrics(TopicRuleCloudwatchMetricArgs.builder()
.metricName("string")
.metricNamespace("string")
.metricUnit("string")
.metricValue("string")
.roleArn("string")
.metricTimestamp("string")
.build())
.cloudwatchLogs(TopicRuleCloudwatchLogArgs.builder()
.logGroupName("string")
.roleArn("string")
.batchMode(false)
.build())
.sqs(TopicRuleSqsArgs.builder()
.queueUrl("string")
.roleArn("string")
.useBase64(false)
.build())
.stepFunctions(TopicRuleStepFunctionArgs.builder()
.roleArn("string")
.stateMachineName("string")
.executionNamePrefix("string")
.build())
.tags(Map.of("string", "string"))
.timestreams(TopicRuleTimestreamArgs.builder()
.databaseName("string")
.dimensions(TopicRuleTimestreamDimensionArgs.builder()
.name("string")
.value("string")
.build())
.roleArn("string")
.tableName("string")
.timestamp(TopicRuleTimestreamTimestampArgs.builder()
.unit("string")
.value("string")
.build())
.build())
.build());
topic_rule_resource = aws.iot.TopicRule("topicRuleResource",
enabled=False,
sql_version="string",
sql="string",
iot_events=[{
"input_name": "string",
"role_arn": "string",
"batch_mode": False,
"message_id": "string",
}],
kineses=[{
"role_arn": "string",
"stream_name": "string",
"partition_key": "string",
}],
dynamodbv2s=[{
"role_arn": "string",
"put_item": {
"table_name": "string",
},
}],
elasticsearch=[{
"endpoint": "string",
"id": "string",
"index": "string",
"role_arn": "string",
"type": "string",
}],
description="string",
error_action={
"cloudwatch_alarm": {
"alarm_name": "string",
"role_arn": "string",
"state_reason": "string",
"state_value": "string",
},
"cloudwatch_logs": {
"log_group_name": "string",
"role_arn": "string",
"batch_mode": False,
},
"cloudwatch_metric": {
"metric_name": "string",
"metric_namespace": "string",
"metric_unit": "string",
"metric_value": "string",
"role_arn": "string",
"metric_timestamp": "string",
},
"dynamodb": {
"hash_key_field": "string",
"hash_key_value": "string",
"role_arn": "string",
"table_name": "string",
"hash_key_type": "string",
"operation": "string",
"payload_field": "string",
"range_key_field": "string",
"range_key_type": "string",
"range_key_value": "string",
},
"dynamodbv2": {
"role_arn": "string",
"put_item": {
"table_name": "string",
},
},
"elasticsearch": {
"endpoint": "string",
"id": "string",
"index": "string",
"role_arn": "string",
"type": "string",
},
"firehose": {
"delivery_stream_name": "string",
"role_arn": "string",
"batch_mode": False,
"separator": "string",
},
"http": {
"url": "string",
"confirmation_url": "string",
"http_headers": [{
"key": "string",
"value": "string",
}],
},
"iot_analytics": {
"channel_name": "string",
"role_arn": "string",
"batch_mode": False,
},
"iot_events": {
"input_name": "string",
"role_arn": "string",
"batch_mode": False,
"message_id": "string",
},
"kafka": {
"client_properties": {
"string": "string",
},
"destination_arn": "string",
"topic": "string",
"headers": [{
"key": "string",
"value": "string",
}],
"key": "string",
"partition": "string",
},
"kinesis": {
"role_arn": "string",
"stream_name": "string",
"partition_key": "string",
},
"lambda_": {
"function_arn": "string",
},
"republish": {
"role_arn": "string",
"topic": "string",
"qos": 0,
},
"s3": {
"bucket_name": "string",
"key": "string",
"role_arn": "string",
"canned_acl": "string",
},
"sns": {
"role_arn": "string",
"target_arn": "string",
"message_format": "string",
},
"sqs": {
"queue_url": "string",
"role_arn": "string",
"use_base64": False,
},
"step_functions": {
"role_arn": "string",
"state_machine_name": "string",
"execution_name_prefix": "string",
},
"timestream": {
"database_name": "string",
"dimensions": [{
"name": "string",
"value": "string",
}],
"role_arn": "string",
"table_name": "string",
"timestamp": {
"unit": "string",
"value": "string",
},
},
},
firehoses=[{
"delivery_stream_name": "string",
"role_arn": "string",
"batch_mode": False,
"separator": "string",
}],
https=[{
"url": "string",
"confirmation_url": "string",
"http_headers": [{
"key": "string",
"value": "string",
}],
}],
iot_analytics=[{
"channel_name": "string",
"role_arn": "string",
"batch_mode": False,
}],
cloudwatch_alarms=[{
"alarm_name": "string",
"role_arn": "string",
"state_reason": "string",
"state_value": "string",
}],
kafkas=[{
"client_properties": {
"string": "string",
},
"destination_arn": "string",
"topic": "string",
"headers": [{
"key": "string",
"value": "string",
}],
"key": "string",
"partition": "string",
}],
dynamodbs=[{
"hash_key_field": "string",
"hash_key_value": "string",
"role_arn": "string",
"table_name": "string",
"hash_key_type": "string",
"operation": "string",
"payload_field": "string",
"range_key_field": "string",
"range_key_type": "string",
"range_key_value": "string",
}],
lambdas=[{
"function_arn": "string",
}],
name="string",
republishes=[{
"role_arn": "string",
"topic": "string",
"qos": 0,
}],
s3=[{
"bucket_name": "string",
"key": "string",
"role_arn": "string",
"canned_acl": "string",
}],
sns=[{
"role_arn": "string",
"target_arn": "string",
"message_format": "string",
}],
cloudwatch_metrics=[{
"metric_name": "string",
"metric_namespace": "string",
"metric_unit": "string",
"metric_value": "string",
"role_arn": "string",
"metric_timestamp": "string",
}],
cloudwatch_logs=[{
"log_group_name": "string",
"role_arn": "string",
"batch_mode": False,
}],
sqs=[{
"queue_url": "string",
"role_arn": "string",
"use_base64": False,
}],
step_functions=[{
"role_arn": "string",
"state_machine_name": "string",
"execution_name_prefix": "string",
}],
tags={
"string": "string",
},
timestreams=[{
"database_name": "string",
"dimensions": [{
"name": "string",
"value": "string",
}],
"role_arn": "string",
"table_name": "string",
"timestamp": {
"unit": "string",
"value": "string",
},
}])
const topicRuleResource = new aws.iot.TopicRule("topicRuleResource", {
enabled: false,
sqlVersion: "string",
sql: "string",
iotEvents: [{
inputName: "string",
roleArn: "string",
batchMode: false,
messageId: "string",
}],
kineses: [{
roleArn: "string",
streamName: "string",
partitionKey: "string",
}],
dynamodbv2s: [{
roleArn: "string",
putItem: {
tableName: "string",
},
}],
elasticsearch: [{
endpoint: "string",
id: "string",
index: "string",
roleArn: "string",
type: "string",
}],
description: "string",
errorAction: {
cloudwatchAlarm: {
alarmName: "string",
roleArn: "string",
stateReason: "string",
stateValue: "string",
},
cloudwatchLogs: {
logGroupName: "string",
roleArn: "string",
batchMode: false,
},
cloudwatchMetric: {
metricName: "string",
metricNamespace: "string",
metricUnit: "string",
metricValue: "string",
roleArn: "string",
metricTimestamp: "string",
},
dynamodb: {
hashKeyField: "string",
hashKeyValue: "string",
roleArn: "string",
tableName: "string",
hashKeyType: "string",
operation: "string",
payloadField: "string",
rangeKeyField: "string",
rangeKeyType: "string",
rangeKeyValue: "string",
},
dynamodbv2: {
roleArn: "string",
putItem: {
tableName: "string",
},
},
elasticsearch: {
endpoint: "string",
id: "string",
index: "string",
roleArn: "string",
type: "string",
},
firehose: {
deliveryStreamName: "string",
roleArn: "string",
batchMode: false,
separator: "string",
},
http: {
url: "string",
confirmationUrl: "string",
httpHeaders: [{
key: "string",
value: "string",
}],
},
iotAnalytics: {
channelName: "string",
roleArn: "string",
batchMode: false,
},
iotEvents: {
inputName: "string",
roleArn: "string",
batchMode: false,
messageId: "string",
},
kafka: {
clientProperties: {
string: "string",
},
destinationArn: "string",
topic: "string",
headers: [{
key: "string",
value: "string",
}],
key: "string",
partition: "string",
},
kinesis: {
roleArn: "string",
streamName: "string",
partitionKey: "string",
},
lambda: {
functionArn: "string",
},
republish: {
roleArn: "string",
topic: "string",
qos: 0,
},
s3: {
bucketName: "string",
key: "string",
roleArn: "string",
cannedAcl: "string",
},
sns: {
roleArn: "string",
targetArn: "string",
messageFormat: "string",
},
sqs: {
queueUrl: "string",
roleArn: "string",
useBase64: false,
},
stepFunctions: {
roleArn: "string",
stateMachineName: "string",
executionNamePrefix: "string",
},
timestream: {
databaseName: "string",
dimensions: [{
name: "string",
value: "string",
}],
roleArn: "string",
tableName: "string",
timestamp: {
unit: "string",
value: "string",
},
},
},
firehoses: [{
deliveryStreamName: "string",
roleArn: "string",
batchMode: false,
separator: "string",
}],
https: [{
url: "string",
confirmationUrl: "string",
httpHeaders: [{
key: "string",
value: "string",
}],
}],
iotAnalytics: [{
channelName: "string",
roleArn: "string",
batchMode: false,
}],
cloudwatchAlarms: [{
alarmName: "string",
roleArn: "string",
stateReason: "string",
stateValue: "string",
}],
kafkas: [{
clientProperties: {
string: "string",
},
destinationArn: "string",
topic: "string",
headers: [{
key: "string",
value: "string",
}],
key: "string",
partition: "string",
}],
dynamodbs: [{
hashKeyField: "string",
hashKeyValue: "string",
roleArn: "string",
tableName: "string",
hashKeyType: "string",
operation: "string",
payloadField: "string",
rangeKeyField: "string",
rangeKeyType: "string",
rangeKeyValue: "string",
}],
lambdas: [{
functionArn: "string",
}],
name: "string",
republishes: [{
roleArn: "string",
topic: "string",
qos: 0,
}],
s3: [{
bucketName: "string",
key: "string",
roleArn: "string",
cannedAcl: "string",
}],
sns: [{
roleArn: "string",
targetArn: "string",
messageFormat: "string",
}],
cloudwatchMetrics: [{
metricName: "string",
metricNamespace: "string",
metricUnit: "string",
metricValue: "string",
roleArn: "string",
metricTimestamp: "string",
}],
cloudwatchLogs: [{
logGroupName: "string",
roleArn: "string",
batchMode: false,
}],
sqs: [{
queueUrl: "string",
roleArn: "string",
useBase64: false,
}],
stepFunctions: [{
roleArn: "string",
stateMachineName: "string",
executionNamePrefix: "string",
}],
tags: {
string: "string",
},
timestreams: [{
databaseName: "string",
dimensions: [{
name: "string",
value: "string",
}],
roleArn: "string",
tableName: "string",
timestamp: {
unit: "string",
value: "string",
},
}],
});
type: aws:iot:TopicRule
properties:
cloudwatchAlarms:
- alarmName: string
roleArn: string
stateReason: string
stateValue: string
cloudwatchLogs:
- batchMode: false
logGroupName: string
roleArn: string
cloudwatchMetrics:
- metricName: string
metricNamespace: string
metricTimestamp: string
metricUnit: string
metricValue: string
roleArn: string
description: string
dynamodbs:
- hashKeyField: string
hashKeyType: string
hashKeyValue: string
operation: string
payloadField: string
rangeKeyField: string
rangeKeyType: string
rangeKeyValue: string
roleArn: string
tableName: string
dynamodbv2s:
- putItem:
tableName: string
roleArn: string
elasticsearch:
- endpoint: string
id: string
index: string
roleArn: string
type: string
enabled: false
errorAction:
cloudwatchAlarm:
alarmName: string
roleArn: string
stateReason: string
stateValue: string
cloudwatchLogs:
batchMode: false
logGroupName: string
roleArn: string
cloudwatchMetric:
metricName: string
metricNamespace: string
metricTimestamp: string
metricUnit: string
metricValue: string
roleArn: string
dynamodb:
hashKeyField: string
hashKeyType: string
hashKeyValue: string
operation: string
payloadField: string
rangeKeyField: string
rangeKeyType: string
rangeKeyValue: string
roleArn: string
tableName: string
dynamodbv2:
putItem:
tableName: string
roleArn: string
elasticsearch:
endpoint: string
id: string
index: string
roleArn: string
type: string
firehose:
batchMode: false
deliveryStreamName: string
roleArn: string
separator: string
http:
confirmationUrl: string
httpHeaders:
- key: string
value: string
url: string
iotAnalytics:
batchMode: false
channelName: string
roleArn: string
iotEvents:
batchMode: false
inputName: string
messageId: string
roleArn: string
kafka:
clientProperties:
string: string
destinationArn: string
headers:
- key: string
value: string
key: string
partition: string
topic: string
kinesis:
partitionKey: string
roleArn: string
streamName: string
lambda:
functionArn: string
republish:
qos: 0
roleArn: string
topic: string
s3:
bucketName: string
cannedAcl: string
key: string
roleArn: string
sns:
messageFormat: string
roleArn: string
targetArn: string
sqs:
queueUrl: string
roleArn: string
useBase64: false
stepFunctions:
executionNamePrefix: string
roleArn: string
stateMachineName: string
timestream:
databaseName: string
dimensions:
- name: string
value: string
roleArn: string
tableName: string
timestamp:
unit: string
value: string
firehoses:
- batchMode: false
deliveryStreamName: string
roleArn: string
separator: string
https:
- confirmationUrl: string
httpHeaders:
- key: string
value: string
url: string
iotAnalytics:
- batchMode: false
channelName: string
roleArn: string
iotEvents:
- batchMode: false
inputName: string
messageId: string
roleArn: string
kafkas:
- clientProperties:
string: string
destinationArn: string
headers:
- key: string
value: string
key: string
partition: string
topic: string
kineses:
- partitionKey: string
roleArn: string
streamName: string
lambdas:
- functionArn: string
name: string
republishes:
- qos: 0
roleArn: string
topic: string
s3:
- bucketName: string
cannedAcl: string
key: string
roleArn: string
sns:
- messageFormat: string
roleArn: string
targetArn: string
sql: string
sqlVersion: string
sqs:
- queueUrl: string
roleArn: string
useBase64: false
stepFunctions:
- executionNamePrefix: string
roleArn: string
stateMachineName: string
tags:
string: string
timestreams:
- databaseName: string
dimensions:
- name: string
value: string
roleArn: string
tableName: string
timestamp:
unit: string
value: string
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
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The TopicRule resource accepts the following input properties:
- Enabled bool
- Specifies whether the rule is enabled.
- Sql string
- The SQL statement used to query the topic. For more information, see AWS IoT SQL Reference (http://docs.aws.amazon.com/iot/latest/developerguide/iot-rules.html#aws-iot-sql-reference) in the AWS IoT Developer Guide.
- Sql
Version string - The version of the SQL rules engine to use when evaluating the rule.
- Cloudwatch
Alarms List<TopicRule Cloudwatch Alarm> - Cloudwatch
Logs List<TopicRule Cloudwatch Log> - Cloudwatch
Metrics List<TopicRule Cloudwatch Metric> - Description string
- The description of the rule.
- Dynamodbs
List<Topic
Rule Dynamodb> - Dynamodbv2s
List<Topic
Rule Dynamodbv2> - Elasticsearch
List<Topic
Rule Elasticsearch> - Error
Action TopicRule Error Action - Configuration block with error action to be associated with the rule. See the documentation for
cloudwatch_alarm,cloudwatch_logs,cloudwatch_metric,dynamodb,dynamodbv2,elasticsearch,firehose,http,iot_analytics,iot_events,kafka,kinesis,lambda,republish,s3,sns,sqs,step_functions,timestreamconfiguration blocks for further configuration details. - Firehoses
List<Topic
Rule Firehose> - Https
List<Topic
Rule Http> - Iot
Analytics List<TopicRule Iot Analytic> - Iot
Events List<TopicRule Iot Event> - Kafkas
List<Topic
Rule Kafka> - Kineses
List<Topic
Rule Kinesis> - Lambdas
List<Topic
Rule Lambda> - Name string
- The name of the rule.
- Republishes
List<Topic
Rule Republish> - S3
List<Topic
Rule S3> - Sns
List<Topic
Rule Sns> - Sqs
List<Topic
Rule Sqs> - Step
Functions List<TopicRule Step Function> - Dictionary<string, string>
- Key-value map of resource tags. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - Timestreams
List<Topic
Rule Timestream>
- Enabled bool
- Specifies whether the rule is enabled.
- Sql string
- The SQL statement used to query the topic. For more information, see AWS IoT SQL Reference (http://docs.aws.amazon.com/iot/latest/developerguide/iot-rules.html#aws-iot-sql-reference) in the AWS IoT Developer Guide.
- Sql
Version string - The version of the SQL rules engine to use when evaluating the rule.
- Cloudwatch
Alarms []TopicRule Cloudwatch Alarm Args - Cloudwatch
Logs []TopicRule Cloudwatch Log Args - Cloudwatch
Metrics []TopicRule Cloudwatch Metric Args - Description string
- The description of the rule.
- Dynamodbs
[]Topic
Rule Dynamodb Args - Dynamodbv2s
[]Topic
Rule Dynamodbv2Args - Elasticsearch
[]Topic
Rule Elasticsearch Args - Error
Action TopicRule Error Action Args - Configuration block with error action to be associated with the rule. See the documentation for
cloudwatch_alarm,cloudwatch_logs,cloudwatch_metric,dynamodb,dynamodbv2,elasticsearch,firehose,http,iot_analytics,iot_events,kafka,kinesis,lambda,republish,s3,sns,sqs,step_functions,timestreamconfiguration blocks for further configuration details. - Firehoses
[]Topic
Rule Firehose Args - Https
[]Topic
Rule Http Args - Iot
Analytics []TopicRule Iot Analytic Args - Iot
Events []TopicRule Iot Event Args - Kafkas
[]Topic
Rule Kafka Args - Kineses
[]Topic
Rule Kinesis Args - Lambdas
[]Topic
Rule Lambda Args - Name string
- The name of the rule.
- Republishes
[]Topic
Rule Republish Args - S3
[]Topic
Rule S3Args - Sns
[]Topic
Rule Sns Args - Sqs
[]Topic
Rule Sqs Args - Step
Functions []TopicRule Step Function Args - map[string]string
- Key-value map of resource tags. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - Timestreams
[]Topic
Rule Timestream Args
- enabled Boolean
- Specifies whether the rule is enabled.
- sql String
- The SQL statement used to query the topic. For more information, see AWS IoT SQL Reference (http://docs.aws.amazon.com/iot/latest/developerguide/iot-rules.html#aws-iot-sql-reference) in the AWS IoT Developer Guide.
- sql
Version String - The version of the SQL rules engine to use when evaluating the rule.
- cloudwatch
Alarms List<TopicRule Cloudwatch Alarm> - cloudwatch
Logs List<TopicRule Cloudwatch Log> - cloudwatch
Metrics List<TopicRule Cloudwatch Metric> - description String
- The description of the rule.
- dynamodbs
List<Topic
Rule Dynamodb> - dynamodbv2s
List<Topic
Rule Dynamodbv2> - elasticsearch
List<Topic
Rule Elasticsearch> - error
Action TopicRule Error Action - Configuration block with error action to be associated with the rule. See the documentation for
cloudwatch_alarm,cloudwatch_logs,cloudwatch_metric,dynamodb,dynamodbv2,elasticsearch,firehose,http,iot_analytics,iot_events,kafka,kinesis,lambda,republish,s3,sns,sqs,step_functions,timestreamconfiguration blocks for further configuration details. - firehoses
List<Topic
Rule Firehose> - https
List<Topic
Rule Http> - iot
Analytics List<TopicRule Iot Analytic> - iot
Events List<TopicRule Iot Event> - kafkas
List<Topic
Rule Kafka> - kineses
List<Topic
Rule Kinesis> - lambdas
List<Topic
Rule Lambda> - name String
- The name of the rule.
- republishes
List<Topic
Rule Republish> - s3
List<Topic
Rule S3> - sns
List<Topic
Rule Sns> - sqs
List<Topic
Rule Sqs> - step
Functions List<TopicRule Step Function> - Map<String,String>
- Key-value map of resource tags. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - timestreams
List<Topic
Rule Timestream>
- enabled boolean
- Specifies whether the rule is enabled.
- sql string
- The SQL statement used to query the topic. For more information, see AWS IoT SQL Reference (http://docs.aws.amazon.com/iot/latest/developerguide/iot-rules.html#aws-iot-sql-reference) in the AWS IoT Developer Guide.
- sql
Version string - The version of the SQL rules engine to use when evaluating the rule.
- cloudwatch
Alarms TopicRule Cloudwatch Alarm[] - cloudwatch
Logs TopicRule Cloudwatch Log[] - cloudwatch
Metrics TopicRule Cloudwatch Metric[] - description string
- The description of the rule.
- dynamodbs
Topic
Rule Dynamodb[] - dynamodbv2s
Topic
Rule Dynamodbv2[] - elasticsearch
Topic
Rule Elasticsearch[] - error
Action TopicRule Error Action - Configuration block with error action to be associated with the rule. See the documentation for
cloudwatch_alarm,cloudwatch_logs,cloudwatch_metric,dynamodb,dynamodbv2,elasticsearch,firehose,http,iot_analytics,iot_events,kafka,kinesis,lambda,republish,s3,sns,sqs,step_functions,timestreamconfiguration blocks for further configuration details. - firehoses
Topic
Rule Firehose[] - https
Topic
Rule Http[] - iot
Analytics TopicRule Iot Analytic[] - iot
Events TopicRule Iot Event[] - kafkas
Topic
Rule Kafka[] - kineses
Topic
Rule Kinesis[] - lambdas
Topic
Rule Lambda[] - name string
- The name of the rule.
- republishes
Topic
Rule Republish[] - s3
Topic
Rule S3[] - sns
Topic
Rule Sns[] - sqs
Topic
Rule Sqs[] - step
Functions TopicRule Step Function[] - {[key: string]: string}
- Key-value map of resource tags. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - timestreams
Topic
Rule Timestream[]
- enabled bool
- Specifies whether the rule is enabled.
- sql str
- The SQL statement used to query the topic. For more information, see AWS IoT SQL Reference (http://docs.aws.amazon.com/iot/latest/developerguide/iot-rules.html#aws-iot-sql-reference) in the AWS IoT Developer Guide.
- sql_
version str - The version of the SQL rules engine to use when evaluating the rule.
- cloudwatch_
alarms Sequence[TopicRule Cloudwatch Alarm Args] - cloudwatch_
logs Sequence[TopicRule Cloudwatch Log Args] - cloudwatch_
metrics Sequence[TopicRule Cloudwatch Metric Args] - description str
- The description of the rule.
- dynamodbs
Sequence[Topic
Rule Dynamodb Args] - dynamodbv2s
Sequence[Topic
Rule Dynamodbv2Args] - elasticsearch
Sequence[Topic
Rule Elasticsearch Args] - error_
action TopicRule Error Action Args - Configuration block with error action to be associated with the rule. See the documentation for
cloudwatch_alarm,cloudwatch_logs,cloudwatch_metric,dynamodb,dynamodbv2,elasticsearch,firehose,http,iot_analytics,iot_events,kafka,kinesis,lambda,republish,s3,sns,sqs,step_functions,timestreamconfiguration blocks for further configuration details. - firehoses
Sequence[Topic
Rule Firehose Args] - https
Sequence[Topic
Rule Http Args] - iot_
analytics Sequence[TopicRule Iot Analytic Args] - iot_
events Sequence[TopicRule Iot Event Args] - kafkas
Sequence[Topic
Rule Kafka Args] - kineses
Sequence[Topic
Rule Kinesis Args] - lambdas
Sequence[Topic
Rule Lambda Args] - name str
- The name of the rule.
- republishes
Sequence[Topic
Rule Republish Args] - s3
Sequence[Topic
Rule S3Args] - sns
Sequence[Topic
Rule Sns Args] - sqs
Sequence[Topic
Rule Sqs Args] - step_
functions Sequence[TopicRule Step Function Args] - Mapping[str, str]
- Key-value map of resource tags. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - timestreams
Sequence[Topic
Rule Timestream Args]
- enabled Boolean
- Specifies whether the rule is enabled.
- sql String
- The SQL statement used to query the topic. For more information, see AWS IoT SQL Reference (http://docs.aws.amazon.com/iot/latest/developerguide/iot-rules.html#aws-iot-sql-reference) in the AWS IoT Developer Guide.
- sql
Version String - The version of the SQL rules engine to use when evaluating the rule.
- cloudwatch
Alarms List<Property Map> - cloudwatch
Logs List<Property Map> - cloudwatch
Metrics List<Property Map> - description String
- The description of the rule.
- dynamodbs List<Property Map>
- dynamodbv2s List<Property Map>
- elasticsearch List<Property Map>
- error
Action Property Map - Configuration block with error action to be associated with the rule. See the documentation for
cloudwatch_alarm,cloudwatch_logs,cloudwatch_metric,dynamodb,dynamodbv2,elasticsearch,firehose,http,iot_analytics,iot_events,kafka,kinesis,lambda,republish,s3,sns,sqs,step_functions,timestreamconfiguration blocks for further configuration details. - firehoses List<Property Map>
- https List<Property Map>
- iot
Analytics List<Property Map> - iot
Events List<Property Map> - kafkas List<Property Map>
- kineses List<Property Map>
- lambdas List<Property Map>
- name String
- The name of the rule.
- republishes List<Property Map>
- s3 List<Property Map>
- sns List<Property Map>
- sqs List<Property Map>
- step
Functions List<Property Map> - Map<String>
- Key-value map of resource tags. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - timestreams List<Property Map>
Outputs
All input properties are implicitly available as output properties. Additionally, the TopicRule resource produces the following output properties:
Look up Existing TopicRule Resource
Get an existing TopicRule resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: TopicRuleState, opts?: CustomResourceOptions): TopicRule@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
arn: Optional[str] = None,
cloudwatch_alarms: Optional[Sequence[TopicRuleCloudwatchAlarmArgs]] = None,
cloudwatch_logs: Optional[Sequence[TopicRuleCloudwatchLogArgs]] = None,
cloudwatch_metrics: Optional[Sequence[TopicRuleCloudwatchMetricArgs]] = None,
description: Optional[str] = None,
dynamodbs: Optional[Sequence[TopicRuleDynamodbArgs]] = None,
dynamodbv2s: Optional[Sequence[TopicRuleDynamodbv2Args]] = None,
elasticsearch: Optional[Sequence[TopicRuleElasticsearchArgs]] = None,
enabled: Optional[bool] = None,
error_action: Optional[TopicRuleErrorActionArgs] = None,
firehoses: Optional[Sequence[TopicRuleFirehoseArgs]] = None,
https: Optional[Sequence[TopicRuleHttpArgs]] = None,
iot_analytics: Optional[Sequence[TopicRuleIotAnalyticArgs]] = None,
iot_events: Optional[Sequence[TopicRuleIotEventArgs]] = None,
kafkas: Optional[Sequence[TopicRuleKafkaArgs]] = None,
kineses: Optional[Sequence[TopicRuleKinesisArgs]] = None,
lambdas: Optional[Sequence[TopicRuleLambdaArgs]] = None,
name: Optional[str] = None,
republishes: Optional[Sequence[TopicRuleRepublishArgs]] = None,
s3: Optional[Sequence[TopicRuleS3Args]] = None,
sns: Optional[Sequence[TopicRuleSnsArgs]] = None,
sql: Optional[str] = None,
sql_version: Optional[str] = None,
sqs: Optional[Sequence[TopicRuleSqsArgs]] = None,
step_functions: Optional[Sequence[TopicRuleStepFunctionArgs]] = None,
tags: Optional[Mapping[str, str]] = None,
tags_all: Optional[Mapping[str, str]] = None,
timestreams: Optional[Sequence[TopicRuleTimestreamArgs]] = None) -> TopicRulefunc GetTopicRule(ctx *Context, name string, id IDInput, state *TopicRuleState, opts ...ResourceOption) (*TopicRule, error)public static TopicRule Get(string name, Input<string> id, TopicRuleState? state, CustomResourceOptions? opts = null)public static TopicRule get(String name, Output<String> id, TopicRuleState state, CustomResourceOptions options)resources: _: type: aws:iot:TopicRule get: id: ${id}- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Arn string
- The ARN of the topic rule
- Cloudwatch
Alarms List<TopicRule Cloudwatch Alarm> - Cloudwatch
Logs List<TopicRule Cloudwatch Log> - Cloudwatch
Metrics List<TopicRule Cloudwatch Metric> - Description string
- The description of the rule.
- Dynamodbs
List<Topic
Rule Dynamodb> - Dynamodbv2s
List<Topic
Rule Dynamodbv2> - Elasticsearch
List<Topic
Rule Elasticsearch> - Enabled bool
- Specifies whether the rule is enabled.
- Error
Action TopicRule Error Action - Configuration block with error action to be associated with the rule. See the documentation for
cloudwatch_alarm,cloudwatch_logs,cloudwatch_metric,dynamodb,dynamodbv2,elasticsearch,firehose,http,iot_analytics,iot_events,kafka,kinesis,lambda,republish,s3,sns,sqs,step_functions,timestreamconfiguration blocks for further configuration details. - Firehoses
List<Topic
Rule Firehose> - Https
List<Topic
Rule Http> - Iot
Analytics List<TopicRule Iot Analytic> - Iot
Events List<TopicRule Iot Event> - Kafkas
List<Topic
Rule Kafka> - Kineses
List<Topic
Rule Kinesis> - Lambdas
List<Topic
Rule Lambda> - Name string
- The name of the rule.
- Republishes
List<Topic
Rule Republish> - S3
List<Topic
Rule S3> - Sns
List<Topic
Rule Sns> - Sql string
- The SQL statement used to query the topic. For more information, see AWS IoT SQL Reference (http://docs.aws.amazon.com/iot/latest/developerguide/iot-rules.html#aws-iot-sql-reference) in the AWS IoT Developer Guide.
- Sql
Version string - The version of the SQL rules engine to use when evaluating the rule.
- Sqs
List<Topic
Rule Sqs> - Step
Functions List<TopicRule Step Function> - Dictionary<string, string>
- Key-value map of resource tags. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - Dictionary<string, string>
- A map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block. - Timestreams
List<Topic
Rule Timestream>
- Arn string
- The ARN of the topic rule
- Cloudwatch
Alarms []TopicRule Cloudwatch Alarm Args - Cloudwatch
Logs []TopicRule Cloudwatch Log Args - Cloudwatch
Metrics []TopicRule Cloudwatch Metric Args - Description string
- The description of the rule.
- Dynamodbs
[]Topic
Rule Dynamodb Args - Dynamodbv2s
[]Topic
Rule Dynamodbv2Args - Elasticsearch
[]Topic
Rule Elasticsearch Args - Enabled bool
- Specifies whether the rule is enabled.
- Error
Action TopicRule Error Action Args - Configuration block with error action to be associated with the rule. See the documentation for
cloudwatch_alarm,cloudwatch_logs,cloudwatch_metric,dynamodb,dynamodbv2,elasticsearch,firehose,http,iot_analytics,iot_events,kafka,kinesis,lambda,republish,s3,sns,sqs,step_functions,timestreamconfiguration blocks for further configuration details. - Firehoses
[]Topic
Rule Firehose Args - Https
[]Topic
Rule Http Args - Iot
Analytics []TopicRule Iot Analytic Args - Iot
Events []TopicRule Iot Event Args - Kafkas
[]Topic
Rule Kafka Args - Kineses
[]Topic
Rule Kinesis Args - Lambdas
[]Topic
Rule Lambda Args - Name string
- The name of the rule.
- Republishes
[]Topic
Rule Republish Args - S3
[]Topic
Rule S3Args - Sns
[]Topic
Rule Sns Args - Sql string
- The SQL statement used to query the topic. For more information, see AWS IoT SQL Reference (http://docs.aws.amazon.com/iot/latest/developerguide/iot-rules.html#aws-iot-sql-reference) in the AWS IoT Developer Guide.
- Sql
Version string - The version of the SQL rules engine to use when evaluating the rule.
- Sqs
[]Topic
Rule Sqs Args - Step
Functions []TopicRule Step Function Args - map[string]string
- Key-value map of resource tags. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - map[string]string
- A map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block. - Timestreams
[]Topic
Rule Timestream Args
- arn String
- The ARN of the topic rule
- cloudwatch
Alarms List<TopicRule Cloudwatch Alarm> - cloudwatch
Logs List<TopicRule Cloudwatch Log> - cloudwatch
Metrics List<TopicRule Cloudwatch Metric> - description String
- The description of the rule.
- dynamodbs
List<Topic
Rule Dynamodb> - dynamodbv2s
List<Topic
Rule Dynamodbv2> - elasticsearch
List<Topic
Rule Elasticsearch> - enabled Boolean
- Specifies whether the rule is enabled.
- error
Action TopicRule Error Action - Configuration block with error action to be associated with the rule. See the documentation for
cloudwatch_alarm,cloudwatch_logs,cloudwatch_metric,dynamodb,dynamodbv2,elasticsearch,firehose,http,iot_analytics,iot_events,kafka,kinesis,lambda,republish,s3,sns,sqs,step_functions,timestreamconfiguration blocks for further configuration details. - firehoses
List<Topic
Rule Firehose> - https
List<Topic
Rule Http> - iot
Analytics List<TopicRule Iot Analytic> - iot
Events List<TopicRule Iot Event> - kafkas
List<Topic
Rule Kafka> - kineses
List<Topic
Rule Kinesis> - lambdas
List<Topic
Rule Lambda> - name String
- The name of the rule.
- republishes
List<Topic
Rule Republish> - s3
List<Topic
Rule S3> - sns
List<Topic
Rule Sns> - sql String
- The SQL statement used to query the topic. For more information, see AWS IoT SQL Reference (http://docs.aws.amazon.com/iot/latest/developerguide/iot-rules.html#aws-iot-sql-reference) in the AWS IoT Developer Guide.
- sql
Version String - The version of the SQL rules engine to use when evaluating the rule.
- sqs
List<Topic
Rule Sqs> - step
Functions List<TopicRule Step Function> - Map<String,String>
- Key-value map of resource tags. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - Map<String,String>
- A map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block. - timestreams
List<Topic
Rule Timestream>
- arn string
- The ARN of the topic rule
- cloudwatch
Alarms TopicRule Cloudwatch Alarm[] - cloudwatch
Logs TopicRule Cloudwatch Log[] - cloudwatch
Metrics TopicRule Cloudwatch Metric[] - description string
- The description of the rule.
- dynamodbs
Topic
Rule Dynamodb[] - dynamodbv2s
Topic
Rule Dynamodbv2[] - elasticsearch
Topic
Rule Elasticsearch[] - enabled boolean
- Specifies whether the rule is enabled.
- error
Action TopicRule Error Action - Configuration block with error action to be associated with the rule. See the documentation for
cloudwatch_alarm,cloudwatch_logs,cloudwatch_metric,dynamodb,dynamodbv2,elasticsearch,firehose,http,iot_analytics,iot_events,kafka,kinesis,lambda,republish,s3,sns,sqs,step_functions,timestreamconfiguration blocks for further configuration details. - firehoses
Topic
Rule Firehose[] - https
Topic
Rule Http[] - iot
Analytics TopicRule Iot Analytic[] - iot
Events TopicRule Iot Event[] - kafkas
Topic
Rule Kafka[] - kineses
Topic
Rule Kinesis[] - lambdas
Topic
Rule Lambda[] - name string
- The name of the rule.
- republishes
Topic
Rule Republish[] - s3
Topic
Rule S3[] - sns
Topic
Rule Sns[] - sql string
- The SQL statement used to query the topic. For more information, see AWS IoT SQL Reference (http://docs.aws.amazon.com/iot/latest/developerguide/iot-rules.html#aws-iot-sql-reference) in the AWS IoT Developer Guide.
- sql
Version string - The version of the SQL rules engine to use when evaluating the rule.
- sqs
Topic
Rule Sqs[] - step
Functions TopicRule Step Function[] - {[key: string]: string}
- Key-value map of resource tags. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - {[key: string]: string}
- A map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block. - timestreams
Topic
Rule Timestream[]
- arn str
- The ARN of the topic rule
- cloudwatch_
alarms Sequence[TopicRule Cloudwatch Alarm Args] - cloudwatch_
logs Sequence[TopicRule Cloudwatch Log Args] - cloudwatch_
metrics Sequence[TopicRule Cloudwatch Metric Args] - description str
- The description of the rule.
- dynamodbs
Sequence[Topic
Rule Dynamodb Args] - dynamodbv2s
Sequence[Topic
Rule Dynamodbv2Args] - elasticsearch
Sequence[Topic
Rule Elasticsearch Args] - enabled bool
- Specifies whether the rule is enabled.
- error_
action TopicRule Error Action Args - Configuration block with error action to be associated with the rule. See the documentation for
cloudwatch_alarm,cloudwatch_logs,cloudwatch_metric,dynamodb,dynamodbv2,elasticsearch,firehose,http,iot_analytics,iot_events,kafka,kinesis,lambda,republish,s3,sns,sqs,step_functions,timestreamconfiguration blocks for further configuration details. - firehoses
Sequence[Topic
Rule Firehose Args] - https
Sequence[Topic
Rule Http Args] - iot_
analytics Sequence[TopicRule Iot Analytic Args] - iot_
events Sequence[TopicRule Iot Event Args] - kafkas
Sequence[Topic
Rule Kafka Args] - kineses
Sequence[Topic
Rule Kinesis Args] - lambdas
Sequence[Topic
Rule Lambda Args] - name str
- The name of the rule.
- republishes
Sequence[Topic
Rule Republish Args] - s3
Sequence[Topic
Rule S3Args] - sns
Sequence[Topic
Rule Sns Args] - sql str
- The SQL statement used to query the topic. For more information, see AWS IoT SQL Reference (http://docs.aws.amazon.com/iot/latest/developerguide/iot-rules.html#aws-iot-sql-reference) in the AWS IoT Developer Guide.
- sql_
version str - The version of the SQL rules engine to use when evaluating the rule.
- sqs
Sequence[Topic
Rule Sqs Args] - step_
functions Sequence[TopicRule Step Function Args] - Mapping[str, str]
- Key-value map of resource tags. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - Mapping[str, str]
- A map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block. - timestreams
Sequence[Topic
Rule Timestream Args]
- arn String
- The ARN of the topic rule
- cloudwatch
Alarms List<Property Map> - cloudwatch
Logs List<Property Map> - cloudwatch
Metrics List<Property Map> - description String
- The description of the rule.
- dynamodbs List<Property Map>
- dynamodbv2s List<Property Map>
- elasticsearch List<Property Map>
- enabled Boolean
- Specifies whether the rule is enabled.
- error
Action Property Map - Configuration block with error action to be associated with the rule. See the documentation for
cloudwatch_alarm,cloudwatch_logs,cloudwatch_metric,dynamodb,dynamodbv2,elasticsearch,firehose,http,iot_analytics,iot_events,kafka,kinesis,lambda,republish,s3,sns,sqs,step_functions,timestreamconfiguration blocks for further configuration details. - firehoses List<Property Map>
- https List<Property Map>
- iot
Analytics List<Property Map> - iot
Events List<Property Map> - kafkas List<Property Map>
- kineses List<Property Map>
- lambdas List<Property Map>
- name String
- The name of the rule.
- republishes List<Property Map>
- s3 List<Property Map>
- sns List<Property Map>
- sql String
- The SQL statement used to query the topic. For more information, see AWS IoT SQL Reference (http://docs.aws.amazon.com/iot/latest/developerguide/iot-rules.html#aws-iot-sql-reference) in the AWS IoT Developer Guide.
- sql
Version String - The version of the SQL rules engine to use when evaluating the rule.
- sqs List<Property Map>
- step
Functions List<Property Map> - Map<String>
- Key-value map of resource tags. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. - Map<String>
- A map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block. - timestreams List<Property Map>
Supporting Types
TopicRuleCloudwatchAlarm, TopicRuleCloudwatchAlarmArgs
- Alarm
Name string - The CloudWatch alarm name.
- Role
Arn string - The IAM role ARN that allows access to the CloudWatch alarm.
- State
Reason string - The reason for the alarm change.
- State
Value string - The value of the alarm state. Acceptable values are: OK, ALARM, INSUFFICIENT_DATA.
- Alarm
Name string - The CloudWatch alarm name.
- Role
Arn string - The IAM role ARN that allows access to the CloudWatch alarm.
- State
Reason string - The reason for the alarm change.
- State
Value string - The value of the alarm state. Acceptable values are: OK, ALARM, INSUFFICIENT_DATA.
- alarm
Name String - The CloudWatch alarm name.
- role
Arn String - The IAM role ARN that allows access to the CloudWatch alarm.
- state
Reason String - The reason for the alarm change.
- state
Value String - The value of the alarm state. Acceptable values are: OK, ALARM, INSUFFICIENT_DATA.
- alarm
Name string - The CloudWatch alarm name.
- role
Arn string - The IAM role ARN that allows access to the CloudWatch alarm.
- state
Reason string - The reason for the alarm change.
- state
Value string - The value of the alarm state. Acceptable values are: OK, ALARM, INSUFFICIENT_DATA.
- alarm_
name str - The CloudWatch alarm name.
- role_
arn str - The IAM role ARN that allows access to the CloudWatch alarm.
- state_
reason str - The reason for the alarm change.
- state_
value str - The value of the alarm state. Acceptable values are: OK, ALARM, INSUFFICIENT_DATA.
- alarm
Name String - The CloudWatch alarm name.
- role
Arn String - The IAM role ARN that allows access to the CloudWatch alarm.
- state
Reason String - The reason for the alarm change.
- state
Value String - The value of the alarm state. Acceptable values are: OK, ALARM, INSUFFICIENT_DATA.
TopicRuleCloudwatchLog, TopicRuleCloudwatchLogArgs
- Log
Group stringName - The CloudWatch log group name.
- Role
Arn string - The IAM role ARN that allows access to the CloudWatch alarm.
- Batch
Mode bool - The payload that contains a JSON array of records will be sent to CloudWatch via a batch call.
- Log
Group stringName - The CloudWatch log group name.
- Role
Arn string - The IAM role ARN that allows access to the CloudWatch alarm.
- Batch
Mode bool - The payload that contains a JSON array of records will be sent to CloudWatch via a batch call.
- log
Group StringName - The CloudWatch log group name.
- role
Arn String - The IAM role ARN that allows access to the CloudWatch alarm.
- batch
Mode Boolean - The payload that contains a JSON array of records will be sent to CloudWatch via a batch call.
- log
Group stringName - The CloudWatch log group name.
- role
Arn string - The IAM role ARN that allows access to the CloudWatch alarm.
- batch
Mode boolean - The payload that contains a JSON array of records will be sent to CloudWatch via a batch call.
- log_
group_ strname - The CloudWatch log group name.
- role_
arn str - The IAM role ARN that allows access to the CloudWatch alarm.
- batch_
mode bool - The payload that contains a JSON array of records will be sent to CloudWatch via a batch call.
- log
Group StringName - The CloudWatch log group name.
- role
Arn String - The IAM role ARN that allows access to the CloudWatch alarm.
- batch
Mode Boolean - The payload that contains a JSON array of records will be sent to CloudWatch via a batch call.
TopicRuleCloudwatchMetric, TopicRuleCloudwatchMetricArgs
- Metric
Name string - The CloudWatch metric name.
- Metric
Namespace string - The CloudWatch metric namespace name.
- Metric
Unit string - The metric unit (supported units can be found here: http://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/cloudwatch_concepts.html#Unit)
- Metric
Value string - The CloudWatch metric value.
- Role
Arn string - The IAM role ARN that allows access to the CloudWatch metric.
- Metric
Timestamp string - An optional Unix timestamp (http://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/cloudwatch_concepts.html#about_timestamp).
- Metric
Name string - The CloudWatch metric name.
- Metric
Namespace string - The CloudWatch metric namespace name.
- Metric
Unit string - The metric unit (supported units can be found here: http://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/cloudwatch_concepts.html#Unit)
- Metric
Value string - The CloudWatch metric value.
- Role
Arn string - The IAM role ARN that allows access to the CloudWatch metric.
- Metric
Timestamp string - An optional Unix timestamp (http://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/cloudwatch_concepts.html#about_timestamp).
- metric
Name String - The CloudWatch metric name.
- metric
Namespace String - The CloudWatch metric namespace name.
- metric
Unit String - The metric unit (supported units can be found here: http://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/cloudwatch_concepts.html#Unit)
- metric
Value String - The CloudWatch metric value.
- role
Arn String - The IAM role ARN that allows access to the CloudWatch metric.
- metric
Timestamp String - An optional Unix timestamp (http://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/cloudwatch_concepts.html#about_timestamp).
- metric
Name string - The CloudWatch metric name.
- metric
Namespace string - The CloudWatch metric namespace name.
- metric
Unit string - The metric unit (supported units can be found here: http://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/cloudwatch_concepts.html#Unit)
- metric
Value string - The CloudWatch metric value.
- role
Arn string - The IAM role ARN that allows access to the CloudWatch metric.
- metric
Timestamp string - An optional Unix timestamp (http://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/cloudwatch_concepts.html#about_timestamp).
- metric_
name str - The CloudWatch metric name.
- metric_
namespace str - The CloudWatch metric namespace name.
- metric_
unit str - The metric unit (supported units can be found here: http://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/cloudwatch_concepts.html#Unit)
- metric_
value str - The CloudWatch metric value.
- role_
arn str - The IAM role ARN that allows access to the CloudWatch metric.
- metric_
timestamp str - An optional Unix timestamp (http://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/cloudwatch_concepts.html#about_timestamp).
- metric
Name String - The CloudWatch metric name.
- metric
Namespace String - The CloudWatch metric namespace name.
- metric
Unit String - The metric unit (supported units can be found here: http://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/cloudwatch_concepts.html#Unit)
- metric
Value String - The CloudWatch metric value.
- role
Arn String - The IAM role ARN that allows access to the CloudWatch metric.
- metric
Timestamp String - An optional Unix timestamp (http://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/cloudwatch_concepts.html#about_timestamp).
TopicRuleDynamodb, TopicRuleDynamodbArgs
- Hash
Key stringField - The hash key name.
- Hash
Key stringValue - The hash key value.
- Role
Arn string - The ARN of the IAM role that grants access to the DynamoDB table.
- Table
Name string - The name of the DynamoDB table.
- Hash
Key stringType - The hash key type. Valid values are "STRING" or "NUMBER".
- Operation string
- The operation. Valid values are "INSERT", "UPDATE", or "DELETE".
- Payload
Field string - The action payload.
- Range
Key stringField - The range key name.
- Range
Key stringType - The range key type. Valid values are "STRING" or "NUMBER".
- Range
Key stringValue - The range key value.
- Hash
Key stringField - The hash key name.
- Hash
Key stringValue - The hash key value.
- Role
Arn string - The ARN of the IAM role that grants access to the DynamoDB table.
- Table
Name string - The name of the DynamoDB table.
- Hash
Key stringType - The hash key type. Valid values are "STRING" or "NUMBER".
- Operation string
- The operation. Valid values are "INSERT", "UPDATE", or "DELETE".
- Payload
Field string - The action payload.
- Range
Key stringField - The range key name.
- Range
Key stringType - The range key type. Valid values are "STRING" or "NUMBER".
- Range
Key stringValue - The range key value.
- hash
Key StringField - The hash key name.
- hash
Key StringValue - The hash key value.
- role
Arn String - The ARN of the IAM role that grants access to the DynamoDB table.
- table
Name String - The name of the DynamoDB table.
- hash
Key StringType - The hash key type. Valid values are "STRING" or "NUMBER".
- operation String
- The operation. Valid values are "INSERT", "UPDATE", or "DELETE".
- payload
Field String - The action payload.
- range
Key StringField - The range key name.
- range
Key StringType - The range key type. Valid values are "STRING" or "NUMBER".
- range
Key StringValue - The range key value.
- hash
Key stringField - The hash key name.
- hash
Key stringValue - The hash key value.
- role
Arn string - The ARN of the IAM role that grants access to the DynamoDB table.
- table
Name string - The name of the DynamoDB table.
- hash
Key stringType - The hash key type. Valid values are "STRING" or "NUMBER".
- operation string
- The operation. Valid values are "INSERT", "UPDATE", or "DELETE".
- payload
Field string - The action payload.
- range
Key stringField - The range key name.
- range
Key stringType - The range key type. Valid values are "STRING" or "NUMBER".
- range
Key stringValue - The range key value.
- hash_
key_ strfield - The hash key name.
- hash_
key_ strvalue - The hash key value.
- role_
arn str - The ARN of the IAM role that grants access to the DynamoDB table.
- table_
name str - The name of the DynamoDB table.
- hash_
key_ strtype - The hash key type. Valid values are "STRING" or "NUMBER".
- operation str
- The operation. Valid values are "INSERT", "UPDATE", or "DELETE".
- payload_
field str - The action payload.
- range_
key_ strfield - The range key name.
- range_
key_ strtype - The range key type. Valid values are "STRING" or "NUMBER".
- range_
key_ strvalue - The range key value.
- hash
Key StringField - The hash key name.
- hash
Key StringValue - The hash key value.
- role
Arn String - The ARN of the IAM role that grants access to the DynamoDB table.
- table
Name String - The name of the DynamoDB table.
- hash
Key StringType - The hash key type. Valid values are "STRING" or "NUMBER".
- operation String
- The operation. Valid values are "INSERT", "UPDATE", or "DELETE".
- payload
Field String - The action payload.
- range
Key StringField - The range key name.
- range
Key StringType - The range key type. Valid values are "STRING" or "NUMBER".
- range
Key StringValue - The range key value.
TopicRuleDynamodbv2, TopicRuleDynamodbv2Args
- Role
Arn string - The ARN of the IAM role that grants access to the DynamoDB table.
- Put
Item TopicRule Dynamodbv2Put Item - Configuration block with DynamoDB Table to which the message will be written. Nested arguments below.
- Role
Arn string - The ARN of the IAM role that grants access to the DynamoDB table.
- Put
Item TopicRule Dynamodbv2Put Item - Configuration block with DynamoDB Table to which the message will be written. Nested arguments below.
- role
Arn String - The ARN of the IAM role that grants access to the DynamoDB table.
- put
Item TopicRule Dynamodbv2Put Item - Configuration block with DynamoDB Table to which the message will be written. Nested arguments below.
- role
Arn string - The ARN of the IAM role that grants access to the DynamoDB table.
- put
Item TopicRule Dynamodbv2Put Item - Configuration block with DynamoDB Table to which the message will be written. Nested arguments below.
- role_
arn str - The ARN of the IAM role that grants access to the DynamoDB table.
- put_
item TopicRule Dynamodbv2Put Item - Configuration block with DynamoDB Table to which the message will be written. Nested arguments below.
- role
Arn String - The ARN of the IAM role that grants access to the DynamoDB table.
- put
Item Property Map - Configuration block with DynamoDB Table to which the message will be written. Nested arguments below.
TopicRuleDynamodbv2PutItem, TopicRuleDynamodbv2PutItemArgs
- Table
Name string - The name of the DynamoDB table.
- Table
Name string - The name of the DynamoDB table.
- table
Name String - The name of the DynamoDB table.
- table
Name string - The name of the DynamoDB table.
- table_
name str - The name of the DynamoDB table.
- table
Name String - The name of the DynamoDB table.
TopicRuleElasticsearch, TopicRuleElasticsearchArgs
- Endpoint string
- The endpoint of your Elasticsearch domain.
- Id string
- The unique identifier for the document you are storing.
- Index string
- The Elasticsearch index where you want to store your data.
- Role
Arn string - The IAM role ARN that has access to Elasticsearch.
- Type string
- The type of document you are storing.
- Endpoint string
- The endpoint of your Elasticsearch domain.
- Id string
- The unique identifier for the document you are storing.
- Index string
- The Elasticsearch index where you want to store your data.
- Role
Arn string - The IAM role ARN that has access to Elasticsearch.
- Type string
- The type of document you are storing.
- endpoint String
- The endpoint of your Elasticsearch domain.
- id String
- The unique identifier for the document you are storing.
- index String
- The Elasticsearch index where you want to store your data.
- role
Arn String - The IAM role ARN that has access to Elasticsearch.
- type String
- The type of document you are storing.
- endpoint string
- The endpoint of your Elasticsearch domain.
- id string
- The unique identifier for the document you are storing.
- index string
- The Elasticsearch index where you want to store your data.
- role
Arn string - The IAM role ARN that has access to Elasticsearch.
- type string
- The type of document you are storing.
- endpoint String
- The endpoint of your Elasticsearch domain.
- id String
- The unique identifier for the document you are storing.
- index String
- The Elasticsearch index where you want to store your data.
- role
Arn String - The IAM role ARN that has access to Elasticsearch.
- type String
- The type of document you are storing.
TopicRuleErrorAction, TopicRuleErrorActionArgs
- Cloudwatch
Alarm TopicRule Error Action Cloudwatch Alarm - Cloudwatch
Logs TopicRule Error Action Cloudwatch Logs - Cloudwatch
Metric TopicRule Error Action Cloudwatch Metric - Dynamodb
Topic
Rule Error Action Dynamodb - Dynamodbv2
Topic
Rule Error Action Dynamodbv2 - Elasticsearch
Topic
Rule Error Action Elasticsearch - Firehose
Topic
Rule Error Action Firehose - Http
Topic
Rule Error Action Http - Iot
Analytics TopicRule Error Action Iot Analytics - Iot
Events TopicRule Error Action Iot Events - Kafka
Topic
Rule Error Action Kafka - Kinesis
Topic
Rule Error Action Kinesis - Lambda
Topic
Rule Error Action Lambda - Republish
Topic
Rule Error Action Republish - S3
Topic
Rule Error Action S3 - Sns
Topic
Rule Error Action Sns - Sqs
Topic
Rule Error Action Sqs - Step
Functions TopicRule Error Action Step Functions - Timestream
Topic
Rule Error Action Timestream
- Cloudwatch
Alarm TopicRule Error Action Cloudwatch Alarm - Cloudwatch
Logs TopicRule Error Action Cloudwatch Logs - Cloudwatch
Metric TopicRule Error Action Cloudwatch Metric - Dynamodb
Topic
Rule Error Action Dynamodb - Dynamodbv2
Topic
Rule Error Action Dynamodbv2 - Elasticsearch
Topic
Rule Error Action Elasticsearch - Firehose
Topic
Rule Error Action Firehose - Http
Topic
Rule Error Action Http - Iot
Analytics TopicRule Error Action Iot Analytics - Iot
Events TopicRule Error Action Iot Events - Kafka
Topic
Rule Error Action Kafka - Kinesis
Topic
Rule Error Action Kinesis - Lambda
Topic
Rule Error Action Lambda - Republish
Topic
Rule Error Action Republish - S3
Topic
Rule Error Action S3 - Sns
Topic
Rule Error Action Sns - Sqs
Topic
Rule Error Action Sqs - Step
Functions TopicRule Error Action Step Functions - Timestream
Topic
Rule Error Action Timestream
- cloudwatch
Alarm TopicRule Error Action Cloudwatch Alarm - cloudwatch
Logs TopicRule Error Action Cloudwatch Logs - cloudwatch
Metric TopicRule Error Action Cloudwatch Metric - dynamodb
Topic
Rule Error Action Dynamodb - dynamodbv2
Topic
Rule Error Action Dynamodbv2 - elasticsearch
Topic
Rule Error Action Elasticsearch - firehose
Topic
Rule Error Action Firehose - http
Topic
Rule Error Action Http - iot
Analytics TopicRule Error Action Iot Analytics - iot
Events TopicRule Error Action Iot Events - kafka
Topic
Rule Error Action Kafka - kinesis
Topic
Rule Error Action Kinesis - lambda
Topic
Rule Error Action Lambda - republish
Topic
Rule Error Action Republish - s3
Topic
Rule Error Action S3 - sns
Topic
Rule Error Action Sns - sqs
Topic
Rule Error Action Sqs - step
Functions TopicRule Error Action Step Functions - timestream
Topic
Rule Error Action Timestream
- cloudwatch
Alarm TopicRule Error Action Cloudwatch Alarm - cloudwatch
Logs TopicRule Error Action Cloudwatch Logs - cloudwatch
Metric TopicRule Error Action Cloudwatch Metric - dynamodb
Topic
Rule Error Action Dynamodb - dynamodbv2
Topic
Rule Error Action Dynamodbv2 - elasticsearch
Topic
Rule Error Action Elasticsearch - firehose
Topic
Rule Error Action Firehose - http
Topic
Rule Error Action Http - iot
Analytics TopicRule Error Action Iot Analytics - iot
Events TopicRule Error Action Iot Events - kafka
Topic
Rule Error Action Kafka - kinesis
Topic
Rule Error Action Kinesis - lambda
Topic
Rule Error Action Lambda - republish
Topic
Rule Error Action Republish - s3
Topic
Rule Error Action S3 - sns
Topic
Rule Error Action Sns - sqs
Topic
Rule Error Action Sqs - step
Functions TopicRule Error Action Step Functions - timestream
Topic
Rule Error Action Timestream
- cloudwatch_
alarm TopicRule Error Action Cloudwatch Alarm - cloudwatch_
logs TopicRule Error Action Cloudwatch Logs - cloudwatch_
metric TopicRule Error Action Cloudwatch Metric - dynamodb
Topic
Rule Error Action Dynamodb - dynamodbv2
Topic
Rule Error Action Dynamodbv2 - elasticsearch
Topic
Rule Error Action Elasticsearch - firehose
Topic
Rule Error Action Firehose - http
Topic
Rule Error Action Http - iot_
analytics TopicRule Error Action Iot Analytics - iot_
events TopicRule Error Action Iot Events - kafka
Topic
Rule Error Action Kafka - kinesis
Topic
Rule Error Action Kinesis - lambda_
Topic
Rule Error Action Lambda - republish
Topic
Rule Error Action Republish - s3
Topic
Rule Error Action S3 - sns
Topic
Rule Error Action Sns - sqs
Topic
Rule Error Action Sqs - step_
functions TopicRule Error Action Step Functions - timestream
Topic
Rule Error Action Timestream
- cloudwatch
Alarm Property Map - cloudwatch
Logs Property Map - cloudwatch
Metric Property Map - dynamodb Property Map
- dynamodbv2 Property Map
- elasticsearch Property Map
- firehose Property Map
- http Property Map
- iot
Analytics Property Map - iot
Events Property Map - kafka Property Map
- kinesis Property Map
- lambda Property Map
- republish Property Map
- s3 Property Map
- sns Property Map
- sqs Property Map
- step
Functions Property Map - timestream Property Map
TopicRuleErrorActionCloudwatchAlarm, TopicRuleErrorActionCloudwatchAlarmArgs
- Alarm
Name string - The CloudWatch alarm name.
- Role
Arn string - The IAM role ARN that allows access to the CloudWatch alarm.
- State
Reason string - The reason for the alarm change.
- State
Value string - The value of the alarm state. Acceptable values are: OK, ALARM, INSUFFICIENT_DATA.
- Alarm
Name string - The CloudWatch alarm name.
- Role
Arn string - The IAM role ARN that allows access to the CloudWatch alarm.
- State
Reason string - The reason for the alarm change.
- State
Value string - The value of the alarm state. Acceptable values are: OK, ALARM, INSUFFICIENT_DATA.
- alarm
Name String - The CloudWatch alarm name.
- role
Arn String - The IAM role ARN that allows access to the CloudWatch alarm.
- state
Reason String - The reason for the alarm change.
- state
Value String - The value of the alarm state. Acceptable values are: OK, ALARM, INSUFFICIENT_DATA.
- alarm
Name string - The CloudWatch alarm name.
- role
Arn string - The IAM role ARN that allows access to the CloudWatch alarm.
- state
Reason string - The reason for the alarm change.
- state
Value string - The value of the alarm state. Acceptable values are: OK, ALARM, INSUFFICIENT_DATA.
- alarm_
name str - The CloudWatch alarm name.
- role_
arn str - The IAM role ARN that allows access to the CloudWatch alarm.
- state_
reason str - The reason for the alarm change.
- state_
value str - The value of the alarm state. Acceptable values are: OK, ALARM, INSUFFICIENT_DATA.
- alarm
Name String - The CloudWatch alarm name.
- role
Arn String - The IAM role ARN that allows access to the CloudWatch alarm.
- state
Reason String - The reason for the alarm change.
- state
Value String - The value of the alarm state. Acceptable values are: OK, ALARM, INSUFFICIENT_DATA.
TopicRuleErrorActionCloudwatchLogs, TopicRuleErrorActionCloudwatchLogsArgs
- Log
Group stringName - The CloudWatch log group name.
- Role
Arn string - The IAM role ARN that allows access to the CloudWatch alarm.
- Batch
Mode bool - The payload that contains a JSON array of records will be sent to CloudWatch via a batch call.
- Log
Group stringName - The CloudWatch log group name.
- Role
Arn string - The IAM role ARN that allows access to the CloudWatch alarm.
- Batch
Mode bool - The payload that contains a JSON array of records will be sent to CloudWatch via a batch call.
- log
Group StringName - The CloudWatch log group name.
- role
Arn String - The IAM role ARN that allows access to the CloudWatch alarm.
- batch
Mode Boolean - The payload that contains a JSON array of records will be sent to CloudWatch via a batch call.
- log
Group stringName - The CloudWatch log group name.
- role
Arn string - The IAM role ARN that allows access to the CloudWatch alarm.
- batch
Mode boolean - The payload that contains a JSON array of records will be sent to CloudWatch via a batch call.
- log_
group_ strname - The CloudWatch log group name.
- role_
arn str - The IAM role ARN that allows access to the CloudWatch alarm.
- batch_
mode bool - The payload that contains a JSON array of records will be sent to CloudWatch via a batch call.
- log
Group StringName - The CloudWatch log group name.
- role
Arn String - The IAM role ARN that allows access to the CloudWatch alarm.
- batch
Mode Boolean - The payload that contains a JSON array of records will be sent to CloudWatch via a batch call.
TopicRuleErrorActionCloudwatchMetric, TopicRuleErrorActionCloudwatchMetricArgs
- Metric
Name string - The CloudWatch metric name.
- Metric
Namespace string - The CloudWatch metric namespace name.
- Metric
Unit string - The metric unit (supported units can be found here: http://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/cloudwatch_concepts.html#Unit)
- Metric
Value string - The CloudWatch metric value.
- Role
Arn string - The IAM role ARN that allows access to the CloudWatch metric.
- Metric
Timestamp string - An optional Unix timestamp (http://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/cloudwatch_concepts.html#about_timestamp).
- Metric
Name string - The CloudWatch metric name.
- Metric
Namespace string - The CloudWatch metric namespace name.
- Metric
Unit string - The metric unit (supported units can be found here: http://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/cloudwatch_concepts.html#Unit)
- Metric
Value string - The CloudWatch metric value.
- Role
Arn string - The IAM role ARN that allows access to the CloudWatch metric.
- Metric
Timestamp string - An optional Unix timestamp (http://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/cloudwatch_concepts.html#about_timestamp).
- metric
Name String - The CloudWatch metric name.
- metric
Namespace String - The CloudWatch metric namespace name.
- metric
Unit String - The metric unit (supported units can be found here: http://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/cloudwatch_concepts.html#Unit)
- metric
Value String - The CloudWatch metric value.
- role
Arn String - The IAM role ARN that allows access to the CloudWatch metric.
- metric
Timestamp String - An optional Unix timestamp (http://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/cloudwatch_concepts.html#about_timestamp).
- metric
Name string - The CloudWatch metric name.
- metric
Namespace string - The CloudWatch metric namespace name.
- metric
Unit string - The metric unit (supported units can be found here: http://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/cloudwatch_concepts.html#Unit)
- metric
Value string - The CloudWatch metric value.
- role
Arn string - The IAM role ARN that allows access to the CloudWatch metric.
- metric
Timestamp string - An optional Unix timestamp (http://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/cloudwatch_concepts.html#about_timestamp).
- metric_
name str - The CloudWatch metric name.
- metric_
namespace str - The CloudWatch metric namespace name.
- metric_
unit str - The metric unit (supported units can be found here: http://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/cloudwatch_concepts.html#Unit)
- metric_
value str - The CloudWatch metric value.
- role_
arn str - The IAM role ARN that allows access to the CloudWatch metric.
- metric_
timestamp str - An optional Unix timestamp (http://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/cloudwatch_concepts.html#about_timestamp).
- metric
Name String - The CloudWatch metric name.
- metric
Namespace String - The CloudWatch metric namespace name.
- metric
Unit String - The metric unit (supported units can be found here: http://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/cloudwatch_concepts.html#Unit)
- metric
Value String - The CloudWatch metric value.
- role
Arn String - The IAM role ARN that allows access to the CloudWatch metric.
- metric
Timestamp String - An optional Unix timestamp (http://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/cloudwatch_concepts.html#about_timestamp).
TopicRuleErrorActionDynamodb, TopicRuleErrorActionDynamodbArgs
- Hash
Key stringField - The hash key name.
- Hash
Key stringValue - The hash key value.
- Role
Arn string - The ARN of the IAM role that grants access to the DynamoDB table.
- Table
Name string - The name of the DynamoDB table.
- Hash
Key stringType - The hash key type. Valid values are "STRING" or "NUMBER".
- Operation string
- The operation. Valid values are "INSERT", "UPDATE", or "DELETE".
- Payload
Field string - The action payload.
- Range
Key stringField - The range key name.
- Range
Key stringType - The range key type. Valid values are "STRING" or "NUMBER".
- Range
Key stringValue - The range key value.
- Hash
Key stringField - The hash key name.
- Hash
Key stringValue - The hash key value.
- Role
Arn string - The ARN of the IAM role that grants access to the DynamoDB table.
- Table
Name string - The name of the DynamoDB table.
- Hash
Key stringType - The hash key type. Valid values are "STRING" or "NUMBER".
- Operation string
- The operation. Valid values are "INSERT", "UPDATE", or "DELETE".
- Payload
Field string - The action payload.
- Range
Key stringField - The range key name.
- Range
Key stringType - The range key type. Valid values are "STRING" or "NUMBER".
- Range
Key stringValue - The range key value.
- hash
Key StringField - The hash key name.
- hash
Key StringValue - The hash key value.
- role
Arn String - The ARN of the IAM role that grants access to the DynamoDB table.
- table
Name String - The name of the DynamoDB table.
- hash
Key StringType - The hash key type. Valid values are "STRING" or "NUMBER".
- operation String
- The operation. Valid values are "INSERT", "UPDATE", or "DELETE".
- payload
Field String - The action payload.
- range
Key StringField - The range key name.
- range
Key StringType - The range key type. Valid values are "STRING" or "NUMBER".
- range
Key StringValue - The range key value.
- hash
Key stringField - The hash key name.
- hash
Key stringValue - The hash key value.
- role
Arn string - The ARN of the IAM role that grants access to the DynamoDB table.
- table
Name string - The name of the DynamoDB table.
- hash
Key stringType - The hash key type. Valid values are "STRING" or "NUMBER".
- operation string
- The operation. Valid values are "INSERT", "UPDATE", or "DELETE".
- payload
Field string - The action payload.
- range
Key stringField - The range key name.
- range
Key stringType - The range key type. Valid values are "STRING" or "NUMBER".
- range
Key stringValue - The range key value.
- hash_
key_ strfield - The hash key name.
- hash_
key_ strvalue - The hash key value.
- role_
arn str - The ARN of the IAM role that grants access to the DynamoDB table.
- table_
name str - The name of the DynamoDB table.
- hash_
key_ strtype - The hash key type. Valid values are "STRING" or "NUMBER".
- operation str
- The operation. Valid values are "INSERT", "UPDATE", or "DELETE".
- payload_
field str - The action payload.
- range_
key_ strfield - The range key name.
- range_
key_ strtype - The range key type. Valid values are "STRING" or "NUMBER".
- range_
key_ strvalue - The range key value.
- hash
Key StringField - The hash key name.
- hash
Key StringValue - The hash key value.
- role
Arn String - The ARN of the IAM role that grants access to the DynamoDB table.
- table
Name String - The name of the DynamoDB table.
- hash
Key StringType - The hash key type. Valid values are "STRING" or "NUMBER".
- operation String
- The operation. Valid values are "INSERT", "UPDATE", or "DELETE".
- payload
Field String - The action payload.
- range
Key StringField - The range key name.
- range
Key StringType - The range key type. Valid values are "STRING" or "NUMBER".
- range
Key StringValue - The range key value.
TopicRuleErrorActionDynamodbv2, TopicRuleErrorActionDynamodbv2Args
- Role
Arn string - The ARN of the IAM role that grants access to the DynamoDB table.
- Put
Item TopicRule Error Action Dynamodbv2Put Item - Configuration block with DynamoDB Table to which the message will be written. Nested arguments below.
- Role
Arn string - The ARN of the IAM role that grants access to the DynamoDB table.
- Put
Item TopicRule Error Action Dynamodbv2Put Item - Configuration block with DynamoDB Table to which the message will be written. Nested arguments below.
- role
Arn String - The ARN of the IAM role that grants access to the DynamoDB table.
- put
Item TopicRule Error Action Dynamodbv2Put Item - Configuration block with DynamoDB Table to which the message will be written. Nested arguments below.
- role
Arn string - The ARN of the IAM role that grants access to the DynamoDB table.
- put
Item TopicRule Error Action Dynamodbv2Put Item - Configuration block with DynamoDB Table to which the message will be written. Nested arguments below.
- role_
arn str - The ARN of the IAM role that grants access to the DynamoDB table.
- put_
item TopicRule Error Action Dynamodbv2Put Item - Configuration block with DynamoDB Table to which the message will be written. Nested arguments below.
- role
Arn String - The ARN of the IAM role that grants access to the DynamoDB table.
- put
Item Property Map - Configuration block with DynamoDB Table to which the message will be written. Nested arguments below.
TopicRuleErrorActionDynamodbv2PutItem, TopicRuleErrorActionDynamodbv2PutItemArgs
- Table
Name string - The name of the DynamoDB table.
- Table
Name string - The name of the DynamoDB table.
- table
Name String - The name of the DynamoDB table.
- table
Name string - The name of the DynamoDB table.
- table_
name str - The name of the DynamoDB table.
- table
Name String - The name of the DynamoDB table.
TopicRuleErrorActionElasticsearch, TopicRuleErrorActionElasticsearchArgs
- Endpoint string
- The endpoint of your Elasticsearch domain.
- Id string
- The unique identifier for the document you are storing.
- Index string
- The Elasticsearch index where you want to store your data.
- Role
Arn string - The IAM role ARN that has access to Elasticsearch.
- Type string
- The type of document you are storing.
- Endpoint string
- The endpoint of your Elasticsearch domain.
- Id string
- The unique identifier for the document you are storing.
- Index string
- The Elasticsearch index where you want to store your data.
- Role
Arn string - The IAM role ARN that has access to Elasticsearch.
- Type string
- The type of document you are storing.
- endpoint String
- The endpoint of your Elasticsearch domain.
- id String
- The unique identifier for the document you are storing.
- index String
- The Elasticsearch index where you want to store your data.
- role
Arn String - The IAM role ARN that has access to Elasticsearch.
- type String
- The type of document you are storing.
- endpoint string
- The endpoint of your Elasticsearch domain.
- id string
- The unique identifier for the document you are storing.
- index string
- The Elasticsearch index where you want to store your data.
- role
Arn string - The IAM role ARN that has access to Elasticsearch.
- type string
- The type of document you are storing.
- endpoint String
- The endpoint of your Elasticsearch domain.
- id String
- The unique identifier for the document you are storing.
- index String
- The Elasticsearch index where you want to store your data.
- role
Arn String - The IAM role ARN that has access to Elasticsearch.
- type String
- The type of document you are storing.
TopicRuleErrorActionFirehose, TopicRuleErrorActionFirehoseArgs
- Delivery
Stream stringName - The delivery stream name.
- Role
Arn string - The IAM role ARN that grants access to the Amazon Kinesis Firehose stream.
- Batch
Mode bool - The payload that contains a JSON array of records will be sent to Kinesis Firehose via a batch call.
- Separator string
- A character separator that is used to separate records written to the Firehose stream. Valid values are: '\n' (newline), '\t' (tab), '\r\n' (Windows newline), ',' (comma).
- Delivery
Stream stringName - The delivery stream name.
- Role
Arn string - The IAM role ARN that grants access to the Amazon Kinesis Firehose stream.
- Batch
Mode bool - The payload that contains a JSON array of records will be sent to Kinesis Firehose via a batch call.
- Separator string
- A character separator that is used to separate records written to the Firehose stream. Valid values are: '\n' (newline), '\t' (tab), '\r\n' (Windows newline), ',' (comma).
- delivery
Stream StringName - The delivery stream name.
- role
Arn String - The IAM role ARN that grants access to the Amazon Kinesis Firehose stream.
- batch
Mode Boolean - The payload that contains a JSON array of records will be sent to Kinesis Firehose via a batch call.
- separator String
- A character separator that is used to separate records written to the Firehose stream. Valid values are: '\n' (newline), '\t' (tab), '\r\n' (Windows newline), ',' (comma).
- delivery
Stream stringName - The delivery stream name.
- role
Arn string - The IAM role ARN that grants access to the Amazon Kinesis Firehose stream.
- batch
Mode boolean - The payload that contains a JSON array of records will be sent to Kinesis Firehose via a batch call.
- separator string
- A character separator that is used to separate records written to the Firehose stream. Valid values are: '\n' (newline), '\t' (tab), '\r\n' (Windows newline), ',' (comma).
- delivery_
stream_ strname - The delivery stream name.
- role_
arn str - The IAM role ARN that grants access to the Amazon Kinesis Firehose stream.
- batch_
mode bool - The payload that contains a JSON array of records will be sent to Kinesis Firehose via a batch call.
- separator str
- A character separator that is used to separate records written to the Firehose stream. Valid values are: '\n' (newline), '\t' (tab), '\r\n' (Windows newline), ',' (comma).
- delivery
Stream StringName - The delivery stream name.
- role
Arn String - The IAM role ARN that grants access to the Amazon Kinesis Firehose stream.
- batch
Mode Boolean - The payload that contains a JSON array of records will be sent to Kinesis Firehose via a batch call.
- separator String
- A character separator that is used to separate records written to the Firehose stream. Valid values are: '\n' (newline), '\t' (tab), '\r\n' (Windows newline), ',' (comma).
TopicRuleErrorActionHttp, TopicRuleErrorActionHttpArgs
- Url string
- The HTTPS URL.
- Confirmation
Url string - The HTTPS URL used to verify ownership of
url. - Http
Headers List<TopicRule Error Action Http Http Header> - Custom HTTP header IoT Core should send. It is possible to define more than one custom header.
- Url string
- The HTTPS URL.
- Confirmation
Url string - The HTTPS URL used to verify ownership of
url. - Http
Headers []TopicRule Error Action Http Http Header - Custom HTTP header IoT Core should send. It is possible to define more than one custom header.
- url String
- The HTTPS URL.
- confirmation
Url String - The HTTPS URL used to verify ownership of
url. - http
Headers List<TopicRule Error Action Http Http Header> - Custom HTTP header IoT Core should send. It is possible to define more than one custom header.
- url string
- The HTTPS URL.
- confirmation
Url string - The HTTPS URL used to verify ownership of
url. - http
Headers TopicRule Error Action Http Http Header[] - Custom HTTP header IoT Core should send. It is possible to define more than one custom header.
- url str
- The HTTPS URL.
- confirmation_
url str - The HTTPS URL used to verify ownership of
url. - http_
headers Sequence[TopicRule Error Action Http Http Header] - Custom HTTP header IoT Core should send. It is possible to define more than one custom header.
- url String
- The HTTPS URL.
- confirmation
Url String - The HTTPS URL used to verify ownership of
url. - http
Headers List<Property Map> - Custom HTTP header IoT Core should send. It is possible to define more than one custom header.
TopicRuleErrorActionHttpHttpHeader, TopicRuleErrorActionHttpHttpHeaderArgs
TopicRuleErrorActionIotAnalytics, TopicRuleErrorActionIotAnalyticsArgs
- Channel
Name string - Name of AWS IOT Analytics channel.
- Role
Arn string - The ARN of the IAM role that grants access.
- Batch
Mode bool - The payload that contains a JSON array of records will be sent to IoT Analytics via a batch call.
- Channel
Name string - Name of AWS IOT Analytics channel.
- Role
Arn string - The ARN of the IAM role that grants access.
- Batch
Mode bool - The payload that contains a JSON array of records will be sent to IoT Analytics via a batch call.
- channel
Name String - Name of AWS IOT Analytics channel.
- role
Arn String - The ARN of the IAM role that grants access.
- batch
Mode Boolean - The payload that contains a JSON array of records will be sent to IoT Analytics via a batch call.
- channel
Name string - Name of AWS IOT Analytics channel.
- role
Arn string - The ARN of the IAM role that grants access.
- batch
Mode boolean - The payload that contains a JSON array of records will be sent to IoT Analytics via a batch call.
- channel_
name str - Name of AWS IOT Analytics channel.
- role_
arn str - The ARN of the IAM role that grants access.
- batch_
mode bool - The payload that contains a JSON array of records will be sent to IoT Analytics via a batch call.
- channel
Name String - Name of AWS IOT Analytics channel.
- role
Arn String - The ARN of the IAM role that grants access.
- batch
Mode Boolean - The payload that contains a JSON array of records will be sent to IoT Analytics via a batch call.
TopicRuleErrorActionIotEvents, TopicRuleErrorActionIotEventsArgs
- Input
Name string - The name of the AWS IoT Events input.
- Role
Arn string - The ARN of the IAM role that grants access.
- Batch
Mode bool - The payload that contains a JSON array of records will be sent to IoT Events via a batch call.
- Message
Id string - Use this to ensure that only one input (message) with a given messageId is processed by an AWS IoT Events detector.
- Input
Name string - The name of the AWS IoT Events input.
- Role
Arn string - The ARN of the IAM role that grants access.
- Batch
Mode bool - The payload that contains a JSON array of records will be sent to IoT Events via a batch call.
- Message
Id string - Use this to ensure that only one input (message) with a given messageId is processed by an AWS IoT Events detector.
- input
Name String - The name of the AWS IoT Events input.
- role
Arn String - The ARN of the IAM role that grants access.
- batch
Mode Boolean - The payload that contains a JSON array of records will be sent to IoT Events via a batch call.
- message
Id String - Use this to ensure that only one input (message) with a given messageId is processed by an AWS IoT Events detector.
- input
Name string - The name of the AWS IoT Events input.
- role
Arn string - The ARN of the IAM role that grants access.
- batch
Mode boolean - The payload that contains a JSON array of records will be sent to IoT Events via a batch call.
- message
Id string - Use this to ensure that only one input (message) with a given messageId is processed by an AWS IoT Events detector.
- input_
name str - The name of the AWS IoT Events input.
- role_
arn str - The ARN of the IAM role that grants access.
- batch_
mode bool - The payload that contains a JSON array of records will be sent to IoT Events via a batch call.
- message_
id str - Use this to ensure that only one input (message) with a given messageId is processed by an AWS IoT Events detector.
- input
Name String - The name of the AWS IoT Events input.
- role
Arn String - The ARN of the IAM role that grants access.
- batch
Mode Boolean - The payload that contains a JSON array of records will be sent to IoT Events via a batch call.
- message
Id String - Use this to ensure that only one input (message) with a given messageId is processed by an AWS IoT Events detector.
TopicRuleErrorActionKafka, TopicRuleErrorActionKafkaArgs
- Client
Properties Dictionary<string, string> - Properties of the Apache Kafka producer client. For more info, see the AWS documentation.
- Destination
Arn string - The ARN of Kafka action's VPC
aws.iot.TopicRuleDestination. - Topic string
- The Kafka topic for messages to be sent to the Kafka broker.
- Headers
List<Topic
Rule Error Action Kafka Header> - The list of Kafka headers that you specify. Nested arguments below.
- Key string
- The Kafka message key.
- Partition string
- The Kafka message partition.
- Client
Properties map[string]string - Properties of the Apache Kafka producer client. For more info, see the AWS documentation.
- Destination
Arn string - The ARN of Kafka action's VPC
aws.iot.TopicRuleDestination. - Topic string
- The Kafka topic for messages to be sent to the Kafka broker.
- Headers
[]Topic
Rule Error Action Kafka Header - The list of Kafka headers that you specify. Nested arguments below.
- Key string
- The Kafka message key.
- Partition string
- The Kafka message partition.
- client
Properties Map<String,String> - Properties of the Apache Kafka producer client. For more info, see the AWS documentation.
- destination
Arn String - The ARN of Kafka action's VPC
aws.iot.TopicRuleDestination. - topic String
- The Kafka topic for messages to be sent to the Kafka broker.
- headers
List<Topic
Rule Error Action Kafka Header> - The list of Kafka headers that you specify. Nested arguments below.
- key String
- The Kafka message key.
- partition String
- The Kafka message partition.
- client
Properties {[key: string]: string} - Properties of the Apache Kafka producer client. For more info, see the AWS documentation.
- destination
Arn string - The ARN of Kafka action's VPC
aws.iot.TopicRuleDestination. - topic string
- The Kafka topic for messages to be sent to the Kafka broker.
- headers
Topic
Rule Error Action Kafka Header[] - The list of Kafka headers that you specify. Nested arguments below.
- key string
- The Kafka message key.
- partition string
- The Kafka message partition.
- client_
properties Mapping[str, str] - Properties of the Apache Kafka producer client. For more info, see the AWS documentation.
- destination_
arn str - The ARN of Kafka action's VPC
aws.iot.TopicRuleDestination. - topic str
- The Kafka topic for messages to be sent to the Kafka broker.
- headers
Sequence[Topic
Rule Error Action Kafka Header] - The list of Kafka headers that you specify. Nested arguments below.
- key str
- The Kafka message key.
- partition str
- The Kafka message partition.
- client
Properties Map<String> - Properties of the Apache Kafka producer client. For more info, see the AWS documentation.
- destination
Arn String - The ARN of Kafka action's VPC
aws.iot.TopicRuleDestination. - topic String
- The Kafka topic for messages to be sent to the Kafka broker.
- headers List<Property Map>
- The list of Kafka headers that you specify. Nested arguments below.
- key String
- The Kafka message key.
- partition String
- The Kafka message partition.
TopicRuleErrorActionKafkaHeader, TopicRuleErrorActionKafkaHeaderArgs
TopicRuleErrorActionKinesis, TopicRuleErrorActionKinesisArgs
- Role
Arn string - The ARN of the IAM role that grants access to the Amazon Kinesis stream.
- Stream
Name string - The name of the Amazon Kinesis stream.
- Partition
Key string - The partition key.
- Role
Arn string - The ARN of the IAM role that grants access to the Amazon Kinesis stream.
- Stream
Name string - The name of the Amazon Kinesis stream.
- Partition
Key string - The partition key.
- role
Arn String - The ARN of the IAM role that grants access to the Amazon Kinesis stream.
- stream
Name String - The name of the Amazon Kinesis stream.
- partition
Key String - The partition key.
- role
Arn string - The ARN of the IAM role that grants access to the Amazon Kinesis stream.
- stream
Name string - The name of the Amazon Kinesis stream.
- partition
Key string - The partition key.
- role_
arn str - The ARN of the IAM role that grants access to the Amazon Kinesis stream.
- stream_
name str - The name of the Amazon Kinesis stream.
- partition_
key str - The partition key.
- role
Arn String - The ARN of the IAM role that grants access to the Amazon Kinesis stream.
- stream
Name String - The name of the Amazon Kinesis stream.
- partition
Key String - The partition key.
TopicRuleErrorActionLambda, TopicRuleErrorActionLambdaArgs
- Function
Arn string - The ARN of the Lambda function.
- Function
Arn string - The ARN of the Lambda function.
- function
Arn String - The ARN of the Lambda function.
- function
Arn string - The ARN of the Lambda function.
- function_
arn str - The ARN of the Lambda function.
- function
Arn String - The ARN of the Lambda function.
TopicRuleErrorActionRepublish, TopicRuleErrorActionRepublishArgs
TopicRuleErrorActionS3, TopicRuleErrorActionS3Args
- Bucket
Name string - The Amazon S3 bucket name.
- Key string
- The object key.
- Role
Arn string - The ARN of the IAM role that grants access.
- Canned
Acl string - The Amazon S3 canned ACL that controls access to the object identified by the object key. Valid values.
- Bucket
Name string - The Amazon S3 bucket name.
- Key string
- The object key.
- Role
Arn string - The ARN of the IAM role that grants access.
- Canned
Acl string - The Amazon S3 canned ACL that controls access to the object identified by the object key. Valid values.
- bucket
Name String - The Amazon S3 bucket name.
- key String
- The object key.
- role
Arn String - The ARN of the IAM role that grants access.
- canned
Acl String - The Amazon S3 canned ACL that controls access to the object identified by the object key. Valid values.
- bucket
Name string - The Amazon S3 bucket name.
- key string
- The object key.
- role
Arn string - The ARN of the IAM role that grants access.
- canned
Acl string - The Amazon S3 canned ACL that controls access to the object identified by the object key. Valid values.
- bucket_
name str - The Amazon S3 bucket name.
- key str
- The object key.
- role_
arn str - The ARN of the IAM role that grants access.
- canned_
acl str - The Amazon S3 canned ACL that controls access to the object identified by the object key. Valid values.
- bucket
Name String - The Amazon S3 bucket name.
- key String
- The object key.
- role
Arn String - The ARN of the IAM role that grants access.
- canned
Acl String - The Amazon S3 canned ACL that controls access to the object identified by the object key. Valid values.
TopicRuleErrorActionSns, TopicRuleErrorActionSnsArgs
- Role
Arn string - The ARN of the IAM role that grants access.
- Target
Arn string - The ARN of the SNS topic.
- Message
Format string - The message format of the message to publish. Accepted values are "JSON" and "RAW".
- Role
Arn string - The ARN of the IAM role that grants access.
- Target
Arn string - The ARN of the SNS topic.
- Message
Format string - The message format of the message to publish. Accepted values are "JSON" and "RAW".
- role
Arn String - The ARN of the IAM role that grants access.
- target
Arn String - The ARN of the SNS topic.
- message
Format String - The message format of the message to publish. Accepted values are "JSON" and "RAW".
- role
Arn string - The ARN of the IAM role that grants access.
- target
Arn string - The ARN of the SNS topic.
- message
Format string - The message format of the message to publish. Accepted values are "JSON" and "RAW".
- role_
arn str - The ARN of the IAM role that grants access.
- target_
arn str - The ARN of the SNS topic.
- message_
format str - The message format of the message to publish. Accepted values are "JSON" and "RAW".
- role
Arn String - The ARN of the IAM role that grants access.
- target
Arn String - The ARN of the SNS topic.
- message
Format String - The message format of the message to publish. Accepted values are "JSON" and "RAW".
TopicRuleErrorActionSqs, TopicRuleErrorActionSqsArgs
- queue_
url str - The URL of the Amazon SQS queue.
- role_
arn str - The ARN of the IAM role that grants access.
- use_
base64 bool - Specifies whether to use Base64 encoding.
TopicRuleErrorActionStepFunctions, TopicRuleErrorActionStepFunctionsArgs
- Role
Arn string - The ARN of the IAM role that grants access to start execution of the state machine.
- State
Machine stringName - The name of the Step Functions state machine whose execution will be started.
- Execution
Name stringPrefix - The prefix used to generate, along with a UUID, the unique state machine execution name.
- Role
Arn string - The ARN of the IAM role that grants access to start execution of the state machine.
- State
Machine stringName - The name of the Step Functions state machine whose execution will be started.
- Execution
Name stringPrefix - The prefix used to generate, along with a UUID, the unique state machine execution name.
- role
Arn String - The ARN of the IAM role that grants access to start execution of the state machine.
- state
Machine StringName - The name of the Step Functions state machine whose execution will be started.
- execution
Name StringPrefix - The prefix used to generate, along with a UUID, the unique state machine execution name.
- role
Arn string - The ARN of the IAM role that grants access to start execution of the state machine.
- state
Machine stringName - The name of the Step Functions state machine whose execution will be started.
- execution
Name stringPrefix - The prefix used to generate, along with a UUID, the unique state machine execution name.
- role_
arn str - The ARN of the IAM role that grants access to start execution of the state machine.
- state_
machine_ strname - The name of the Step Functions state machine whose execution will be started.
- execution_
name_ strprefix - The prefix used to generate, along with a UUID, the unique state machine execution name.
- role
Arn String - The ARN of the IAM role that grants access to start execution of the state machine.
- state
Machine StringName - The name of the Step Functions state machine whose execution will be started.
- execution
Name StringPrefix - The prefix used to generate, along with a UUID, the unique state machine execution name.
TopicRuleErrorActionTimestream, TopicRuleErrorActionTimestreamArgs
- Database
Name string - The name of an Amazon Timestream database.
- Dimensions
List<Topic
Rule Error Action Timestream Dimension> - Configuration blocks with metadata attributes of the time series that are written in each measure record. Nested arguments below.
- Role
Arn string - The ARN of the role that grants permission to write to the Amazon Timestream database table.
- Table
Name string - The name of the database table into which to write the measure records.
- Timestamp
Topic
Rule Error Action Timestream Timestamp - Configuration block specifying an application-defined value to replace the default value assigned to the Timestream record's timestamp in the time column. Nested arguments below.
- Database
Name string - The name of an Amazon Timestream database.
- Dimensions
[]Topic
Rule Error Action Timestream Dimension - Configuration blocks with metadata attributes of the time series that are written in each measure record. Nested arguments below.
- Role
Arn string - The ARN of the role that grants permission to write to the Amazon Timestream database table.
- Table
Name string - The name of the database table into which to write the measure records.
- Timestamp
Topic
Rule Error Action Timestream Timestamp - Configuration block specifying an application-defined value to replace the default value assigned to the Timestream record's timestamp in the time column. Nested arguments below.
- database
Name String - The name of an Amazon Timestream database.
- dimensions
List<Topic
Rule Error Action Timestream Dimension> - Configuration blocks with metadata attributes of the time series that are written in each measure record. Nested arguments below.
- role
Arn String - The ARN of the role that grants permission to write to the Amazon Timestream database table.
- table
Name String - The name of the database table into which to write the measure records.
- timestamp
Topic
Rule Error Action Timestream Timestamp - Configuration block specifying an application-defined value to replace the default value assigned to the Timestream record's timestamp in the time column. Nested arguments below.
- database
Name string - The name of an Amazon Timestream database.
- dimensions
Topic
Rule Error Action Timestream Dimension[] - Configuration blocks with metadata attributes of the time series that are written in each measure record. Nested arguments below.
- role
Arn string - The ARN of the role that grants permission to write to the Amazon Timestream database table.
- table
Name string - The name of the database table into which to write the measure records.
- timestamp
Topic
Rule Error Action Timestream Timestamp - Configuration block specifying an application-defined value to replace the default value assigned to the Timestream record's timestamp in the time column. Nested arguments below.
- database_
name str - The name of an Amazon Timestream database.
- dimensions
Sequence[Topic
Rule Error Action Timestream Dimension] - Configuration blocks with metadata attributes of the time series that are written in each measure record. Nested arguments below.
- role_
arn str - The ARN of the role that grants permission to write to the Amazon Timestream database table.
- table_
name str - The name of the database table into which to write the measure records.
- timestamp
Topic
Rule Error Action Timestream Timestamp - Configuration block specifying an application-defined value to replace the default value assigned to the Timestream record's timestamp in the time column. Nested arguments below.
- database
Name String - The name of an Amazon Timestream database.
- dimensions List<Property Map>
- Configuration blocks with metadata attributes of the time series that are written in each measure record. Nested arguments below.
- role
Arn String - The ARN of the role that grants permission to write to the Amazon Timestream database table.
- table
Name String - The name of the database table into which to write the measure records.
- timestamp Property Map
- Configuration block specifying an application-defined value to replace the default value assigned to the Timestream record's timestamp in the time column. Nested arguments below.
TopicRuleErrorActionTimestreamDimension, TopicRuleErrorActionTimestreamDimensionArgs
TopicRuleErrorActionTimestreamTimestamp, TopicRuleErrorActionTimestreamTimestampArgs
TopicRuleFirehose, TopicRuleFirehoseArgs
- Delivery
Stream stringName - The delivery stream name.
- Role
Arn string - The IAM role ARN that grants access to the Amazon Kinesis Firehose stream.
- Batch
Mode bool - The payload that contains a JSON array of records will be sent to Kinesis Firehose via a batch call.
- Separator string
- A character separator that is used to separate records written to the Firehose stream. Valid values are: '\n' (newline), '\t' (tab), '\r\n' (Windows newline), ',' (comma).
- Delivery
Stream stringName - The delivery stream name.
- Role
Arn string - The IAM role ARN that grants access to the Amazon Kinesis Firehose stream.
- Batch
Mode bool - The payload that contains a JSON array of records will be sent to Kinesis Firehose via a batch call.
- Separator string
- A character separator that is used to separate records written to the Firehose stream. Valid values are: '\n' (newline), '\t' (tab), '\r\n' (Windows newline), ',' (comma).
- delivery
Stream StringName - The delivery stream name.
- role
Arn String - The IAM role ARN that grants access to the Amazon Kinesis Firehose stream.
- batch
Mode Boolean - The payload that contains a JSON array of records will be sent to Kinesis Firehose via a batch call.
- separator String
- A character separator that is used to separate records written to the Firehose stream. Valid values are: '\n' (newline), '\t' (tab), '\r\n' (Windows newline), ',' (comma).
- delivery
Stream stringName - The delivery stream name.
- role
Arn string - The IAM role ARN that grants access to the Amazon Kinesis Firehose stream.
- batch
Mode boolean - The payload that contains a JSON array of records will be sent to Kinesis Firehose via a batch call.
- separator string
- A character separator that is used to separate records written to the Firehose stream. Valid values are: '\n' (newline), '\t' (tab), '\r\n' (Windows newline), ',' (comma).
- delivery_
stream_ strname - The delivery stream name.
- role_
arn str - The IAM role ARN that grants access to the Amazon Kinesis Firehose stream.
- batch_
mode bool - The payload that contains a JSON array of records will be sent to Kinesis Firehose via a batch call.
- separator str
- A character separator that is used to separate records written to the Firehose stream. Valid values are: '\n' (newline), '\t' (tab), '\r\n' (Windows newline), ',' (comma).
- delivery
Stream StringName - The delivery stream name.
- role
Arn String - The IAM role ARN that grants access to the Amazon Kinesis Firehose stream.
- batch
Mode Boolean - The payload that contains a JSON array of records will be sent to Kinesis Firehose via a batch call.
- separator String
- A character separator that is used to separate records written to the Firehose stream. Valid values are: '\n' (newline), '\t' (tab), '\r\n' (Windows newline), ',' (comma).
TopicRuleHttp, TopicRuleHttpArgs
- Url string
- The HTTPS URL.
- Confirmation
Url string - The HTTPS URL used to verify ownership of
url. - Http
Headers List<TopicRule Http Http Header> - Custom HTTP header IoT Core should send. It is possible to define more than one custom header.
- Url string
- The HTTPS URL.
- Confirmation
Url string - The HTTPS URL used to verify ownership of
url. - Http
Headers []TopicRule Http Http Header - Custom HTTP header IoT Core should send. It is possible to define more than one custom header.
- url String
- The HTTPS URL.
- confirmation
Url String - The HTTPS URL used to verify ownership of
url. - http
Headers List<TopicRule Http Http Header> - Custom HTTP header IoT Core should send. It is possible to define more than one custom header.
- url string
- The HTTPS URL.
- confirmation
Url string - The HTTPS URL used to verify ownership of
url. - http
Headers TopicRule Http Http Header[] - Custom HTTP header IoT Core should send. It is possible to define more than one custom header.
- url str
- The HTTPS URL.
- confirmation_
url str - The HTTPS URL used to verify ownership of
url. - http_
headers Sequence[TopicRule Http Http Header] - Custom HTTP header IoT Core should send. It is possible to define more than one custom header.
- url String
- The HTTPS URL.
- confirmation
Url String - The HTTPS URL used to verify ownership of
url. - http
Headers List<Property Map> - Custom HTTP header IoT Core should send. It is possible to define more than one custom header.
TopicRuleHttpHttpHeader, TopicRuleHttpHttpHeaderArgs
TopicRuleIotAnalytic, TopicRuleIotAnalyticArgs
- Channel
Name string - Name of AWS IOT Analytics channel.
- Role
Arn string - The ARN of the IAM role that grants access.
- Batch
Mode bool - The payload that contains a JSON array of records will be sent to IoT Analytics via a batch call.
- Channel
Name string - Name of AWS IOT Analytics channel.
- Role
Arn string - The ARN of the IAM role that grants access.
- Batch
Mode bool - The payload that contains a JSON array of records will be sent to IoT Analytics via a batch call.
- channel
Name String - Name of AWS IOT Analytics channel.
- role
Arn String - The ARN of the IAM role that grants access.
- batch
Mode Boolean - The payload that contains a JSON array of records will be sent to IoT Analytics via a batch call.
- channel
Name string - Name of AWS IOT Analytics channel.
- role
Arn string - The ARN of the IAM role that grants access.
- batch
Mode boolean - The payload that contains a JSON array of records will be sent to IoT Analytics via a batch call.
- channel_
name str - Name of AWS IOT Analytics channel.
- role_
arn str - The ARN of the IAM role that grants access.
- batch_
mode bool - The payload that contains a JSON array of records will be sent to IoT Analytics via a batch call.
- channel
Name String - Name of AWS IOT Analytics channel.
- role
Arn String - The ARN of the IAM role that grants access.
- batch
Mode Boolean - The payload that contains a JSON array of records will be sent to IoT Analytics via a batch call.
TopicRuleIotEvent, TopicRuleIotEventArgs
- Input
Name string - The name of the AWS IoT Events input.
- Role
Arn string - The ARN of the IAM role that grants access.
- Batch
Mode bool - The payload that contains a JSON array of records will be sent to IoT Events via a batch call.
- Message
Id string - Use this to ensure that only one input (message) with a given messageId is processed by an AWS IoT Events detector.
- Input
Name string - The name of the AWS IoT Events input.
- Role
Arn string - The ARN of the IAM role that grants access.
- Batch
Mode bool - The payload that contains a JSON array of records will be sent to IoT Events via a batch call.
- Message
Id string - Use this to ensure that only one input (message) with a given messageId is processed by an AWS IoT Events detector.
- input
Name String - The name of the AWS IoT Events input.
- role
Arn String - The ARN of the IAM role that grants access.
- batch
Mode Boolean - The payload that contains a JSON array of records will be sent to IoT Events via a batch call.
- message
Id String - Use this to ensure that only one input (message) with a given messageId is processed by an AWS IoT Events detector.
- input
Name string - The name of the AWS IoT Events input.
- role
Arn string - The ARN of the IAM role that grants access.
- batch
Mode boolean - The payload that contains a JSON array of records will be sent to IoT Events via a batch call.
- message
Id string - Use this to ensure that only one input (message) with a given messageId is processed by an AWS IoT Events detector.
- input_
name str - The name of the AWS IoT Events input.
- role_
arn str - The ARN of the IAM role that grants access.
- batch_
mode bool - The payload that contains a JSON array of records will be sent to IoT Events via a batch call.
- message_
id str - Use this to ensure that only one input (message) with a given messageId is processed by an AWS IoT Events detector.
- input
Name String - The name of the AWS IoT Events input.
- role
Arn String - The ARN of the IAM role that grants access.
- batch
Mode Boolean - The payload that contains a JSON array of records will be sent to IoT Events via a batch call.
- message
Id String - Use this to ensure that only one input (message) with a given messageId is processed by an AWS IoT Events detector.
TopicRuleKafka, TopicRuleKafkaArgs
- Client
Properties Dictionary<string, string> - Properties of the Apache Kafka producer client. For more info, see the AWS documentation.
- Destination
Arn string - The ARN of Kafka action's VPC
aws.iot.TopicRuleDestination. - Topic string
- The Kafka topic for messages to be sent to the Kafka broker.
- Headers
List<Topic
Rule Kafka Header> - The list of Kafka headers that you specify. Nested arguments below.
- Key string
- The Kafka message key.
- Partition string
- The Kafka message partition.
- Client
Properties map[string]string - Properties of the Apache Kafka producer client. For more info, see the AWS documentation.
- Destination
Arn string - The ARN of Kafka action's VPC
aws.iot.TopicRuleDestination. - Topic string
- The Kafka topic for messages to be sent to the Kafka broker.
- Headers
[]Topic
Rule Kafka Header - The list of Kafka headers that you specify. Nested arguments below.
- Key string
- The Kafka message key.
- Partition string
- The Kafka message partition.
- client
Properties Map<String,String> - Properties of the Apache Kafka producer client. For more info, see the AWS documentation.
- destination
Arn String - The ARN of Kafka action's VPC
aws.iot.TopicRuleDestination. - topic String
- The Kafka topic for messages to be sent to the Kafka broker.
- headers
List<Topic
Rule Kafka Header> - The list of Kafka headers that you specify. Nested arguments below.
- key String
- The Kafka message key.
- partition String
- The Kafka message partition.
- client
Properties {[key: string]: string} - Properties of the Apache Kafka producer client. For more info, see the AWS documentation.
- destination
Arn string - The ARN of Kafka action's VPC
aws.iot.TopicRuleDestination. - topic string
- The Kafka topic for messages to be sent to the Kafka broker.
- headers
Topic
Rule Kafka Header[] - The list of Kafka headers that you specify. Nested arguments below.
- key string
- The Kafka message key.
- partition string
- The Kafka message partition.
- client_
properties Mapping[str, str] - Properties of the Apache Kafka producer client. For more info, see the AWS documentation.
- destination_
arn str - The ARN of Kafka action's VPC
aws.iot.TopicRuleDestination. - topic str
- The Kafka topic for messages to be sent to the Kafka broker.
- headers
Sequence[Topic
Rule Kafka Header] - The list of Kafka headers that you specify. Nested arguments below.
- key str
- The Kafka message key.
- partition str
- The Kafka message partition.
- client
Properties Map<String> - Properties of the Apache Kafka producer client. For more info, see the AWS documentation.
- destination
Arn String - The ARN of Kafka action's VPC
aws.iot.TopicRuleDestination. - topic String
- The Kafka topic for messages to be sent to the Kafka broker.
- headers List<Property Map>
- The list of Kafka headers that you specify. Nested arguments below.
- key String
- The Kafka message key.
- partition String
- The Kafka message partition.
TopicRuleKafkaHeader, TopicRuleKafkaHeaderArgs
TopicRuleKinesis, TopicRuleKinesisArgs
- Role
Arn string - The ARN of the IAM role that grants access to the Amazon Kinesis stream.
- Stream
Name string - The name of the Amazon Kinesis stream.
- Partition
Key string - The partition key.
- Role
Arn string - The ARN of the IAM role that grants access to the Amazon Kinesis stream.
- Stream
Name string - The name of the Amazon Kinesis stream.
- Partition
Key string - The partition key.
- role
Arn String - The ARN of the IAM role that grants access to the Amazon Kinesis stream.
- stream
Name String - The name of the Amazon Kinesis stream.
- partition
Key String - The partition key.
- role
Arn string - The ARN of the IAM role that grants access to the Amazon Kinesis stream.
- stream
Name string - The name of the Amazon Kinesis stream.
- partition
Key string - The partition key.
- role_
arn str - The ARN of the IAM role that grants access to the Amazon Kinesis stream.
- stream_
name str - The name of the Amazon Kinesis stream.
- partition_
key str - The partition key.
- role
Arn String - The ARN of the IAM role that grants access to the Amazon Kinesis stream.
- stream
Name String - The name of the Amazon Kinesis stream.
- partition
Key String - The partition key.
TopicRuleLambda, TopicRuleLambdaArgs
- Function
Arn string - The ARN of the Lambda function.
- Function
Arn string - The ARN of the Lambda function.
- function
Arn String - The ARN of the Lambda function.
- function
Arn string - The ARN of the Lambda function.
- function_
arn str - The ARN of the Lambda function.
- function
Arn String - The ARN of the Lambda function.
TopicRuleRepublish, TopicRuleRepublishArgs
TopicRuleS3, TopicRuleS3Args
- Bucket
Name string - The Amazon S3 bucket name.
- Key string
- The object key.
- Role
Arn string - The ARN of the IAM role that grants access.
- Canned
Acl string - The Amazon S3 canned ACL that controls access to the object identified by the object key. Valid values.
- Bucket
Name string - The Amazon S3 bucket name.
- Key string
- The object key.
- Role
Arn string - The ARN of the IAM role that grants access.
- Canned
Acl string - The Amazon S3 canned ACL that controls access to the object identified by the object key. Valid values.
- bucket
Name String - The Amazon S3 bucket name.
- key String
- The object key.
- role
Arn String - The ARN of the IAM role that grants access.
- canned
Acl String - The Amazon S3 canned ACL that controls access to the object identified by the object key. Valid values.
- bucket
Name string - The Amazon S3 bucket name.
- key string
- The object key.
- role
Arn string - The ARN of the IAM role that grants access.
- canned
Acl string - The Amazon S3 canned ACL that controls access to the object identified by the object key. Valid values.
- bucket_
name str - The Amazon S3 bucket name.
- key str
- The object key.
- role_
arn str - The ARN of the IAM role that grants access.
- canned_
acl str - The Amazon S3 canned ACL that controls access to the object identified by the object key. Valid values.
- bucket
Name String - The Amazon S3 bucket name.
- key String
- The object key.
- role
Arn String - The ARN of the IAM role that grants access.
- canned
Acl String - The Amazon S3 canned ACL that controls access to the object identified by the object key. Valid values.
TopicRuleSns, TopicRuleSnsArgs
- Role
Arn string - The ARN of the IAM role that grants access.
- Target
Arn string - The ARN of the SNS topic.
- Message
Format string - The message format of the message to publish. Accepted values are "JSON" and "RAW".
- Role
Arn string - The ARN of the IAM role that grants access.
- Target
Arn string - The ARN of the SNS topic.
- Message
Format string - The message format of the message to publish. Accepted values are "JSON" and "RAW".
- role
Arn String - The ARN of the IAM role that grants access.
- target
Arn String - The ARN of the SNS topic.
- message
Format String - The message format of the message to publish. Accepted values are "JSON" and "RAW".
- role
Arn string - The ARN of the IAM role that grants access.
- target
Arn string - The ARN of the SNS topic.
- message
Format string - The message format of the message to publish. Accepted values are "JSON" and "RAW".
- role_
arn str - The ARN of the IAM role that grants access.
- target_
arn str - The ARN of the SNS topic.
- message_
format str - The message format of the message to publish. Accepted values are "JSON" and "RAW".
- role
Arn String - The ARN of the IAM role that grants access.
- target
Arn String - The ARN of the SNS topic.
- message
Format String - The message format of the message to publish. Accepted values are "JSON" and "RAW".
TopicRuleSqs, TopicRuleSqsArgs
- queue_
url str - The URL of the Amazon SQS queue.
- role_
arn str - The ARN of the IAM role that grants access.
- use_
base64 bool - Specifies whether to use Base64 encoding.
TopicRuleStepFunction, TopicRuleStepFunctionArgs
- Role
Arn string - The ARN of the IAM role that grants access to start execution of the state machine.
- State
Machine stringName - The name of the Step Functions state machine whose execution will be started.
- Execution
Name stringPrefix - The prefix used to generate, along with a UUID, the unique state machine execution name.
- Role
Arn string - The ARN of the IAM role that grants access to start execution of the state machine.
- State
Machine stringName - The name of the Step Functions state machine whose execution will be started.
- Execution
Name stringPrefix - The prefix used to generate, along with a UUID, the unique state machine execution name.
- role
Arn String - The ARN of the IAM role that grants access to start execution of the state machine.
- state
Machine StringName - The name of the Step Functions state machine whose execution will be started.
- execution
Name StringPrefix - The prefix used to generate, along with a UUID, the unique state machine execution name.
- role
Arn string - The ARN of the IAM role that grants access to start execution of the state machine.
- state
Machine stringName - The name of the Step Functions state machine whose execution will be started.
- execution
Name stringPrefix - The prefix used to generate, along with a UUID, the unique state machine execution name.
- role_
arn str - The ARN of the IAM role that grants access to start execution of the state machine.
- state_
machine_ strname - The name of the Step Functions state machine whose execution will be started.
- execution_
name_ strprefix - The prefix used to generate, along with a UUID, the unique state machine execution name.
- role
Arn String - The ARN of the IAM role that grants access to start execution of the state machine.
- state
Machine StringName - The name of the Step Functions state machine whose execution will be started.
- execution
Name StringPrefix - The prefix used to generate, along with a UUID, the unique state machine execution name.
TopicRuleTimestream, TopicRuleTimestreamArgs
- Database
Name string - The name of an Amazon Timestream database.
- Dimensions
List<Topic
Rule Timestream Dimension> - Configuration blocks with metadata attributes of the time series that are written in each measure record. Nested arguments below.
- Role
Arn string - The ARN of the role that grants permission to write to the Amazon Timestream database table.
- Table
Name string - The name of the database table into which to write the measure records.
- Timestamp
Topic
Rule Timestream Timestamp - Configuration block specifying an application-defined value to replace the default value assigned to the Timestream record's timestamp in the time column. Nested arguments below.
- Database
Name string - The name of an Amazon Timestream database.
- Dimensions
[]Topic
Rule Timestream Dimension - Configuration blocks with metadata attributes of the time series that are written in each measure record. Nested arguments below.
- Role
Arn string - The ARN of the role that grants permission to write to the Amazon Timestream database table.
- Table
Name string - The name of the database table into which to write the measure records.
- Timestamp
Topic
Rule Timestream Timestamp - Configuration block specifying an application-defined value to replace the default value assigned to the Timestream record's timestamp in the time column. Nested arguments below.
- database
Name String - The name of an Amazon Timestream database.
- dimensions
List<Topic
Rule Timestream Dimension> - Configuration blocks with metadata attributes of the time series that are written in each measure record. Nested arguments below.
- role
Arn String - The ARN of the role that grants permission to write to the Amazon Timestream database table.
- table
Name String - The name of the database table into which to write the measure records.
- timestamp
Topic
Rule Timestream Timestamp - Configuration block specifying an application-defined value to replace the default value assigned to the Timestream record's timestamp in the time column. Nested arguments below.
- database
Name string - The name of an Amazon Timestream database.
- dimensions
Topic
Rule Timestream Dimension[] - Configuration blocks with metadata attributes of the time series that are written in each measure record. Nested arguments below.
- role
Arn string - The ARN of the role that grants permission to write to the Amazon Timestream database table.
- table
Name string - The name of the database table into which to write the measure records.
- timestamp
Topic
Rule Timestream Timestamp - Configuration block specifying an application-defined value to replace the default value assigned to the Timestream record's timestamp in the time column. Nested arguments below.
- database_
name str - The name of an Amazon Timestream database.
- dimensions
Sequence[Topic
Rule Timestream Dimension] - Configuration blocks with metadata attributes of the time series that are written in each measure record. Nested arguments below.
- role_
arn str - The ARN of the role that grants permission to write to the Amazon Timestream database table.
- table_
name str - The name of the database table into which to write the measure records.
- timestamp
Topic
Rule Timestream Timestamp - Configuration block specifying an application-defined value to replace the default value assigned to the Timestream record's timestamp in the time column. Nested arguments below.
- database
Name String - The name of an Amazon Timestream database.
- dimensions List<Property Map>
- Configuration blocks with metadata attributes of the time series that are written in each measure record. Nested arguments below.
- role
Arn String - The ARN of the role that grants permission to write to the Amazon Timestream database table.
- table
Name String - The name of the database table into which to write the measure records.
- timestamp Property Map
- Configuration block specifying an application-defined value to replace the default value assigned to the Timestream record's timestamp in the time column. Nested arguments below.
TopicRuleTimestreamDimension, TopicRuleTimestreamDimensionArgs
TopicRuleTimestreamTimestamp, TopicRuleTimestreamTimestampArgs
Import
Using pulumi import, import IoT Topic Rules using the name. For example:
$ pulumi import aws:iot/topicRule:TopicRule rule <name>
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
awsTerraform Provider.