@natzka-oss/pulumi-netbox
Version:
A Pulumi package for creating and managing Netbox cloud resources.
80 lines • 3.93 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.Webhook = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("./utilities");
/**
* From the [official documentation](https://docs.netbox.dev/en/stable/integrations/webhooks/):
*
* > A webhook is a mechanism for conveying to some external system a change that took place in NetBox. For example, you may want to notify a monitoring system whenever the status of a device is updated in NetBox. This can be done by creating a webhook for the device model in NetBox and identifying the webhook receiver. When NetBox detects a change to a device, an HTTP request containing the details of the change and who made it be sent to the specified receiver.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as netbox from "@natzka-oss/pulumi-netbox";
*
* const test = new netbox.Webhook("test", {
* name: "test",
* payloadUrl: "https://example.com/webhook",
* bodytemplate: "Sample body",
* });
* ```
*/
class Webhook extends pulumi.CustomResource {
/**
* Get an existing Webhook 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 Webhook(name, state, Object.assign(Object.assign({}, opts), { id: id }));
}
/**
* Returns true if the given object is an instance of Webhook. 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'] === Webhook.__pulumiType;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["additionalHeaders"] = state ? state.additionalHeaders : undefined;
resourceInputs["bodyTemplate"] = state ? state.bodyTemplate : undefined;
resourceInputs["httpContentType"] = state ? state.httpContentType : undefined;
resourceInputs["httpMethod"] = state ? state.httpMethod : undefined;
resourceInputs["name"] = state ? state.name : undefined;
resourceInputs["payloadUrl"] = state ? state.payloadUrl : undefined;
}
else {
const args = argsOrState;
if ((!args || args.payloadUrl === undefined) && !opts.urn) {
throw new Error("Missing required property 'payloadUrl'");
}
resourceInputs["additionalHeaders"] = args ? args.additionalHeaders : undefined;
resourceInputs["bodyTemplate"] = args ? args.bodyTemplate : undefined;
resourceInputs["httpContentType"] = args ? args.httpContentType : undefined;
resourceInputs["httpMethod"] = args ? args.httpMethod : undefined;
resourceInputs["name"] = args ? args.name : undefined;
resourceInputs["payloadUrl"] = args ? args.payloadUrl : undefined;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
super(Webhook.__pulumiType, name, resourceInputs, opts);
}
}
exports.Webhook = Webhook;
/** @internal */
Webhook.__pulumiType = 'netbox:index/webhook:Webhook';
//# sourceMappingURL=webhook.js.map