pulumi-netbox/provider.d.ts

A Pulumi package for creating and managing Netbox resources.

import * as pulumi from "@pulumi/pulumi";
/**
 * The provider type for the netbox package. By default, resources use package-wide configuration
 * settings, however an explicit `Provider` instance may be created and passed during resource
 * construction to achieve fine-grained programmatic control over provider settings. See the
 * [documentation](https://www.pulumi.com/docs/reference/programming-model/#providers) for more information.
 */
export declare class Provider extends pulumi.ProviderResource {
    /**
     * Returns true if the given object is an instance of Provider.  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 Provider;
    /**
     * Netbox API authentication token
     */
    readonly apiToken: pulumi.Output<string | undefined>;
    /**
     * Location of Netbox server including scheme and optional port
     */
    readonly serverUrl: pulumi.Output<string | undefined>;
    /**
     * Create a Provider 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?: ProviderArgs, opts?: pulumi.ResourceOptions);
}
/**
 * The set of arguments for constructing a Provider resource.
 */
export interface ProviderArgs {
    /**
     * Flag to set whether to allow https with invalid certificates
     */
    allowInsecureHttps?: pulumi.Input<boolean>;
    /**
     * Netbox API authentication token
     */
    apiToken?: pulumi.Input<string>;
    /**
     * Set these header on all requests to Netbox
     */
    headers?: pulumi.Input<{
        [key: string]: any;
    }>;
    /**
     * Location of Netbox server including scheme and optional port
     */
    serverUrl?: pulumi.Input<string>;
    /**
     * If true, do not try to determine the running Netbox version at provider startup. Disables warnings about possibly
     * unsupported Netbox version. Also useful for local testing on terraform plans.
     */
    skipVersionCheck?: pulumi.Input<boolean>;
}