@natzka-oss/pulumi-netbox/ipam/vrf.d.ts

A Pulumi package for creating and managing Netbox cloud resources.

import * as pulumi from "@pulumi/pulumi";
/**
 * From the [official documentation](https://docs.netbox.dev/en/stable/features/ipam/#virtual-routing-and-forwarding-vrf):
 *
 * > A VRF object in NetBox represents a virtual routing and forwarding (VRF) domain. Each VRF is essentially a separate routing table. VRFs are commonly used to isolate customers or organizations from one another within a network, or to route overlapping address space (e.g. multiple instances of the 10.0.0.0/8 space). Each VRF may be assigned to a specific tenant to aid in organizing the available IP space by customer or internal user.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as netbox from "@natzka-oss/pulumi-netbox";
 *
 * const custAProd = new netbox.ipam.Vrf("cust_a_prod", {
 *     name: "cust-a-prod",
 *     tags: [
 *         "customer-a",
 *         "prod",
 *     ],
 * });
 * ```
 */
export declare class Vrf extends pulumi.CustomResource {
    /**
     * Get an existing Vrf 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?: VrfState, opts?: pulumi.CustomResourceOptions): Vrf;
    /**
     * Returns true if the given object is an instance of Vrf.  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 Vrf;
    readonly description: pulumi.Output<string | undefined>;
    /**
     * Defaults to `true`.
     */
    readonly enforceUnique: pulumi.Output<boolean | undefined>;
    readonly name: pulumi.Output<string>;
    readonly rd: pulumi.Output<string | undefined>;
    readonly tags: pulumi.Output<string[] | undefined>;
    readonly tenantId: pulumi.Output<number | undefined>;
    /**
     * Create a Vrf 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?: VrfArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering Vrf resources.
 */
export interface VrfState {
    description?: pulumi.Input<string>;
    /**
     * Defaults to `true`.
     */
    enforceUnique?: pulumi.Input<boolean>;
    name?: pulumi.Input<string>;
    rd?: pulumi.Input<string>;
    tags?: pulumi.Input<pulumi.Input<string>[]>;
    tenantId?: pulumi.Input<number>;
}
/**
 * The set of arguments for constructing a Vrf resource.
 */
export interface VrfArgs {
    description?: pulumi.Input<string>;
    /**
     * Defaults to `true`.
     */
    enforceUnique?: pulumi.Input<boolean>;
    name?: pulumi.Input<string>;
    rd?: pulumi.Input<string>;
    tags?: pulumi.Input<pulumi.Input<string>[]>;
    tenantId?: pulumi.Input<number>;
}