@pulumi/aws/iam/getUsers.js

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

"use strict";
// *** WARNING: this file was generated by pulumi-language-nodejs. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
Object.defineProperty(exports, "__esModule", { value: true });
exports.getUsersOutput = exports.getUsers = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("../utilities");
/**
 * Use this data source to get the ARNs and Names of IAM Users.
 *
 * ## Example Usage
 *
 * ### All users in an account
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as aws from "@pulumi/aws";
 *
 * const users = aws.iam.getUsers({});
 * ```
 *
 * ### Users filtered by name regex
 *
 * Users whose username contains `abc`
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as aws from "@pulumi/aws";
 *
 * const users = aws.iam.getUsers({
 *     nameRegex: ".*abc.*",
 * });
 * ```
 *
 * ### Users filtered by path prefix
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as aws from "@pulumi/aws";
 *
 * const users = aws.iam.getUsers({
 *     pathPrefix: "/custom-path",
 * });
 * ```
 */
function getUsers(args, opts) {
    args = args || {};
    opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
    return pulumi.runtime.invoke("aws:iam/getUsers:getUsers", {
        "nameRegex": args.nameRegex,
        "pathPrefix": args.pathPrefix,
    }, opts);
}
exports.getUsers = getUsers;
/**
 * Use this data source to get the ARNs and Names of IAM Users.
 *
 * ## Example Usage
 *
 * ### All users in an account
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as aws from "@pulumi/aws";
 *
 * const users = aws.iam.getUsers({});
 * ```
 *
 * ### Users filtered by name regex
 *
 * Users whose username contains `abc`
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as aws from "@pulumi/aws";
 *
 * const users = aws.iam.getUsers({
 *     nameRegex: ".*abc.*",
 * });
 * ```
 *
 * ### Users filtered by path prefix
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as aws from "@pulumi/aws";
 *
 * const users = aws.iam.getUsers({
 *     pathPrefix: "/custom-path",
 * });
 * ```
 */
function getUsersOutput(args, opts) {
    args = args || {};
    opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
    return pulumi.runtime.invokeOutput("aws:iam/getUsers:getUsers", {
        "nameRegex": args.nameRegex,
        "pathPrefix": args.pathPrefix,
    }, opts);
}
exports.getUsersOutput = getUsersOutput;
//# sourceMappingURL=getUsers.js.map