@natzka-oss/pulumi-netbox
Version:
A Pulumi package for creating and managing Netbox cloud resources.
88 lines (87 loc) • 3.66 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* From the [official documentation](https://docs.netbox.dev/en/stable/models/dcim/modulebay/):
*
* > Module bays represent a space or slot within a device in which a field-replaceable module may be installed. A common example is that of a chassis-based switch such as the Cisco Nexus 9000 or Juniper EX9200. Modules in turn hold additional components that become available to the parent device.
*
* ## 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,
* roleId: testNetboxDeviceRole.id,
* siteId: testNetboxSite.id,
* });
* const testDeviceModuleBay = new netbox.dcim.DeviceModuleBay("test", {
* deviceId: test.id,
* name: "module bay 1",
* });
* ```
*/
export declare class DeviceModuleBay extends pulumi.CustomResource {
/**
* Get an existing DeviceModuleBay 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?: DeviceModuleBayState, opts?: pulumi.CustomResourceOptions): DeviceModuleBay;
/**
* Returns true if the given object is an instance of DeviceModuleBay. 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 DeviceModuleBay;
readonly customFields: pulumi.Output<{
[key: string]: string;
} | undefined>;
readonly description: pulumi.Output<string | undefined>;
readonly deviceId: pulumi.Output<number>;
readonly label: pulumi.Output<string | undefined>;
readonly name: pulumi.Output<string>;
readonly position: pulumi.Output<string | undefined>;
readonly tags: pulumi.Output<string[] | undefined>;
/**
* Create a DeviceModuleBay 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: DeviceModuleBayArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering DeviceModuleBay resources.
*/
export interface DeviceModuleBayState {
customFields?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
description?: pulumi.Input<string>;
deviceId?: pulumi.Input<number>;
label?: pulumi.Input<string>;
name?: pulumi.Input<string>;
position?: pulumi.Input<string>;
tags?: pulumi.Input<pulumi.Input<string>[]>;
}
/**
* The set of arguments for constructing a DeviceModuleBay resource.
*/
export interface DeviceModuleBayArgs {
customFields?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
description?: pulumi.Input<string>;
deviceId: pulumi.Input<number>;
label?: pulumi.Input<string>;
name?: pulumi.Input<string>;
position?: pulumi.Input<string>;
tags?: pulumi.Input<pulumi.Input<string>[]>;
}