@natzka-oss/pulumi-netbox
Version:
A Pulumi package for creating and managing Netbox cloud resources.
70 lines (69 loc) • 3.13 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* From the [official documentation](https://docs.netbox.dev/en/stable/models/ipam/routetarget/):
*
* > A route target is a particular type of extended BGP community used to control the redistribution of routes among VRF tables in a network. Route targets can be assigned to individual VRFs in NetBox as import or export targets (or both) to model this exchange in an L3VPN. Each route target must be given a unique name, which should be in a format prescribed by RFC 4364, similar to a VR route distinguisher.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as netbox from "@natzka-oss/pulumi-netbox";
*
* const test = new netbox.tenancy.Tenant("test", {name: "test"});
* const testRouteTarget = new netbox.ipam.RouteTarget("test", {
* name: "test",
* description: "my description",
* tenantId: test.id,
* });
* ```
*/
export declare class RouteTarget extends pulumi.CustomResource {
/**
* Get an existing RouteTarget 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?: RouteTargetState, opts?: pulumi.CustomResourceOptions): RouteTarget;
/**
* Returns true if the given object is an instance of RouteTarget. 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 RouteTarget;
readonly description: pulumi.Output<string | undefined>;
readonly name: pulumi.Output<string>;
readonly tags: pulumi.Output<string[] | undefined>;
readonly tagsAlls: pulumi.Output<string[]>;
readonly tenantId: pulumi.Output<number | undefined>;
/**
* Create a RouteTarget 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?: RouteTargetArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering RouteTarget resources.
*/
export interface RouteTargetState {
description?: pulumi.Input<string>;
name?: pulumi.Input<string>;
tags?: pulumi.Input<pulumi.Input<string>[]>;
tagsAlls?: pulumi.Input<pulumi.Input<string>[]>;
tenantId?: pulumi.Input<number>;
}
/**
* The set of arguments for constructing a RouteTarget resource.
*/
export interface RouteTargetArgs {
description?: pulumi.Input<string>;
name?: pulumi.Input<string>;
tags?: pulumi.Input<pulumi.Input<string>[]>;
tenantId?: pulumi.Input<number>;
}