UNPKG

@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)

143 lines (142 loc) 4.55 kB
import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * Resource Type definition for AWS::IoTAnalytics::Channel * * ## Example Usage * ### Example * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as aws_native from "@pulumi/aws-native"; * * const channel = new aws_native.iotanalytics.Channel("channel", {channelName: "SimpleChannel"}); * * ``` * ### Example * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as aws_native from "@pulumi/aws-native"; * * const channel = new aws_native.iotanalytics.Channel("channel", {channelName: "SimpleChannel"}); * * ``` * ### Example * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as aws_native from "@pulumi/aws-native"; * * const channel = new aws_native.iotanalytics.Channel("channel", { * channelName: "ComplexChannel", * retentionPeriod: { * unlimited: false, * numberOfDays: 10, * }, * tags: [ * { * key: "keyname1", * value: "value1", * }, * { * key: "keyname2", * value: "value2", * }, * ], * }); * * ``` * ### Example * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as aws_native from "@pulumi/aws-native"; * * const channel = new aws_native.iotanalytics.Channel("channel", { * channelName: "ComplexChannel", * retentionPeriod: { * unlimited: false, * numberOfDays: 10, * }, * tags: [ * { * key: "keyname1", * value: "value1", * }, * { * key: "keyname2", * value: "value2", * }, * ], * }); * * ``` */ export declare class Channel extends pulumi.CustomResource { /** * Get an existing Channel 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): Channel; /** * Returns true if the given object is an instance of Channel. 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 Channel; readonly awsId: pulumi.Output<string>; /** * The name of the channel. */ readonly channelName: pulumi.Output<string | undefined>; /** * Where channel data is stored. */ readonly channelStorage: pulumi.Output<outputs.iotanalytics.ChannelStorage | undefined>; /** * How long, in days, message data is kept for the channel. */ readonly retentionPeriod: pulumi.Output<outputs.iotanalytics.ChannelRetentionPeriod | undefined>; /** * Metadata which can be used to manage the channel. * * For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) . */ readonly tags: pulumi.Output<outputs.Tag[] | undefined>; /** * Create a Channel 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?: ChannelArgs, opts?: pulumi.CustomResourceOptions); } /** * The set of arguments for constructing a Channel resource. */ export interface ChannelArgs { /** * The name of the channel. */ channelName?: pulumi.Input<string>; /** * Where channel data is stored. */ channelStorage?: pulumi.Input<inputs.iotanalytics.ChannelStorageArgs>; /** * How long, in days, message data is kept for the channel. */ retentionPeriod?: pulumi.Input<inputs.iotanalytics.ChannelRetentionPeriodArgs>; /** * Metadata which can be used to manage the channel. * * For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) . */ tags?: pulumi.Input<pulumi.Input<inputs.TagArgs>[]>; }