@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)
72 lines (71 loc) • 3.08 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* A channel receives events from a specific source (such as an on-premises storage solution or application, or a partner event data source), and delivers the events to one or more event data stores. You use channels to ingest events into CloudTrail from sources outside AWS.
*/
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;
/**
* `Ref` returns the ARN of the CloudTrail channel, such as `arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890` .
*/
readonly channelArn: pulumi.Output<string>;
/**
* One or more resources to which events arriving through a channel are logged and stored.
*/
readonly destinations: pulumi.Output<outputs.cloudtrail.ChannelDestination[] | undefined>;
/**
* The name of the channel.
*/
readonly name: pulumi.Output<string | undefined>;
/**
* The ARN of an on-premises storage solution or application, or a partner event source.
*/
readonly source: pulumi.Output<string | undefined>;
/**
* An array of key-value pairs to apply to this resource.
*/
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 {
/**
* One or more resources to which events arriving through a channel are logged and stored.
*/
destinations?: pulumi.Input<pulumi.Input<inputs.cloudtrail.ChannelDestinationArgs>[]>;
/**
* The name of the channel.
*/
name?: pulumi.Input<string>;
/**
* The ARN of an on-premises storage solution or application, or a partner event source.
*/
source?: pulumi.Input<string>;
/**
* An array of key-value pairs to apply to this resource.
*/
tags?: pulumi.Input<pulumi.Input<inputs.TagArgs>[]>;
}