CfnTopicRule (software.amazon.awscdk:aws-cdk-lib 2.3.0 API)

java.lang.Object
- software.amazon.jsii.JsiiObject
- - software.constructs.Construct
  - - software.amazon.awscdk.CfnElement
    - - software.amazon.awscdk.CfnRefElement
      - software.amazon.awscdk.CfnResource
        
        software.amazon.awscdk.services.iot.CfnTopicRule

All Implemented Interfaces:: IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.47.0 (build 86d2c33)",
           date="2021-12-22T10:27:17.995Z")
 @Stability(value=Stable)
public class CfnTopicRule
extends CfnResource
implements IInspectable

A CloudFormation `AWS::IoT::TopicRule`.

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.*;
 CfnTopicRule cfnTopicRule = CfnTopicRule.Builder.create(this, "MyCfnTopicRule")
         .topicRulePayload(TopicRulePayloadProperty.builder()
                 .actions(List.of(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()))
                 .sql("sql")
                 // the properties below are optional
                 .awsIotSqlVersion("awsIotSqlVersion")
                 .description("description")
                 .errorAction(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())
                 .ruleDisabled(false)
                 .build())
         // the properties below are optional
         .ruleName("ruleName")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CfnTopicRule.ActionProperty` Example:
`static interface`	`CfnTopicRule.AssetPropertyTimestampProperty` Example:
`static interface`	`CfnTopicRule.AssetPropertyValueProperty` Example:
`static interface`	`CfnTopicRule.AssetPropertyVariantProperty` Example:
`static class`	`CfnTopicRule.Builder` A fluent builder for `CfnTopicRule`.
`static interface`	`CfnTopicRule.CloudwatchAlarmActionProperty` Example:
`static interface`	`CfnTopicRule.CloudwatchLogsActionProperty` Example:
`static interface`	`CfnTopicRule.CloudwatchMetricActionProperty` Example:
`static interface`	`CfnTopicRule.DynamoDBActionProperty` Example:
`static interface`	`CfnTopicRule.DynamoDBv2ActionProperty` Example:
`static interface`	`CfnTopicRule.ElasticsearchActionProperty` Example:
`static interface`	`CfnTopicRule.FirehoseActionProperty` Example:
`static interface`	`CfnTopicRule.HttpActionHeaderProperty` Example:
`static interface`	`CfnTopicRule.HttpActionProperty` Example:
`static interface`	`CfnTopicRule.HttpAuthorizationProperty` Example:
`static interface`	`CfnTopicRule.IotAnalyticsActionProperty` Example:
`static interface`	`CfnTopicRule.IotEventsActionProperty` Example:
`static interface`	`CfnTopicRule.IotSiteWiseActionProperty` Example:
`static interface`	`CfnTopicRule.KafkaActionProperty` Example:
`static interface`	`CfnTopicRule.KinesisActionProperty` Example:
`static interface`	`CfnTopicRule.LambdaActionProperty` Example:
`static interface`	`CfnTopicRule.OpenSearchActionProperty` Example:
`static interface`	`CfnTopicRule.PutAssetPropertyValueEntryProperty` Example:
`static interface`	`CfnTopicRule.PutItemInputProperty` Example:
`static interface`	`CfnTopicRule.RepublishActionProperty` Example:
`static interface`	`CfnTopicRule.S3ActionProperty` Example:
`static interface`	`CfnTopicRule.SigV4AuthorizationProperty` Example:
`static interface`	`CfnTopicRule.SnsActionProperty` Example:
`static interface`	`CfnTopicRule.SqsActionProperty` Example:
`static interface`	`CfnTopicRule.StepFunctionsActionProperty` Example:
`static interface`	`CfnTopicRule.TimestreamActionProperty` Example:
`static interface`	`CfnTopicRule.TimestreamDimensionProperty` Example:
`static interface`	`CfnTopicRule.TimestreamTimestampProperty` Example:
`static interface`	`CfnTopicRule.TopicRulePayloadProperty` Example:

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default

Field Summary

Fields
Modifier and Type Field and Description

static String CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.

Fields
Modifier and Type	Field and Description
`static String`	`CFN_RESOURCE_TYPE_NAME` The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors
Modifier	Constructor and Description
	`CfnTopicRule(software.constructs.Construct scope, String id, CfnTopicRuleProps props)` Create a new `AWS::IoT::TopicRule`.
`protected`	`CfnTopicRule(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)`
`protected`	`CfnTopicRule(software.amazon.jsii.JsiiObjectRef objRef)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getAttrArn()`
`protected Map<String,Object>`	`getCfnProperties()`
`String`	`getRuleName()` `AWS::IoT::TopicRule.RuleName`.
`TagManager`	`getTags()` `AWS::IoT::TopicRule.Tags`.
`Object`	`getTopicRulePayload()` `AWS::IoT::TopicRule.TopicRulePayload`.
`void`	`inspect(TreeInspector inspector)` Examines the CloudFormation resource and discloses attributes.
`protected Map<String,Object>`	`renderProperties(Map<String,Object> props)`
`void`	`setRuleName(String value)` `AWS::IoT::TopicRule.RuleName`.
`void`	`setTopicRulePayload(CfnTopicRule.TopicRulePayloadProperty value)` `AWS::IoT::TopicRule.TopicRulePayload`.
`void`	`setTopicRulePayload(IResolvable value)` `AWS::IoT::TopicRule.TopicRulePayload`.

Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement
getRef

Methods inherited from class software.amazon.awscdk.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct
getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson

Field Detail
- CFN_RESOURCE_TYPE_NAME
```
@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME
```
  The CloudFormation resource type name for this resource class.

Constructor Detail

CfnTopicRule

protected CfnTopicRule(software.amazon.jsii.JsiiObjectRef objRef)

CfnTopicRule

protected CfnTopicRule(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnTopicRule

@Stability(value=Stable)
public CfnTopicRule(@NotNull
                                             software.constructs.Construct scope,
                                             @NotNull
                                             String id,
                                             @NotNull
                                             CfnTopicRuleProps props)

Create a new `AWS::IoT::TopicRule`.

Parameters:: scope - - scope in which this resource is defined. This parameter is required.; id - - scoped id of the resource. This parameter is required.; props - - resource properties. This parameter is required.

Method Detail

inspect
```
@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)
```
Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:: renderProperties in class CfnResource
Parameters:: props - This parameter is required.

getAttrArn

@Stability(value=Stable)
 @NotNull
public String getAttrArn()

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:: getCfnProperties in class CfnResource

getRuleName

@Stability(value=Stable)
 @Nullable
public String getRuleName()

`AWS::IoT::TopicRule.RuleName`.

setRuleName

@Stability(value=Stable)
public void setRuleName(@Nullable
                                                 String value)

`AWS::IoT::TopicRule.RuleName`.

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

`AWS::IoT::TopicRule.Tags`.

getTopicRulePayload

@Stability(value=Stable)
 @NotNull
public Object getTopicRulePayload()

`AWS::IoT::TopicRule.TopicRulePayload`.

setTopicRulePayload

@Stability(value=Stable)
public void setTopicRulePayload(@NotNull
                                                         CfnTopicRule.TopicRulePayloadProperty value)

`AWS::IoT::TopicRule.TopicRulePayload`.

setTopicRulePayload

@Stability(value=Stable)
public void setTopicRulePayload(@NotNull
                                                         IResolvable value)

`AWS::IoT::TopicRule.TopicRulePayload`.

Class CfnTopicRule

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

Nested classes/interfaces inherited from interface software.constructs.IConstruct

Field Summary

Constructor Summary

Method Summary

Methods inherited from class software.amazon.awscdk.CfnResource

Methods inherited from class software.amazon.awscdk.CfnRefElement

Methods inherited from class software.amazon.awscdk.CfnElement

Methods inherited from class software.constructs.Construct

Methods inherited from class software.amazon.jsii.JsiiObject

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Field Detail

CFN_RESOURCE_TYPE_NAME

Constructor Detail

CfnTopicRule

CfnTopicRule

CfnTopicRule

Method Detail

inspect

renderProperties

getAttrArn

getCfnProperties

getRuleName

setRuleName

getTags

getTopicRulePayload

setTopicRulePayload

setTopicRulePayload