pulumi-netbox
Version:
A Pulumi package for creating and managing Netbox resources.
99 lines (98 loc) • 3.7 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as netbox from "@pulumi/netbox";
*
* const example1 = new netbox.Site("example1", {
* asn: 1337,
* facility: "Data center",
* latitude: -45.4085,
* longitude: 30.1496,
* status: "staging",
* timezone: "Africa/Johannesburg",
* });
* ```
*/
export declare class Site extends pulumi.CustomResource {
/**
* Get an existing Site 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?: SiteState, opts?: pulumi.CustomResourceOptions): Site;
/**
* Returns true if the given object is an instance of Site. 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 Site;
readonly asn: pulumi.Output<number | undefined>;
readonly customFields: pulumi.Output<{
[key: string]: string;
} | undefined>;
readonly description: pulumi.Output<string | undefined>;
readonly facility: pulumi.Output<string | undefined>;
readonly latitude: pulumi.Output<number | undefined>;
readonly longitude: pulumi.Output<number | undefined>;
readonly name: pulumi.Output<string>;
readonly regionId: pulumi.Output<number | undefined>;
readonly slug: pulumi.Output<string>;
readonly status: pulumi.Output<string | undefined>;
readonly tags: pulumi.Output<string[] | undefined>;
readonly tenantId: pulumi.Output<number | undefined>;
readonly timezone: pulumi.Output<string | undefined>;
/**
* Create a Site 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?: SiteArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Site resources.
*/
export interface SiteState {
asn?: pulumi.Input<number>;
customFields?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
description?: pulumi.Input<string>;
facility?: pulumi.Input<string>;
latitude?: pulumi.Input<number>;
longitude?: pulumi.Input<number>;
name?: pulumi.Input<string>;
regionId?: pulumi.Input<number>;
slug?: pulumi.Input<string>;
status?: pulumi.Input<string>;
tags?: pulumi.Input<pulumi.Input<string>[]>;
tenantId?: pulumi.Input<number>;
timezone?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a Site resource.
*/
export interface SiteArgs {
asn?: pulumi.Input<number>;
customFields?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
description?: pulumi.Input<string>;
facility?: pulumi.Input<string>;
latitude?: pulumi.Input<number>;
longitude?: pulumi.Input<number>;
name?: pulumi.Input<string>;
regionId?: pulumi.Input<number>;
slug?: pulumi.Input<string>;
status?: pulumi.Input<string>;
tags?: pulumi.Input<pulumi.Input<string>[]>;
tenantId?: pulumi.Input<number>;
timezone?: pulumi.Input<string>;
}