@pulumiverse/scaleway
Version:
A Pulumi package for creating and managing Scaleway cloud resources.
105 lines (104 loc) • 2.93 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Gets information about an existing IAM group.
*
* For more information, refer to the [IAM API documentation](https://developers.scaleway.com/en/products/iam/api/v1alpha1/#applications-83ce5e)
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@pulumi/scaleway";
*
* // Get info by name
* const findByName = scaleway.iam.getGroup({
* name: "foobar",
* });
* // Get info by group ID
* const findById = scaleway.iam.getGroup({
* groupId: "11111111-1111-1111-1111-111111111111",
* });
* ```
*/
export declare function getGroup(args?: GetGroupArgs, opts?: pulumi.InvokeOptions): Promise<GetGroupResult>;
/**
* A collection of arguments for invoking getGroup.
*/
export interface GetGroupArgs {
/**
* The ID of the IAM group.
*
* > **Note** You must specify at least one: `name` and/or `groupId`.
*/
groupId?: string;
/**
* The name of the IAM group.
*/
name?: string;
/**
* `organizationId`) The ID of the
* organization the group is associated with.
*/
organizationId?: string;
}
/**
* A collection of values returned by getGroup.
*/
export interface GetGroupResult {
readonly applicationIds: string[];
readonly createdAt: string;
readonly description: string;
readonly externalMembership: boolean;
readonly groupId?: string;
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
readonly name?: string;
readonly organizationId?: string;
readonly tags: string[];
readonly updatedAt: string;
readonly userIds: string[];
}
/**
* Gets information about an existing IAM group.
*
* For more information, refer to the [IAM API documentation](https://developers.scaleway.com/en/products/iam/api/v1alpha1/#applications-83ce5e)
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@pulumi/scaleway";
*
* // Get info by name
* const findByName = scaleway.iam.getGroup({
* name: "foobar",
* });
* // Get info by group ID
* const findById = scaleway.iam.getGroup({
* groupId: "11111111-1111-1111-1111-111111111111",
* });
* ```
*/
export declare function getGroupOutput(args?: GetGroupOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetGroupResult>;
/**
* A collection of arguments for invoking getGroup.
*/
export interface GetGroupOutputArgs {
/**
* The ID of the IAM group.
*
* > **Note** You must specify at least one: `name` and/or `groupId`.
*/
groupId?: pulumi.Input<string>;
/**
* The name of the IAM group.
*/
name?: pulumi.Input<string>;
/**
* `organizationId`) The ID of the
* organization the group is associated with.
*/
organizationId?: pulumi.Input<string>;
}