@pulumi/openstack
Version:
A Pulumi package for creating and managing OpenStack cloud resources.
102 lines (101 loc) • 3.27 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Manages a V3 Role resource within OpenStack Keystone.
*
* > **Note:** You _must_ have admin privileges in your OpenStack cloud to use
* this resource.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as openstack from "@pulumi/openstack";
*
* const role1 = new openstack.identity.Role("role_1", {name: "role_1"});
* ```
*
* ## Import
*
* Roles can be imported using the `id`, e.g.
*
* ```sh
* $ pulumi import openstack:identity/role:Role role_1 89c60255-9bd6-460c-822a-e2b959ede9d2
* ```
*/
export declare class Role extends pulumi.CustomResource {
/**
* Get an existing Role 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?: RoleState, opts?: pulumi.CustomResourceOptions): Role;
/**
* Returns true if the given object is an instance of Role. 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 Role;
/**
* The domain the role belongs to.
*/
readonly domainId: pulumi.Output<string>;
/**
* The name of the role.
*/
readonly name: pulumi.Output<string>;
/**
* The region in which to obtain the V3 Keystone client.
* If omitted, the `region` argument of the provider is used. Changing this
* creates a new Role.
*/
readonly region: pulumi.Output<string>;
/**
* Create a Role 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?: RoleArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Role resources.
*/
export interface RoleState {
/**
* The domain the role belongs to.
*/
domainId?: pulumi.Input<string>;
/**
* The name of the role.
*/
name?: pulumi.Input<string>;
/**
* The region in which to obtain the V3 Keystone client.
* If omitted, the `region` argument of the provider is used. Changing this
* creates a new Role.
*/
region?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a Role resource.
*/
export interface RoleArgs {
/**
* The domain the role belongs to.
*/
domainId?: pulumi.Input<string>;
/**
* The name of the role.
*/
name?: pulumi.Input<string>;
/**
* The region in which to obtain the V3 Keystone client.
* If omitted, the `region` argument of the provider is used. Changing this
* creates a new Role.
*/
region?: pulumi.Input<string>;
}