@natzka-oss/pulumi-netbox/dcim/siteGroup.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/facilities/#site-groups):
 *
 * > Like regions, site groups can be arranged in a recursive hierarchy for grouping sites. However, whereas regions are intended for geographic organization, site groups may be used for functional grouping. For example, you might classify sites as corporate, branch, or customer sites in addition to where they are physically located.
 * >
 * > The use of both regions and site groups affords to independent but complementary dimensions across which sites can be organized.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as netbox from "@natzka-oss/pulumi-netbox";
 *
 * const parent = new netbox.dcim.SiteGroup("parent", {
 *     name: "parent",
 *     description: "sample description",
 * });
 * const child = new netbox.dcim.SiteGroup("child", {
 *     name: "child",
 *     description: "sample description",
 *     parentId: parent.id,
 * });
 * ```
 */
export declare class SiteGroup extends pulumi.CustomResource {
    /**
     * Get an existing SiteGroup 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?: SiteGroupState, opts?: pulumi.CustomResourceOptions): SiteGroup;
    /**
     * Returns true if the given object is an instance of SiteGroup.  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 SiteGroup;
    readonly description: pulumi.Output<string | undefined>;
    readonly name: pulumi.Output<string>;
    readonly parentId: pulumi.Output<number | undefined>;
    readonly slug: pulumi.Output<string>;
    /**
     * Create a SiteGroup 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?: SiteGroupArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering SiteGroup resources.
 */
export interface SiteGroupState {
    description?: pulumi.Input<string>;
    name?: pulumi.Input<string>;
    parentId?: pulumi.Input<number>;
    slug?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a SiteGroup resource.
 */
export interface SiteGroupArgs {
    description?: pulumi.Input<string>;
    name?: pulumi.Input<string>;
    parentId?: pulumi.Input<number>;
    slug?: pulumi.Input<string>;
}