UNPKG

@lbrlabs/pulumi-harness

Version:

A Pulumi package for creating and managing Harness resources.

171 lines (170 loc) 4.89 kB
import * as pulumi from "@pulumi/pulumi"; /** * Resource for creating roles. * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as harness from "@lbrlabs/pulumi-harness"; * * const example = new harness.platform.Roles("example", { * allowedScopeLevels: ["account"], * description: "test", * identifier: "identifier", * permissions: ["core_resourcegroup_view"], * tags: ["foo:bar"], * }); * ``` * * ## Import * * Import account level roles * * ```sh * $ pulumi import harness:platform/roles:Roles example <roles_id> * ``` * * Import org level roles * * ```sh * $ pulumi import harness:platform/roles:Roles example <ord_id>/<roles_id> * ``` * * Import project level roles * * ```sh * $ pulumi import harness:platform/roles:Roles example <org_id>/<project_id>/<roles_id> * ``` */ export declare class Roles extends pulumi.CustomResource { /** * Get an existing Roles 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?: RolesState, opts?: pulumi.CustomResourceOptions): Roles; /** * Returns true if the given object is an instance of Roles. 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 Roles; /** * The scope levels at which this role can be used */ readonly allowedScopeLevels: pulumi.Output<string[]>; /** * Description of the resource. */ readonly description: pulumi.Output<string | undefined>; /** * Unique identifier of the resource. */ readonly identifier: pulumi.Output<string>; /** * Name of the resource. */ readonly name: pulumi.Output<string>; /** * Unique identifier of the organization. */ readonly orgId: pulumi.Output<string | undefined>; /** * List of the permission identifiers */ readonly permissions: pulumi.Output<string[] | undefined>; /** * Unique identifier of the project. */ readonly projectId: pulumi.Output<string | undefined>; /** * Tags to associate with the resource. */ readonly tags: pulumi.Output<string[] | undefined>; /** * Create a Roles 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: RolesArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering Roles resources. */ export interface RolesState { /** * The scope levels at which this role can be used */ allowedScopeLevels?: pulumi.Input<pulumi.Input<string>[]>; /** * Description of the resource. */ description?: pulumi.Input<string>; /** * Unique identifier of the resource. */ identifier?: pulumi.Input<string>; /** * Name of the resource. */ name?: pulumi.Input<string>; /** * Unique identifier of the organization. */ orgId?: pulumi.Input<string>; /** * List of the permission identifiers */ permissions?: pulumi.Input<pulumi.Input<string>[]>; /** * Unique identifier of the project. */ projectId?: pulumi.Input<string>; /** * Tags to associate with the resource. */ tags?: pulumi.Input<pulumi.Input<string>[]>; } /** * The set of arguments for constructing a Roles resource. */ export interface RolesArgs { /** * The scope levels at which this role can be used */ allowedScopeLevels?: pulumi.Input<pulumi.Input<string>[]>; /** * Description of the resource. */ description?: pulumi.Input<string>; /** * Unique identifier of the resource. */ identifier: pulumi.Input<string>; /** * Name of the resource. */ name?: pulumi.Input<string>; /** * Unique identifier of the organization. */ orgId?: pulumi.Input<string>; /** * List of the permission identifiers */ permissions?: pulumi.Input<pulumi.Input<string>[]>; /** * Unique identifier of the project. */ projectId?: pulumi.Input<string>; /** * Tags to associate with the resource. */ tags?: pulumi.Input<pulumi.Input<string>[]>; }