@natzka-oss/pulumi-netbox
Version:
A Pulumi package for creating and managing Netbox cloud resources.
84 lines • 3.62 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.Asn = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("../utilities");
/**
* From the [official documentation](https://docs.netbox.dev/en/stable/features/ipam/#asn):
* > ASN is short for Autonomous System Number. This identifier is used in the BGP protocol to identify which "autonomous system" a particular prefix is originating and transiting through.
* >
* > The AS number model within NetBox allows you to model some of this real-world relationship.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as netbox from "@natzka-oss/pulumi-netbox";
*
* const test = new netbox.ipam.Rir("test", {name: "testrir"});
* const testAsn = new netbox.ipam.Asn("test", {
* asn: 1337,
* rirId: test.id,
* description: "test",
* comments: "test",
* });
* ```
*/
class Asn extends pulumi.CustomResource {
/**
* Get an existing Asn 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 Asn(name, state, Object.assign(Object.assign({}, opts), { id: id }));
}
/**
* Returns true if the given object is an instance of Asn. 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'] === Asn.__pulumiType;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["asn"] = state ? state.asn : undefined;
resourceInputs["comments"] = state ? state.comments : undefined;
resourceInputs["description"] = state ? state.description : undefined;
resourceInputs["rirId"] = state ? state.rirId : undefined;
resourceInputs["tags"] = state ? state.tags : undefined;
}
else {
const args = argsOrState;
if ((!args || args.asn === undefined) && !opts.urn) {
throw new Error("Missing required property 'asn'");
}
if ((!args || args.rirId === undefined) && !opts.urn) {
throw new Error("Missing required property 'rirId'");
}
resourceInputs["asn"] = args ? args.asn : undefined;
resourceInputs["comments"] = args ? args.comments : undefined;
resourceInputs["description"] = args ? args.description : undefined;
resourceInputs["rirId"] = args ? args.rirId : undefined;
resourceInputs["tags"] = args ? args.tags : undefined;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
super(Asn.__pulumiType, name, resourceInputs, opts);
}
}
exports.Asn = Asn;
/** @internal */
Asn.__pulumiType = 'netbox:ipam/asn:Asn';
//# sourceMappingURL=asn.js.map