@equinix-labs/pulumi-equinix/metal/vlan.d.ts

A Pulumi package for creating and managing equinix cloud resources.

import * as pulumi from "@pulumi/pulumi";
import * as enums from "../types/enums";
/**
 * 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}
 * ```
 */
export declare 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: string, id: pulumi.Input<pulumi.ID>, state?: VlanState, opts?: pulumi.CustomResourceOptions): Vlan;
    /**
     * 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: any): obj is Vlan;
    /**
     * Description string.
     */
    readonly description: pulumi.Output<string | undefined>;
    /**
     * Facility where to create the VLAN. Use metro instead; read the facility to metro migration guide
     *
     * @deprecated Use metro instead of facility.  For more information, read the migration guide: https://registry.terraform.io/providers/equinix/equinix/latest/docs/guides/migration_guide_facilities_to_metros_devices
     */
    readonly facility: pulumi.Output<string>;
    /**
     * Metro in which to create the VLAN
     */
    readonly metro: pulumi.Output<string>;
    /**
     * ID of parent project.
     */
    readonly projectId: pulumi.Output<string>;
    /**
     * VLAN ID, must be unique in metro.
     */
    readonly vxlan: pulumi.Output<number>;
    /**
     * Create a Vlan 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: VlanArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering Vlan resources.
 */
export interface VlanState {
    /**
     * Description string.
     */
    description?: pulumi.Input<string>;
    /**
     * Facility where to create the VLAN. Use metro instead; read the facility to metro migration guide
     *
     * @deprecated Use metro instead of facility.  For more information, read the migration guide: https://registry.terraform.io/providers/equinix/equinix/latest/docs/guides/migration_guide_facilities_to_metros_devices
     */
    facility?: pulumi.Input<string | enums.metal.Facility>;
    /**
     * Metro in which to create the VLAN
     */
    metro?: pulumi.Input<string>;
    /**
     * ID of parent project.
     */
    projectId?: pulumi.Input<string>;
    /**
     * VLAN ID, must be unique in metro.
     */
    vxlan?: pulumi.Input<number>;
}
/**
 * The set of arguments for constructing a Vlan resource.
 */
export interface VlanArgs {
    /**
     * Description string.
     */
    description?: pulumi.Input<string>;
    /**
     * Facility where to create the VLAN. Use metro instead; read the facility to metro migration guide
     *
     * @deprecated Use metro instead of facility.  For more information, read the migration guide: https://registry.terraform.io/providers/equinix/equinix/latest/docs/guides/migration_guide_facilities_to_metros_devices
     */
    facility?: pulumi.Input<string | enums.metal.Facility>;
    /**
     * Metro in which to create the VLAN
     */
    metro?: pulumi.Input<string>;
    /**
     * ID of parent project.
     */
    projectId: pulumi.Input<string>;
    /**
     * VLAN ID, must be unique in metro.
     */
    vxlan?: pulumi.Input<number>;
}