Package software.amazon.awscdk.services.iot

Interface CfnTopicRule.ActionProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTopicRule.ActionProperty.Jsii$Proxy

Enclosing class:

CfnTopicRule

@Stability(Stable)
public static interface CfnTopicRule.ActionProperty
extends software.amazon.jsii.JsiiSerializable

Describes the actions associated with a rule.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.iot.*;
 ActionProperty actionProperty = ActionProperty.builder()
         .cloudwatchAlarm(CloudwatchAlarmActionProperty.builder()
                 .alarmName("alarmName")
                 .roleArn("roleArn")
                 .stateReason("stateReason")
                 .stateValue("stateValue")
                 .build())
         .cloudwatchLogs(CloudwatchLogsActionProperty.builder()
                 .logGroupName("logGroupName")
                 .roleArn("roleArn")
                 // the properties below are optional
                 .batchMode(false)
                 .build())
         .cloudwatchMetric(CloudwatchMetricActionProperty.builder()
                 .metricName("metricName")
                 .metricNamespace("metricNamespace")
                 .metricUnit("metricUnit")
                 .metricValue("metricValue")
                 .roleArn("roleArn")
                 // the properties below are optional
                 .metricTimestamp("metricTimestamp")
                 .build())
         .dynamoDb(DynamoDBActionProperty.builder()
                 .hashKeyField("hashKeyField")
                 .hashKeyValue("hashKeyValue")
                 .roleArn("roleArn")
                 .tableName("tableName")
                 // the properties below are optional
                 .hashKeyType("hashKeyType")
                 .payloadField("payloadField")
                 .rangeKeyField("rangeKeyField")
                 .rangeKeyType("rangeKeyType")
                 .rangeKeyValue("rangeKeyValue")
                 .build())
         .dynamoDBv2(DynamoDBv2ActionProperty.builder()
                 .putItem(PutItemInputProperty.builder()
                         .tableName("tableName")
                         .build())
                 .roleArn("roleArn")
                 .build())
         .elasticsearch(ElasticsearchActionProperty.builder()
                 .endpoint("endpoint")
                 .id("id")
                 .index("index")
                 .roleArn("roleArn")
                 .type("type")
                 .build())
         .firehose(FirehoseActionProperty.builder()
                 .deliveryStreamName("deliveryStreamName")
                 .roleArn("roleArn")
                 // the properties below are optional
                 .batchMode(false)
                 .separator("separator")
                 .build())
         .http(HttpActionProperty.builder()
                 .url("url")
                 // the properties below are optional
                 .auth(HttpAuthorizationProperty.builder()
                         .sigv4(SigV4AuthorizationProperty.builder()
                                 .roleArn("roleArn")
                                 .serviceName("serviceName")
                                 .signingRegion("signingRegion")
                                 .build())
                         .build())
                 .confirmationUrl("confirmationUrl")
                 .headers(List.of(HttpActionHeaderProperty.builder()
                         .key("key")
                         .value("value")
                         .build()))
                 .build())
         .iotAnalytics(IotAnalyticsActionProperty.builder()
                 .channelName("channelName")
                 .roleArn("roleArn")
                 // the properties below are optional
                 .batchMode(false)
                 .build())
         .iotEvents(IotEventsActionProperty.builder()
                 .inputName("inputName")
                 .roleArn("roleArn")
                 // the properties below are optional
                 .batchMode(false)
                 .messageId("messageId")
                 .build())
         .iotSiteWise(IotSiteWiseActionProperty.builder()
                 .putAssetPropertyValueEntries(List.of(PutAssetPropertyValueEntryProperty.builder()
                         .propertyValues(List.of(AssetPropertyValueProperty.builder()
                                 .timestamp(AssetPropertyTimestampProperty.builder()
                                         .timeInSeconds("timeInSeconds")
                                         // the properties below are optional
                                         .offsetInNanos("offsetInNanos")
                                         .build())
                                 .value(AssetPropertyVariantProperty.builder()
                                         .booleanValue("booleanValue")
                                         .doubleValue("doubleValue")
                                         .integerValue("integerValue")
                                         .stringValue("stringValue")
                                         .build())
                                 // the properties below are optional
                                 .quality("quality")
                                 .build()))
                         // the properties below are optional
                         .assetId("assetId")
                         .entryId("entryId")
                         .propertyAlias("propertyAlias")
                         .propertyId("propertyId")
                         .build()))
                 .roleArn("roleArn")
                 .build())
         .kafka(KafkaActionProperty.builder()
                 .clientProperties(Map.of(
                         "clientPropertiesKey", "clientProperties"))
                 .destinationArn("destinationArn")
                 .topic("topic")
                 // the properties below are optional
                 .headers(List.of(KafkaActionHeaderProperty.builder()
                         .key("key")
                         .value("value")
                         .build()))
                 .key("key")
                 .partition("partition")
                 .build())
         .kinesis(KinesisActionProperty.builder()
                 .roleArn("roleArn")
                 .streamName("streamName")
                 // the properties below are optional
                 .partitionKey("partitionKey")
                 .build())
         .lambda(LambdaActionProperty.builder()
                 .functionArn("functionArn")
                 .build())
         .location(LocationActionProperty.builder()
                 .deviceId("deviceId")
                 .latitude("latitude")
                 .longitude("longitude")
                 .roleArn("roleArn")
                 .trackerName("trackerName")
                 // the properties below are optional
                 .timestamp(TimestampProperty.builder()
                         .value("value")
                         // the properties below are optional
                         .unit("unit")
                         .build())
                 .build())
         .openSearch(OpenSearchActionProperty.builder()
                 .endpoint("endpoint")
                 .id("id")
                 .index("index")
                 .roleArn("roleArn")
                 .type("type")
                 .build())
         .republish(RepublishActionProperty.builder()
                 .roleArn("roleArn")
                 .topic("topic")
                 // the properties below are optional
                 .headers(RepublishActionHeadersProperty.builder()
                         .contentType("contentType")
                         .correlationData("correlationData")
                         .messageExpiry("messageExpiry")
                         .payloadFormatIndicator("payloadFormatIndicator")
                         .responseTopic("responseTopic")
                         .userProperties(List.of(UserPropertyProperty.builder()
                                 .key("key")
                                 .value("value")
                                 .build()))
                         .build())
                 .qos(123)
                 .build())
         .s3(S3ActionProperty.builder()
                 .bucketName("bucketName")
                 .key("key")
                 .roleArn("roleArn")
                 // the properties below are optional
                 .cannedAcl("cannedAcl")
                 .build())
         .sns(SnsActionProperty.builder()
                 .roleArn("roleArn")
                 .targetArn("targetArn")
                 // the properties below are optional
                 .messageFormat("messageFormat")
                 .build())
         .sqs(SqsActionProperty.builder()
                 .queueUrl("queueUrl")
                 .roleArn("roleArn")
                 // the properties below are optional
                 .useBase64(false)
                 .build())
         .stepFunctions(StepFunctionsActionProperty.builder()
                 .roleArn("roleArn")
                 .stateMachineName("stateMachineName")
                 // the properties below are optional
                 .executionNamePrefix("executionNamePrefix")
                 .build())
         .timestream(TimestreamActionProperty.builder()
                 .databaseName("databaseName")
                 .dimensions(List.of(TimestreamDimensionProperty.builder()
                         .name("name")
                         .value("value")
                         .build()))
                 .roleArn("roleArn")
                 .tableName("tableName")
                 // the properties below are optional
                 .timestamp(TimestreamTimestampProperty.builder()
                         .unit("unit")
                         .value("value")
                         .build())
                 .build())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-action.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnTopicRule.ActionProperty.Builder	A builder for CfnTopicRule.ActionProperty
static final class	CfnTopicRule.ActionProperty.Jsii$Proxy	An implementation for CfnTopicRule.ActionProperty

Method Summary

Modifier and Type	Method	Description
static CfnTopicRule.ActionProperty.Builder	builder()
default Object	getCloudwatchAlarm()	Change the state of a CloudWatch alarm.
default Object	getCloudwatchLogs()	Sends data to CloudWatch.
default Object	getCloudwatchMetric()	Capture a CloudWatch metric.
default Object	getDynamoDb()	Write to a DynamoDB table.
default Object	getDynamoDBv2()	Write to a DynamoDB table.
default Object	getElasticsearch()	Write data to an Amazon OpenSearch Service domain.
default Object	getFirehose()	Write to an Amazon Kinesis Firehose stream.
default Object	getHttp()	Send data to an HTTPS endpoint.
default Object	getIotAnalytics()	Sends message data to an AWS IoT Analytics channel.
default Object	getIotEvents()	Sends an input to an AWS IoT Events detector.
default Object	getIotSiteWise()	Sends data from the MQTT message that triggered the rule to AWS IoT SiteWise asset properties.
default Object	getKafka()	Send messages to an Amazon Managed Streaming for Apache Kafka (Amazon MSK) or self-managed Apache Kafka cluster.
default Object	getKinesis()	Write data to an Amazon Kinesis stream.
default Object	getLambda()	Invoke a Lambda function.
default Object	getLocation()	Sends device location data to Amazon Location Service .
default Object	getOpenSearch()	Write data to an Amazon OpenSearch Service domain.
default Object	getRepublish()	Publish to another MQTT topic.
default Object	getS3()	Write to an Amazon S3 bucket.
default Object	getSns()	Publish to an Amazon SNS topic.
default Object	getSqs()	Publish to an Amazon SQS queue.
default Object	getStepFunctions()	Starts execution of a Step Functions state machine.
default Object	getTimestream()	Writes attributes from an MQTT message.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCloudwatchAlarm

@Stability(Stable)
@Nullable
default Object getCloudwatchAlarm()

Change the state of a CloudWatch alarm.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-action.html#cfn-iot-topicrule-action-cloudwatchalarm

getCloudwatchLogs

@Stability(Stable)
@Nullable
default Object getCloudwatchLogs()

Sends data to CloudWatch.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-action.html#cfn-iot-topicrule-action-cloudwatchlogs

getCloudwatchMetric

@Stability(Stable)
@Nullable
default Object getCloudwatchMetric()

Capture a CloudWatch metric.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-action.html#cfn-iot-topicrule-action-cloudwatchmetric

getDynamoDb

@Stability(Stable)
@Nullable
default Object getDynamoDb()

Write to a DynamoDB table.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-action.html#cfn-iot-topicrule-action-dynamodb

getDynamoDBv2

@Stability(Stable)
@Nullable
default Object getDynamoDBv2()

Write to a DynamoDB table.

This is a new version of the DynamoDB action. It allows you to write each attribute in an MQTT message payload into a separate DynamoDB column.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-action.html#cfn-iot-topicrule-action-dynamodbv2

getElasticsearch

@Stability(Stable)
@Nullable
default Object getElasticsearch()

Write data to an Amazon OpenSearch Service domain.

The Elasticsearch action can only be used by existing rule actions. To create a new rule action or to update an existing rule action, use the OpenSearch rule action instead. For more information, see OpenSearchAction .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-action.html#cfn-iot-topicrule-action-elasticsearch

getFirehose

@Stability(Stable)
@Nullable
default Object getFirehose()

Write to an Amazon Kinesis Firehose stream.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-action.html#cfn-iot-topicrule-action-firehose

getHttp

@Stability(Stable)
@Nullable
default Object getHttp()

Send data to an HTTPS endpoint.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-action.html#cfn-iot-topicrule-action-http

getIotAnalytics

@Stability(Stable)
@Nullable
default Object getIotAnalytics()

Sends message data to an AWS IoT Analytics channel.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-action.html#cfn-iot-topicrule-action-iotanalytics

getIotEvents

@Stability(Stable)
@Nullable
default Object getIotEvents()

Sends an input to an AWS IoT Events detector.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-action.html#cfn-iot-topicrule-action-iotevents

getIotSiteWise

@Stability(Stable)
@Nullable
default Object getIotSiteWise()

Sends data from the MQTT message that triggered the rule to AWS IoT SiteWise asset properties.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-action.html#cfn-iot-topicrule-action-iotsitewise

getKafka

@Stability(Stable)
@Nullable
default Object getKafka()

Send messages to an Amazon Managed Streaming for Apache Kafka (Amazon MSK) or self-managed Apache Kafka cluster.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-action.html#cfn-iot-topicrule-action-kafka

getKinesis

@Stability(Stable)
@Nullable
default Object getKinesis()

Write data to an Amazon Kinesis stream.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-action.html#cfn-iot-topicrule-action-kinesis

getLambda

@Stability(Stable)
@Nullable
default Object getLambda()

Invoke a Lambda function.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-action.html#cfn-iot-topicrule-action-lambda

getLocation

@Stability(Stable)
@Nullable
default Object getLocation()

Sends device location data to Amazon Location Service .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-action.html#cfn-iot-topicrule-action-location

getOpenSearch

@Stability(Stable)
@Nullable
default Object getOpenSearch()

Write data to an Amazon OpenSearch Service domain.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-action.html#cfn-iot-topicrule-action-opensearch

getRepublish

@Stability(Stable)
@Nullable
default Object getRepublish()

Publish to another MQTT topic.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-action.html#cfn-iot-topicrule-action-republish

getS3

@Stability(Stable)
@Nullable
default Object getS3()

Write to an Amazon S3 bucket.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-action.html#cfn-iot-topicrule-action-s3

getSns

@Stability(Stable)
@Nullable
default Object getSns()

Publish to an Amazon SNS topic.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-action.html#cfn-iot-topicrule-action-sns

getSqs

@Stability(Stable)
@Nullable
default Object getSqs()

Publish to an Amazon SQS queue.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-action.html#cfn-iot-topicrule-action-sqs

getStepFunctions

@Stability(Stable)
@Nullable
default Object getStepFunctions()

Starts execution of a Step Functions state machine.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-action.html#cfn-iot-topicrule-action-stepfunctions

getTimestream

@Stability(Stable)
@Nullable
default Object getTimestream()

Writes attributes from an MQTT message.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iot-topicrule-action.html#cfn-iot-topicrule-action-timestream

builder

@Stability(Stable)
static CfnTopicRule.ActionProperty.Builder builder()

Returns:

a CfnTopicRule.ActionProperty.Builder of CfnTopicRule.ActionProperty