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(value=Stable)
public static interface CfnTopicRule.ActionProperty
extends software.amazon.jsii.JsiiSerializable

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")
                 .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
                 .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())
         .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
                 .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
                 .batchMode(false)
                 .timestamp(TimestreamTimestampProperty.builder()
                         .unit("unit")
                         .value("value")
                         .build())
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnTopicRule.ActionProperty.Builder	builder()
default Object	getCloudwatchAlarm() `CfnTopicRule.ActionProperty.CloudwatchAlarm`.
default Object	getCloudwatchLogs() `CfnTopicRule.ActionProperty.CloudwatchLogs`.
default Object	getCloudwatchMetric() `CfnTopicRule.ActionProperty.CloudwatchMetric`.
default Object	getDynamoDb() `CfnTopicRule.ActionProperty.DynamoDB`.
default Object	getDynamoDBv2() `CfnTopicRule.ActionProperty.DynamoDBv2`.
default Object	getElasticsearch() `CfnTopicRule.ActionProperty.Elasticsearch`.
default Object	getFirehose() `CfnTopicRule.ActionProperty.Firehose`.
default Object	getHttp() `CfnTopicRule.ActionProperty.Http`.
default Object	getIotAnalytics() `CfnTopicRule.ActionProperty.IotAnalytics`.
default Object	getIotEvents() `CfnTopicRule.ActionProperty.IotEvents`.
default Object	getIotSiteWise() `CfnTopicRule.ActionProperty.IotSiteWise`.
default Object	getKafka() `CfnTopicRule.ActionProperty.Kafka`.
default Object	getKinesis() `CfnTopicRule.ActionProperty.Kinesis`.
default Object	getLambda() `CfnTopicRule.ActionProperty.Lambda`.
default Object	getOpenSearch() `CfnTopicRule.ActionProperty.OpenSearch`.
default Object	getRepublish() `CfnTopicRule.ActionProperty.Republish`.
default Object	getS3() `CfnTopicRule.ActionProperty.S3`.
default Object	getSns() `CfnTopicRule.ActionProperty.Sns`.
default Object	getSqs() `CfnTopicRule.ActionProperty.Sqs`.
default Object	getStepFunctions() `CfnTopicRule.ActionProperty.StepFunctions`.
default Object	getTimestream() `CfnTopicRule.ActionProperty.Timestream`.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getCloudwatchAlarm

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

`CfnTopicRule.ActionProperty.CloudwatchAlarm`.

getCloudwatchLogs

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

`CfnTopicRule.ActionProperty.CloudwatchLogs`.

getCloudwatchMetric

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

`CfnTopicRule.ActionProperty.CloudwatchMetric`.

getDynamoDb

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

`CfnTopicRule.ActionProperty.DynamoDB`.

getDynamoDBv2

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

`CfnTopicRule.ActionProperty.DynamoDBv2`.

getElasticsearch

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

`CfnTopicRule.ActionProperty.Elasticsearch`.

getFirehose

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

`CfnTopicRule.ActionProperty.Firehose`.

getHttp

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

`CfnTopicRule.ActionProperty.Http`.

getIotAnalytics

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

`CfnTopicRule.ActionProperty.IotAnalytics`.

getIotEvents

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

`CfnTopicRule.ActionProperty.IotEvents`.

getIotSiteWise

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

`CfnTopicRule.ActionProperty.IotSiteWise`.

getKafka

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

`CfnTopicRule.ActionProperty.Kafka`.

getKinesis

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

`CfnTopicRule.ActionProperty.Kinesis`.

getLambda

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

`CfnTopicRule.ActionProperty.Lambda`.

getOpenSearch

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

`CfnTopicRule.ActionProperty.OpenSearch`.

getRepublish

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

`CfnTopicRule.ActionProperty.Republish`.

getS3

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

`CfnTopicRule.ActionProperty.S3`.

getSns

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

`CfnTopicRule.ActionProperty.Sns`.

getSqs

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

`CfnTopicRule.ActionProperty.Sqs`.

getStepFunctions

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

`CfnTopicRule.ActionProperty.StepFunctions`.

getTimestream

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

`CfnTopicRule.ActionProperty.Timestream`.

builder

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

Returns:

a CfnTopicRule.ActionProperty.Builder of CfnTopicRule.ActionProperty