@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
101 lines (100 loc) • 2.61 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* This data source can be used to fetch information about a specific
* IAM user. By using this data source, you can reference IAM user
* properties without having to hard code ARNs or unique IDs as input.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = aws.iam.getUser({
* userName: "an_example_user_name",
* });
* ```
*/
export declare function getUser(args: GetUserArgs, opts?: pulumi.InvokeOptions): Promise<GetUserResult>;
/**
* A collection of arguments for invoking getUser.
*/
export interface GetUserArgs {
/**
* Map of key-value pairs associated with the user.
*/
tags?: {
[key: string]: string;
};
/**
* Friendly IAM user name to match.
*/
userName: string;
}
/**
* A collection of values returned by getUser.
*/
export interface GetUserResult {
/**
* ARN assigned by AWS for this user.
*/
readonly arn: string;
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
/**
* Path in which this user was created.
*/
readonly path: string;
/**
* The ARN of the policy that is used to set the permissions boundary for the user.
*/
readonly permissionsBoundary: string;
/**
* Map of key-value pairs associated with the user.
*/
readonly tags: {
[key: string]: string;
};
/**
* Unique ID assigned by AWS for this user.
*/
readonly userId: string;
/**
* Name associated to this User
*/
readonly userName: string;
}
/**
* This data source can be used to fetch information about a specific
* IAM user. By using this data source, you can reference IAM user
* properties without having to hard code ARNs or unique IDs as input.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = aws.iam.getUser({
* userName: "an_example_user_name",
* });
* ```
*/
export declare function getUserOutput(args: GetUserOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetUserResult>;
/**
* A collection of arguments for invoking getUser.
*/
export interface GetUserOutputArgs {
/**
* Map of key-value pairs associated with the user.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* Friendly IAM user name to match.
*/
userName: pulumi.Input<string>;
}