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

getPolicy

suspend fun getPolicy(argument: GetPolicyPlainArgs): GetPolicyResult

This data source can be used to fetch information about a specific IAM policy.

Example Usage

By ARN

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = aws.iam.getPolicy({
    arn: "arn:aws:iam::123456789012:policy/UsersManageOwnCredentials",
});
Content copied to clipboard
import pulumi
import pulumi_aws as aws
example = aws.iam.get_policy(arn="arn:aws:iam::123456789012:policy/UsersManageOwnCredentials")
Content copied to clipboard
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
    var example = Aws.Iam.GetPolicy.Invoke(new()
    {
        Arn = "arn:aws:iam::123456789012:policy/UsersManageOwnCredentials",
    });
});
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.LookupPolicy(ctx, &iam.LookupPolicyArgs{
			Arn: pulumi.StringRef("arn:aws:iam::123456789012:policy/UsersManageOwnCredentials"),
		}, 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.GetPolicyArgs;
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 example = IamFunctions.getPolicy(GetPolicyArgs.builder()
            .arn("arn:aws:iam::123456789012:policy/UsersManageOwnCredentials")
            .build());
    }
}
Content copied to clipboard
variables:
  example:
    fn::invoke:
      function: aws:iam:getPolicy
      arguments:
        arn: arn:aws:iam::123456789012:policy/UsersManageOwnCredentials
Content copied to clipboard

By Name

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = aws.iam.getPolicy({
    name: "test_policy",
});
Content copied to clipboard
import pulumi
import pulumi_aws as aws
example = aws.iam.get_policy(name="test_policy")
Content copied to clipboard
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
    var example = Aws.Iam.GetPolicy.Invoke(new()
    {
        Name = "test_policy",
    });
});
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.LookupPolicy(ctx, &iam.LookupPolicyArgs{
			Name: pulumi.StringRef("test_policy"),
		}, 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.GetPolicyArgs;
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 example = IamFunctions.getPolicy(GetPolicyArgs.builder()
            .name("test_policy")
            .build());
    }
}
Content copied to clipboard
variables:
  example:
    fn::invoke:
      function: aws:iam:getPolicy
      arguments:
        name: test_policy
Content copied to clipboard

Return

A collection of values returned by getPolicy.

Parameters

argument

A collection of arguments for invoking getPolicy.

suspend fun getPolicy(arn: String? = null, name: String? = null, pathPrefix: String? = null, tags: Map<String, String>? = null): GetPolicyResult

Return

A collection of values returned by getPolicy.

Parameters

arn

ARN of the IAM policy. Conflicts with name and path_prefix.

name

Name of the IAM policy. Conflicts with arn.

pathPrefix

Prefix of the path to the IAM policy. Defaults to a slash (/). Conflicts with arn.

tags

Key-value mapping of tags for the IAM Policy.

See also

.

suspend fun getPolicy(argument: suspend GetPolicyPlainArgsBuilder.() -> Unit): GetPolicyResult

Return

A collection of values returned by getPolicy.

Parameters

argument

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

See also

.