@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
81 lines (80 loc) • 2.15 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
* This data source can be used to fetch information about a specific
* IAM group. By using this data source, you can reference IAM group
* properties without having to hard code ARNs as input.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = aws.iam.getGroup({
* groupName: "an_example_group_name",
* });
* ```
*/
export declare function getGroup(args: GetGroupArgs, opts?: pulumi.InvokeOptions): Promise<GetGroupResult>;
/**
* A collection of arguments for invoking getGroup.
*/
export interface GetGroupArgs {
/**
* Friendly IAM group name to match.
*/
groupName: string;
}
/**
* A collection of values returned by getGroup.
*/
export interface GetGroupResult {
/**
* User ARN.
*/
readonly arn: string;
/**
* Stable and unique string identifying the group.
*/
readonly groupId: string;
readonly groupName: string;
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
/**
* Path to the IAM user.
*/
readonly path: string;
/**
* List of objects containing group member information. See below.
*/
readonly users: outputs.iam.GetGroupUser[];
}
/**
* This data source can be used to fetch information about a specific
* IAM group. By using this data source, you can reference IAM group
* properties without having to hard code ARNs as input.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = aws.iam.getGroup({
* groupName: "an_example_group_name",
* });
* ```
*/
export declare function getGroupOutput(args: GetGroupOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetGroupResult>;
/**
* A collection of arguments for invoking getGroup.
*/
export interface GetGroupOutputArgs {
/**
* Friendly IAM group name to match.
*/
groupName: pulumi.Input<string>;
}