@pulumi/aws-native
Version:
The Pulumi AWS Cloud Control Provider enables you to build, deploy, and manage [any AWS resource that's supported by the AWS Cloud Control API](https://github.com/pulumi/pulumi-aws-native/blob/master/provider/cmd/pulumi-gen-aws-native/supported-types.txt)
76 lines (75 loc) • 2.93 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Resource Type definition for AWS::IoT::TopicRule
*/
export declare class TopicRule extends pulumi.CustomResource {
/**
* Get an existing TopicRule resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): TopicRule;
/**
* Returns true if the given object is an instance of TopicRule. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is TopicRule;
/**
* The Amazon Resource Name (ARN) of the AWS IoT rule, such as `arn:aws:iot:us-east-2:123456789012:rule/MyIoTRule` .
*/
readonly arn: pulumi.Output<string>;
/**
* The name of the rule.
*/
readonly ruleName: pulumi.Output<string | undefined>;
/**
* Metadata which can be used to manage the topic rule.
*
* > For URI Request parameters use format: ...key1=value1&key2=value2...
* >
* > For the CLI command-line parameter use format: --tags "key1=value1&key2=value2..."
* >
* > For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."
*/
readonly tags: pulumi.Output<outputs.Tag[] | undefined>;
/**
* The rule payload.
*/
readonly topicRulePayload: pulumi.Output<outputs.iot.TopicRulePayload>;
/**
* Create a TopicRule resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: TopicRuleArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a TopicRule resource.
*/
export interface TopicRuleArgs {
/**
* The name of the rule.
*/
ruleName?: pulumi.Input<string>;
/**
* Metadata which can be used to manage the topic rule.
*
* > For URI Request parameters use format: ...key1=value1&key2=value2...
* >
* > For the CLI command-line parameter use format: --tags "key1=value1&key2=value2..."
* >
* > For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."
*/
tags?: pulumi.Input<pulumi.Input<inputs.TagArgs>[]>;
/**
* The rule payload.
*/
topicRulePayload: pulumi.Input<inputs.iot.TopicRulePayloadArgs>;
}