@natzka-oss/pulumi-netbox
Version:
A Pulumi package for creating and managing Netbox cloud resources.
97 lines (96 loc) • 4.07 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* From the [official documentation](https://docs.netbox.dev/en/stable/models/dcim/moduletype/):
*
* > A module type represents a specific make and model of hardware component which is installable within a device's module bay and has its own child components. For example, consider a chassis-based switch or router with a number of field-replaceable line cards. Each line card has its own model number and includes a certain set of components such as interfaces. Each module type may have a manufacturer, model number, and part number assigned to it.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as netbox from "@natzka-oss/pulumi-netbox";
*
* const test = new netbox.dcim.Manufacturer("test", {name: "Dell"});
* const testModuleType = new netbox.dcim.ModuleType("test", {
* manufacturerId: test.id,
* model: "Networking",
* });
* ```
*/
export declare class ModuleType extends pulumi.CustomResource {
/**
* Get an existing ModuleType 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?: ModuleTypeState, opts?: pulumi.CustomResourceOptions): ModuleType;
/**
* Returns true if the given object is an instance of ModuleType. 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 ModuleType;
readonly comments: pulumi.Output<string | undefined>;
readonly customFields: pulumi.Output<{
[key: string]: string;
} | undefined>;
readonly description: pulumi.Output<string | undefined>;
readonly manufacturerId: pulumi.Output<number>;
readonly model: pulumi.Output<string>;
readonly partNumber: pulumi.Output<string | undefined>;
readonly tags: pulumi.Output<string[] | undefined>;
readonly weight: pulumi.Output<number | undefined>;
/**
* One of [kg, g, lb, oz]. Required when `weight` is set.
*/
readonly weightUnit: pulumi.Output<string | undefined>;
/**
* Create a ModuleType 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: ModuleTypeArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering ModuleType resources.
*/
export interface ModuleTypeState {
comments?: pulumi.Input<string>;
customFields?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
description?: pulumi.Input<string>;
manufacturerId?: pulumi.Input<number>;
model?: pulumi.Input<string>;
partNumber?: pulumi.Input<string>;
tags?: pulumi.Input<pulumi.Input<string>[]>;
weight?: pulumi.Input<number>;
/**
* One of [kg, g, lb, oz]. Required when `weight` is set.
*/
weightUnit?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a ModuleType resource.
*/
export interface ModuleTypeArgs {
comments?: pulumi.Input<string>;
customFields?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
description?: pulumi.Input<string>;
manufacturerId: pulumi.Input<number>;
model: pulumi.Input<string>;
partNumber?: pulumi.Input<string>;
tags?: pulumi.Input<pulumi.Input<string>[]>;
weight?: pulumi.Input<number>;
/**
* One of [kg, g, lb, oz]. Required when `weight` is set.
*/
weightUnit?: pulumi.Input<string>;
}