pulumi-aws-kotlin/com.pulumi.aws.iam.kotlin/IamFunctions/getUsers

getUsers

suspend fun getUsers(argument: GetUsersPlainArgs): GetUsersResult

Use this data source to get the ARNs and Names of IAM Users.

Example Usage

All users in an account

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const users = aws.iam.getUsers({});
Content copied to clipboard
import pulumi
import pulumi_aws as aws
users = aws.iam.get_users()
Content copied to clipboard
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
    var users = Aws.Iam.GetUsers.Invoke();
});
Content copied to clipboard
package main
import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/iam"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := iam.GetUsers(ctx, &iam.GetUsersArgs{}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.iam.IamFunctions;
import com.pulumi.aws.iam.inputs.GetUsersArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        final var users = IamFunctions.getUsers(GetUsersArgs.builder()
            .build());
    }
}
Content copied to clipboard
variables:
  users:
    fn::invoke:
      function: aws:iam:getUsers
      arguments: {}
Content copied to clipboard

Users filtered by name regex

Users whose username contains abc

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const users = aws.iam.getUsers({
    nameRegex: ".*abc.*",
});
Content copied to clipboard
import pulumi
import pulumi_aws as aws
users = aws.iam.get_users(name_regex=".*abc.*")
Content copied to clipboard
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
    var users = Aws.Iam.GetUsers.Invoke(new()
    {
        NameRegex = ".*abc.*",
    });
});
Content copied to clipboard
package main
import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/iam"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := iam.GetUsers(ctx, &iam.GetUsersArgs{
			NameRegex: pulumi.StringRef(".*abc.*"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.iam.IamFunctions;
import com.pulumi.aws.iam.inputs.GetUsersArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        final var users = IamFunctions.getUsers(GetUsersArgs.builder()
            .nameRegex(".*abc.*")
            .build());
    }
}
Content copied to clipboard
variables:
  users:
    fn::invoke:
      function: aws:iam:getUsers
      arguments:
        nameRegex: .*abc.*
Content copied to clipboard

Users filtered by path prefix

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const users = aws.iam.getUsers({
    pathPrefix: "/custom-path",
});
Content copied to clipboard
import pulumi
import pulumi_aws as aws
users = aws.iam.get_users(path_prefix="/custom-path")
Content copied to clipboard
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
    var users = Aws.Iam.GetUsers.Invoke(new()
    {
        PathPrefix = "/custom-path",
    });
});
Content copied to clipboard
package main
import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/iam"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := iam.GetUsers(ctx, &iam.GetUsersArgs{
			PathPrefix: pulumi.StringRef("/custom-path"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.iam.IamFunctions;
import com.pulumi.aws.iam.inputs.GetUsersArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        final var users = IamFunctions.getUsers(GetUsersArgs.builder()
            .pathPrefix("/custom-path")
            .build());
    }
}
Content copied to clipboard
variables:
  users:
    fn::invoke:
      function: aws:iam:getUsers
      arguments:
        pathPrefix: /custom-path
Content copied to clipboard

Return

A collection of values returned by getUsers.

Parameters

argument

A collection of arguments for invoking getUsers.

suspend fun getUsers(nameRegex: String? = null, pathPrefix: String? = null): GetUsersResult

Return

A collection of values returned by getUsers.

Parameters

nameRegex

Regex string to apply to the IAM users list returned by AWS. This allows more advanced filtering not supported from the AWS API. This filtering is done locally on what AWS returns, and could have a performance impact if the result is large. Combine this with other options to narrow down the list AWS returns.

pathPrefix

Path prefix for filtering the results. For example, the prefix /division_abc/subdivision_xyz/ gets all users whose path starts with /division_abc/subdivision_xyz/. If it is not included, it defaults to a slash (/), listing all users. For more details, check out 1.

See also

.

suspend fun getUsers(argument: suspend GetUsersPlainArgsBuilder.() -> Unit): GetUsersResult

Return

A collection of values returned by getUsers.

Parameters

argument

Builder for com.pulumi.aws.iam.kotlin.inputs.GetUsersPlainArgs.

See also

.