@natzka-oss/pulumi-netbox
Version:
A Pulumi package for creating and managing Netbox cloud resources.
92 lines (91 loc) • 3.66 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* From the [official documentation](https://docs.netbox.dev/en/stable/models/dcim/inventoryitemrole/):
*
* > Inventory items can be organized by functional roles, which are fully customizable by the user. For example, you might create roles for power supplies, fans, interface optics, etc.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as netbox from "@natzka-oss/pulumi-netbox";
*
* // Note that some terraform code is not included in the example for brevity
* const test = new netbox.dcim.Device("test", {
* name: "%[1]s",
* deviceTypeId: testNetboxDeviceType.id,
* tenantId: testNetboxTenant.id,
* roleId: testNetboxDeviceRole.id,
* siteId: testNetboxSite.id,
* });
* const testInventoryItemRole = new netbox.dcim.InventoryItemRole("test", {
* name: "Role 1",
* slug: "role-1-slug",
* colorHex: "123456",
* });
* const parent = new netbox.dcim.InventoryItem("parent", {
* deviceId: test.id,
* name: "Inventory Item 1",
* roleId: testInventoryItemRole.id,
* });
* ```
*/
export declare class InventoryItemRole extends pulumi.CustomResource {
/**
* Get an existing InventoryItemRole 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?: InventoryItemRoleState, opts?: pulumi.CustomResourceOptions): InventoryItemRole;
/**
* Returns true if the given object is an instance of InventoryItemRole. 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 InventoryItemRole;
readonly colorHex: pulumi.Output<string>;
readonly customFields: pulumi.Output<{
[key: string]: string;
} | undefined>;
readonly description: pulumi.Output<string | undefined>;
readonly name: pulumi.Output<string>;
readonly slug: pulumi.Output<string>;
readonly tags: pulumi.Output<string[] | undefined>;
/**
* Create a InventoryItemRole 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: InventoryItemRoleArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering InventoryItemRole resources.
*/
export interface InventoryItemRoleState {
colorHex?: pulumi.Input<string>;
customFields?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
description?: pulumi.Input<string>;
name?: pulumi.Input<string>;
slug?: pulumi.Input<string>;
tags?: pulumi.Input<pulumi.Input<string>[]>;
}
/**
* The set of arguments for constructing a InventoryItemRole resource.
*/
export interface InventoryItemRoleArgs {
colorHex: pulumi.Input<string>;
customFields?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
description?: pulumi.Input<string>;
name?: pulumi.Input<string>;
slug: pulumi.Input<string>;
tags?: pulumi.Input<pulumi.Input<string>[]>;
}