@aws-cdk_aws-iot-alpha.ITopicRule

interface ITopicRule ๐Ÿ”น

LanguageType name
.NETAmazon.CDK.AWS.IoT.Alpha.ITopicRule
Gogithub.com/aws/aws-cdk-go/awscdkiotalpha/v2#ITopicRule
Javasoftware.amazon.awscdk.services.iot.alpha.ITopicRule
Pythonaws_cdk.aws_iot_alpha.ITopicRule
TypeScript (source)@aws-cdk/aws-iot-alpha ยป ITopicRule

Implemented by TopicRule

Obtainable from TopicRule.fromTopicRuleArn()

Represents an AWS IoT Rule.

Properties

NameTypeDescription
env๐Ÿ”นResourceEnvironmentThe environment this resource belongs to.
node๐Ÿ”นNodeThe tree node.
stack๐Ÿ”นStackThe stack in which this resource is defined.
topicRuleArn๐Ÿ”นstringThe value of the topic rule Amazon Resource Name (ARN), such as arn:aws:iot:us-east-2:123456789012:rule/rule_name.
topicRuleName๐Ÿ”นstringThe name topic rule.

env๐Ÿ”น

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.


node๐Ÿ”น

Type: Node

The tree node.


stack๐Ÿ”น

Type: Stack

The stack in which this resource is defined.


topicRuleArn๐Ÿ”น

Type: string

The value of the topic rule Amazon Resource Name (ARN), such as arn:aws:iot:us-east-2:123456789012:rule/rule_name.


topicRuleName๐Ÿ”น

Type: string

The name topic rule.

Methods

NameDescription
applyRemovalPolicy(policy)๐Ÿ”นApply the given removal policy to this resource.

applyRemovalPolicy(policy)๐Ÿ”น

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

  • policy RemovalPolicy

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).