@natzka-oss/pulumi-netbox
Version:
A Pulumi package for creating and managing Netbox cloud resources.
104 lines • 5.88 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.CustomField = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("./utilities");
/**
* From the [official documentation](https://docs.netbox.dev/en/stable/customization/custom-fields/#custom-fields):
*
* > Each model in NetBox is represented in the database as a discrete table, and each attribute of a model exists as a column within its table. For example, sites are stored in the dcimSite table, which has columns named name, facility, physical_address, and so on. As new attributes are added to objects throughout the development of NetBox, tables are expanded to include new rows.
* >
* > However, some users might want to store additional object attributes that are somewhat esoteric in nature, and that would not make sense to include in the core NetBox database schema. For instance, suppose your organization needs to associate each device with a ticket number correlating it with an internal support system record. This is certainly a legitimate use for NetBox, but it's not a common enough need to warrant including a field for every NetBox installation. Instead, you can create a custom field to hold this data.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as netbox from "@natzka-oss/pulumi-netbox";
*
* const test = new netbox.CustomField("test", {
* name: "test",
* type: "text",
* contentTypes: ["virtualization.vminterface"],
* weight: 100,
* validationRegex: "^.*$",
* });
* ```
*/
class CustomField extends pulumi.CustomResource {
/**
* Get an existing CustomField 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 CustomField(name, state, Object.assign(Object.assign({}, opts), { id: id }));
}
/**
* Returns true if the given object is an instance of CustomField. 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'] === CustomField.__pulumiType;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["choiceSetId"] = state ? state.choiceSetId : undefined;
resourceInputs["contentTypes"] = state ? state.contentTypes : undefined;
resourceInputs["default"] = state ? state.default : undefined;
resourceInputs["description"] = state ? state.description : undefined;
resourceInputs["groupName"] = state ? state.groupName : undefined;
resourceInputs["label"] = state ? state.label : undefined;
resourceInputs["name"] = state ? state.name : undefined;
resourceInputs["required"] = state ? state.required : undefined;
resourceInputs["type"] = state ? state.type : undefined;
resourceInputs["validationMaximum"] = state ? state.validationMaximum : undefined;
resourceInputs["validationMinimum"] = state ? state.validationMinimum : undefined;
resourceInputs["validationRegex"] = state ? state.validationRegex : undefined;
resourceInputs["weight"] = state ? state.weight : undefined;
}
else {
const args = argsOrState;
if ((!args || args.contentTypes === undefined) && !opts.urn) {
throw new Error("Missing required property 'contentTypes'");
}
if ((!args || args.type === undefined) && !opts.urn) {
throw new Error("Missing required property 'type'");
}
if ((!args || args.weight === undefined) && !opts.urn) {
throw new Error("Missing required property 'weight'");
}
resourceInputs["choiceSetId"] = args ? args.choiceSetId : undefined;
resourceInputs["contentTypes"] = args ? args.contentTypes : undefined;
resourceInputs["default"] = args ? args.default : undefined;
resourceInputs["description"] = args ? args.description : undefined;
resourceInputs["groupName"] = args ? args.groupName : undefined;
resourceInputs["label"] = args ? args.label : undefined;
resourceInputs["name"] = args ? args.name : undefined;
resourceInputs["required"] = args ? args.required : undefined;
resourceInputs["type"] = args ? args.type : undefined;
resourceInputs["validationMaximum"] = args ? args.validationMaximum : undefined;
resourceInputs["validationMinimum"] = args ? args.validationMinimum : undefined;
resourceInputs["validationRegex"] = args ? args.validationRegex : undefined;
resourceInputs["weight"] = args ? args.weight : undefined;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
super(CustomField.__pulumiType, name, resourceInputs, opts);
}
}
exports.CustomField = CustomField;
/** @internal */
CustomField.__pulumiType = 'netbox:index/customField:CustomField';
//# sourceMappingURL=customField.js.map