@pulumi/openstack
Version:
A Pulumi package for creating and managing OpenStack cloud resources.
99 lines (98 loc) • 2.45 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Use this data source to get the ID of an OpenStack group.
*
* > **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 admins = openstack.identity.getGroup({
* name: "admins",
* });
* ```
*/
export declare function getGroup(args: GetGroupArgs, opts?: pulumi.InvokeOptions): Promise<GetGroupResult>;
/**
* A collection of arguments for invoking getGroup.
*/
export interface GetGroupArgs {
/**
* The domain the group belongs to.
*/
domainId?: string;
/**
* The name of the group.
*/
name: string;
/**
* The region in which to obtain the V3 Keystone client.
* If omitted, the `region` argument of the provider is used.
*/
region?: string;
}
/**
* A collection of values returned by getGroup.
*/
export interface GetGroupResult {
/**
* A description of the group.
*/
readonly description: string;
/**
* See Argument Reference above.
*/
readonly domainId: string;
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
/**
* See Argument Reference above.
*/
readonly name: string;
/**
* See Argument Reference above.
*/
readonly region: string;
}
/**
* Use this data source to get the ID of an OpenStack group.
*
* > **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 admins = openstack.identity.getGroup({
* name: "admins",
* });
* ```
*/
export declare function getGroupOutput(args: GetGroupOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetGroupResult>;
/**
* A collection of arguments for invoking getGroup.
*/
export interface GetGroupOutputArgs {
/**
* The domain the group belongs to.
*/
domainId?: pulumi.Input<string>;
/**
* The name of the group.
*/
name: pulumi.Input<string>;
/**
* The region in which to obtain the V3 Keystone client.
* If omitted, the `region` argument of the provider is used.
*/
region?: pulumi.Input<string>;
}