@natzka-oss/pulumi-netbox
Version:
A Pulumi package for creating and managing Netbox cloud resources.
68 lines (67 loc) • 2.88 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* From the [official documentation](https://docs.netbox.dev/en/stable/features/sites-and-racks/#regions):
*
* > Sites can be arranged geographically using regions. A region might represent a continent, country, city, campus, or other area depending on your use case. Regions can be nested recursively to construct a hierarchy. For example, you might define several country regions, and within each of those several state or city regions to which sites are assigned.
* >
* > Each region must have a name that is unique within its parent region, if any.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as netbox from "@natzka-oss/pulumi-netbox";
*
* const test = new netbox.dcim.Region("test", {
* name: "test",
* description: "test description",
* });
* ```
*/
export declare class Region extends pulumi.CustomResource {
/**
* Get an existing Region 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?: RegionState, opts?: pulumi.CustomResourceOptions): Region;
/**
* Returns true if the given object is an instance of Region. 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 Region;
readonly description: pulumi.Output<string | undefined>;
readonly name: pulumi.Output<string>;
readonly parentRegionId: pulumi.Output<number | undefined>;
readonly slug: pulumi.Output<string>;
/**
* Create a Region 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?: RegionArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Region resources.
*/
export interface RegionState {
description?: pulumi.Input<string>;
name?: pulumi.Input<string>;
parentRegionId?: pulumi.Input<number>;
slug?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a Region resource.
*/
export interface RegionArgs {
description?: pulumi.Input<string>;
name?: pulumi.Input<string>;
parentRegionId?: pulumi.Input<number>;
slug?: pulumi.Input<string>;
}