@equinix-labs/pulumi-equinix
Version:
A Pulumi package for creating and managing equinix cloud resources.
177 lines (176 loc) • 6.54 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 Subscriptions
*
* 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/Stream-Subscriptions
*/
export declare class StreamSubscription extends pulumi.CustomResource {
/**
* Get an existing StreamSubscription 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?: StreamSubscriptionState, opts?: pulumi.CustomResourceOptions): StreamSubscription;
/**
* Returns true if the given object is an instance of StreamSubscription. 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 StreamSubscription;
/**
* Details of the last change on the stream resource
*/
readonly changeLog: pulumi.Output<outputs.fabric.StreamSubscriptionChangeLog>;
/**
* Customer-provided stream subscription description
*/
readonly description: pulumi.Output<string>;
/**
* Stream subscription enabled status
*/
readonly enabled: pulumi.Output<boolean>;
/**
* Lists of events to be included/excluded on the stream subscription
*/
readonly eventSelector: pulumi.Output<outputs.fabric.StreamSubscriptionEventSelector>;
/**
* Equinix assigned URI of the stream subscription resource
*/
readonly href: pulumi.Output<string>;
/**
* Lists of metrics to be included/excluded on the stream subscription
*/
readonly metricSelector: pulumi.Output<outputs.fabric.StreamSubscriptionMetricSelector>;
/**
* Customer-provided stream subscription name
*/
readonly name: pulumi.Output<string>;
/**
* The details of the subscriber to the Equinix Stream
*/
readonly sink: pulumi.Output<outputs.fabric.StreamSubscriptionSink>;
/**
* Value representing provisioning status for the stream resource
*/
readonly state: pulumi.Output<string>;
/**
* The uuid of the stream that is the target of the stream subscription
*/
readonly streamId: pulumi.Output<string>;
readonly timeouts: pulumi.Output<outputs.fabric.StreamSubscriptionTimeouts | undefined>;
/**
* Type of the stream subscription request
*/
readonly type: pulumi.Output<string>;
/**
* Equinix assigned unique identifier of the stream subscription resource
*/
readonly uuid: pulumi.Output<string>;
/**
* Create a StreamSubscription 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: StreamSubscriptionArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering StreamSubscription resources.
*/
export interface StreamSubscriptionState {
/**
* Details of the last change on the stream resource
*/
changeLog?: pulumi.Input<inputs.fabric.StreamSubscriptionChangeLog>;
/**
* Customer-provided stream subscription description
*/
description?: pulumi.Input<string>;
/**
* Stream subscription enabled status
*/
enabled?: pulumi.Input<boolean>;
/**
* Lists of events to be included/excluded on the stream subscription
*/
eventSelector?: pulumi.Input<inputs.fabric.StreamSubscriptionEventSelector>;
/**
* Equinix assigned URI of the stream subscription resource
*/
href?: pulumi.Input<string>;
/**
* Lists of metrics to be included/excluded on the stream subscription
*/
metricSelector?: pulumi.Input<inputs.fabric.StreamSubscriptionMetricSelector>;
/**
* Customer-provided stream subscription name
*/
name?: pulumi.Input<string>;
/**
* The details of the subscriber to the Equinix Stream
*/
sink?: pulumi.Input<inputs.fabric.StreamSubscriptionSink>;
/**
* Value representing provisioning status for the stream resource
*/
state?: pulumi.Input<string>;
/**
* The uuid of the stream that is the target of the stream subscription
*/
streamId?: pulumi.Input<string>;
timeouts?: pulumi.Input<inputs.fabric.StreamSubscriptionTimeouts>;
/**
* Type of the stream subscription request
*/
type?: pulumi.Input<string>;
/**
* Equinix assigned unique identifier of the stream subscription resource
*/
uuid?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a StreamSubscription resource.
*/
export interface StreamSubscriptionArgs {
/**
* Customer-provided stream subscription description
*/
description: pulumi.Input<string>;
/**
* Stream subscription enabled status
*/
enabled: pulumi.Input<boolean>;
/**
* Lists of events to be included/excluded on the stream subscription
*/
eventSelector?: pulumi.Input<inputs.fabric.StreamSubscriptionEventSelector>;
/**
* Lists of metrics to be included/excluded on the stream subscription
*/
metricSelector?: pulumi.Input<inputs.fabric.StreamSubscriptionMetricSelector>;
/**
* Customer-provided stream subscription name
*/
name?: pulumi.Input<string>;
/**
* The details of the subscriber to the Equinix Stream
*/
sink: pulumi.Input<inputs.fabric.StreamSubscriptionSink>;
/**
* The uuid of the stream that is the target of the stream subscription
*/
streamId: pulumi.Input<string>;
timeouts?: pulumi.Input<inputs.fabric.StreamSubscriptionTimeouts>;
/**
* Type of the stream subscription request
*/
type: pulumi.Input<string>;
}