Policy

Provides an IAM policy.

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

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

",
        });
    }

}

package main

import (
    "fmt"

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

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        _, err := iam.NewPolicy(ctx, "policy", &iam.PolicyArgs{
            Description: pulumi.String("My test policy"),
            Path:        pulumi.String("/"),
            Policy:      pulumi.String(fmt.Sprintf("%v%v%v%v%v%v%v%v%v%v%v%v%v", "{\n", "  \"Version\": \"2012-10-17\",\n", "  \"Statement\": [\n", "    {\n", "      \"Action\": [\n", "        \"ec2:Describe*\"\n", "      ],\n", "      \"Effect\": \"Allow\",\n", "      \"Resource\": \"*\"\n", "    }\n", "  ]\n", "}\n", "\n")),
        })
        if err != nil {
            return err
        }
        return nil
    })
}

import pulumi
import pulumi_aws as aws

policy = aws.iam.Policy("policy",
    description="My test policy",
    path="/",
    policy="""{
  "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", {
    description: "My test policy",
    path: "/",
    policy: `{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Action": [
        "ec2:Describe*"
      ],
      "Effect": "Allow",
      "Resource": "*"
    }
  ]
}
`,
});

Create a Policy Resource

new Policy(name: string, args: PolicyArgs, opts?: CustomResourceOptions);

def Policy(resource_name, opts=None, description=None, name=None, name_prefix=None, path=None, policy=None, __props__=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.
opts ResourceOptions: A bag of options that control this 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: 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.

Policy interface{}: 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.

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.

policy string | 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.

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.

Arn string: The ARN assigned by AWS to this policy.
Id string: The provider-assigned unique ID for this managed resource.

arn string: The ARN assigned by AWS to this policy.
id string: The provider-assigned unique ID for this managed resource.

arn str: The ARN assigned by AWS to this policy.
id str: The provider-assigned unique ID for this managed resource.

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

static get(resource_name, id, opts=None, arn=None, description=None, name=None, name_prefix=None, path=None, policy=None, __props__=None);

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: The policy document. This is a JSON formatted string.

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 interface{}: The policy document. This is a JSON formatted string.

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.

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 string | str: The policy document. This is a JSON formatted string.

Package Details

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

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud