pulumi-netbox/vlan.d.ts

A Pulumi package for creating and managing Netbox resources.

import * as pulumi from "@pulumi/pulumi";
/**
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as pulumi_netbox from "pulumi-netbox";
 *
 * const example1 = new netbox.Vlan("example1", {
 *     vid: 1777,
 *     tags: [],
 * });
 * // Assume netbox_tenant, netbox_site, and netbox_tag resources exist
 * const example2 = new netbox.Vlan("example2", {
 *     vid: 1778,
 *     status: "reserved",
 *     description: "Reserved example VLAN",
 *     tenantId: netbox_tenant.ex.id,
 *     siteId: netbox_site.ex.id,
 *     tags: [netbox_tag.ex.name],
 * });
 * ```
 */
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;
    readonly description: pulumi.Output<string | undefined>;
    readonly name: pulumi.Output<string>;
    readonly roleId: pulumi.Output<number | undefined>;
    readonly siteId: pulumi.Output<number | undefined>;
    readonly status: pulumi.Output<string | undefined>;
    readonly tags: pulumi.Output<string[]>;
    readonly tenantId: pulumi.Output<number | undefined>;
    readonly vid: 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?: pulumi.Input<string>;
    name?: pulumi.Input<string>;
    roleId?: pulumi.Input<number>;
    siteId?: pulumi.Input<number>;
    status?: pulumi.Input<string>;
    tags?: pulumi.Input<pulumi.Input<string>[]>;
    tenantId?: pulumi.Input<number>;
    vid?: pulumi.Input<number>;
}
/**
 * The set of arguments for constructing a Vlan resource.
 */
export interface VlanArgs {
    description?: pulumi.Input<string>;
    name?: pulumi.Input<string>;
    roleId?: pulumi.Input<number>;
    siteId?: pulumi.Input<number>;
    status?: pulumi.Input<string>;
    tags: pulumi.Input<pulumi.Input<string>[]>;
    tenantId?: pulumi.Input<number>;
    vid: pulumi.Input<number>;
}