@natzka-oss/pulumi-netbox/dcim/location.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/sites-and-racks/#locations):
 *
 * > Racks and devices can be grouped by location within a site. A location may represent a floor, room, cage, or similar organizational unit. Locations can be nested to form a hierarchy. For example, you may have floors within a site, and rooms within a floor.
 *
 * Each location must have a name that is unique within its parent site and location, if any.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as netbox from "@natzka-oss/pulumi-netbox";
 *
 * const test = new netbox.dcim.Site("test", {name: "test"});
 * const testTenant = new netbox.tenancy.Tenant("test", {name: "test"});
 * const testLocation = new netbox.dcim.Location("test", {
 *     name: "test",
 *     description: "my description",
 *     siteId: test.id,
 *     tenantId: testTenant.id,
 * });
 * ```
 */
export declare class Location extends pulumi.CustomResource {
    /**
     * Get an existing Location 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?: LocationState, opts?: pulumi.CustomResourceOptions): Location;
    /**
     * Returns true if the given object is an instance of Location.  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 Location;
    readonly customFields: pulumi.Output<{
        [key: string]: string;
    } | undefined>;
    readonly description: pulumi.Output<string | undefined>;
    readonly name: pulumi.Output<string>;
    readonly parentId: pulumi.Output<number | undefined>;
    readonly siteId: pulumi.Output<number | undefined>;
    readonly slug: pulumi.Output<string>;
    readonly tags: pulumi.Output<string[] | undefined>;
    readonly tenantId: pulumi.Output<number | undefined>;
    /**
     * Create a Location 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?: LocationArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering Location resources.
 */
export interface LocationState {
    customFields?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    }>;
    description?: pulumi.Input<string>;
    name?: pulumi.Input<string>;
    parentId?: pulumi.Input<number>;
    siteId?: pulumi.Input<number>;
    slug?: pulumi.Input<string>;
    tags?: pulumi.Input<pulumi.Input<string>[]>;
    tenantId?: pulumi.Input<number>;
}
/**
 * The set of arguments for constructing a Location resource.
 */
export interface LocationArgs {
    customFields?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    }>;
    description?: pulumi.Input<string>;
    name?: pulumi.Input<string>;
    parentId?: pulumi.Input<number>;
    siteId?: pulumi.Input<number>;
    slug?: pulumi.Input<string>;
    tags?: pulumi.Input<pulumi.Input<string>[]>;
    tenantId?: pulumi.Input<number>;
}