@natzka-oss/pulumi-netbox
Version:
A Pulumi package for creating and managing Netbox cloud resources.
75 lines (74 loc) • 2.98 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* From the [official documentation](https://docs.netbox.dev/en/stable/features/ipam/#regional-internet-registries-rirs):
*
* > Regional Internet registries are responsible for the allocation of globally-routable address space. The five RIRs are ARIN, RIPE, APNIC, LACNIC, and AFRINIC. However, some address space has been set aside for internal use, such as defined in RFCs 1918 and 6598. NetBox considers these RFCs as a sort of RIR as well; that is, an authority which "owns" certain address space. There also exist lower-tier registries which serve particular geographic areas.
*
* ## 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: "test",
* description: "my description",
* });
* ```
*/
export declare class Rir extends pulumi.CustomResource {
/**
* Get an existing Rir 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: string, id: pulumi.Input<pulumi.ID>, state?: RirState, opts?: pulumi.CustomResourceOptions): Rir;
/**
* Returns true if the given object is an instance of Rir. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is Rir;
readonly description: pulumi.Output<string | undefined>;
/**
* Defaults to `false`.
*/
readonly isPrivate: pulumi.Output<boolean | undefined>;
readonly name: pulumi.Output<string>;
readonly slug: pulumi.Output<string>;
/**
* Create a Rir resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args?: RirArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Rir resources.
*/
export interface RirState {
description?: pulumi.Input<string>;
/**
* Defaults to `false`.
*/
isPrivate?: pulumi.Input<boolean>;
name?: pulumi.Input<string>;
slug?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a Rir resource.
*/
export interface RirArgs {
description?: pulumi.Input<string>;
/**
* Defaults to `false`.
*/
isPrivate?: pulumi.Input<boolean>;
name?: pulumi.Input<string>;
slug?: pulumi.Input<string>;
}