Class CfnTopicRulePropsMixin
java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.Mixin
software.amazon.awscdk.cfnpropertymixins.services.iot.CfnTopicRulePropsMixin
- All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable,software.constructs.IMixin
@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
date="2026-03-11T13:20:00.232Z")
@Stability(Stable)
public class CfnTopicRulePropsMixin
extends Mixin
implements software.constructs.IMixin
Use the
AWS::IoT::TopicRule resource to declare an AWS IoT rule.
For information about working with AWS IoT rules, see Rules for AWS IoT in the AWS IoT Developer Guide .
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.*;
import software.amazon.awscdk.*;
IMergeStrategy mergeStrategy;
CfnTopicRulePropsMixin cfnTopicRulePropsMixin = CfnTopicRulePropsMixin.Builder.create(CfnTopicRuleMixinProps.builder()
.ruleName("ruleName")
.tags(List.of(CfnTag.builder()
.key("key")
.value("value")
.build()))
.topicRulePayload(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())
.build())
.strategy(mergeStrategy)
.build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic interfaceDescribes the actions associated with a rule.static interfaceAn asset property timestamp entry containing the following information.static interfaceAn asset property value entry containing the following information.static interfaceContains an asset property value (of a single type).static interfaceExample:static final classA fluent builder forCfnTopicRulePropsMixin.static interfaceDescribes an action that updates a CloudWatch alarm.static interfaceDescribes an action that updates a CloudWatch log.static interfaceDescribes an action that captures a CloudWatch metric.static interfaceDescribes an action to write to a DynamoDB table.static interfaceDescribes an action to write to a DynamoDB table.static interfaceDescribes an action that writes data to an Amazon OpenSearch Service domain.static interfaceDescribes an action that writes data to an Amazon Kinesis Firehose stream.static interfaceThe HTTP action header.static interfaceSend data to an HTTPS endpoint.static interfaceThe authorization method used to send messages.static interfaceSends message data to an AWS IoT Analytics channel.static interfaceSends an input to an AWS IoT Events detector.static interfaceDescribes an action to send data from an MQTT message that triggered the rule to AWS IoT SiteWise asset properties.static interfaceSpecifies a Kafka header using key-value pairs when you create a Rule’s Kafka Action.static interfaceSend messages to an Amazon Managed Streaming for Apache Kafka (Amazon MSK) or self-managed Apache Kafka cluster.static interfaceDescribes an action to write data to an Amazon Kinesis stream.static interfaceDescribes an action to invoke a Lambda function.static interfaceDescribes an action to send device location updates from an MQTT message to an Amazon Location tracker resource.static interfaceDescribes an action that writes data to an Amazon OpenSearch Service domain.static interfaceAn asset property value entry containing the following information.static interfaceThe input for the DynamoActionVS action that specifies the DynamoDB table to which the message data will be written.static interfaceSpecifies MQTT Version 5.0 headers information.static interfaceDescribes an action to republish to another topic.static interfaceDescribes an action to write data to an Amazon S3 bucket.static interfaceFor more information, see Signature Version 4 signing process .static interfaceDescribes an action to publish to an Amazon SNS topic.static interfaceDescribes an action to publish data to an Amazon SQS queue.static interfaceStarts execution of a Step Functions state machine.static interfaceDescribes how to interpret an application-defined timestamp value from an MQTT message payload and the precision of that value.static interfaceDescribes an action that writes records into an Amazon Timestream table.static interfaceMetadata attributes of the time series that are written in each measure record.static interfaceThe value to use for the entry's timestamp.static interfaceDescribes a rule.static interfaceA key-value pair that you define in the header.Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationModeNested classes/interfaces inherited from interface software.constructs.IMixin
software.constructs.IMixin.Jsii$Default, software.constructs.IMixin.Jsii$Proxy -
Field Summary
Fields -
Constructor Summary
ConstructorsModifierConstructorDescriptionCreate a mixin to apply properties toAWS::IoT::TopicRule.CfnTopicRulePropsMixin(CfnTopicRuleMixinProps props, CfnPropertyMixinOptions options) Create a mixin to apply properties toAWS::IoT::TopicRule.protectedCfnTopicRulePropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protectedCfnTopicRulePropsMixin(software.amazon.jsii.JsiiObjectRef objRef) -
Method Summary
Modifier and TypeMethodDescriptionvoidapplyTo(software.constructs.IConstruct construct) Apply the mixin properties to the construct.protected CfnTopicRuleMixinPropsgetProps()protected IMergeStrategysupports(software.constructs.IConstruct construct) Check if this mixin supports the given construct.Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSetMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
CFN_PROPERTY_KEYS
-
-
Constructor Details
-
CfnTopicRulePropsMixin
protected CfnTopicRulePropsMixin(software.amazon.jsii.JsiiObjectRef objRef) -
CfnTopicRulePropsMixin
protected CfnTopicRulePropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnTopicRulePropsMixin
@Stability(Stable) public CfnTopicRulePropsMixin(@NotNull CfnTopicRuleMixinProps props, @Nullable CfnPropertyMixinOptions options) Create a mixin to apply properties toAWS::IoT::TopicRule.- Parameters:
props- L1 properties to apply. This parameter is required.options- Mixin options.
-
CfnTopicRulePropsMixin
Create a mixin to apply properties toAWS::IoT::TopicRule.- Parameters:
props- L1 properties to apply. This parameter is required.
-
-
Method Details
-
applyTo
@Stability(Stable) public void applyTo(@NotNull software.constructs.IConstruct construct) Apply the mixin properties to the construct. -
supports
@Stability(Stable) @NotNull public Boolean supports(@NotNull software.constructs.IConstruct construct) Check if this mixin supports the given construct. -
getProps
-
getStrategy
-