@pulumi/opsgenie
Version:
A Pulumi package for creating and managing opsgenie cloud resources.
105 lines (104 loc) • 4.38 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Manages custom user roles within Opsgenie.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as opsgenie from "@pulumi/opsgenie";
*
* const test = new opsgenie.CustomRole("test", {
* roleName: "genierole",
* extendedRole: "user",
* grantedRights: ["alert-delete"],
* disallowedRights: [
* "profile-edit",
* "contacts-edit",
* ],
* });
* ```
*/
export declare class CustomRole extends pulumi.CustomResource {
/**
* Get an existing CustomRole 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?: CustomRoleState, opts?: pulumi.CustomResourceOptions): CustomRole;
/**
* Returns true if the given object is an instance of CustomRole. 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 CustomRole;
/**
* The rights this role cannot have. For allowed values please refer [User Right Prerequisites](https://docs.opsgenie.com/docs/custom-user-role-api#section-user-right-prerequisites)
*/
readonly disallowedRights: pulumi.Output<string[] | undefined>;
/**
* The role from which this role has been derived. Allowed Values: "user", "observer", "stakeholder".
*/
readonly extendedRole: pulumi.Output<string | undefined>;
/**
* The rights granted to this role. For allowed values please refer [User Right Prerequisites](https://docs.opsgenie.com/docs/custom-user-role-api#section-user-right-prerequisites)
*/
readonly grantedRights: pulumi.Output<string[] | undefined>;
/**
* Name of the custom role.
*/
readonly roleName: pulumi.Output<string>;
/**
* Create a CustomRole 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: CustomRoleArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering CustomRole resources.
*/
export interface CustomRoleState {
/**
* The rights this role cannot have. For allowed values please refer [User Right Prerequisites](https://docs.opsgenie.com/docs/custom-user-role-api#section-user-right-prerequisites)
*/
disallowedRights?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The role from which this role has been derived. Allowed Values: "user", "observer", "stakeholder".
*/
extendedRole?: pulumi.Input<string>;
/**
* The rights granted to this role. For allowed values please refer [User Right Prerequisites](https://docs.opsgenie.com/docs/custom-user-role-api#section-user-right-prerequisites)
*/
grantedRights?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Name of the custom role.
*/
roleName?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a CustomRole resource.
*/
export interface CustomRoleArgs {
/**
* The rights this role cannot have. For allowed values please refer [User Right Prerequisites](https://docs.opsgenie.com/docs/custom-user-role-api#section-user-right-prerequisites)
*/
disallowedRights?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The role from which this role has been derived. Allowed Values: "user", "observer", "stakeholder".
*/
extendedRole?: pulumi.Input<string>;
/**
* The rights granted to this role. For allowed values please refer [User Right Prerequisites](https://docs.opsgenie.com/docs/custom-user-role-api#section-user-right-prerequisites)
*/
grantedRights?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Name of the custom role.
*/
roleName: pulumi.Input<string>;
}