@equinix-labs/pulumi-equinix
Version:
A Pulumi package for creating and managing equinix cloud resources.
89 lines • 3.58 kB
JavaScript
;
// *** WARNING: this file was generated by the Pulumi Terraform Bridge (tfgen) Tool. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
Object.defineProperty(exports, "__esModule", { value: true });
exports.Vlan = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("../utilities");
/**
* Provides a resource to allow users to manage Virtual Networks in their projects.
*
* To learn more about Layer 2 networking in Equinix Metal, refer to
*
* * https://metal.equinix.com/developers/docs/networking/layer2/
* * https://metal.equinix.com/developers/docs/networking/layer2-configs/
*
* ## Example Usage
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as equinix from "@equinix-labs/pulumi-equinix";
*
* const vlan1 = new equinix.metal.Vlan("vlan1", {
* description: "VLAN in New Jersey",
* metro: "sv",
* projectId: projectId,
* vxlan: 1040,
* });
* ```
*
* ## Import
*
* This resource can be imported using an existing VLAN ID (UUID):
*
* ```sh
* $ pulumi import equinix:metal/vlan:Vlan equinix_metal_vlan {existing_vlan_id}
* ```
*/
class Vlan extends pulumi.CustomResource {
/**
* Get an existing Vlan 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, id, state, opts) {
return new Vlan(name, state, Object.assign(Object.assign({}, opts), { id: id }));
}
/**
* Returns true if the given object is an instance of Vlan. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj) {
if (obj === undefined || obj === null) {
return false;
}
return obj['__pulumiType'] === Vlan.__pulumiType;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["description"] = state ? state.description : undefined;
resourceInputs["facility"] = state ? state.facility : undefined;
resourceInputs["metro"] = state ? state.metro : undefined;
resourceInputs["projectId"] = state ? state.projectId : undefined;
resourceInputs["vxlan"] = state ? state.vxlan : undefined;
}
else {
const args = argsOrState;
if ((!args || args.projectId === undefined) && !opts.urn) {
throw new Error("Missing required property 'projectId'");
}
resourceInputs["description"] = args ? args.description : undefined;
resourceInputs["facility"] = args ? args.facility : undefined;
resourceInputs["metro"] = args ? args.metro : undefined;
resourceInputs["projectId"] = args ? args.projectId : undefined;
resourceInputs["vxlan"] = args ? args.vxlan : undefined;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
super(Vlan.__pulumiType, name, resourceInputs, opts);
}
}
exports.Vlan = Vlan;
/** @internal */
Vlan.__pulumiType = 'equinix:metal/vlan:Vlan';
//# sourceMappingURL=vlan.js.map