@natzka-oss/pulumi-netbox/dcim/deviceRole.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/features/devices/#device-roles):
 *
 * > Devices can be organized by functional roles, which are fully customizable by the user. For example, you might create roles for core switches, distribution switches, and access switches within your network.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as netbox from "@natzka-oss/pulumi-netbox";
 *
 * const coreSw = new netbox.dcim.DeviceRole("core_sw", {
 *     colorHex: "FF00FF",
 *     name: "core-sw",
 * });
 * ```
 */
export declare class DeviceRole extends pulumi.CustomResource {
    /**
     * Get an existing DeviceRole 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?: DeviceRoleState, opts?: pulumi.CustomResourceOptions): DeviceRole;
    /**
     * Returns true if the given object is an instance of DeviceRole.  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 DeviceRole;
    readonly colorHex: pulumi.Output<string>;
    readonly description: pulumi.Output<string | undefined>;
    readonly name: pulumi.Output<string>;
    readonly slug: pulumi.Output<string>;
    readonly tags: pulumi.Output<string[] | undefined>;
    /**
     * Defaults to `true`.
     */
    readonly vmRole: pulumi.Output<boolean | undefined>;
    /**
     * Create a DeviceRole 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: DeviceRoleArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering DeviceRole resources.
 */
export interface DeviceRoleState {
    colorHex?: pulumi.Input<string>;
    description?: pulumi.Input<string>;
    name?: pulumi.Input<string>;
    slug?: pulumi.Input<string>;
    tags?: pulumi.Input<pulumi.Input<string>[]>;
    /**
     * Defaults to `true`.
     */
    vmRole?: pulumi.Input<boolean>;
}
/**
 * The set of arguments for constructing a DeviceRole resource.
 */
export interface DeviceRoleArgs {
    colorHex: pulumi.Input<string>;
    description?: pulumi.Input<string>;
    name?: pulumi.Input<string>;
    slug?: pulumi.Input<string>;
    tags?: pulumi.Input<pulumi.Input<string>[]>;
    /**
     * Defaults to `true`.
     */
    vmRole?: pulumi.Input<boolean>;
}