@natzka-oss/pulumi-netbox
Version:
A Pulumi package for creating and managing Netbox cloud resources.
83 lines • 3.94 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.ConfigTemplate = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("./utilities");
/**
* From the [official documentation](https://docs.netbox.dev/en/stable/models/extras/configtemplate/):
*
* > Configuration templates can be used to render device configurations from context data. Templates are written in the Jinja2 language and can be associated with devices roles, platforms, and/or individual devices.
*
* > Context data is made available to devices and/or virtual machines based on their relationships to other objects in NetBox. For example, context data can be associated only with devices assigned to a particular site, or only to virtual machines in a certain cluster.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as netbox from "@natzka-oss/pulumi-netbox";
*
* const test = new netbox.ConfigTemplate("test", {
* name: "test",
* description: "test description",
* templateCode: "hostname {{ name }}",
* environmentParams: JSON.stringify({
* name: "my-hostname",
* }),
* });
* ```
*/
class ConfigTemplate extends pulumi.CustomResource {
/**
* Get an existing ConfigTemplate 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 ConfigTemplate(name, state, Object.assign(Object.assign({}, opts), { id: id }));
}
/**
* Returns true if the given object is an instance of ConfigTemplate. 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'] === ConfigTemplate.__pulumiType;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["description"] = state ? state.description : undefined;
resourceInputs["environmentParams"] = state ? state.environmentParams : undefined;
resourceInputs["name"] = state ? state.name : undefined;
resourceInputs["tags"] = state ? state.tags : undefined;
resourceInputs["templateCode"] = state ? state.templateCode : undefined;
}
else {
const args = argsOrState;
if ((!args || args.templateCode === undefined) && !opts.urn) {
throw new Error("Missing required property 'templateCode'");
}
resourceInputs["description"] = args ? args.description : undefined;
resourceInputs["environmentParams"] = args ? args.environmentParams : undefined;
resourceInputs["name"] = args ? args.name : undefined;
resourceInputs["tags"] = args ? args.tags : undefined;
resourceInputs["templateCode"] = args ? args.templateCode : undefined;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
super(ConfigTemplate.__pulumiType, name, resourceInputs, opts);
}
}
exports.ConfigTemplate = ConfigTemplate;
/** @internal */
ConfigTemplate.__pulumiType = 'netbox:index/configTemplate:ConfigTemplate';
//# sourceMappingURL=configTemplate.js.map