@equinix-labs/pulumi-equinix
Version:
A Pulumi package for creating and managing equinix cloud resources.
145 lines (144 loc) • 5 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Fabric V4 API compatible resource allows creation and management of Equinix Fabric Stream
*
* Additional Documentation:
* * Getting Started: https://docs.equinix.com/en-us/Content/KnowledgeCenter/Fabric/GettingStarted/Integrating-with-Fabric-V4-APIs/IntegrateWithSink.htm
* * API: https://developer.equinix.com/catalog/fabricv4#tag/Streams
*/
export declare class Stream extends pulumi.CustomResource {
/**
* Get an existing Stream 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 state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: StreamState, opts?: pulumi.CustomResourceOptions): Stream;
/**
* Returns true if the given object is an instance of Stream. 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 Stream;
/**
* Count of the streaming assets attached to the stream resource
*/
readonly assetsCount: pulumi.Output<number>;
/**
* Details of the last change on the stream resource
*/
readonly changeLog: pulumi.Output<outputs.fabric.StreamChangeLog>;
/**
* Customer-provided description of the stream resource
*/
readonly description: pulumi.Output<string>;
/**
* Equinix auto generated URI to the stream resource in Equinix Portal
*/
readonly href: pulumi.Output<string>;
/**
* Customer-provided name of the stream resource
*/
readonly name: pulumi.Output<string>;
/**
* Equinix Project attribute object
*/
readonly project: pulumi.Output<outputs.fabric.StreamProject>;
/**
* Value representing provisioning status for the stream resource
*/
readonly state: pulumi.Output<string>;
/**
* Count of the client subscriptions on the stream resource
*/
readonly streamSubscriptionsCount: pulumi.Output<number>;
readonly timeouts: pulumi.Output<outputs.fabric.StreamTimeouts | undefined>;
/**
* Equinix defined Streaming Type
*/
readonly type: pulumi.Output<string>;
/**
* Equinix-assigned unique id for the stream resource
*/
readonly uuid: pulumi.Output<string>;
/**
* Create a Stream 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: StreamArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Stream resources.
*/
export interface StreamState {
/**
* Count of the streaming assets attached to the stream resource
*/
assetsCount?: pulumi.Input<number>;
/**
* Details of the last change on the stream resource
*/
changeLog?: pulumi.Input<inputs.fabric.StreamChangeLog>;
/**
* Customer-provided description of the stream resource
*/
description?: pulumi.Input<string>;
/**
* Equinix auto generated URI to the stream resource in Equinix Portal
*/
href?: pulumi.Input<string>;
/**
* Customer-provided name of the stream resource
*/
name?: pulumi.Input<string>;
/**
* Equinix Project attribute object
*/
project?: pulumi.Input<inputs.fabric.StreamProject>;
/**
* Value representing provisioning status for the stream resource
*/
state?: pulumi.Input<string>;
/**
* Count of the client subscriptions on the stream resource
*/
streamSubscriptionsCount?: pulumi.Input<number>;
timeouts?: pulumi.Input<inputs.fabric.StreamTimeouts>;
/**
* Equinix defined Streaming Type
*/
type?: pulumi.Input<string>;
/**
* Equinix-assigned unique id for the stream resource
*/
uuid?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a Stream resource.
*/
export interface StreamArgs {
/**
* Customer-provided description of the stream resource
*/
description: pulumi.Input<string>;
/**
* Customer-provided name of the stream resource
*/
name?: pulumi.Input<string>;
/**
* Equinix Project attribute object
*/
project?: pulumi.Input<inputs.fabric.StreamProject>;
timeouts?: pulumi.Input<inputs.fabric.StreamTimeouts>;
/**
* Equinix defined Streaming Type
*/
type: pulumi.Input<string>;
}