@natzka-oss/pulumi-netbox/configTemplate.d.ts

A Pulumi package for creating and managing Netbox cloud resources.

import * as pulumi from "@pulumi/pulumi";
/**
 * From the [official documentation](https://docs.netbox.dev/en/stable/models/extras/configtemplate/):
 *
 * > Configuration templates can be used to render device configurations from context data. Templates are written in the Jinja2 language and can be associated with devices roles, platforms, and/or individual devices.
 *
 * > Context data is made available to devices and/or virtual machines based on their relationships to other objects in NetBox. For example, context data can be associated only with devices assigned to a particular site, or only to virtual machines in a certain cluster.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as netbox from "@natzka-oss/pulumi-netbox";
 *
 * const test = new netbox.ConfigTemplate("test", {
 *     name: "test",
 *     description: "test description",
 *     templateCode: "hostname {{ name }}",
 *     environmentParams: JSON.stringify({
 *         name: "my-hostname",
 *     }),
 * });
 * ```
 */
export declare class ConfigTemplate extends pulumi.CustomResource {
    /**
     * Get an existing ConfigTemplate 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?: ConfigTemplateState, opts?: pulumi.CustomResourceOptions): ConfigTemplate;
    /**
     * Returns true if the given object is an instance of ConfigTemplate.  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 ConfigTemplate;
    readonly description: pulumi.Output<string | undefined>;
    /**
     * Defaults to `{}`.
     */
    readonly environmentParams: pulumi.Output<string | undefined>;
    readonly name: pulumi.Output<string>;
    readonly tags: pulumi.Output<string[] | undefined>;
    readonly templateCode: pulumi.Output<string>;
    /**
     * Create a ConfigTemplate 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: ConfigTemplateArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering ConfigTemplate resources.
 */
export interface ConfigTemplateState {
    description?: pulumi.Input<string>;
    /**
     * Defaults to `{}`.
     */
    environmentParams?: pulumi.Input<string>;
    name?: pulumi.Input<string>;
    tags?: pulumi.Input<pulumi.Input<string>[]>;
    templateCode?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a ConfigTemplate resource.
 */
export interface ConfigTemplateArgs {
    description?: pulumi.Input<string>;
    /**
     * Defaults to `{}`.
     */
    environmentParams?: pulumi.Input<string>;
    name?: pulumi.Input<string>;
    tags?: pulumi.Input<pulumi.Input<string>[]>;
    templateCode: pulumi.Input<string>;
}