getRole function
This data source can be used to fetch information about a specific IAM role. By using this data source, you can reference IAM role properties without having to hard code ARNs as input.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = aws.iam.getRole({
name: "an_example_role_name",
});
import pulumi
import pulumi_aws as aws
example = aws.iam.get_role(name="an_example_role_name")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = Aws.Iam.GetRole.Invoke(new()
{
Name = "an_example_role_name",
});
});
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.LookupRole(ctx, &iam.LookupRoleArgs{
Name: "an_example_role_name",
}, nil)
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
data "aws_iam_getrole" "example" {
name = "an_example_role_name"
}
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.GetRoleArgs;
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 example = IamFunctions.getRole(GetRoleArgs.builder()
.name("an_example_role_name")
.build());
}
}
variables:
example:
fn::invoke:
function: aws:iam:getRole
arguments:
name: an_example_role_name
args Arguments passed to this invoke. Arguments for getRole.
options Invoke options controlling this call.
Implementation
Future<GetRoleResult> getRole(
GetRoleArgs args, {
pulumi.InvokeOptions? options,
}) async {
final deployment = pulumi.Deployment.instance;
final result = await deployment.invoke<Map<String, dynamic>>(
'aws:iam/getRole:getRole',
args.toMap(),
options: pulumi.toDeploymentInvokeOptions(options),
);
return GetRoleResult.fromMap(result);
}