Policy

Provides an IAM policy.

Example Usage

using System.Collections.Generic;
using System.Text.Json;
using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var policy = new Aws.Iam.Policy("policy", new Aws.Iam.PolicyArgs
        {
            Path = "/",
            Description = "My test policy",
            Policy = JsonSerializer.Serialize(new Dictionary<string, object?>
            {
                { "Version", "2012-10-17" },
                { "Statement", new[]
                    {
                        new Dictionary<string, object?>
                        {
                            { "Action", new[]
                                {
                                    "ec2:Describe*",
                                }
                             },
                            { "Effect", "Allow" },
                            { "Resource", "*" },
                        },
                    }
                 },
            }),
        });
    }

}
package main

import (
	"encoding/json"

	"github.com/pulumi/pulumi-aws/sdk/v4/go/aws/iam"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		tmpJSON0, err := json.Marshal(map[string]interface{}{
			"Version": "2012-10-17",
			"Statement": []map[string]interface{}{
				map[string]interface{}{
					"Action": []string{
						"ec2:Describe*",
					},
					"Effect":   "Allow",
					"Resource": "*",
				},
			},
		})
		if err != nil {
			return err
		}
		json0 := string(tmpJSON0)
		_, err := iam.NewPolicy(ctx, "policy", &iam.PolicyArgs{
			Path:        pulumi.String("/"),
			Description: pulumi.String("My test policy"),
			Policy:      pulumi.String(json0),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
import pulumi
import json
import pulumi_aws as aws

policy = aws.iam.Policy("policy",
    path="/",
    description="My test policy",
    policy=json.dumps({
        "Version": "2012-10-17",
        "Statement": [{
            "Action": ["ec2:Describe*"],
            "Effect": "Allow",
            "Resource": "*",
        }],
    }))
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const policy = new aws.iam.Policy("policy", {
    path: "/",
    description: "My test policy",
    policy: JSON.stringify({
        Version: "2012-10-17",
        Statement: [{
            Action: ["ec2:Describe*"],
            Effect: "Allow",
            Resource: "*",
        }],
    }),
});

Create a Policy Resource

new Policy(name: string, args: PolicyArgs, opts?: CustomResourceOptions);
@overload
def Policy(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           description: Optional[str] = None,
           name: Optional[str] = None,
           name_prefix: Optional[str] = None,
           path: Optional[str] = None,
           policy: Optional[str] = None,
           tags: Optional[Mapping[str, str]] = None,
           tags_all: Optional[Mapping[str, str]] = None)
@overload
def Policy(resource_name: str,
           args: PolicyArgs,
           opts: Optional[ResourceOptions] = None)
func NewPolicy(ctx *Context, name string, args PolicyArgs, opts ...ResourceOption) (*Policy, error)
public Policy(string name, PolicyArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args PolicyArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args PolicyArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args PolicyArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args PolicyArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

Policy Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The Policy resource accepts the following input properties:

PolicyDocument string | string
The policy document. This is a JSON formatted string.
Description string
Description of the IAM policy.
Name string
The name of the policy. If omitted, this provider will assign a random, unique name.
NamePrefix string
Creates a unique name beginning with the specified prefix. Conflicts with name.
Path string
Path in which to create the policy. See IAM Identifiers for more information.
Tags Dictionary<string, string>
Map of resource tags for the IAM Policy
TagsAll Dictionary<string, string>
A map of tags assigned to the resource, including those inherited from the provider.
Policy string | string
The policy document. This is a JSON formatted string.
Description string
Description of the IAM policy.
Name string
The name of the policy. If omitted, this provider will assign a random, unique name.
NamePrefix string
Creates a unique name beginning with the specified prefix. Conflicts with name.
Path string
Path in which to create the policy. See IAM Identifiers for more information.
Tags map[string]string
Map of resource tags for the IAM Policy
TagsAll map[string]string
A map of tags assigned to the resource, including those inherited from the provider.
policy string | PolicyDocument
The policy document. This is a JSON formatted string.
description string
Description of the IAM policy.
name string
The name of the policy. If omitted, this provider will assign a random, unique name.
namePrefix string
Creates a unique name beginning with the specified prefix. Conflicts with name.
path string
Path in which to create the policy. See IAM Identifiers for more information.
tags {[key: string]: string}
Map of resource tags for the IAM Policy
tagsAll {[key: string]: string}
A map of tags assigned to the resource, including those inherited from the provider.
policy str | str
The policy document. This is a JSON formatted string.
description str
Description of the IAM policy.
name str
The name of the policy. If omitted, this provider will assign a random, unique name.
name_prefix str
Creates a unique name beginning with the specified prefix. Conflicts with name.
path str
Path in which to create the policy. See IAM Identifiers for more information.
tags Mapping[str, str]
Map of resource tags for the IAM Policy
tags_all Mapping[str, str]
A map of tags assigned to the resource, including those inherited from the provider.

Outputs

All input properties are implicitly available as output properties. Additionally, the Policy resource produces the following output properties:

Arn string
The ARN assigned by AWS to this policy.
Id string
The provider-assigned unique ID for this managed resource.
PolicyId string
The policy’s ID.
Arn string
The ARN assigned by AWS to this policy.
Id string
The provider-assigned unique ID for this managed resource.
PolicyId string
The policy’s ID.
arn string
The ARN assigned by AWS to this policy.
id string
The provider-assigned unique ID for this managed resource.
policyId string
The policy’s ID.
arn str
The ARN assigned by AWS to this policy.
id str
The provider-assigned unique ID for this managed resource.
policy_id str
The policy’s ID.

Look up an Existing Policy Resource

Get an existing Policy resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: PolicyState, opts?: CustomResourceOptions): Policy
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        description: Optional[str] = None,
        name: Optional[str] = None,
        name_prefix: Optional[str] = None,
        path: Optional[str] = None,
        policy: Optional[str] = None,
        policy_id: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None) -> Policy
func GetPolicy(ctx *Context, name string, id IDInput, state *PolicyState, opts ...ResourceOption) (*Policy, error)
public static Policy Get(string name, Input<string> id, PolicyState? state, CustomResourceOptions? opts = null)
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.

The following state arguments are supported:

Arn string
The ARN assigned by AWS to this policy.
Description string
Description of the IAM policy.
Name string
The name of the policy. If omitted, this provider will assign a random, unique name.
NamePrefix string
Creates a unique name beginning with the specified prefix. Conflicts with name.
Path string
Path in which to create the policy. See IAM Identifiers for more information.
PolicyDocument string | string
The policy document. This is a JSON formatted string.
PolicyId string
The policy’s ID.
Tags Dictionary<string, string>
Map of resource tags for the IAM Policy
TagsAll Dictionary<string, string>
A map of tags assigned to the resource, including those inherited from the provider.
Arn string
The ARN assigned by AWS to this policy.
Description string
Description of the IAM policy.
Name string
The name of the policy. If omitted, this provider will assign a random, unique name.
NamePrefix string
Creates a unique name beginning with the specified prefix. Conflicts with name.
Path string
Path in which to create the policy. See IAM Identifiers for more information.
Policy string | string
The policy document. This is a JSON formatted string.
PolicyId string
The policy’s ID.
Tags map[string]string
Map of resource tags for the IAM Policy
TagsAll map[string]string
A map of tags assigned to the resource, including those inherited from the provider.
arn string
The ARN assigned by AWS to this policy.
description string
Description of the IAM policy.
name string
The name of the policy. If omitted, this provider will assign a random, unique name.
namePrefix string
Creates a unique name beginning with the specified prefix. Conflicts with name.
path string
Path in which to create the policy. See IAM Identifiers for more information.
policy string | PolicyDocument
The policy document. This is a JSON formatted string.
policyId string
The policy’s ID.
tags {[key: string]: string}
Map of resource tags for the IAM Policy
tagsAll {[key: string]: string}
A map of tags assigned to the resource, including those inherited from the provider.
arn str
The ARN assigned by AWS to this policy.
description str
Description of the IAM policy.
name str
The name of the policy. If omitted, this provider will assign a random, unique name.
name_prefix str
Creates a unique name beginning with the specified prefix. Conflicts with name.
path str
Path in which to create the policy. See IAM Identifiers for more information.
policy str | str
The policy document. This is a JSON formatted string.
policy_id str
The policy’s ID.
tags Mapping[str, str]
Map of resource tags for the IAM Policy
tags_all Mapping[str, str]
A map of tags assigned to the resource, including those inherited from the provider.

Import

IAM Policies can be imported using the arn, e.g.

 $ pulumi import aws:iam/policy:Policy administrator arn:aws:iam::123456789012:policy/UsersManageOwnCredentials

Package Details

Repository
https://github.com/pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.