@equinix-labs/pulumi-equinix
Version:
A Pulumi package for creating and managing equinix cloud resources.
196 lines (195 loc) • 6.46 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 Network
*
* Additional documentation:
* * Getting Started: https://docs.equinix.com/en-us/Content/Interconnection/Fabric/IMPLEMENTATION/fabric-networks-implement.htm
* * API: https://developer.equinix.com/dev-docs/fabric/api-reference/fabric-v4-apis#fabric-networks
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as equinix from "@equinix-labs/pulumi-equinix";
*
* const newNetwork = new equinix.fabric.Network("newNetwork", {
* notifications: [{
* emails: [
* "example@equinix.com",
* "test1@equinix.com",
* ],
* type: "ALL",
* }],
* project: {
* projectId: "776847000642406",
* },
* scope: "GLOBAL",
* type: "EVPLAN",
* });
* ```
*/
export declare class Network extends pulumi.CustomResource {
/**
* Get an existing Network 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?: NetworkState, opts?: pulumi.CustomResourceOptions): Network;
/**
* Returns true if the given object is an instance of Network. 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 Network;
/**
* Information on asset change operation
*/
readonly change: pulumi.Output<outputs.fabric.NetworkChange>;
/**
* A permanent record of asset creation, modification, or deletion
*/
readonly changeLog: pulumi.Output<outputs.fabric.NetworkChangeLog>;
/**
* Number of connections associated with this network
*/
readonly connectionsCount: pulumi.Output<number>;
/**
* Fabric Network URI information
*/
readonly href: pulumi.Output<string>;
/**
* Fabric Network location
*/
readonly location: pulumi.Output<outputs.fabric.NetworkLocation>;
/**
* Fabric Network name. An alpha-numeric 24 characters string which can include only hyphens and underscores
*/
readonly name: pulumi.Output<string>;
/**
* Preferences for notifications on Fabric Network configuration or status changes
*/
readonly notifications: pulumi.Output<outputs.fabric.NetworkNotification[]>;
/**
* Network operation information that is associated with this Fabric Network
*/
readonly operation: pulumi.Output<outputs.fabric.NetworkOperation>;
/**
* Fabric Network project
*/
readonly project: pulumi.Output<outputs.fabric.NetworkProject>;
/**
* Fabric Network scope
*/
readonly scope: pulumi.Output<string>;
/**
* Fabric Network overall state
*/
readonly state: pulumi.Output<string>;
/**
* Supported Network types - EVPLAN, EPLAN, IPWAN
*/
readonly type: pulumi.Output<string>;
/**
* Equinix-assigned network identifier
*/
readonly uuid: pulumi.Output<string>;
/**
* Create a Network 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: NetworkArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Network resources.
*/
export interface NetworkState {
/**
* Information on asset change operation
*/
change?: pulumi.Input<inputs.fabric.NetworkChange>;
/**
* A permanent record of asset creation, modification, or deletion
*/
changeLog?: pulumi.Input<inputs.fabric.NetworkChangeLog>;
/**
* Number of connections associated with this network
*/
connectionsCount?: pulumi.Input<number>;
/**
* Fabric Network URI information
*/
href?: pulumi.Input<string>;
/**
* Fabric Network location
*/
location?: pulumi.Input<inputs.fabric.NetworkLocation>;
/**
* Fabric Network name. An alpha-numeric 24 characters string which can include only hyphens and underscores
*/
name?: pulumi.Input<string>;
/**
* Preferences for notifications on Fabric Network configuration or status changes
*/
notifications?: pulumi.Input<pulumi.Input<inputs.fabric.NetworkNotification>[]>;
/**
* Network operation information that is associated with this Fabric Network
*/
operation?: pulumi.Input<inputs.fabric.NetworkOperation>;
/**
* Fabric Network project
*/
project?: pulumi.Input<inputs.fabric.NetworkProject>;
/**
* Fabric Network scope
*/
scope?: pulumi.Input<string>;
/**
* Fabric Network overall state
*/
state?: pulumi.Input<string>;
/**
* Supported Network types - EVPLAN, EPLAN, IPWAN
*/
type?: pulumi.Input<string>;
/**
* Equinix-assigned network identifier
*/
uuid?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a Network resource.
*/
export interface NetworkArgs {
/**
* Fabric Network location
*/
location?: pulumi.Input<inputs.fabric.NetworkLocation>;
/**
* Fabric Network name. An alpha-numeric 24 characters string which can include only hyphens and underscores
*/
name?: pulumi.Input<string>;
/**
* Preferences for notifications on Fabric Network configuration or status changes
*/
notifications: pulumi.Input<pulumi.Input<inputs.fabric.NetworkNotification>[]>;
/**
* Fabric Network project
*/
project: pulumi.Input<inputs.fabric.NetworkProject>;
/**
* Fabric Network scope
*/
scope: pulumi.Input<string>;
/**
* Supported Network types - EVPLAN, EPLAN, IPWAN
*/
type: pulumi.Input<string>;
}