@pulumi/aws/identitystore/getUser.d.ts

A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.

import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
 * Use this data source to get an Identity Store User.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as aws from "@pulumi/aws";
 *
 * const example = aws.ssoadmin.getInstances({});
 * const exampleGetUser = example.then(example => aws.identitystore.getUser({
 *     identityStoreId: example.identityStoreIds?.[0],
 *     alternateIdentifier: {
 *         uniqueAttribute: {
 *             attributePath: "UserName",
 *             attributeValue: "ExampleUser",
 *         },
 *     },
 * }));
 * export const userId = exampleGetUser.then(exampleGetUser => exampleGetUser.userId);
 * ```
 */
export declare function getUser(args: GetUserArgs, opts?: pulumi.InvokeOptions): Promise<GetUserResult>;
/**
 * A collection of arguments for invoking getUser.
 */
export interface GetUserArgs {
    /**
     * A unique identifier for a user or group that is not the primary identifier. Conflicts with `userId` and `filter`. Detailed below.
     */
    alternateIdentifier?: inputs.identitystore.GetUserAlternateIdentifier;
    /**
     * Identity Store ID associated with the Single Sign-On Instance.
     *
     * The following arguments are optional:
     */
    identityStoreId: string;
    /**
     * Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
     */
    region?: string;
    /**
     * The identifier for a user in the Identity Store.
     *
     * > Exactly one of the above arguments must be provided. Passing both `filter` and `userId` is allowed for backwards compatibility.
     */
    userId?: string;
}
/**
 * A collection of values returned by getUser.
 */
export interface GetUserResult {
    /**
     * List of details about the user's address.
     */
    readonly addresses: outputs.identitystore.GetUserAddress[];
    readonly alternateIdentifier?: outputs.identitystore.GetUserAlternateIdentifier;
    /**
     * The name that is typically displayed when the user is referenced.
     */
    readonly displayName: string;
    /**
     * List of details about the user's email.
     */
    readonly emails: outputs.identitystore.GetUserEmail[];
    /**
     * List of identifiers issued to this resource by an external identity provider.
     */
    readonly externalIds: outputs.identitystore.GetUserExternalId[];
    /**
     * The provider-assigned unique ID for this managed resource.
     */
    readonly id: string;
    readonly identityStoreId: string;
    /**
     * The user's geographical region or location.
     */
    readonly locale: string;
    /**
     * Details about the user's full name.
     */
    readonly names: outputs.identitystore.GetUserName[];
    /**
     * An alternate name for the user.
     */
    readonly nickname: string;
    /**
     * List of details about the user's phone number.
     */
    readonly phoneNumbers: outputs.identitystore.GetUserPhoneNumber[];
    /**
     * The preferred language of the user.
     */
    readonly preferredLanguage: string;
    /**
     * An URL that may be associated with the user.
     */
    readonly profileUrl: string;
    /**
     * The region of the address.
     */
    readonly region: string;
    /**
     * The user's time zone.
     */
    readonly timezone: string;
    /**
     * The user's title.
     */
    readonly title: string;
    readonly userId: string;
    /**
     * User's user name value.
     */
    readonly userName: string;
    /**
     * The user type.
     */
    readonly userType: string;
}
/**
 * Use this data source to get an Identity Store User.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as aws from "@pulumi/aws";
 *
 * const example = aws.ssoadmin.getInstances({});
 * const exampleGetUser = example.then(example => aws.identitystore.getUser({
 *     identityStoreId: example.identityStoreIds?.[0],
 *     alternateIdentifier: {
 *         uniqueAttribute: {
 *             attributePath: "UserName",
 *             attributeValue: "ExampleUser",
 *         },
 *     },
 * }));
 * export const userId = exampleGetUser.then(exampleGetUser => exampleGetUser.userId);
 * ```
 */
export declare function getUserOutput(args: GetUserOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetUserResult>;
/**
 * A collection of arguments for invoking getUser.
 */
export interface GetUserOutputArgs {
    /**
     * A unique identifier for a user or group that is not the primary identifier. Conflicts with `userId` and `filter`. Detailed below.
     */
    alternateIdentifier?: pulumi.Input<inputs.identitystore.GetUserAlternateIdentifierArgs>;
    /**
     * Identity Store ID associated with the Single Sign-On Instance.
     *
     * The following arguments are optional:
     */
    identityStoreId: pulumi.Input<string>;
    /**
     * Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
     */
    region?: pulumi.Input<string>;
    /**
     * The identifier for a user in the Identity Store.
     *
     * > Exactly one of the above arguments must be provided. Passing both `filter` and `userId` is allowed for backwards compatibility.
     */
    userId?: pulumi.Input<string>;
}