@natzka-oss/pulumi-netbox
Version:
A Pulumi package for creating and managing Netbox cloud resources.
57 lines (56 loc) • 2.32 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* From the [official documentation](https://docs.netbox.dev/en/stable/features/contacts/#contactroles):
*
* > A contact role defines the relationship of a contact to an assigned object. For example, you might define roles for administrative, operational, and emergency contacts
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as netbox from "@natzka-oss/pulumi-netbox";
*
* const test = new netbox.tenancy.ContactRole("test", {name: "test"});
* ```
*/
export declare class ContactRole extends pulumi.CustomResource {
/**
* Get an existing ContactRole 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?: ContactRoleState, opts?: pulumi.CustomResourceOptions): ContactRole;
/**
* Returns true if the given object is an instance of ContactRole. 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 ContactRole;
readonly name: pulumi.Output<string>;
readonly slug: pulumi.Output<string>;
/**
* Create a ContactRole 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?: ContactRoleArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering ContactRole resources.
*/
export interface ContactRoleState {
name?: pulumi.Input<string>;
slug?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a ContactRole resource.
*/
export interface ContactRoleArgs {
name?: pulumi.Input<string>;
slug?: pulumi.Input<string>;
}