Interface CfnTopicRulePropsMixin.TopicRulePayloadProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnTopicRulePropsMixin.TopicRulePayloadProperty.Jsii$Proxy
- Enclosing class:
CfnTopicRulePropsMixin
@Stability(Stable)
public static interface CfnTopicRulePropsMixin.TopicRulePayloadProperty
extends software.amazon.jsii.JsiiSerializable
Describes 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.cfnpropertymixins.services.iot.*;
TopicRulePayloadProperty topicRulePayloadProperty = TopicRulePayloadProperty.builder()
.actions(List.of(ActionProperty.builder()
.cloudwatchAlarm(CloudwatchAlarmActionProperty.builder()
.alarmName("alarmName")
.roleArn("roleArn")
.stateReason("stateReason")
.stateValue("stateValue")
.build())
.cloudwatchLogs(CloudwatchLogsActionProperty.builder()
.batchMode(false)
.logGroupName("logGroupName")
.roleArn("roleArn")
.build())
.cloudwatchMetric(CloudwatchMetricActionProperty.builder()
.metricName("metricName")
.metricNamespace("metricNamespace")
.metricTimestamp("metricTimestamp")
.metricUnit("metricUnit")
.metricValue("metricValue")
.roleArn("roleArn")
.build())
.dynamoDb(DynamoDBActionProperty.builder()
.hashKeyField("hashKeyField")
.hashKeyType("hashKeyType")
.hashKeyValue("hashKeyValue")
.payloadField("payloadField")
.rangeKeyField("rangeKeyField")
.rangeKeyType("rangeKeyType")
.rangeKeyValue("rangeKeyValue")
.roleArn("roleArn")
.tableName("tableName")
.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()
.batchMode(false)
.deliveryStreamName("deliveryStreamName")
.roleArn("roleArn")
.separator("separator")
.build())
.http(HttpActionProperty.builder()
.auth(HttpAuthorizationProperty.builder()
.sigv4(SigV4AuthorizationProperty.builder()
.roleArn("roleArn")
.serviceName("serviceName")
.signingRegion("signingRegion")
.build())
.build())
.batchConfig(BatchConfigProperty.builder()
.maxBatchOpenMs(123)
.maxBatchSize(123)
.maxBatchSizeBytes(123)
.build())
.confirmationUrl("confirmationUrl")
.enableBatching(false)
.headers(List.of(HttpActionHeaderProperty.builder()
.key("key")
.value("value")
.build()))
.url("url")
.build())
.iotAnalytics(IotAnalyticsActionProperty.builder()
.batchMode(false)
.channelName("channelName")
.roleArn("roleArn")
.build())
.iotEvents(IotEventsActionProperty.builder()
.batchMode(false)
.inputName("inputName")
.messageId("messageId")
.roleArn("roleArn")
.build())
.iotSiteWise(IotSiteWiseActionProperty.builder()
.putAssetPropertyValueEntries(List.of(PutAssetPropertyValueEntryProperty.builder()
.assetId("assetId")
.entryId("entryId")
.propertyAlias("propertyAlias")
.propertyId("propertyId")
.propertyValues(List.of(AssetPropertyValueProperty.builder()
.quality("quality")
.timestamp(AssetPropertyTimestampProperty.builder()
.offsetInNanos("offsetInNanos")
.timeInSeconds("timeInSeconds")
.build())
.value(AssetPropertyVariantProperty.builder()
.booleanValue("booleanValue")
.doubleValue("doubleValue")
.integerValue("integerValue")
.stringValue("stringValue")
.build())
.build()))
.build()))
.roleArn("roleArn")
.build())
.kafka(KafkaActionProperty.builder()
.clientProperties(Map.of(
"clientPropertiesKey", "clientProperties"))
.destinationArn("destinationArn")
.headers(List.of(KafkaActionHeaderProperty.builder()
.key("key")
.value("value")
.build()))
.key("key")
.partition("partition")
.topic("topic")
.build())
.kinesis(KinesisActionProperty.builder()
.partitionKey("partitionKey")
.roleArn("roleArn")
.streamName("streamName")
.build())
.lambda(LambdaActionProperty.builder()
.functionArn("functionArn")
.build())
.location(LocationActionProperty.builder()
.deviceId("deviceId")
.latitude("latitude")
.longitude("longitude")
.roleArn("roleArn")
.timestamp(TimestampProperty.builder()
.unit("unit")
.value("value")
.build())
.trackerName("trackerName")
.build())
.openSearch(OpenSearchActionProperty.builder()
.endpoint("endpoint")
.id("id")
.index("index")
.roleArn("roleArn")
.type("type")
.build())
.republish(RepublishActionProperty.builder()
.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)
.roleArn("roleArn")
.topic("topic")
.build())
.s3(S3ActionProperty.builder()
.bucketName("bucketName")
.cannedAcl("cannedAcl")
.key("key")
.roleArn("roleArn")
.build())
.sns(SnsActionProperty.builder()
.messageFormat("messageFormat")
.roleArn("roleArn")
.targetArn("targetArn")
.build())
.sqs(SqsActionProperty.builder()
.queueUrl("queueUrl")
.roleArn("roleArn")
.useBase64(false)
.build())
.stepFunctions(StepFunctionsActionProperty.builder()
.executionNamePrefix("executionNamePrefix")
.roleArn("roleArn")
.stateMachineName("stateMachineName")
.build())
.timestream(TimestreamActionProperty.builder()
.databaseName("databaseName")
.dimensions(List.of(TimestreamDimensionProperty.builder()
.name("name")
.value("value")
.build()))
.roleArn("roleArn")
.tableName("tableName")
.timestamp(TimestreamTimestampProperty.builder()
.unit("unit")
.value("value")
.build())
.build())
.build()))
.awsIotSqlVersion("awsIotSqlVersion")
.description("description")
.errorAction(ActionProperty.builder()
.cloudwatchAlarm(CloudwatchAlarmActionProperty.builder()
.alarmName("alarmName")
.roleArn("roleArn")
.stateReason("stateReason")
.stateValue("stateValue")
.build())
.cloudwatchLogs(CloudwatchLogsActionProperty.builder()
.batchMode(false)
.logGroupName("logGroupName")
.roleArn("roleArn")
.build())
.cloudwatchMetric(CloudwatchMetricActionProperty.builder()
.metricName("metricName")
.metricNamespace("metricNamespace")
.metricTimestamp("metricTimestamp")
.metricUnit("metricUnit")
.metricValue("metricValue")
.roleArn("roleArn")
.build())
.dynamoDb(DynamoDBActionProperty.builder()
.hashKeyField("hashKeyField")
.hashKeyType("hashKeyType")
.hashKeyValue("hashKeyValue")
.payloadField("payloadField")
.rangeKeyField("rangeKeyField")
.rangeKeyType("rangeKeyType")
.rangeKeyValue("rangeKeyValue")
.roleArn("roleArn")
.tableName("tableName")
.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()
.batchMode(false)
.deliveryStreamName("deliveryStreamName")
.roleArn("roleArn")
.separator("separator")
.build())
.http(HttpActionProperty.builder()
.auth(HttpAuthorizationProperty.builder()
.sigv4(SigV4AuthorizationProperty.builder()
.roleArn("roleArn")
.serviceName("serviceName")
.signingRegion("signingRegion")
.build())
.build())
.batchConfig(BatchConfigProperty.builder()
.maxBatchOpenMs(123)
.maxBatchSize(123)
.maxBatchSizeBytes(123)
.build())
.confirmationUrl("confirmationUrl")
.enableBatching(false)
.headers(List.of(HttpActionHeaderProperty.builder()
.key("key")
.value("value")
.build()))
.url("url")
.build())
.iotAnalytics(IotAnalyticsActionProperty.builder()
.batchMode(false)
.channelName("channelName")
.roleArn("roleArn")
.build())
.iotEvents(IotEventsActionProperty.builder()
.batchMode(false)
.inputName("inputName")
.messageId("messageId")
.roleArn("roleArn")
.build())
.iotSiteWise(IotSiteWiseActionProperty.builder()
.putAssetPropertyValueEntries(List.of(PutAssetPropertyValueEntryProperty.builder()
.assetId("assetId")
.entryId("entryId")
.propertyAlias("propertyAlias")
.propertyId("propertyId")
.propertyValues(List.of(AssetPropertyValueProperty.builder()
.quality("quality")
.timestamp(AssetPropertyTimestampProperty.builder()
.offsetInNanos("offsetInNanos")
.timeInSeconds("timeInSeconds")
.build())
.value(AssetPropertyVariantProperty.builder()
.booleanValue("booleanValue")
.doubleValue("doubleValue")
.integerValue("integerValue")
.stringValue("stringValue")
.build())
.build()))
.build()))
.roleArn("roleArn")
.build())
.kafka(KafkaActionProperty.builder()
.clientProperties(Map.of(
"clientPropertiesKey", "clientProperties"))
.destinationArn("destinationArn")
.headers(List.of(KafkaActionHeaderProperty.builder()
.key("key")
.value("value")
.build()))
.key("key")
.partition("partition")
.topic("topic")
.build())
.kinesis(KinesisActionProperty.builder()
.partitionKey("partitionKey")
.roleArn("roleArn")
.streamName("streamName")
.build())
.lambda(LambdaActionProperty.builder()
.functionArn("functionArn")
.build())
.location(LocationActionProperty.builder()
.deviceId("deviceId")
.latitude("latitude")
.longitude("longitude")
.roleArn("roleArn")
.timestamp(TimestampProperty.builder()
.unit("unit")
.value("value")
.build())
.trackerName("trackerName")
.build())
.openSearch(OpenSearchActionProperty.builder()
.endpoint("endpoint")
.id("id")
.index("index")
.roleArn("roleArn")
.type("type")
.build())
.republish(RepublishActionProperty.builder()
.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)
.roleArn("roleArn")
.topic("topic")
.build())
.s3(S3ActionProperty.builder()
.bucketName("bucketName")
.cannedAcl("cannedAcl")
.key("key")
.roleArn("roleArn")
.build())
.sns(SnsActionProperty.builder()
.messageFormat("messageFormat")
.roleArn("roleArn")
.targetArn("targetArn")
.build())
.sqs(SqsActionProperty.builder()
.queueUrl("queueUrl")
.roleArn("roleArn")
.useBase64(false)
.build())
.stepFunctions(StepFunctionsActionProperty.builder()
.executionNamePrefix("executionNamePrefix")
.roleArn("roleArn")
.stateMachineName("stateMachineName")
.build())
.timestream(TimestreamActionProperty.builder()
.databaseName("databaseName")
.dimensions(List.of(TimestreamDimensionProperty.builder()
.name("name")
.value("value")
.build()))
.roleArn("roleArn")
.tableName("tableName")
.timestamp(TimestreamTimestampProperty.builder()
.unit("unit")
.value("value")
.build())
.build())
.build())
.ruleDisabled(false)
.sql("sql")
.build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forCfnTopicRulePropsMixin.TopicRulePayloadPropertystatic final classAn implementation forCfnTopicRulePropsMixin.TopicRulePayloadProperty -
Method Summary
Modifier and TypeMethodDescriptionbuilder()default ObjectThe actions associated with the rule.default StringThe version of the SQL rules engine to use when evaluating the rule.default StringThe description of the rule.default ObjectThe action to take when an error occurs.default ObjectSpecifies whether the rule is disabled.default StringgetSql()The SQL statement used to query the topic.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getActions
The actions associated with the rule.Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnTopicRulePropsMixin.ActionProperty>- See Also:
-
getAwsIotSqlVersion
The version of the SQL rules engine to use when evaluating the rule.The default value is 2015-10-08.
- See Also:
-
getDescription
The description of the rule.- See Also:
-
getErrorAction
The action to take when an error occurs.Returns union: either
IResolvableorCfnTopicRulePropsMixin.ActionProperty- See Also:
-
getRuleDisabled
Specifies whether the rule is disabled.Returns union: either
BooleanorIResolvable- See Also:
-
getSql
The SQL statement used to query the topic.For more information, see AWS IoT SQL Reference in the AWS IoT Developer Guide .
- See Also:
-
builder
-