@lbrlabs/pulumi-harness
Version:
A Pulumi package for creating and managing Harness resources.
229 lines (228 loc) • 7.12 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Resource for creating role assignments in Harness.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as harness from "@lbrlabs/pulumi-harness";
*
* //To create a role binding in service account
* const example1RoleAssignments = new harness.platform.RoleAssignments("example1RoleAssignments", {
* orgId: "org_id",
* projectId: "project_id",
* resourceGroupIdentifier: "_all_project_level_resources",
* roleIdentifier: "_project_viewer",
* principals: [{
* identifier: harness_platform_service_account.test.id,
* type: "SERVICE_ACCOUNT",
* }],
* disabled: false,
* managed: false,
* });
* //To create a role binding in user group
* const example1Platform_roleAssignmentsRoleAssignments = new harness.platform.RoleAssignments("example1Platform/roleAssignmentsRoleAssignments", {
* orgId: "org_id",
* projectId: "project_id",
* resourceGroupIdentifier: "_all_project_level_resources",
* roleIdentifier: "_project_viewer",
* principals: [{
* identifier: harness_platform_usergroup.test.id,
* type: "USER_GROUP",
* }],
* disabled: false,
* managed: false,
* });
* const example2RoleAssignments = new harness.platform.RoleAssignments("example2RoleAssignments", {
* identifier: "identifier",
* orgId: "org_id",
* projectId: "project_id",
* resourceGroupIdentifier: "_all_project_level_resources",
* roleIdentifier: "_project_viewer",
* principals: [{
* identifier: "user_id",
* type: "USER",
* }],
* disabled: false,
* managed: false,
* });
* const example2Platform_roleAssignmentsRoleAssignments = new harness.platform.RoleAssignments("example2Platform/roleAssignmentsRoleAssignments", {
* orgId: "org_id",
* projectId: "project_id",
* resourceGroupIdentifier: "_all_project_level_resources",
* roleIdentifier: "_project_viewer",
* principals: [{
* identifier: "service_id",
* type: "SERVICE",
* }],
* disabled: false,
* managed: false,
* });
* const example2HarnessPlatform_roleAssignmentsRoleAssignments = new harness.platform.RoleAssignments("example2HarnessPlatform/roleAssignmentsRoleAssignments", {
* orgId: "org_id",
* projectId: "project_id",
* resourceGroupIdentifier: "_all_project_level_resources",
* roleIdentifier: "_project_viewer",
* principals: [{
* identifier: "api_key_id",
* type: "API_KEY",
* }],
* disabled: false,
* managed: false,
* });
* ```
*
* ## Import
*
* Import account level role assignments
*
* ```sh
* $ pulumi import harness:platform/roleAssignments:RoleAssignments example <role_assignments_id>
* ```
*
* Import org level role assignments
*
* ```sh
* $ pulumi import harness:platform/roleAssignments:RoleAssignments example <ord_id>/<role_assignments_id>
* ```
*
* Import project level role assignments
*
* ```sh
* $ pulumi import harness:platform/roleAssignments:RoleAssignments example <org_id>/<project_id>/<role_assignments_id>
* ```
*/
export declare class RoleAssignments extends pulumi.CustomResource {
/**
* Get an existing RoleAssignments 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?: RoleAssignmentsState, opts?: pulumi.CustomResourceOptions): RoleAssignments;
/**
* Returns true if the given object is an instance of RoleAssignments. 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 RoleAssignments;
/**
* Disabled or not.
*/
readonly disabled: pulumi.Output<boolean | undefined>;
/**
* Identifier for role assignment.
*/
readonly identifier: pulumi.Output<string>;
/**
* Managed or not.
*/
readonly managed: pulumi.Output<boolean | undefined>;
/**
* Org identifier.
*/
readonly orgId: pulumi.Output<string | undefined>;
/**
* Principal.
*/
readonly principals: pulumi.Output<outputs.platform.RoleAssignmentsPrincipal[]>;
/**
* Project Identifier
*/
readonly projectId: pulumi.Output<string | undefined>;
/**
* Resource group identifier.
*/
readonly resourceGroupIdentifier: pulumi.Output<string>;
/**
* Role identifier.
*/
readonly roleIdentifier: pulumi.Output<string>;
/**
* Create a RoleAssignments 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: RoleAssignmentsArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering RoleAssignments resources.
*/
export interface RoleAssignmentsState {
/**
* Disabled or not.
*/
disabled?: pulumi.Input<boolean>;
/**
* Identifier for role assignment.
*/
identifier?: pulumi.Input<string>;
/**
* Managed or not.
*/
managed?: pulumi.Input<boolean>;
/**
* Org identifier.
*/
orgId?: pulumi.Input<string>;
/**
* Principal.
*/
principals?: pulumi.Input<pulumi.Input<inputs.platform.RoleAssignmentsPrincipal>[]>;
/**
* Project Identifier
*/
projectId?: pulumi.Input<string>;
/**
* Resource group identifier.
*/
resourceGroupIdentifier?: pulumi.Input<string>;
/**
* Role identifier.
*/
roleIdentifier?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a RoleAssignments resource.
*/
export interface RoleAssignmentsArgs {
/**
* Disabled or not.
*/
disabled?: pulumi.Input<boolean>;
/**
* Identifier for role assignment.
*/
identifier?: pulumi.Input<string>;
/**
* Managed or not.
*/
managed?: pulumi.Input<boolean>;
/**
* Org identifier.
*/
orgId?: pulumi.Input<string>;
/**
* Principal.
*/
principals: pulumi.Input<pulumi.Input<inputs.platform.RoleAssignmentsPrincipal>[]>;
/**
* Project Identifier
*/
projectId?: pulumi.Input<string>;
/**
* Resource group identifier.
*/
resourceGroupIdentifier: pulumi.Input<string>;
/**
* Role identifier.
*/
roleIdentifier: pulumi.Input<string>;
}