@natzka-oss/pulumi-netbox
Version:
A Pulumi package for creating and managing Netbox cloud resources.
79 lines • 3.55 kB
JavaScript
;
// *** WARNING: this file was generated by the Pulumi Terraform Bridge (tfgen) Tool. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
Object.defineProperty(exports, "__esModule", { value: true });
exports.DeviceRole = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("../utilities");
/**
* From the [official documentation](https://docs.netbox.dev/en/stable/features/devices/#device-roles):
*
* > Devices can be organized by functional roles, which are fully customizable by the user. For example, you might create roles for core switches, distribution switches, and access switches within your network.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as netbox from "@natzka-oss/pulumi-netbox";
*
* const coreSw = new netbox.dcim.DeviceRole("core_sw", {
* colorHex: "FF00FF",
* name: "core-sw",
* });
* ```
*/
class DeviceRole extends pulumi.CustomResource {
/**
* Get an existing DeviceRole 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, id, state, opts) {
return new DeviceRole(name, state, Object.assign(Object.assign({}, opts), { id: id }));
}
/**
* Returns true if the given object is an instance of DeviceRole. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj) {
if (obj === undefined || obj === null) {
return false;
}
return obj['__pulumiType'] === DeviceRole.__pulumiType;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["colorHex"] = state ? state.colorHex : undefined;
resourceInputs["description"] = state ? state.description : undefined;
resourceInputs["name"] = state ? state.name : undefined;
resourceInputs["slug"] = state ? state.slug : undefined;
resourceInputs["tags"] = state ? state.tags : undefined;
resourceInputs["vmRole"] = state ? state.vmRole : undefined;
}
else {
const args = argsOrState;
if ((!args || args.colorHex === undefined) && !opts.urn) {
throw new Error("Missing required property 'colorHex'");
}
resourceInputs["colorHex"] = args ? args.colorHex : undefined;
resourceInputs["description"] = args ? args.description : undefined;
resourceInputs["name"] = args ? args.name : undefined;
resourceInputs["slug"] = args ? args.slug : undefined;
resourceInputs["tags"] = args ? args.tags : undefined;
resourceInputs["vmRole"] = args ? args.vmRole : undefined;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
super(DeviceRole.__pulumiType, name, resourceInputs, opts);
}
}
exports.DeviceRole = DeviceRole;
/** @internal */
DeviceRole.__pulumiType = 'netbox:dcim/deviceRole:DeviceRole';
//# sourceMappingURL=deviceRole.js.map