@natzka-oss/pulumi-netbox
Version:
A Pulumi package for creating and managing Netbox cloud resources.
109 lines (108 loc) • 3.65 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* 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",
* });
* ```
*/
export declare 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: string, id: pulumi.Input<pulumi.ID>, state?: AsnState, opts?: pulumi.CustomResourceOptions): Asn;
/**
* 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: any): obj is Asn;
/**
* Value for the AS Number record.
*/
readonly asn: pulumi.Output<number>;
/**
* Comments field for the AS Number record.
*/
readonly comments: pulumi.Output<string | undefined>;
/**
* Description field for the AS Number record.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* ID for the RIR for the AS Number record.
*/
readonly rirId: pulumi.Output<number>;
readonly tags: pulumi.Output<string[] | undefined>;
/**
* Create a Asn 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: AsnArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Asn resources.
*/
export interface AsnState {
/**
* Value for the AS Number record.
*/
asn?: pulumi.Input<number>;
/**
* Comments field for the AS Number record.
*/
comments?: pulumi.Input<string>;
/**
* Description field for the AS Number record.
*/
description?: pulumi.Input<string>;
/**
* ID for the RIR for the AS Number record.
*/
rirId?: pulumi.Input<number>;
tags?: pulumi.Input<pulumi.Input<string>[]>;
}
/**
* The set of arguments for constructing a Asn resource.
*/
export interface AsnArgs {
/**
* Value for the AS Number record.
*/
asn: pulumi.Input<number>;
/**
* Comments field for the AS Number record.
*/
comments?: pulumi.Input<string>;
/**
* Description field for the AS Number record.
*/
description?: pulumi.Input<string>;
/**
* ID for the RIR for the AS Number record.
*/
rirId: pulumi.Input<number>;
tags?: pulumi.Input<pulumi.Input<string>[]>;
}