AWS Classic

Pulumi Official
Package maintained by Pulumi
v5.10.0 published on Monday, Jul 11, 2022 by Pulumi

TopicRule

Import

IoT Topic Rules can be imported using the name, e.g.,

 $ pulumi import aws:iot/topicRule:TopicRule rule <name>

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var mytopic = new Aws.Sns.Topic("mytopic", new Aws.Sns.TopicArgs
        {
        });
        var myerrortopic = new Aws.Sns.Topic("myerrortopic", new Aws.Sns.TopicArgs
        {
        });
        var role = new Aws.Iam.Role("role", new Aws.Iam.RoleArgs
        {
            AssumeRolePolicy = @"{
  ""Version"": ""2012-10-17"",
  ""Statement"": [
    {
      ""Effect"": ""Allow"",
      ""Principal"": {
        ""Service"": ""iot.amazonaws.com""
      },
      ""Action"": ""sts:AssumeRole""
    }
  ]
}
",
        });
        var rule = new Aws.Iot.TopicRule("rule", new Aws.Iot.TopicRuleArgs
        {
            Description = "Example rule",
            Enabled = true,
            Sql = "SELECT * FROM 'topic/test'",
            SqlVersion = "2016-03-23",
            Sns = 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 iamPolicyForLambda = new Aws.Iam.RolePolicy("iamPolicyForLambda", new Aws.Iam.RolePolicyArgs
        {
            Role = role.Id,
            Policy = mytopic.Arn.Apply(arn => @$"{{
  ""Version"": ""2012-10-17"",
  ""Statement"": [
    {{
        ""Effect"": ""Allow"",
        ""Action"": [
            ""sns:Publish""
        ],
        ""Resource"": ""{arn}""
    }}
  ]
}}
"),
        });
    }

}
package main

import (
	"fmt"

	"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/iam"
	"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/iot"
	"github.com/pulumi/pulumi-aws/sdk/v5/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", nil)
		if err != nil {
			return err
		}
		myerrortopic, err := sns.NewTopic(ctx, "myerrortopic", nil)
		if err != nil {
			return err
		}
		role, err := iam.NewRole(ctx, "role", &iam.RoleArgs{
			AssumeRolePolicy: pulumi.Any(fmt.Sprintf("%v%v%v%v%v%v%v%v%v%v%v%v", "{\n", "  \"Version\": \"2012-10-17\",\n", "  \"Statement\": [\n", "    {\n", "      \"Effect\": \"Allow\",\n", "      \"Principal\": {\n", "        \"Service\": \"iot.amazonaws.com\"\n", "      },\n", "      \"Action\": \"sts:AssumeRole\"\n", "    }\n", "  ]\n", "}\n")),
		})
		if err != nil {
			return err
		}
		_, err = iot.NewTopicRule(ctx, "rule", &iot.TopicRuleArgs{
			Description: pulumi.String("Example rule"),
			Enabled:     pulumi.Bool(true),
			Sql:         pulumi.String("SELECT * FROM 'topic/test'"),
			SqlVersion:  pulumi.String("2016-03-23"),
			Sns: &iot.TopicRuleSnsArgs{
				MessageFormat: pulumi.String("RAW"),
				RoleArn:       role.Arn,
				TargetArn:     mytopic.Arn,
			},
			ErrorAction: &iot.TopicRuleErrorActionArgs{
				Sns: &iot.TopicRuleErrorActionSnsArgs{
					MessageFormat: pulumi.String("RAW"),
					RoleArn:       role.Arn,
					TargetArn:     myerrortopic.Arn,
				},
			},
		})
		if err != nil {
			return err
		}
		_, err = iam.NewRolePolicy(ctx, "iamPolicyForLambda", &iam.RolePolicyArgs{
			Role: role.ID(),
			Policy: mytopic.Arn.ApplyT(func(arn string) (string, error) {
				return fmt.Sprintf("%v%v%v%v%v%v%v%v%v%v%v%v%v%v", "{\n", "  \"Version\": \"2012-10-17\",\n", "  \"Statement\": [\n", "    {\n", "        \"Effect\": \"Allow\",\n", "        \"Action\": [\n", "            \"sns:Publish\"\n", "        ],\n", "        \"Resource\": \"", arn, "\"\n", "    }\n", "  ]\n", "}\n"), nil
			}).(pulumi.StringOutput),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var mytopic = new Topic("mytopic");

        var myerrortopic = new Topic("myerrortopic");

        var role = new Role("role", RoleArgs.builder()        
            .assumeRolePolicy("""
{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Effect": "Allow",
      "Principal": {
        "Service": "iot.amazonaws.com"
      },
      "Action": "sts:AssumeRole"
    }
  ]
}
            """)
            .build());

        var rule = new TopicRule("rule", TopicRuleArgs.builder()        
            .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());

        var iamPolicyForLambda = new RolePolicy("iamPolicyForLambda", RolePolicyArgs.builder()        
            .role(role.id())
            .policy(mytopic.arn().apply(arn -> """
{
  "Version": "2012-10-17",
  "Statement": [
    {
        "Effect": "Allow",
        "Action": [
            "sns:Publish"
        ],
        "Resource": "%s"
    }
  ]
}
", arn)))
            .build());

    }
}
import pulumi
import pulumi_aws as aws

mytopic = aws.sns.Topic("mytopic")
myerrortopic = aws.sns.Topic("myerrortopic")
role = aws.iam.Role("role", assume_role_policy="""{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Effect": "Allow",
      "Principal": {
        "Service": "iot.amazonaws.com"
      },
      "Action": "sts:AssumeRole"
    }
  ]
}
""")
rule = aws.iot.TopicRule("rule",
    description="Example rule",
    enabled=True,
    sql="SELECT * FROM 'topic/test'",
    sql_version="2016-03-23",
    sns=aws.iot.TopicRuleSnsArgs(
        message_format="RAW",
        role_arn=role.arn,
        target_arn=mytopic.arn,
    ),
    error_action=aws.iot.TopicRuleErrorActionArgs(
        sns=aws.iot.TopicRuleErrorActionSnsArgs(
            message_format="RAW",
            role_arn=role.arn,
            target_arn=myerrortopic.arn,
        ),
    ))
iam_policy_for_lambda = aws.iam.RolePolicy("iamPolicyForLambda",
    role=role.id,
    policy=mytopic.arn.apply(lambda arn: f"""{{
  "Version": "2012-10-17",
  "Statement": [
    {{
        "Effect": "Allow",
        "Action": [
            "sns:Publish"
        ],
        "Resource": "{arn}"
    }}
  ]
}}
"""))
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const mytopic = new aws.sns.Topic("mytopic", {});
const myerrortopic = new aws.sns.Topic("myerrortopic", {});
const role = new aws.iam.Role("role", {assumeRolePolicy: `{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Effect": "Allow",
      "Principal": {
        "Service": "iot.amazonaws.com"
      },
      "Action": "sts:AssumeRole"
    }
  ]
}
`});
const rule = new aws.iot.TopicRule("rule", {
    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 iamPolicyForLambda = new aws.iam.RolePolicy("iamPolicyForLambda", {
    role: role.id,
    policy: pulumi.interpolate`{
  "Version": "2012-10-17",
  "Statement": [
    {
        "Effect": "Allow",
        "Action": [
            "sns:Publish"
        ],
        "Resource": "${mytopic.arn}"
    }
  ]
}
`,
});
resources:
  rule:
    type: aws:iot:TopicRule
    properties:
      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
  myerrortopic:
    type: aws:sns:Topic
  role:
    type: aws:iam:Role
    properties:
      assumeRolePolicy: |
        {
          "Version": "2012-10-17",
          "Statement": [
            {
              "Effect": "Allow",
              "Principal": {
                "Service": "iot.amazonaws.com"
              },
              "Action": "sts:AssumeRole"
            }
          ]
        }        
  iamPolicyForLambda:
    type: aws:iam:RolePolicy
    properties:
      role: ${role.id}
      policy: |
        {
          "Version": "2012-10-17",
          "Statement": [
            {
                "Effect": "Allow",
                "Action": [
                    "sns:Publish"
                ],
                "Resource": "${mytopic.arn}"
            }
          ]
        }        

Create a TopicRule Resource

new TopicRule(name: string, args: TopicRuleArgs, opts?: CustomResourceOptions);
@overload
def TopicRule(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              cloudwatch_alarm: Optional[TopicRuleCloudwatchAlarmArgs] = None,
              cloudwatch_logs: Optional[Sequence[TopicRuleCloudwatchLogArgs]] = None,
              cloudwatch_metric: Optional[TopicRuleCloudwatchMetricArgs] = None,
              description: Optional[str] = None,
              dynamodb: Optional[TopicRuleDynamodbArgs] = None,
              dynamodbv2s: Optional[Sequence[TopicRuleDynamodbv2Args]] = None,
              elasticsearch: Optional[TopicRuleElasticsearchArgs] = None,
              enabled: Optional[bool] = None,
              error_action: Optional[TopicRuleErrorActionArgs] = None,
              firehose: Optional[TopicRuleFirehoseArgs] = None,
              https: Optional[Sequence[TopicRuleHttpArgs]] = None,
              iot_analytics: Optional[Sequence[TopicRuleIotAnalyticArgs]] = None,
              iot_events: Optional[Sequence[TopicRuleIotEventArgs]] = None,
              kafkas: Optional[Sequence[TopicRuleKafkaArgs]] = None,
              kinesis: Optional[TopicRuleKinesisArgs] = None,
              lambda_: Optional[TopicRuleLambdaArgs] = None,
              name: Optional[str] = None,
              republish: Optional[TopicRuleRepublishArgs] = None,
              s3: Optional[TopicRuleS3Args] = None,
              sns: Optional[TopicRuleSnsArgs] = None,
              sql: Optional[str] = None,
              sql_version: Optional[str] = None,
              sqs: Optional[TopicRuleSqsArgs] = None,
              step_functions: Optional[Sequence[TopicRuleStepFunctionArgs]] = None,
              tags: Optional[Mapping[str, str]] = None,
              timestreams: Optional[Sequence[TopicRuleTimestreamArgs]] = None)
@overload
def TopicRule(resource_name: str,
              args: TopicRuleArgs,
              opts: Optional[ResourceOptions] = None)
func NewTopicRule(ctx *Context, name string, args TopicRuleArgs, opts ...ResourceOption) (*TopicRule, error)
public TopicRule(string name, TopicRuleArgs args, CustomResourceOptions? opts = null)
public TopicRule(String name, TopicRuleArgs args)
public TopicRule(String name, TopicRuleArgs args, CustomResourceOptions options)
type: aws:iot:TopicRule
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args TopicRuleArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args TopicRuleArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args TopicRuleArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args TopicRuleArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args TopicRuleArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

TopicRule Resource Properties

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

Inputs

The TopicRule resource accepts the following input properties:

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.

SqlVersion string

The version of the SQL rules engine to use when evaluating the rule.

CloudwatchAlarm TopicRuleCloudwatchAlarmArgs
CloudwatchLogs List<TopicRuleCloudwatchLogArgs>
CloudwatchMetric TopicRuleCloudwatchMetricArgs
Description string

The description of the rule.

Dynamodb TopicRuleDynamodbArgs
Dynamodbv2s List<TopicRuleDynamodbv2Args>
Elasticsearch TopicRuleElasticsearchArgs
ErrorAction TopicRuleErrorActionArgs

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, timestream configuration blocks for further configuration details.

Firehose TopicRuleFirehoseArgs
Https List<TopicRuleHttpArgs>
IotAnalytics List<TopicRuleIotAnalyticArgs>
IotEvents List<TopicRuleIotEventArgs>
Kafkas List<TopicRuleKafkaArgs>
Kinesis TopicRuleKinesisArgs
Lambda TopicRuleLambdaArgs
Name string

The name of the rule.

Republish TopicRuleRepublishArgs
S3 TopicRuleS3Args
Sns TopicRuleSnsArgs
Sqs TopicRuleSqsArgs
StepFunctions List<TopicRuleStepFunctionArgs>
Tags Dictionary<string, string>

Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

Timestreams List<TopicRuleTimestreamArgs>
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.

SqlVersion string

The version of the SQL rules engine to use when evaluating the rule.

CloudwatchAlarm TopicRuleCloudwatchAlarmArgs
CloudwatchLogs []TopicRuleCloudwatchLogArgs
CloudwatchMetric TopicRuleCloudwatchMetricArgs
Description string

The description of the rule.

Dynamodb TopicRuleDynamodbArgs
Dynamodbv2s []TopicRuleDynamodbv2Args
Elasticsearch TopicRuleElasticsearchArgs
ErrorAction TopicRuleErrorActionArgs

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, timestream configuration blocks for further configuration details.

Firehose TopicRuleFirehoseArgs
Https []TopicRuleHttpArgs
IotAnalytics []TopicRuleIotAnalyticArgs
IotEvents []TopicRuleIotEventArgs
Kafkas []TopicRuleKafkaArgs
Kinesis TopicRuleKinesisArgs
Lambda TopicRuleLambdaArgs
Name string

The name of the rule.

Republish TopicRuleRepublishArgs
S3 TopicRuleS3Args
Sns TopicRuleSnsArgs
Sqs TopicRuleSqsArgs
StepFunctions []TopicRuleStepFunctionArgs
Tags map[string]string

Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

Timestreams []TopicRuleTimestreamArgs
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.

sqlVersion String

The version of the SQL rules engine to use when evaluating the rule.

cloudwatchAlarm TopicRuleCloudwatchAlarmArgs
cloudwatchLogs List<TopicRuleCloudwatchLogArgs>
cloudwatchMetric TopicRuleCloudwatchMetricArgs
description String

The description of the rule.

dynamodb TopicRuleDynamodbArgs
dynamodbv2s List<TopicRuleDynamodbv2Args>
elasticsearch TopicRuleElasticsearchArgs
errorAction TopicRuleErrorActionArgs

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, timestream configuration blocks for further configuration details.

firehose TopicRuleFirehoseArgs
https List<TopicRuleHttpArgs>
iotAnalytics List<TopicRuleIotAnalyticArgs>
iotEvents List<TopicRuleIotEventArgs>
kafkas List<TopicRuleKafkaArgs>
kinesis TopicRuleKinesisArgs
lambda TopicRuleLambdaArgs
name String

The name of the rule.

republish TopicRuleRepublishArgs
s3 TopicRuleS3Args
sns TopicRuleSnsArgs
sqs TopicRuleSqsArgs
stepFunctions List<TopicRuleStepFunctionArgs>
tags Map<String,String>

Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

timestreams List<TopicRuleTimestreamArgs>
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.

sqlVersion string

The version of the SQL rules engine to use when evaluating the rule.

cloudwatchAlarm TopicRuleCloudwatchAlarmArgs
cloudwatchLogs TopicRuleCloudwatchLogArgs[]
cloudwatchMetric TopicRuleCloudwatchMetricArgs
description string

The description of the rule.

dynamodb TopicRuleDynamodbArgs
dynamodbv2s TopicRuleDynamodbv2Args[]
elasticsearch TopicRuleElasticsearchArgs
errorAction TopicRuleErrorActionArgs

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, timestream configuration blocks for further configuration details.

firehose TopicRuleFirehoseArgs
https TopicRuleHttpArgs[]
iotAnalytics TopicRuleIotAnalyticArgs[]
iotEvents TopicRuleIotEventArgs[]
kafkas TopicRuleKafkaArgs[]
kinesis TopicRuleKinesisArgs
lambda TopicRuleLambdaArgs
name string

The name of the rule.

republish TopicRuleRepublishArgs
s3 TopicRuleS3Args
sns TopicRuleSnsArgs
sqs TopicRuleSqsArgs
stepFunctions TopicRuleStepFunctionArgs[]
tags {[key: string]: string}

Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

timestreams TopicRuleTimestreamArgs[]
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_alarm TopicRuleCloudwatchAlarmArgs
cloudwatch_logs Sequence[TopicRuleCloudwatchLogArgs]
cloudwatch_metric TopicRuleCloudwatchMetricArgs
description str

The description of the rule.

dynamodb TopicRuleDynamodbArgs
dynamodbv2s Sequence[TopicRuleDynamodbv2Args]
elasticsearch TopicRuleElasticsearchArgs
error_action TopicRuleErrorActionArgs

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, timestream configuration blocks for further configuration details.

firehose TopicRuleFirehoseArgs
https Sequence[TopicRuleHttpArgs]
iot_analytics Sequence[TopicRuleIotAnalyticArgs]
iot_events Sequence[TopicRuleIotEventArgs]
kafkas Sequence[TopicRuleKafkaArgs]
kinesis TopicRuleKinesisArgs
lambda_ TopicRuleLambdaArgs
name str

The name of the rule.

republish TopicRuleRepublishArgs
s3 TopicRuleS3Args
sns TopicRuleSnsArgs
sqs TopicRuleSqsArgs
step_functions Sequence[TopicRuleStepFunctionArgs]
tags Mapping[str, str]

Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

timestreams Sequence[TopicRuleTimestreamArgs]
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.

sqlVersion String

The version of the SQL rules engine to use when evaluating the rule.

cloudwatchAlarm Property Map
cloudwatchLogs List<Property Map>
cloudwatchMetric Property Map
description String

The description of the rule.

dynamodb Property Map
dynamodbv2s List<Property Map>
elasticsearch Property Map
errorAction 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, timestream configuration blocks for further configuration details.

firehose Property Map
https List<Property Map>
iotAnalytics List<Property Map>
iotEvents List<Property Map>
kafkas List<Property Map>
kinesis Property Map
lambda Property Map
name String

The name of the rule.

republish Property Map
s3 Property Map
sns Property Map
sqs Property Map
stepFunctions List<Property Map>
tags Map<String>

Key-value map of resource tags. If configured with a provider default_tags configuration 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:

Arn string

The ARN of the topic rule

Id string

The provider-assigned unique ID for this managed resource.

TagsAll Dictionary<string, string>

A map of tags assigned to the resource, including those inherited from the provider .

Arn string

The ARN of the topic rule

Id string

The provider-assigned unique ID for this managed resource.

TagsAll map[string]string

A map of tags assigned to the resource, including those inherited from the provider .

arn String

The ARN of the topic rule

id String

The provider-assigned unique ID for this managed resource.

tagsAll Map<String,String>

A map of tags assigned to the resource, including those inherited from the provider .

arn string

The ARN of the topic rule

id string

The provider-assigned unique ID for this managed resource.

tagsAll {[key: string]: string}

A map of tags assigned to the resource, including those inherited from the provider .

arn str

The ARN of the topic rule

id str

The provider-assigned unique ID for this managed resource.

tags_all Mapping[str, str]

A map of tags assigned to the resource, including those inherited from the provider .

arn String

The ARN of the topic rule

id String

The provider-assigned unique ID for this managed resource.

tagsAll Map<String>

A map of tags assigned to the resource, including those inherited from the provider .

Look up an 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_alarm: Optional[TopicRuleCloudwatchAlarmArgs] = None,
        cloudwatch_logs: Optional[Sequence[TopicRuleCloudwatchLogArgs]] = None,
        cloudwatch_metric: Optional[TopicRuleCloudwatchMetricArgs] = None,
        description: Optional[str] = None,
        dynamodb: Optional[TopicRuleDynamodbArgs] = None,
        dynamodbv2s: Optional[Sequence[TopicRuleDynamodbv2Args]] = None,
        elasticsearch: Optional[TopicRuleElasticsearchArgs] = None,
        enabled: Optional[bool] = None,
        error_action: Optional[TopicRuleErrorActionArgs] = None,
        firehose: Optional[TopicRuleFirehoseArgs] = None,
        https: Optional[Sequence[TopicRuleHttpArgs]] = None,
        iot_analytics: Optional[Sequence[TopicRuleIotAnalyticArgs]] = None,
        iot_events: Optional[Sequence[TopicRuleIotEventArgs]] = None,
        kafkas: Optional[Sequence[TopicRuleKafkaArgs]] = None,
        kinesis: Optional[TopicRuleKinesisArgs] = None,
        lambda_: Optional[TopicRuleLambdaArgs] = None,
        name: Optional[str] = None,
        republish: Optional[TopicRuleRepublishArgs] = None,
        s3: Optional[TopicRuleS3Args] = None,
        sns: Optional[TopicRuleSnsArgs] = None,
        sql: Optional[str] = None,
        sql_version: Optional[str] = None,
        sqs: Optional[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) -> TopicRule
func 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)
Resource lookup is not supported in YAML
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.
The following state arguments are supported:
Arn string

The ARN of the topic rule

CloudwatchAlarm TopicRuleCloudwatchAlarmArgs
CloudwatchLogs List<TopicRuleCloudwatchLogArgs>
CloudwatchMetric TopicRuleCloudwatchMetricArgs
Description string

The description of the rule.

Dynamodb TopicRuleDynamodbArgs
Dynamodbv2s List<TopicRuleDynamodbv2Args>
Elasticsearch TopicRuleElasticsearchArgs
Enabled bool

Specifies whether the rule is enabled.

ErrorAction TopicRuleErrorActionArgs

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, timestream configuration blocks for further configuration details.

Firehose TopicRuleFirehoseArgs
Https List<TopicRuleHttpArgs>
IotAnalytics List<TopicRuleIotAnalyticArgs>
IotEvents List<TopicRuleIotEventArgs>
Kafkas List<TopicRuleKafkaArgs>
Kinesis TopicRuleKinesisArgs
Lambda TopicRuleLambdaArgs
Name string

The name of the rule.

Republish TopicRuleRepublishArgs
S3 TopicRuleS3Args
Sns TopicRuleSnsArgs
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.

SqlVersion string

The version of the SQL rules engine to use when evaluating the rule.

Sqs TopicRuleSqsArgs
StepFunctions List<TopicRuleStepFunctionArgs>
Tags Dictionary<string, string>

Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

TagsAll Dictionary<string, string>

A map of tags assigned to the resource, including those inherited from the provider .

Timestreams List<TopicRuleTimestreamArgs>
Arn string

The ARN of the topic rule

CloudwatchAlarm TopicRuleCloudwatchAlarmArgs
CloudwatchLogs []TopicRuleCloudwatchLogArgs
CloudwatchMetric TopicRuleCloudwatchMetricArgs
Description string

The description of the rule.

Dynamodb TopicRuleDynamodbArgs
Dynamodbv2s []TopicRuleDynamodbv2Args
Elasticsearch TopicRuleElasticsearchArgs
Enabled bool

Specifies whether the rule is enabled.

ErrorAction TopicRuleErrorActionArgs

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, timestream configuration blocks for further configuration details.

Firehose TopicRuleFirehoseArgs
Https []TopicRuleHttpArgs
IotAnalytics []TopicRuleIotAnalyticArgs
IotEvents []TopicRuleIotEventArgs
Kafkas []TopicRuleKafkaArgs
Kinesis TopicRuleKinesisArgs
Lambda TopicRuleLambdaArgs
Name string

The name of the rule.

Republish TopicRuleRepublishArgs
S3 TopicRuleS3Args
Sns TopicRuleSnsArgs
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.

SqlVersion string

The version of the SQL rules engine to use when evaluating the rule.

Sqs TopicRuleSqsArgs
StepFunctions []TopicRuleStepFunctionArgs
Tags map[string]string

Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

TagsAll map[string]string

A map of tags assigned to the resource, including those inherited from the provider .

Timestreams []TopicRuleTimestreamArgs
arn String

The ARN of the topic rule

cloudwatchAlarm TopicRuleCloudwatchAlarmArgs
cloudwatchLogs List<TopicRuleCloudwatchLogArgs>
cloudwatchMetric TopicRuleCloudwatchMetricArgs
description String

The description of the rule.

dynamodb TopicRuleDynamodbArgs
dynamodbv2s List<TopicRuleDynamodbv2Args>
elasticsearch TopicRuleElasticsearchArgs
enabled Boolean

Specifies whether the rule is enabled.

errorAction TopicRuleErrorActionArgs

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, timestream configuration blocks for further configuration details.

firehose TopicRuleFirehoseArgs
https List<TopicRuleHttpArgs>
iotAnalytics List<TopicRuleIotAnalyticArgs>
iotEvents List<TopicRuleIotEventArgs>
kafkas List<TopicRuleKafkaArgs>
kinesis TopicRuleKinesisArgs
lambda TopicRuleLambdaArgs
name String

The name of the rule.

republish TopicRuleRepublishArgs
s3 TopicRuleS3Args
sns TopicRuleSnsArgs
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.

sqlVersion String

The version of the SQL rules engine to use when evaluating the rule.

sqs TopicRuleSqsArgs
stepFunctions List<TopicRuleStepFunctionArgs>
tags Map<String,String>

Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

tagsAll Map<String,String>

A map of tags assigned to the resource, including those inherited from the provider .

timestreams List<TopicRuleTimestreamArgs>
arn string

The ARN of the topic rule

cloudwatchAlarm TopicRuleCloudwatchAlarmArgs
cloudwatchLogs TopicRuleCloudwatchLogArgs[]
cloudwatchMetric TopicRuleCloudwatchMetricArgs
description string

The description of the rule.

dynamodb TopicRuleDynamodbArgs
dynamodbv2s TopicRuleDynamodbv2Args[]
elasticsearch TopicRuleElasticsearchArgs
enabled boolean

Specifies whether the rule is enabled.

errorAction TopicRuleErrorActionArgs

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, timestream configuration blocks for further configuration details.

firehose TopicRuleFirehoseArgs
https TopicRuleHttpArgs[]
iotAnalytics TopicRuleIotAnalyticArgs[]
iotEvents TopicRuleIotEventArgs[]
kafkas TopicRuleKafkaArgs[]
kinesis TopicRuleKinesisArgs
lambda TopicRuleLambdaArgs
name string

The name of the rule.

republish TopicRuleRepublishArgs
s3 TopicRuleS3Args
sns TopicRuleSnsArgs
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.

sqlVersion string

The version of the SQL rules engine to use when evaluating the rule.

sqs TopicRuleSqsArgs
stepFunctions TopicRuleStepFunctionArgs[]
tags {[key: string]: string}

Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

tagsAll {[key: string]: string}

A map of tags assigned to the resource, including those inherited from the provider .

timestreams TopicRuleTimestreamArgs[]
arn str

The ARN of the topic rule

cloudwatch_alarm TopicRuleCloudwatchAlarmArgs
cloudwatch_logs Sequence[TopicRuleCloudwatchLogArgs]
cloudwatch_metric TopicRuleCloudwatchMetricArgs
description str

The description of the rule.

dynamodb TopicRuleDynamodbArgs
dynamodbv2s Sequence[TopicRuleDynamodbv2Args]
elasticsearch TopicRuleElasticsearchArgs
enabled bool

Specifies whether the rule is enabled.

error_action TopicRuleErrorActionArgs

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, timestream configuration blocks for further configuration details.

firehose TopicRuleFirehoseArgs
https Sequence[TopicRuleHttpArgs]
iot_analytics Sequence[TopicRuleIotAnalyticArgs]
iot_events Sequence[TopicRuleIotEventArgs]
kafkas Sequence[TopicRuleKafkaArgs]
kinesis TopicRuleKinesisArgs
lambda_ TopicRuleLambdaArgs
name str

The name of the rule.

republish TopicRuleRepublishArgs
s3 TopicRuleS3Args
sns TopicRuleSnsArgs
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 TopicRuleSqsArgs
step_functions Sequence[TopicRuleStepFunctionArgs]
tags Mapping[str, str]

Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

tags_all Mapping[str, str]

A map of tags assigned to the resource, including those inherited from the provider .

timestreams Sequence[TopicRuleTimestreamArgs]
arn String

The ARN of the topic rule

cloudwatchAlarm Property Map
cloudwatchLogs List<Property Map>
cloudwatchMetric Property Map
description String

The description of the rule.

dynamodb Property Map
dynamodbv2s List<Property Map>
elasticsearch Property Map
enabled Boolean

Specifies whether the rule is enabled.

errorAction 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, timestream configuration blocks for further configuration details.

firehose Property Map
https List<Property Map>
iotAnalytics List<Property Map>
iotEvents List<Property Map>
kafkas List<Property Map>
kinesis Property Map
lambda Property Map
name String

The name of the rule.

republish Property Map
s3 Property Map
sns 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.

sqlVersion String

The version of the SQL rules engine to use when evaluating the rule.

sqs Property Map
stepFunctions List<Property Map>
tags Map<String>

Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

tagsAll Map<String>

A map of tags assigned to the resource, including those inherited from the provider .

timestreams List<Property Map>

Supporting Types

TopicRuleCloudwatchAlarm

AlarmName string

The CloudWatch alarm name.

RoleArn string

The IAM role ARN that allows access to the CloudWatch alarm.

StateReason string

The reason for the alarm change.

StateValue string

The value of the alarm state. Acceptable values are: OK, ALARM, INSUFFICIENT_DATA.

AlarmName string

The CloudWatch alarm name.

RoleArn string

The IAM role ARN that allows access to the CloudWatch alarm.

StateReason string

The reason for the alarm change.

StateValue string

The value of the alarm state. Acceptable values are: OK, ALARM, INSUFFICIENT_DATA.

alarmName String

The CloudWatch alarm name.

roleArn String

The IAM role ARN that allows access to the CloudWatch alarm.

stateReason String

The reason for the alarm change.

stateValue String

The value of the alarm state. Acceptable values are: OK, ALARM, INSUFFICIENT_DATA.

alarmName string

The CloudWatch alarm name.

roleArn string

The IAM role ARN that allows access to the CloudWatch alarm.

stateReason string

The reason for the alarm change.

stateValue 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.

alarmName String

The CloudWatch alarm name.

roleArn String

The IAM role ARN that allows access to the CloudWatch alarm.

stateReason String

The reason for the alarm change.

stateValue String

The value of the alarm state. Acceptable values are: OK, ALARM, INSUFFICIENT_DATA.

TopicRuleCloudwatchLog

LogGroupName string

The CloudWatch log group name.

RoleArn string

The IAM role ARN that allows access to the CloudWatch alarm.

LogGroupName string

The CloudWatch log group name.

RoleArn string

The IAM role ARN that allows access to the CloudWatch alarm.

logGroupName String

The CloudWatch log group name.

roleArn String

The IAM role ARN that allows access to the CloudWatch alarm.

logGroupName string

The CloudWatch log group name.

roleArn string

The IAM role ARN that allows access to the CloudWatch alarm.

log_group_name str

The CloudWatch log group name.

role_arn str

The IAM role ARN that allows access to the CloudWatch alarm.

logGroupName String

The CloudWatch log group name.

roleArn String

The IAM role ARN that allows access to the CloudWatch alarm.

TopicRuleCloudwatchMetric

MetricName string

The CloudWatch metric name.

MetricNamespace string

The CloudWatch metric namespace name.

MetricUnit string

The metric unit (supported units can be found here: http://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/cloudwatch_concepts.html#Unit)

MetricValue string

The CloudWatch metric value.

RoleArn string

The IAM role ARN that allows access to the CloudWatch metric.

MetricTimestamp string

An optional Unix timestamp (http://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/cloudwatch_concepts.html#about_timestamp).

MetricName string

The CloudWatch metric name.

MetricNamespace string

The CloudWatch metric namespace name.

MetricUnit string

The metric unit (supported units can be found here: http://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/cloudwatch_concepts.html#Unit)

MetricValue string

The CloudWatch metric value.

RoleArn string

The IAM role ARN that allows access to the CloudWatch metric.

MetricTimestamp string

An optional Unix timestamp (http://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/cloudwatch_concepts.html#about_timestamp).

metricName String

The CloudWatch metric name.

metricNamespace String

The CloudWatch metric namespace name.

metricUnit String

The metric unit (supported units can be found here: http://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/cloudwatch_concepts.html#Unit)

metricValue String

The CloudWatch metric value.

roleArn String

The IAM role ARN that allows access to the CloudWatch metric.

metricTimestamp String

An optional Unix timestamp (http://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/cloudwatch_concepts.html#about_timestamp).

metricName string

The CloudWatch metric name.

metricNamespace string

The CloudWatch metric namespace name.

metricUnit string

The metric unit (supported units can be found here: http://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/cloudwatch_concepts.html#Unit)

metricValue string

The CloudWatch metric value.

roleArn string

The IAM role ARN that allows access to the CloudWatch metric.

metricTimestamp 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).

metricName String

The CloudWatch metric name.

metricNamespace String

The CloudWatch metric namespace name.

metricUnit String

The metric unit (supported units can be found here: http://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/cloudwatch_concepts.html#Unit)

metricValue String

The CloudWatch metric value.

roleArn String

The IAM role ARN that allows access to the CloudWatch metric.

metricTimestamp String

An optional Unix timestamp (http://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/cloudwatch_concepts.html#about_timestamp).

TopicRuleDynamodb

HashKeyField string

The hash key name.

HashKeyValue string

The hash key value.

RoleArn string

The ARN of the IAM role that grants access to the DynamoDB table.

TableName string

The name of the DynamoDB table.

HashKeyType string

The hash key type. Valid values are "STRING" or "NUMBER".

Operation string

The operation. Valid values are "INSERT", "UPDATE", or "DELETE".

PayloadField string

The action payload.

RangeKeyField string

The range key name.

RangeKeyType string

The range key type. Valid values are "STRING" or "NUMBER".

RangeKeyValue string

The range key value.

HashKeyField string

The hash key name.

HashKeyValue string

The hash key value.

RoleArn string

The ARN of the IAM role that grants access to the DynamoDB table.

TableName string

The name of the DynamoDB table.

HashKeyType string

The hash key type. Valid values are "STRING" or "NUMBER".

Operation string

The operation. Valid values are "INSERT", "UPDATE", or "DELETE".

PayloadField string

The action payload.

RangeKeyField string

The range key name.

RangeKeyType string

The range key type. Valid values are "STRING" or "NUMBER".

RangeKeyValue string

The range key value.

hashKeyField String

The hash key name.

hashKeyValue String

The hash key value.

roleArn String

The ARN of the IAM role that grants access to the DynamoDB table.

tableName String

The name of the DynamoDB table.

hashKeyType String

The hash key type. Valid values are "STRING" or "NUMBER".

operation String

The operation. Valid values are "INSERT", "UPDATE", or "DELETE".

payloadField String

The action payload.

rangeKeyField String

The range key name.

rangeKeyType String

The range key type. Valid values are "STRING" or "NUMBER".

rangeKeyValue String

The range key value.

hashKeyField string

The hash key name.

hashKeyValue string

The hash key value.

roleArn string

The ARN of the IAM role that grants access to the DynamoDB table.

tableName string

The name of the DynamoDB table.

hashKeyType string

The hash key type. Valid values are "STRING" or "NUMBER".

operation string

The operation. Valid values are "INSERT", "UPDATE", or "DELETE".

payloadField string

The action payload.

rangeKeyField string

The range key name.

rangeKeyType string

The range key type. Valid values are "STRING" or "NUMBER".

rangeKeyValue string

The range key value.

hash_key_field str

The hash key name.

hash_key_value str

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_type str

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_field str

The range key name.

range_key_type str

The range key type. Valid values are "STRING" or "NUMBER".

range_key_value str

The range key value.

hashKeyField String

The hash key name.

hashKeyValue String

The hash key value.

roleArn String

The ARN of the IAM role that grants access to the DynamoDB table.

tableName String

The name of the DynamoDB table.

hashKeyType String

The hash key type. Valid values are "STRING" or "NUMBER".

operation String

The operation. Valid values are "INSERT", "UPDATE", or "DELETE".

payloadField String

The action payload.

rangeKeyField String

The range key name.

rangeKeyType String

The range key type. Valid values are "STRING" or "NUMBER".

rangeKeyValue String

The range key value.

TopicRuleDynamodbv2

RoleArn string

The IAM role ARN that allows access to the CloudWatch alarm.

PutItem TopicRuleDynamodbv2PutItem

Configuration block with DynamoDB Table to which the message will be written. Nested arguments below.

RoleArn string

The IAM role ARN that allows access to the CloudWatch alarm.

PutItem TopicRuleDynamodbv2PutItem

Configuration block with DynamoDB Table to which the message will be written. Nested arguments below.

roleArn String

The IAM role ARN that allows access to the CloudWatch alarm.

putItem TopicRuleDynamodbv2PutItem

Configuration block with DynamoDB Table to which the message will be written. Nested arguments below.

roleArn string

The IAM role ARN that allows access to the CloudWatch alarm.

putItem TopicRuleDynamodbv2PutItem

Configuration block with DynamoDB Table to which the message will be written. Nested arguments below.

role_arn str

The IAM role ARN that allows access to the CloudWatch alarm.

put_item TopicRuleDynamodbv2PutItem

Configuration block with DynamoDB Table to which the message will be written. Nested arguments below.

roleArn String

The IAM role ARN that allows access to the CloudWatch alarm.

putItem Property Map

Configuration block with DynamoDB Table to which the message will be written. Nested arguments below.

TopicRuleDynamodbv2PutItem

TableName string

The name of the DynamoDB table.

TableName string

The name of the DynamoDB table.

tableName String

The name of the DynamoDB table.

tableName string

The name of the DynamoDB table.

table_name str

The name of the DynamoDB table.

tableName String

The name of the DynamoDB table.

TopicRuleElasticsearch

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.

RoleArn 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.

RoleArn 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.

roleArn 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.

roleArn string

The IAM role ARN that has access to Elasticsearch.

type string

The type of document you are storing.

endpoint str

The endpoint of your Elasticsearch domain.

id str

The unique identifier for the document you are storing.

index str

The Elasticsearch index where you want to store your data.

role_arn str

The IAM role ARN that has access to Elasticsearch.

type str

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.

roleArn String

The IAM role ARN that has access to Elasticsearch.

type String

The type of document you are storing.

TopicRuleErrorAction

TopicRuleErrorActionCloudwatchAlarm

AlarmName string

The CloudWatch alarm name.

RoleArn string

The IAM role ARN that allows access to the CloudWatch alarm.

StateReason string

The reason for the alarm change.

StateValue string

The value of the alarm state. Acceptable values are: OK, ALARM, INSUFFICIENT_DATA.

AlarmName string

The CloudWatch alarm name.

RoleArn string

The IAM role ARN that allows access to the CloudWatch alarm.

StateReason string

The reason for the alarm change.

StateValue string

The value of the alarm state. Acceptable values are: OK, ALARM, INSUFFICIENT_DATA.

alarmName String

The CloudWatch alarm name.

roleArn String

The IAM role ARN that allows access to the CloudWatch alarm.

stateReason String

The reason for the alarm change.

stateValue String

The value of the alarm state. Acceptable values are: OK, ALARM, INSUFFICIENT_DATA.

alarmName string

The CloudWatch alarm name.

roleArn string

The IAM role ARN that allows access to the CloudWatch alarm.

stateReason string

The reason for the alarm change.

stateValue 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.

alarmName String

The CloudWatch alarm name.

roleArn String

The IAM role ARN that allows access to the CloudWatch alarm.

stateReason String

The reason for the alarm change.

stateValue String

The value of the alarm state. Acceptable values are: OK, ALARM, INSUFFICIENT_DATA.

TopicRuleErrorActionCloudwatchLogs

LogGroupName string

The CloudWatch log group name.

RoleArn string

The IAM role ARN that allows access to the CloudWatch alarm.

LogGroupName string

The CloudWatch log group name.

RoleArn string

The IAM role ARN that allows access to the CloudWatch alarm.

logGroupName String

The CloudWatch log group name.

roleArn String

The IAM role ARN that allows access to the CloudWatch alarm.

logGroupName string

The CloudWatch log group name.

roleArn string

The IAM role ARN that allows access to the CloudWatch alarm.

log_group_name str

The CloudWatch log group name.

role_arn str

The IAM role ARN that allows access to the CloudWatch alarm.

logGroupName String

The CloudWatch log group name.

roleArn String

The IAM role ARN that allows access to the CloudWatch alarm.

TopicRuleErrorActionCloudwatchMetric

MetricName string

The CloudWatch metric name.

MetricNamespace string

The CloudWatch metric namespace name.

MetricUnit string

The metric unit (supported units can be found here: http://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/cloudwatch_concepts.html#Unit)

MetricValue string

The CloudWatch metric value.

RoleArn string

The IAM role ARN that allows access to the CloudWatch metric.

MetricTimestamp string

An optional Unix timestamp (http://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/cloudwatch_concepts.html#about_timestamp).

MetricName string

The CloudWatch metric name.

MetricNamespace string

The CloudWatch metric namespace name.

MetricUnit string

The metric unit (supported units can be found here: http://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/cloudwatch_concepts.html#Unit)

MetricValue string

The CloudWatch metric value.

RoleArn string

The IAM role ARN that allows access to the CloudWatch metric.

MetricTimestamp string

An optional Unix timestamp (http://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/cloudwatch_concepts.html#about_timestamp).

metricName String

The CloudWatch metric name.

metricNamespace String

The CloudWatch metric namespace name.

metricUnit String

The metric unit (supported units can be found here: http://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/cloudwatch_concepts.html#Unit)

metricValue String

The CloudWatch metric value.

roleArn String

The IAM role ARN that allows access to the CloudWatch metric.

metricTimestamp String

An optional Unix timestamp (http://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/cloudwatch_concepts.html#about_timestamp).

metricName string

The CloudWatch metric name.

metricNamespace string

The CloudWatch metric namespace name.

metricUnit string

The metric unit (supported units can be found here: http://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/cloudwatch_concepts.html#Unit)

metricValue string

The CloudWatch metric value.

roleArn string

The IAM role ARN that allows access to the CloudWatch metric.

metricTimestamp 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).

metricName String

The CloudWatch metric name.

metricNamespace String

The CloudWatch metric namespace name.

metricUnit String

The metric unit (supported units can be found here: http://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/cloudwatch_concepts.html#Unit)

metricValue String

The CloudWatch metric value.

roleArn String

The IAM role ARN that allows access to the CloudWatch metric.

metricTimestamp String

An optional Unix timestamp (http://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/cloudwatch_concepts.html#about_timestamp).

TopicRuleErrorActionDynamodb

HashKeyField string

The hash key name.

HashKeyValue string

The hash key value.

RoleArn string

The ARN of the IAM role that grants access to the DynamoDB table.

TableName string

The name of the DynamoDB table.

HashKeyType string

The hash key type. Valid values are "STRING" or "NUMBER".

Operation string

The operation. Valid values are "INSERT", "UPDATE", or "DELETE".

PayloadField string

The action payload.

RangeKeyField string

The range key name.

RangeKeyType string

The range key type. Valid values are "STRING" or "NUMBER".

RangeKeyValue string

The range key value.

HashKeyField string

The hash key name.

HashKeyValue string

The hash key value.

RoleArn string

The ARN of the IAM role that grants access to the DynamoDB table.

TableName string

The name of the DynamoDB table.

HashKeyType string

The hash key type. Valid values are "STRING" or "NUMBER".

Operation string

The operation. Valid values are "INSERT", "UPDATE", or "DELETE".

PayloadField string

The action payload.

RangeKeyField string

The range key name.

RangeKeyType string

The range key type. Valid values are "STRING" or "NUMBER".

RangeKeyValue string

The range key value.

hashKeyField String

The hash key name.

hashKeyValue String

The hash key value.

roleArn String

The ARN of the IAM role that grants access to the DynamoDB table.

tableName String

The name of the DynamoDB table.

hashKeyType String

The hash key type. Valid values are "STRING" or "NUMBER".

operation String

The operation. Valid values are "INSERT", "UPDATE", or "DELETE".

payloadField String

The action payload.

rangeKeyField String

The range key name.

rangeKeyType String

The range key type. Valid values are "STRING" or "NUMBER".

rangeKeyValue String

The range key value.

hashKeyField string

The hash key name.

hashKeyValue string

The hash key value.

roleArn string

The ARN of the IAM role that grants access to the DynamoDB table.

tableName string

The name of the DynamoDB table.

hashKeyType string

The hash key type. Valid values are "STRING" or "NUMBER".

operation string

The operation. Valid values are "INSERT", "UPDATE", or "DELETE".

payloadField string

The action payload.

rangeKeyField string

The range key name.

rangeKeyType string

The range key type. Valid values are "STRING" or "NUMBER".

rangeKeyValue string

The range key value.

hash_key_field str

The hash key name.

hash_key_value str

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_type str

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_field str

The range key name.

range_key_type str

The range key type. Valid values are "STRING" or "NUMBER".

range_key_value str

The range key value.

hashKeyField String

The hash key name.

hashKeyValue String

The hash key value.

roleArn String

The ARN of the IAM role that grants access to the DynamoDB table.

tableName String

The name of the DynamoDB table.

hashKeyType String

The hash key type. Valid values are "STRING" or "NUMBER".

operation String

The operation. Valid values are "INSERT", "UPDATE", or "DELETE".

payloadField String

The action payload.

rangeKeyField String

The range key name.

rangeKeyType String

The range key type. Valid values are "STRING" or "NUMBER".

rangeKeyValue String

The range key value.

TopicRuleErrorActionDynamodbv2

RoleArn string

The IAM role ARN that allows access to the CloudWatch alarm.

PutItem TopicRuleErrorActionDynamodbv2PutItem

Configuration block with DynamoDB Table to which the message will be written. Nested arguments below.

RoleArn string

The IAM role ARN that allows access to the CloudWatch alarm.

PutItem TopicRuleErrorActionDynamodbv2PutItem

Configuration block with DynamoDB Table to which the message will be written. Nested arguments below.

roleArn String

The IAM role ARN that allows access to the CloudWatch alarm.

putItem TopicRuleErrorActionDynamodbv2PutItem

Configuration block with DynamoDB Table to which the message will be written. Nested arguments below.

roleArn string

The IAM role ARN that allows access to the CloudWatch alarm.

putItem TopicRuleErrorActionDynamodbv2PutItem

Configuration block with DynamoDB Table to which the message will be written. Nested arguments below.

role_arn str

The IAM role ARN that allows access to the CloudWatch alarm.

put_item TopicRuleErrorActionDynamodbv2PutItem

Configuration block with DynamoDB Table to which the message will be written. Nested arguments below.

roleArn String

The IAM role ARN that allows access to the CloudWatch alarm.

putItem Property Map

Configuration block with DynamoDB Table to which the message will be written. Nested arguments below.

TopicRuleErrorActionDynamodbv2PutItem

TableName string

The name of the DynamoDB table.

TableName string

The name of the DynamoDB table.

tableName String

The name of the DynamoDB table.

tableName string

The name of the DynamoDB table.

table_name str

The name of the DynamoDB table.

tableName String

The name of the DynamoDB table.

TopicRuleErrorActionElasticsearch

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.

RoleArn 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.

RoleArn 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.

roleArn 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.

roleArn string

The IAM role ARN that has access to Elasticsearch.

type string

The type of document you are storing.

endpoint str

The endpoint of your Elasticsearch domain.

id str

The unique identifier for the document you are storing.

index str

The Elasticsearch index where you want to store your data.

role_arn str

The IAM role ARN that has access to Elasticsearch.

type str

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.

roleArn String

The IAM role ARN that has access to Elasticsearch.

type String

The type of document you are storing.

TopicRuleErrorActionFirehose

DeliveryStreamName string

The delivery stream name.

RoleArn string

The IAM role ARN that grants access to the Amazon Kinesis Firehose stream.

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).

DeliveryStreamName string

The delivery stream name.

RoleArn string

The IAM role ARN that grants access to the Amazon Kinesis Firehose stream.

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).

deliveryStreamName String

The delivery stream name.

roleArn String

The IAM role ARN that grants access to the Amazon Kinesis Firehose stream.

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).

deliveryStreamName string

The delivery stream name.

roleArn string

The IAM role ARN that grants access to the Amazon Kinesis Firehose stream.

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_name str

The delivery stream name.

role_arn str

The IAM role ARN that grants access to the Amazon Kinesis Firehose stream.

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).

deliveryStreamName String

The delivery stream name.

roleArn String

The IAM role ARN that grants access to the Amazon Kinesis Firehose stream.

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

Url string

The HTTPS URL.

ConfirmationUrl string

The HTTPS URL used to verify ownership of url.

HttpHeaders List<TopicRuleErrorActionHttpHttpHeader>

Custom HTTP header IoT Core should send. It is possible to define more than one custom header.

Url string

The HTTPS URL.

ConfirmationUrl string

The HTTPS URL used to verify ownership of url.

HttpHeaders []TopicRuleErrorActionHttpHttpHeader

Custom HTTP header IoT Core should send. It is possible to define more than one custom header.

url String

The HTTPS URL.

confirmationUrl String

The HTTPS URL used to verify ownership of url.

httpHeaders List<TopicRuleErrorActionHttpHttpHeader>

Custom HTTP header IoT Core should send. It is possible to define more than one custom header.

url string

The HTTPS URL.

confirmationUrl string

The HTTPS URL used to verify ownership of url.

httpHeaders TopicRuleErrorActionHttpHttpHeader[]

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[TopicRuleErrorActionHttpHttpHeader]

Custom HTTP header IoT Core should send. It is possible to define more than one custom header.

url String

The HTTPS URL.

confirmationUrl String

The HTTPS URL used to verify ownership of url.

httpHeaders List<Property Map>

Custom HTTP header IoT Core should send. It is possible to define more than one custom header.

TopicRuleErrorActionHttpHttpHeader

Key string

The name of the HTTP header.

Value string

The value of the HTTP header.

Key string

The name of the HTTP header.

Value string

The value of the HTTP header.

key String

The name of the HTTP header.

value String

The value of the HTTP header.

key string

The name of the HTTP header.

value string

The value of the HTTP header.

key str

The name of the HTTP header.

value str

The value of the HTTP header.

key String

The name of the HTTP header.

value String

The value of the HTTP header.

TopicRuleErrorActionIotAnalytics

ChannelName string

Name of AWS IOT Analytics channel.

RoleArn string

The ARN of the IAM role that grants access.

ChannelName string

Name of AWS IOT Analytics channel.

RoleArn string

The ARN of the IAM role that grants access.

channelName String

Name of AWS IOT Analytics channel.

roleArn String

The ARN of the IAM role that grants access.

channelName string

Name of AWS IOT Analytics channel.

roleArn string

The ARN of the IAM role that grants access.

channel_name str

Name of AWS IOT Analytics channel.

role_arn str

The ARN of the IAM role that grants access.

channelName String

Name of AWS IOT Analytics channel.

roleArn String

The ARN of the IAM role that grants access.

TopicRuleErrorActionIotEvents

InputName string

The name of the AWS IoT Events input.

RoleArn string

The ARN of the IAM role that grants access.

MessageId string

Use this to ensure that only one input (message) with a given messageId is processed by an AWS IoT Events detector.

InputName string

The name of the AWS IoT Events input.

RoleArn string

The ARN of the IAM role that grants access.

MessageId string

Use this to ensure that only one input (message) with a given messageId is processed by an AWS IoT Events detector.

inputName String

The name of the AWS IoT Events input.

roleArn String

The ARN of the IAM role that grants access.

messageId String

Use this to ensure that only one input (message) with a given messageId is processed by an AWS IoT Events detector.

inputName string

The name of the AWS IoT Events input.

roleArn string

The ARN of the IAM role that grants access.

messageId 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.

message_id str

Use this to ensure that only one input (message) with a given messageId is processed by an AWS IoT Events detector.

inputName String

The name of the AWS IoT Events input.

roleArn String

The ARN of the IAM role that grants access.

messageId String

Use this to ensure that only one input (message) with a given messageId is processed by an AWS IoT Events detector.

TopicRuleErrorActionKafka

ClientProperties Dictionary<string, string>

Properties of the Apache Kafka producer client. For more info, see the AWS documentation.

DestinationArn 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.

Key string

The Kafka message key.

Partition string

The Kafka message partition.

ClientProperties map[string]string

Properties of the Apache Kafka producer client. For more info, see the AWS documentation.

DestinationArn 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.

Key string

The Kafka message key.

Partition string

The Kafka message partition.

clientProperties Map<String,String>

Properties of the Apache Kafka producer client. For more info, see the AWS documentation.

destinationArn 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.

key String

The Kafka message key.

partition String

The Kafka message partition.

clientProperties {[key: string]: string}

Properties of the Apache Kafka producer client. For more info, see the AWS documentation.

destinationArn 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.

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.

key str

The Kafka message key.

partition str

The Kafka message partition.

clientProperties Map<String>

Properties of the Apache Kafka producer client. For more info, see the AWS documentation.

destinationArn 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.

key String

The Kafka message key.

partition String

The Kafka message partition.

TopicRuleErrorActionKinesis

RoleArn string

The ARN of the IAM role that grants access to the Amazon Kinesis stream.

StreamName string

The name of the Amazon Kinesis stream.

PartitionKey string

The partition key.

RoleArn string

The ARN of the IAM role that grants access to the Amazon Kinesis stream.

StreamName string

The name of the Amazon Kinesis stream.

PartitionKey string

The partition key.

roleArn String

The ARN of the IAM role that grants access to the Amazon Kinesis stream.

streamName String

The name of the Amazon Kinesis stream.

partitionKey String

The partition key.

roleArn string

The ARN of the IAM role that grants access to the Amazon Kinesis stream.

streamName string

The name of the Amazon Kinesis stream.

partitionKey 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.

roleArn String

The ARN of the IAM role that grants access to the Amazon Kinesis stream.

streamName String

The name of the Amazon Kinesis stream.

partitionKey String

The partition key.

TopicRuleErrorActionLambda

FunctionArn string

The ARN of the Lambda function.

FunctionArn string

The ARN of the Lambda function.

functionArn String

The ARN of the Lambda function.

functionArn string

The ARN of the Lambda function.

function_arn str

The ARN of the Lambda function.

functionArn String

The ARN of the Lambda function.

TopicRuleErrorActionRepublish

RoleArn string

The ARN of the IAM role that grants access.

Topic string

The name of the MQTT topic the message should be republished to.

Qos int

The Quality of Service (QoS) level to use when republishing messages. Valid values are 0 or 1. The default value is 0.

RoleArn string

The ARN of the IAM role that grants access.

Topic string

The name of the MQTT topic the message should be republished to.

Qos int

The Quality of Service (QoS) level to use when republishing messages. Valid values are 0 or 1. The default value is 0.

roleArn String

The ARN of the IAM role that grants access.

topic String

The name of the MQTT topic the message should be republished to.

qos Integer

The Quality of Service (QoS) level to use when republishing messages. Valid values are 0 or 1. The default value is 0.

roleArn string

The ARN of the IAM role that grants access.

topic string

The name of the MQTT topic the message should be republished to.

qos number

The Quality of Service (QoS) level to use when republishing messages. Valid values are 0 or 1. The default value is 0.

role_arn str

The ARN of the IAM role that grants access.

topic str

The name of the MQTT topic the message should be republished to.

qos int

The Quality of Service (QoS) level to use when republishing messages. Valid values are 0 or 1. The default value is 0.

roleArn String

The ARN of the IAM role that grants access.

topic String

The name of the MQTT topic the message should be republished to.

qos Number

The Quality of Service (QoS) level to use when republishing messages. Valid values are 0 or 1. The default value is 0.

TopicRuleErrorActionS3

BucketName string

The Amazon S3 bucket name.

Key string

The name of the HTTP header.

RoleArn string

The IAM role ARN that allows access to the CloudWatch alarm.

CannedAcl string

The Amazon S3 canned ACL that controls access to the object identified by the object key. Valid values.

BucketName string

The Amazon S3 bucket name.

Key string

The name of the HTTP header.

RoleArn string

The IAM role ARN that allows access to the CloudWatch alarm.

CannedAcl string

The Amazon S3 canned ACL that controls access to the object identified by the object key. Valid values.

bucketName String

The Amazon S3 bucket name.

key String

The name of the HTTP header.

roleArn String

The IAM role ARN that allows access to the CloudWatch alarm.

cannedAcl String

The Amazon S3 canned ACL that controls access to the object identified by the object key. Valid values.

bucketName string

The Amazon S3 bucket name.

key string

The name of the HTTP header.

roleArn string

The IAM role ARN that allows access to the CloudWatch alarm.

cannedAcl 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 name of the HTTP header.

role_arn str

The IAM role ARN that allows access to the CloudWatch alarm.

canned_acl str

The Amazon S3 canned ACL that controls access to the object identified by the object key. Valid values.

bucketName String

The Amazon S3 bucket name.

key String

The name of the HTTP header.

roleArn String

The IAM role ARN that allows access to the CloudWatch alarm.

cannedAcl String

The Amazon S3 canned ACL that controls access to the object identified by the object key. Valid values.

TopicRuleErrorActionSns

RoleArn string

The ARN of the IAM role that grants access.

TargetArn string

The ARN of the SNS topic.

MessageFormat string

The message format of the message to publish. Accepted values are "JSON" and "RAW".

RoleArn string

The ARN of the IAM role that grants access.

TargetArn string

The ARN of the SNS topic.

MessageFormat string

The message format of the message to publish. Accepted values are "JSON" and "RAW".

roleArn String

The ARN of the IAM role that grants access.

targetArn String

The ARN of the SNS topic.

messageFormat String

The message format of the message to publish. Accepted values are "JSON" and "RAW".

roleArn string

The ARN of the IAM role that grants access.

targetArn string

The ARN of the SNS topic.

messageFormat 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".

roleArn String

The ARN of the IAM role that grants access.

targetArn String

The ARN of the SNS topic.

messageFormat String

The message format of the message to publish. Accepted values are "JSON" and "RAW".

TopicRuleErrorActionSqs

QueueUrl string

The URL of the Amazon SQS queue.

RoleArn string

The ARN of the IAM role that grants access.

UseBase64 bool

Specifies whether to use Base64 encoding.

QueueUrl string

The URL of the Amazon SQS queue.

RoleArn string

The ARN of the IAM role that grants access.

UseBase64 bool

Specifies whether to use Base64 encoding.

queueUrl String

The URL of the Amazon SQS queue.

roleArn String

The ARN of the IAM role that grants access.

useBase64 Boolean

Specifies whether to use Base64 encoding.

queueUrl string

The URL of the Amazon SQS queue.

roleArn string

The ARN of the IAM role that grants access.

useBase64 boolean

Specifies whether to use Base64 encoding.

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.

queueUrl String

The URL of the Amazon SQS queue.

roleArn String

The ARN of the IAM role that grants access.

useBase64 Boolean

Specifies whether to use Base64 encoding.

TopicRuleErrorActionStepFunctions

RoleArn string

The ARN of the IAM role that grants access to start execution of the state machine.

StateMachineName string

The name of the Step Functions state machine whose execution will be started.

ExecutionNamePrefix string

The prefix used to generate, along with a UUID, the unique state machine execution name.

RoleArn string

The ARN of the IAM role that grants access to start execution of the state machine.

StateMachineName string

The name of the Step Functions state machine whose execution will be started.

ExecutionNamePrefix string

The prefix used to generate, along with a UUID, the unique state machine execution name.

roleArn String

The ARN of the IAM role that grants access to start execution of the state machine.

stateMachineName String

The name of the Step Functions state machine whose execution will be started.

executionNamePrefix String

The prefix used to generate, along with a UUID, the unique state machine execution name.

roleArn string

The ARN of the IAM role that grants access to start execution of the state machine.

stateMachineName string

The name of the Step Functions state machine whose execution will be started.

executionNamePrefix string

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_name str

The name of the Step Functions state machine whose execution will be started.

execution_name_prefix str

The prefix used to generate, along with a UUID, the unique state machine execution name.

roleArn String

The ARN of the IAM role that grants access to start execution of the state machine.

stateMachineName String

The name of the Step Functions state machine whose execution will be started.

executionNamePrefix String

The prefix used to generate, along with a UUID, the unique state machine execution name.

TopicRuleErrorActionTimestream

DatabaseName string

The name of an Amazon Timestream database.

Dimensions List<TopicRuleErrorActionTimestreamDimension>

Configuration blocks with metadata attributes of the time series that are written in each measure record. Nested arguments below.

RoleArn string

The ARN of the role that grants permission to write to the Amazon Timestream database table.

TableName string

The name of the database table into which to write the measure records.

Timestamp TopicRuleErrorActionTimestreamTimestamp

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.

DatabaseName string

The name of an Amazon Timestream database.

Dimensions []TopicRuleErrorActionTimestreamDimension

Configuration blocks with metadata attributes of the time series that are written in each measure record. Nested arguments below.

RoleArn string

The ARN of the role that grants permission to write to the Amazon Timestream database table.

TableName string

The name of the database table into which to write the measure records.

Timestamp TopicRuleErrorActionTimestreamTimestamp

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.

databaseName String

The name of an Amazon Timestream database.

dimensions List<TopicRuleErrorActionTimestreamDimension>

Configuration blocks with metadata attributes of the time series that are written in each measure record. Nested arguments below.

roleArn String

The ARN of the role that grants permission to write to the Amazon Timestream database table.

tableName String

The name of the database table into which to write the measure records.

timestamp TopicRuleErrorActionTimestreamTimestamp

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.

databaseName string

The name of an Amazon Timestream database.

dimensions TopicRuleErrorActionTimestreamDimension[]

Configuration blocks with metadata attributes of the time series that are written in each measure record. Nested arguments below.

roleArn string

The ARN of the role that grants permission to write to the Amazon Timestream database table.

tableName string

The name of the database table into which to write the measure records.

timestamp TopicRuleErrorActionTimestreamTimestamp

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[TopicRuleErrorActionTimestreamDimension]

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 TopicRuleErrorActionTimestreamTimestamp

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.

databaseName 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.

roleArn String

The ARN of the role that grants permission to write to the Amazon Timestream database table.

tableName 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

Name string

The name of the rule.

Value string

The value of the HTTP header.

Name string

The name of the rule.

Value string

The value of the HTTP header.

name String

The name of the rule.

value String

The value of the HTTP header.

name string

The name of the rule.

value string

The value of the HTTP header.

name str

The name of the rule.

value str

The value of the HTTP header.

name String

The name of the rule.

value String

The value of the HTTP header.

TopicRuleErrorActionTimestreamTimestamp

Unit string

The precision of the timestamp value that results from the expression described in value. Valid values: SECONDS, MILLISECONDS, MICROSECONDS, NANOSECONDS.

Value string

The value of the HTTP header.

Unit string

The precision of the timestamp value that results from the expression described in value. Valid values: SECONDS, MILLISECONDS, MICROSECONDS, NANOSECONDS.

Value string

The value of the HTTP header.

unit String

The precision of the timestamp value that results from the expression described in value. Valid values: SECONDS, MILLISECONDS, MICROSECONDS, NANOSECONDS.

value String

The value of the HTTP header.

unit string

The precision of the timestamp value that results from the expression described in value. Valid values: SECONDS, MILLISECONDS, MICROSECONDS, NANOSECONDS.

value string

The value of the HTTP header.

unit str

The precision of the timestamp value that results from the expression described in value. Valid values: SECONDS, MILLISECONDS, MICROSECONDS, NANOSECONDS.

value str

The value of the HTTP header.

unit String

The precision of the timestamp value that results from the expression described in value. Valid values: SECONDS, MILLISECONDS, MICROSECONDS, NANOSECONDS.

value String

The value of the HTTP header.

TopicRuleFirehose

DeliveryStreamName string

The delivery stream name.

RoleArn string

The IAM role ARN that grants access to the Amazon Kinesis Firehose stream.

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).

DeliveryStreamName string

The delivery stream name.

RoleArn string

The IAM role ARN that grants access to the Amazon Kinesis Firehose stream.

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).

deliveryStreamName String

The delivery stream name.

roleArn String

The IAM role ARN that grants access to the Amazon Kinesis Firehose stream.

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).

deliveryStreamName string

The delivery stream name.

roleArn string

The IAM role ARN that grants access to the Amazon Kinesis Firehose stream.

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_name str

The delivery stream name.

role_arn str

The IAM role ARN that grants access to the Amazon Kinesis Firehose stream.

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).

deliveryStreamName String

The delivery stream name.

roleArn String

The IAM role ARN that grants access to the Amazon Kinesis Firehose stream.

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

Url string

The HTTPS URL.

ConfirmationUrl string

The HTTPS URL used to verify ownership of url.

HttpHeaders List<TopicRuleHttpHttpHeader>

Custom HTTP header IoT Core should send. It is possible to define more than one custom header.

Url string

The HTTPS URL.

ConfirmationUrl string

The HTTPS URL used to verify ownership of url.

HttpHeaders []TopicRuleHttpHttpHeader

Custom HTTP header IoT Core should send. It is possible to define more than one custom header.

url String

The HTTPS URL.

confirmationUrl String

The HTTPS URL used to verify ownership of url.

httpHeaders List<TopicRuleHttpHttpHeader>

Custom HTTP header IoT Core should send. It is possible to define more than one custom header.

url string

The HTTPS URL.

confirmationUrl string

The HTTPS URL used to verify ownership of url.

httpHeaders TopicRuleHttpHttpHeader[]

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[TopicRuleHttpHttpHeader]

Custom HTTP header IoT Core should send. It is possible to define more than one custom header.

url String

The HTTPS URL.

confirmationUrl String

The HTTPS URL used to verify ownership of url.

httpHeaders List<Property Map>

Custom HTTP header IoT Core should send. It is possible to define more than one custom header.

TopicRuleHttpHttpHeader

Key string

The name of the HTTP header.

Value string

The value of the HTTP header.

Key string

The name of the HTTP header.

Value string

The value of the HTTP header.

key String

The name of the HTTP header.

value String

The value of the HTTP header.

key string

The name of the HTTP header.

value string

The value of the HTTP header.

key str

The name of the HTTP header.

value str

The value of the HTTP header.

key String

The name of the HTTP header.

value String

The value of the HTTP header.

TopicRuleIotAnalytic

ChannelName string

Name of AWS IOT Analytics channel.

RoleArn string

The ARN of the IAM role that grants access.

ChannelName string

Name of AWS IOT Analytics channel.

RoleArn string

The ARN of the IAM role that grants access.

channelName String

Name of AWS IOT Analytics channel.

roleArn String

The ARN of the IAM role that grants access.

channelName string

Name of AWS IOT Analytics channel.

roleArn string

The ARN of the IAM role that grants access.

channel_name str

Name of AWS IOT Analytics channel.

role_arn str

The ARN of the IAM role that grants access.

channelName String

Name of AWS IOT Analytics channel.

roleArn String

The ARN of the IAM role that grants access.

TopicRuleIotEvent

InputName string

The name of the AWS IoT Events input.

RoleArn string

The ARN of the IAM role that grants access.

MessageId string

Use this to ensure that only one input (message) with a given messageId is processed by an AWS IoT Events detector.

InputName string

The name of the AWS IoT Events input.

RoleArn string

The ARN of the IAM role that grants access.

MessageId string

Use this to ensure that only one input (message) with a given messageId is processed by an AWS IoT Events detector.

inputName String

The name of the AWS IoT Events input.

roleArn String

The ARN of the IAM role that grants access.

messageId String

Use this to ensure that only one input (message) with a given messageId is processed by an AWS IoT Events detector.

inputName string

The name of the AWS IoT Events input.

roleArn string

The ARN of the IAM role that grants access.

messageId 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.

message_id str

Use this to ensure that only one input (message) with a given messageId is processed by an AWS IoT Events detector.

inputName String

The name of the AWS IoT Events input.

roleArn String

The ARN of the IAM role that grants access.

messageId String

Use this to ensure that only one input (message) with a given messageId is processed by an AWS IoT Events detector.

TopicRuleKafka

ClientProperties Dictionary<string, string>

Properties of the Apache Kafka producer client. For more info, see the AWS documentation.

DestinationArn 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.

Key string

The Kafka message key.

Partition string

The Kafka message partition.

ClientProperties map[string]string

Properties of the Apache Kafka producer client. For more info, see the AWS documentation.

DestinationArn 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.

Key string

The Kafka message key.

Partition string

The Kafka message partition.

clientProperties Map<String,String>

Properties of the Apache Kafka producer client. For more info, see the AWS documentation.

destinationArn 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.

key String

The Kafka message key.

partition String

The Kafka message partition.

clientProperties {[key: string]: string}

Properties of the Apache Kafka producer client. For more info, see the AWS documentation.

destinationArn 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.

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.

key str

The Kafka message key.

partition str

The Kafka message partition.

clientProperties Map<String>

Properties of the Apache Kafka producer client. For more info, see the AWS documentation.

destinationArn 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.

key String

The Kafka message key.

partition String

The Kafka message partition.

TopicRuleKinesis

RoleArn string

The ARN of the IAM role that grants access to the Amazon Kinesis stream.

StreamName string

The name of the Amazon Kinesis stream.

PartitionKey string

The partition key.

RoleArn string

The ARN of the IAM role that grants access to the Amazon Kinesis stream.

StreamName string

The name of the Amazon Kinesis stream.

PartitionKey string

The partition key.

roleArn String

The ARN of the IAM role that grants access to the Amazon Kinesis stream.

streamName String

The name of the Amazon Kinesis stream.

partitionKey String

The partition key.

roleArn string

The ARN of the IAM role that grants access to the Amazon Kinesis stream.

streamName string

The name of the Amazon Kinesis stream.

partitionKey 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.

roleArn String

The ARN of the IAM role that grants access to the Amazon Kinesis stream.

streamName String

The name of the Amazon Kinesis stream.

partitionKey String

The partition key.

TopicRuleLambda

FunctionArn string

The ARN of the Lambda function.

FunctionArn string

The ARN of the Lambda function.

functionArn String

The ARN of the Lambda function.

functionArn string

The ARN of the Lambda function.

function_arn str

The ARN of the Lambda function.

functionArn String

The ARN of the Lambda function.

TopicRuleRepublish

RoleArn string

The ARN of the IAM role that grants access.

Topic string

The name of the MQTT topic the message should be republished to.

Qos int

The Quality of Service (QoS) level to use when republishing messages. Valid values are 0 or 1. The default value is 0.

RoleArn string

The ARN of the IAM role that grants access.

Topic string

The name of the MQTT topic the message should be republished to.

Qos int

The Quality of Service (QoS) level to use when republishing messages. Valid values are 0 or 1. The default value is 0.

roleArn String

The ARN of the IAM role that grants access.

topic String

The name of the MQTT topic the message should be republished to.

qos Integer

The Quality of Service (QoS) level to use when republishing messages. Valid values are 0 or 1. The default value is 0.

roleArn string

The ARN of the IAM role that grants access.

topic string

The name of the MQTT topic the message should be republished to.

qos number

The Quality of Service (QoS) level to use when republishing messages. Valid values are 0 or 1. The default value is 0.

role_arn str

The ARN of the IAM role that grants access.

topic str

The name of the MQTT topic the message should be republished to.

qos int

The Quality of Service (QoS) level to use when republishing messages. Valid values are 0 or 1. The default value is 0.

roleArn String

The ARN of the IAM role that grants access.

topic String

The name of the MQTT topic the message should be republished to.

qos Number

The Quality of Service (QoS) level to use when republishing messages. Valid values are 0 or 1. The default value is 0.

TopicRuleS3

BucketName string

The Amazon S3 bucket name.

Key string

The name of the HTTP header.

RoleArn string

The IAM role ARN that allows access to the CloudWatch alarm.

CannedAcl string

The Amazon S3 canned ACL that controls access to the object identified by the object key. Valid values.

BucketName string

The Amazon S3 bucket name.

Key string

The name of the HTTP header.

RoleArn string

The IAM role ARN that allows access to the CloudWatch alarm.

CannedAcl string

The Amazon S3 canned ACL that controls access to the object identified by the object key. Valid values.

bucketName String

The Amazon S3 bucket name.

key String

The name of the HTTP header.

roleArn String

The IAM role ARN that allows access to the CloudWatch alarm.

cannedAcl String

The Amazon S3 canned ACL that controls access to the object identified by the object key. Valid values.

bucketName string

The Amazon S3 bucket name.

key string

The name of the HTTP header.

roleArn string

The IAM role ARN that allows access to the CloudWatch alarm.

cannedAcl 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 name of the HTTP header.

role_arn str

The IAM role ARN that allows access to the CloudWatch alarm.

canned_acl str

The Amazon S3 canned ACL that controls access to the object identified by the object key. Valid values.

bucketName String

The Amazon S3 bucket name.

key String

The name of the HTTP header.

roleArn String

The IAM role ARN that allows access to the CloudWatch alarm.

cannedAcl String

The Amazon S3 canned ACL that controls access to the object identified by the object key. Valid values.

TopicRuleSns

RoleArn string

The ARN of the IAM role that grants access.

TargetArn string

The ARN of the SNS topic.

MessageFormat string

The message format of the message to publish. Accepted values are "JSON" and "RAW".

RoleArn string

The ARN of the IAM role that grants access.

TargetArn string

The ARN of the SNS topic.

MessageFormat string

The message format of the message to publish. Accepted values are "JSON" and "RAW".

roleArn String

The ARN of the IAM role that grants access.

targetArn String

The ARN of the SNS topic.

messageFormat String

The message format of the message to publish. Accepted values are "JSON" and "RAW".

roleArn string

The ARN of the IAM role that grants access.

targetArn string

The ARN of the SNS topic.

messageFormat 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".

roleArn String

The ARN of the IAM role that grants access.

targetArn String

The ARN of the SNS topic.

messageFormat String

The message format of the message to publish. Accepted values are "JSON" and "RAW".

TopicRuleSqs

QueueUrl string

The URL of the Amazon SQS queue.

RoleArn string

The ARN of the IAM role that grants access.

UseBase64 bool

Specifies whether to use Base64 encoding.

QueueUrl string

The URL of the Amazon SQS queue.

RoleArn string

The ARN of the IAM role that grants access.

UseBase64 bool

Specifies whether to use Base64 encoding.

queueUrl String

The URL of the Amazon SQS queue.

roleArn String

The ARN of the IAM role that grants access.

useBase64 Boolean

Specifies whether to use Base64 encoding.

queueUrl string

The URL of the Amazon SQS queue.

roleArn string

The ARN of the IAM role that grants access.

useBase64 boolean

Specifies whether to use Base64 encoding.

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.

queueUrl String

The URL of the Amazon SQS queue.

roleArn String

The ARN of the IAM role that grants access.

useBase64 Boolean

Specifies whether to use Base64 encoding.

TopicRuleStepFunction

RoleArn string

The ARN of the IAM role that grants access to start execution of the state machine.

StateMachineName string

The name of the Step Functions state machine whose execution will be started.

ExecutionNamePrefix string

The prefix used to generate, along with a UUID, the unique state machine execution name.

RoleArn string

The ARN of the IAM role that grants access to start execution of the state machine.

StateMachineName string

The name of the Step Functions state machine whose execution will be started.

ExecutionNamePrefix string

The prefix used to generate, along with a UUID, the unique state machine execution name.

roleArn String

The ARN of the IAM role that grants access to start execution of the state machine.

stateMachineName String

The name of the Step Functions state machine whose execution will be started.

executionNamePrefix String

The prefix used to generate, along with a UUID, the unique state machine execution name.

roleArn string

The ARN of the IAM role that grants access to start execution of the state machine.

stateMachineName string

The name of the Step Functions state machine whose execution will be started.

executionNamePrefix string

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_name str

The name of the Step Functions state machine whose execution will be started.

execution_name_prefix str

The prefix used to generate, along with a UUID, the unique state machine execution name.

roleArn String

The ARN of the IAM role that grants access to start execution of the state machine.

stateMachineName String

The name of the Step Functions state machine whose execution will be started.

executionNamePrefix String

The prefix used to generate, along with a UUID, the unique state machine execution name.

TopicRuleTimestream

DatabaseName string

The name of an Amazon Timestream database.

Dimensions List<TopicRuleTimestreamDimension>

Configuration blocks with metadata attributes of the time series that are written in each measure record. Nested arguments below.

RoleArn string

The ARN of the role that grants permission to write to the Amazon Timestream database table.

TableName string

The name of the database table into which to write the measure records.

Timestamp TopicRuleTimestreamTimestamp

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.

DatabaseName string

The name of an Amazon Timestream database.

Dimensions []TopicRuleTimestreamDimension

Configuration blocks with metadata attributes of the time series that are written in each measure record. Nested arguments below.

RoleArn string

The ARN of the role that grants permission to write to the Amazon Timestream database table.

TableName string

The name of the database table into which to write the measure records.

Timestamp TopicRuleTimestreamTimestamp

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.

databaseName String

The name of an Amazon Timestream database.

dimensions List<TopicRuleTimestreamDimension>

Configuration blocks with metadata attributes of the time series that are written in each measure record. Nested arguments below.

roleArn String

The ARN of the role that grants permission to write to the Amazon Timestream database table.

tableName String

The name of the database table into which to write the measure records.

timestamp TopicRuleTimestreamTimestamp

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.

databaseName string

The name of an Amazon Timestream database.

dimensions TopicRuleTimestreamDimension[]

Configuration blocks with metadata attributes of the time series that are written in each measure record. Nested arguments below.

roleArn string

The ARN of the role that grants permission to write to the Amazon Timestream database table.

tableName string

The name of the database table into which to write the measure records.

timestamp TopicRuleTimestreamTimestamp

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[TopicRuleTimestreamDimension]

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 TopicRuleTimestreamTimestamp

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.

databaseName 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.

roleArn String

The ARN of the role that grants permission to write to the Amazon Timestream database table.

tableName 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

Name string

The name of the rule.

Value string

The value of the HTTP header.

Name string

The name of the rule.

Value string

The value of the HTTP header.

name String

The name of the rule.

value String

The value of the HTTP header.

name string

The name of the rule.

value string

The value of the HTTP header.

name str

The name of the rule.

value str

The value of the HTTP header.

name String

The name of the rule.

value String

The value of the HTTP header.

TopicRuleTimestreamTimestamp

Unit string

The precision of the timestamp value that results from the expression described in value. Valid values: SECONDS, MILLISECONDS, MICROSECONDS, NANOSECONDS.

Value string

The value of the HTTP header.

Unit string

The precision of the timestamp value that results from the expression described in value. Valid values: SECONDS, MILLISECONDS, MICROSECONDS, NANOSECONDS.

Value string

The value of the HTTP header.

unit String

The precision of the timestamp value that results from the expression described in value. Valid values: SECONDS, MILLISECONDS, MICROSECONDS, NANOSECONDS.

value String

The value of the HTTP header.

unit string

The precision of the timestamp value that results from the expression described in value. Valid values: SECONDS, MILLISECONDS, MICROSECONDS, NANOSECONDS.

value string

The value of the HTTP header.

unit str

The precision of the timestamp value that results from the expression described in value. Valid values: SECONDS, MILLISECONDS, MICROSECONDS, NANOSECONDS.

value str

The value of the HTTP header.

unit String

The precision of the timestamp value that results from the expression described in value. Valid values: SECONDS, MILLISECONDS, MICROSECONDS, NANOSECONDS.

value String

The value of the HTTP header.

Package Details

Repository
https://github.com/pulumi/pulumi-aws
License
Apache-2.0
Notes

This Pulumi package is based on the aws Terraform Provider.