getRoles function

Future<GetRolesResult> getRoles(
  1. GetRolesArgs args, {
  2. InvokeOptions? options,
})

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

Example Usage

All roles in an account

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const roles = aws.iam.getRoles({});
import pulumi
import pulumi_aws as aws

roles = aws.iam.get_roles()
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var roles = Aws.Iam.GetRoles.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.GetRoles(ctx, &iam.GetRolesArgs{}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

data "aws_iam_getroles" "roles" {
}
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.GetRolesArgs;
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 roles = IamFunctions.getRoles(GetRolesArgs.builder()
            .build());

    }
}
variables:
  roles:
    fn::invoke:
      function: aws:iam:getRoles
      arguments: {}

Roles filtered by name regex

Roles whose role-name contains project

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const roles = aws.iam.getRoles({
    nameRegex: ".*project.*",
});
import pulumi
import pulumi_aws as aws

roles = aws.iam.get_roles(name_regex=".*project.*")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var roles = Aws.Iam.GetRoles.Invoke(new()
    {
        NameRegex = ".*project.*",
    });

});
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.GetRoles(ctx, &iam.GetRolesArgs{
			NameRegex: pulumi.StringRef(".*project.*"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

data "aws_iam_getroles" "roles" {
  name_regex = ".*project.*"
}
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.GetRolesArgs;
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 roles = IamFunctions.getRoles(GetRolesArgs.builder()
            .nameRegex(".*project.*")
            .build());

    }
}
variables:
  roles:
    fn::invoke:
      function: aws:iam:getRoles
      arguments:
        nameRegex: .*project.*

Roles filtered by path prefix

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const roles = aws.iam.getRoles({
    pathPrefix: "/custom-path",
});
import pulumi
import pulumi_aws as aws

roles = aws.iam.get_roles(path_prefix="/custom-path")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var roles = Aws.Iam.GetRoles.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.GetRoles(ctx, &iam.GetRolesArgs{
			PathPrefix: pulumi.StringRef("/custom-path"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

data "aws_iam_getroles" "roles" {
  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.GetRolesArgs;
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 roles = IamFunctions.getRoles(GetRolesArgs.builder()
            .pathPrefix("/custom-path")
            .build());

    }
}
variables:
  roles:
    fn::invoke:
      function: aws:iam:getRoles
      arguments:
        pathPrefix: /custom-path

Roles provisioned by AWS SSO

Roles in the account filtered by path prefix

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const roles = aws.iam.getRoles({
    pathPrefix: "/aws-reserved/sso.amazonaws.com/",
});
import pulumi
import pulumi_aws as aws

roles = aws.iam.get_roles(path_prefix="/aws-reserved/sso.amazonaws.com/")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var roles = Aws.Iam.GetRoles.Invoke(new()
    {
        PathPrefix = "/aws-reserved/sso.amazonaws.com/",
    });

});
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.GetRoles(ctx, &iam.GetRolesArgs{
			PathPrefix: pulumi.StringRef("/aws-reserved/sso.amazonaws.com/"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

data "aws_iam_getroles" "roles" {
  path_prefix = "/aws-reserved/sso.amazonaws.com/"
}
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.GetRolesArgs;
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 roles = IamFunctions.getRoles(GetRolesArgs.builder()
            .pathPrefix("/aws-reserved/sso.amazonaws.com/")
            .build());

    }
}
variables:
  roles:
    fn::invoke:
      function: aws:iam:getRoles
      arguments:
        pathPrefix: /aws-reserved/sso.amazonaws.com/

Specific role in the account filtered by name regex and path prefix

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const roles = aws.iam.getRoles({
    nameRegex: "AWSReservedSSO_permission_set_name_.*",
    pathPrefix: "/aws-reserved/sso.amazonaws.com/",
});
import pulumi
import pulumi_aws as aws

roles = aws.iam.get_roles(name_regex="AWSReservedSSO_permission_set_name_.*",
    path_prefix="/aws-reserved/sso.amazonaws.com/")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var roles = Aws.Iam.GetRoles.Invoke(new()
    {
        NameRegex = "AWSReservedSSO_permission_set_name_.*",
        PathPrefix = "/aws-reserved/sso.amazonaws.com/",
    });

});
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.GetRoles(ctx, &iam.GetRolesArgs{
			NameRegex:  pulumi.StringRef("AWSReservedSSO_permission_set_name_.*"),
			PathPrefix: pulumi.StringRef("/aws-reserved/sso.amazonaws.com/"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

data "aws_iam_getroles" "roles" {
  name_regex  = "AWSReservedSSO_permission_set_name_.*"
  path_prefix = "/aws-reserved/sso.amazonaws.com/"
}
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.GetRolesArgs;
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 roles = IamFunctions.getRoles(GetRolesArgs.builder()
            .nameRegex("AWSReservedSSO_permission_set_name_.*")
            .pathPrefix("/aws-reserved/sso.amazonaws.com/")
            .build());

    }
}
variables:
  roles:
    fn::invoke:
      function: aws:iam:getRoles
      arguments:
        nameRegex: AWSReservedSSO_permission_set_name_.*
        pathPrefix: /aws-reserved/sso.amazonaws.com/

args Arguments passed to this invoke. Arguments for getRoles. options Invoke options controlling this call.

Implementation

Future<GetRolesResult> getRoles(
  GetRolesArgs args, {
  pulumi.InvokeOptions? options,
}) async {
  final deployment = pulumi.Deployment.instance;
  final result = await deployment.invoke<Map<String, dynamic>>(
    'aws:iam/getRoles:getRoles',
    args.toMap(),
    options: pulumi.toDeploymentInvokeOptions(options),
  );
  return GetRolesResult.fromMap(result);
}