@natzka-oss/pulumi-netbox
Version:
A Pulumi package for creating and managing Netbox cloud resources.
157 lines (156 loc) • 5.73 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as netbox from "@natzka-oss/pulumi-netbox";
*
* const test = netbox.ipam.getPrefix({
* cidr: "10.0.0.0/24",
* });
* const testAvailablePrefix = new netbox.ipam.AvailablePrefix("test", {
* parentPrefixId: test.then(test => test.id),
* prefixLength: 25,
* status: "active",
* });
* ```
*/
export declare class AvailablePrefix extends pulumi.CustomResource {
/**
* Get an existing AvailablePrefix 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?: AvailablePrefixState, opts?: pulumi.CustomResourceOptions): AvailablePrefix;
/**
* Returns true if the given object is an instance of AvailablePrefix. 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 AvailablePrefix;
readonly customFields: pulumi.Output<{
[key: string]: string;
} | undefined>;
readonly description: pulumi.Output<string | undefined>;
readonly isPool: pulumi.Output<boolean | undefined>;
/**
* Conflicts with `siteId`, `siteGroupId` and `regionId`.
*/
readonly locationId: pulumi.Output<number | undefined>;
readonly markUtilized: pulumi.Output<boolean | undefined>;
readonly parentPrefixId: pulumi.Output<number>;
readonly prefix: pulumi.Output<string>;
readonly prefixLength: pulumi.Output<number>;
/**
* Conflicts with `locationId`, `siteId` and `siteGroupId`.
*/
readonly regionId: pulumi.Output<number | undefined>;
readonly roleId: pulumi.Output<number | undefined>;
/**
* Conflicts with `locationId`, `siteId` and `regionId`.
*/
readonly siteGroupId: pulumi.Output<number | undefined>;
/**
* Conflicts with `locationId`, `siteGroupId` and `regionId`.
*/
readonly siteId: pulumi.Output<number | undefined>;
/**
* Valid values are `active`, `container`, `reserved` and `deprecated`.
*/
readonly status: pulumi.Output<string>;
readonly tags: pulumi.Output<string[] | undefined>;
readonly tagsAlls: pulumi.Output<string[]>;
readonly tenantId: pulumi.Output<number | undefined>;
readonly vlanId: pulumi.Output<number | undefined>;
readonly vrfId: pulumi.Output<number | undefined>;
/**
* Create a AvailablePrefix 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: AvailablePrefixArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering AvailablePrefix resources.
*/
export interface AvailablePrefixState {
customFields?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
description?: pulumi.Input<string>;
isPool?: pulumi.Input<boolean>;
/**
* Conflicts with `siteId`, `siteGroupId` and `regionId`.
*/
locationId?: pulumi.Input<number>;
markUtilized?: pulumi.Input<boolean>;
parentPrefixId?: pulumi.Input<number>;
prefix?: pulumi.Input<string>;
prefixLength?: pulumi.Input<number>;
/**
* Conflicts with `locationId`, `siteId` and `siteGroupId`.
*/
regionId?: pulumi.Input<number>;
roleId?: pulumi.Input<number>;
/**
* Conflicts with `locationId`, `siteId` and `regionId`.
*/
siteGroupId?: pulumi.Input<number>;
/**
* Conflicts with `locationId`, `siteGroupId` and `regionId`.
*/
siteId?: pulumi.Input<number>;
/**
* Valid values are `active`, `container`, `reserved` and `deprecated`.
*/
status?: pulumi.Input<string>;
tags?: pulumi.Input<pulumi.Input<string>[]>;
tagsAlls?: pulumi.Input<pulumi.Input<string>[]>;
tenantId?: pulumi.Input<number>;
vlanId?: pulumi.Input<number>;
vrfId?: pulumi.Input<number>;
}
/**
* The set of arguments for constructing a AvailablePrefix resource.
*/
export interface AvailablePrefixArgs {
customFields?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
description?: pulumi.Input<string>;
isPool?: pulumi.Input<boolean>;
/**
* Conflicts with `siteId`, `siteGroupId` and `regionId`.
*/
locationId?: pulumi.Input<number>;
markUtilized?: pulumi.Input<boolean>;
parentPrefixId: pulumi.Input<number>;
prefixLength: pulumi.Input<number>;
/**
* Conflicts with `locationId`, `siteId` and `siteGroupId`.
*/
regionId?: pulumi.Input<number>;
roleId?: pulumi.Input<number>;
/**
* Conflicts with `locationId`, `siteId` and `regionId`.
*/
siteGroupId?: pulumi.Input<number>;
/**
* Conflicts with `locationId`, `siteGroupId` and `regionId`.
*/
siteId?: pulumi.Input<number>;
/**
* Valid values are `active`, `container`, `reserved` and `deprecated`.
*/
status: pulumi.Input<string>;
tags?: pulumi.Input<pulumi.Input<string>[]>;
tenantId?: pulumi.Input<number>;
vlanId?: pulumi.Input<number>;
vrfId?: pulumi.Input<number>;
}