getUsers function
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({});
import pulumi
import pulumi_aws as aws
users = aws.iam.get_users()
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var users = Aws.Iam.GetUsers.Invoke();
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/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
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
data "aws_iam_getusers" "users" {
}
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.ArrayList;
import java.util.Arrays;
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());
}
}
variables:
users:
fn::invoke:
function: aws:iam:getUsers
arguments: {}
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.*",
});
import pulumi
import pulumi_aws as aws
users = aws.iam.get_users(name_regex=".*abc.*")
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.*",
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/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
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
data "aws_iam_getusers" "users" {
name_regex = ".*abc.*"
}
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.ArrayList;
import java.util.Arrays;
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());
}
}
variables:
users:
fn::invoke:
function: aws:iam:getUsers
arguments:
nameRegex: .*abc.*
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",
});
import pulumi
import pulumi_aws as aws
users = aws.iam.get_users(path_prefix="/custom-path")
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",
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/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
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
data "aws_iam_getusers" "users" {
path_prefix = "/custom-path"
}
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.ArrayList;
import java.util.Arrays;
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());
}
}
variables:
users:
fn::invoke:
function: aws:iam:getUsers
arguments:
pathPrefix: /custom-path
args Arguments passed to this invoke. Arguments for getUsers.
options Invoke options controlling this call.
Implementation
Future<GetUsersResult> getUsers(
GetUsersArgs args, {
pulumi.InvokeOptions? options,
}) async {
final deployment = pulumi.Deployment.instance;
final result = await deployment.invoke<Map<String, dynamic>>(
'aws:iam/getUsers:getUsers',
args.toMap(),
options: pulumi.toDeploymentInvokeOptions(options),
);
return GetUsersResult.fromMap(result);
}