1. Packages
  2. AWS Classic
  3. API Docs
  4. iam
  5. Policy

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.41.0 published on Tuesday, Jun 18, 2024 by Pulumi

aws.iam.Policy

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.41.0 published on Tuesday, Jun 18, 2024 by Pulumi

    Provides an IAM policy.

    NOTE: We suggest using explicit JSON encoding or aws.iam.getPolicyDocument when assigning a value to policy. They seamlessly translate configuration to JSON, enabling you to maintain consistency within your configuration without the need for context switches. Also, you can sidestep potential complications arising from formatting discrepancies, whitespace inconsistencies, and other nuances inherent to JSON.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const policy = new aws.iam.Policy("policy", {
        name: "test_policy",
        path: "/",
        description: "My test policy",
        policy: JSON.stringify({
            Version: "2012-10-17",
            Statement: [{
                Action: ["ec2:Describe*"],
                Effect: "Allow",
                Resource: "*",
            }],
        }),
    });
    
    import pulumi
    import json
    import pulumi_aws as aws
    
    policy = aws.iam.Policy("policy",
        name="test_policy",
        path="/",
        description="My test policy",
        policy=json.dumps({
            "Version": "2012-10-17",
            "Statement": [{
                "Action": ["ec2:Describe*"],
                "Effect": "Allow",
                "Resource": "*",
            }],
        }))
    
    package main
    
    import (
    	"encoding/json"
    
    	"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 {
    		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{
    			Name:        pulumi.String("test_policy"),
    			Path:        pulumi.String("/"),
    			Description: pulumi.String("My test policy"),
    			Policy:      pulumi.String(json0),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using System.Text.Json;
    using Pulumi;
    using Aws = Pulumi.Aws;
    
    return await Deployment.RunAsync(() => 
    {
        var policy = new Aws.Iam.Policy("policy", new()
        {
            Name = "test_policy",
            Path = "/",
            Description = "My test policy",
            PolicyDocument = JsonSerializer.Serialize(new Dictionary<string, object?>
            {
                ["Version"] = "2012-10-17",
                ["Statement"] = new[]
                {
                    new Dictionary<string, object?>
                    {
                        ["Action"] = new[]
                        {
                            "ec2:Describe*",
                        },
                        ["Effect"] = "Allow",
                        ["Resource"] = "*",
                    },
                },
            }),
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.iam.Policy;
    import com.pulumi.aws.iam.PolicyArgs;
    import static com.pulumi.codegen.internal.Serialization.*;
    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) {
            var policy = new Policy("policy", PolicyArgs.builder()
                .name("test_policy")
                .path("/")
                .description("My test policy")
                .policy(serializeJson(
                    jsonObject(
                        jsonProperty("Version", "2012-10-17"),
                        jsonProperty("Statement", jsonArray(jsonObject(
                            jsonProperty("Action", jsonArray("ec2:Describe*")),
                            jsonProperty("Effect", "Allow"),
                            jsonProperty("Resource", "*")
                        )))
                    )))
                .build());
    
        }
    }
    
    resources:
      policy:
        type: aws:iam:Policy
        properties:
          name: test_policy
          path: /
          description: My test policy
          policy:
            fn::toJSON:
              Version: 2012-10-17
              Statement:
                - Action:
                    - ec2:Describe*
                  Effect: Allow
                  Resource: '*'
    

    Create Policy Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

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

    Parameters

    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.
    name String
    The unique name of the resource.
    args PolicyArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var examplepolicyResourceResourceFromIampolicy = new Aws.Iam.Policy("examplepolicyResourceResourceFromIampolicy", new()
    {
        PolicyDocument = "string",
        Description = "string",
        Name = "string",
        NamePrefix = "string",
        Path = "string",
        Tags = 
        {
            { "string", "string" },
        },
    });
    
    example, err := iam.NewPolicy(ctx, "examplepolicyResourceResourceFromIampolicy", &iam.PolicyArgs{
    	Policy:      pulumi.Any("string"),
    	Description: pulumi.String("string"),
    	Name:        pulumi.String("string"),
    	NamePrefix:  pulumi.String("string"),
    	Path:        pulumi.String("string"),
    	Tags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    })
    
    var examplepolicyResourceResourceFromIampolicy = new Policy("examplepolicyResourceResourceFromIampolicy", PolicyArgs.builder()
        .policy("string")
        .description("string")
        .name("string")
        .namePrefix("string")
        .path("string")
        .tags(Map.of("string", "string"))
        .build());
    
    examplepolicy_resource_resource_from_iampolicy = aws.iam.Policy("examplepolicyResourceResourceFromIampolicy",
        policy="string",
        description="string",
        name="string",
        name_prefix="string",
        path="string",
        tags={
            "string": "string",
        })
    
    const examplepolicyResourceResourceFromIampolicy = new aws.iam.Policy("examplepolicyResourceResourceFromIampolicy", {
        policy: "string",
        description: "string",
        name: "string",
        namePrefix: "string",
        path: "string",
        tags: {
            string: "string",
        },
    });
    
    type: aws:iam:Policy
    properties:
        description: string
        name: string
        namePrefix: string
        path: string
        policy: string
        tags:
            string: string
    

    Policy Resource Properties

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

    Inputs

    The Policy resource accepts the following input properties:

    PolicyDocument string | string
    Policy document. This is a JSON formatted string. For more information about building AWS IAM policy documents, see the AWS IAM Policy Document Guide
    Description string
    Description of the IAM policy.
    Name string
    Name of the policy. If omitted, the 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. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    Policy string | string
    Policy document. This is a JSON formatted string. For more information about building AWS IAM policy documents, see the AWS IAM Policy Document Guide
    Description string
    Description of the IAM policy.
    Name string
    Name of the policy. If omitted, the 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. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    policy String | String
    Policy document. This is a JSON formatted string. For more information about building AWS IAM policy documents, see the AWS IAM Policy Document Guide
    description String
    Description of the IAM policy.
    name String
    Name of the policy. If omitted, the 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. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    policy string | PolicyDocument
    Policy document. This is a JSON formatted string. For more information about building AWS IAM policy documents, see the AWS IAM Policy Document Guide
    description string
    Description of the IAM policy.
    name string
    Name of the policy. If omitted, the 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. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    policy str | str
    Policy document. This is a JSON formatted string. For more information about building AWS IAM policy documents, see the AWS IAM Policy Document Guide
    description str
    Description of the IAM policy.
    name str
    Name of the policy. If omitted, the 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. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    policy String |
    Policy document. This is a JSON formatted string. For more information about building AWS IAM policy documents, see the AWS IAM Policy Document Guide
    description String
    Description of the IAM policy.
    name String
    Name of the policy. If omitted, the 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>
    Map of resource tags for the IAM Policy. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    Outputs

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

    Arn string
    ARN assigned by AWS to this policy.
    AttachmentCount int
    Number of entities (users, groups, and roles) that the policy is attached to.
    Id string
    The provider-assigned unique ID for this managed resource.
    PolicyId string
    Policy's ID.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Arn string
    ARN assigned by AWS to this policy.
    AttachmentCount int
    Number of entities (users, groups, and roles) that the policy is attached to.
    Id string
    The provider-assigned unique ID for this managed resource.
    PolicyId string
    Policy's ID.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    ARN assigned by AWS to this policy.
    attachmentCount Integer
    Number of entities (users, groups, and roles) that the policy is attached to.
    id String
    The provider-assigned unique ID for this managed resource.
    policyId String
    Policy's ID.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn string
    ARN assigned by AWS to this policy.
    attachmentCount number
    Number of entities (users, groups, and roles) that the policy is attached to.
    id string
    The provider-assigned unique ID for this managed resource.
    policyId string
    Policy's ID.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn str
    ARN assigned by AWS to this policy.
    attachment_count int
    Number of entities (users, groups, and roles) that the policy is attached to.
    id str
    The provider-assigned unique ID for this managed resource.
    policy_id str
    Policy's ID.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    ARN assigned by AWS to this policy.
    attachmentCount Number
    Number of entities (users, groups, and roles) that the policy is attached to.
    id String
    The provider-assigned unique ID for this managed resource.
    policyId String
    Policy's ID.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Look up 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,
            attachment_count: Optional[int] = 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)
    public static Policy get(String name, Output<String> id, PolicyState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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.
    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
    ARN assigned by AWS to this policy.
    AttachmentCount int
    Number of entities (users, groups, and roles) that the policy is attached to.
    Description string
    Description of the IAM policy.
    Name string
    Name of the policy. If omitted, the 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
    Policy document. This is a JSON formatted string. For more information about building AWS IAM policy documents, see the AWS IAM Policy Document Guide
    PolicyId string
    Policy's ID.
    Tags Dictionary<string, string>
    Map of resource tags for the IAM Policy. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Arn string
    ARN assigned by AWS to this policy.
    AttachmentCount int
    Number of entities (users, groups, and roles) that the policy is attached to.
    Description string
    Description of the IAM policy.
    Name string
    Name of the policy. If omitted, the 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
    Policy document. This is a JSON formatted string. For more information about building AWS IAM policy documents, see the AWS IAM Policy Document Guide
    PolicyId string
    Policy's ID.
    Tags map[string]string
    Map of resource tags for the IAM Policy. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    ARN assigned by AWS to this policy.
    attachmentCount Integer
    Number of entities (users, groups, and roles) that the policy is attached to.
    description String
    Description of the IAM policy.
    name String
    Name of the policy. If omitted, the 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
    Policy document. This is a JSON formatted string. For more information about building AWS IAM policy documents, see the AWS IAM Policy Document Guide
    policyId String
    Policy's ID.
    tags Map<String,String>
    Map of resource tags for the IAM Policy. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn string
    ARN assigned by AWS to this policy.
    attachmentCount number
    Number of entities (users, groups, and roles) that the policy is attached to.
    description string
    Description of the IAM policy.
    name string
    Name of the policy. If omitted, the 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
    Policy document. This is a JSON formatted string. For more information about building AWS IAM policy documents, see the AWS IAM Policy Document Guide
    policyId string
    Policy's ID.
    tags {[key: string]: string}
    Map of resource tags for the IAM Policy. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn str
    ARN assigned by AWS to this policy.
    attachment_count int
    Number of entities (users, groups, and roles) that the policy is attached to.
    description str
    Description of the IAM policy.
    name str
    Name of the policy. If omitted, the 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
    Policy document. This is a JSON formatted string. For more information about building AWS IAM policy documents, see the AWS IAM Policy Document Guide
    policy_id str
    Policy's ID.
    tags Mapping[str, str]
    Map of resource tags for the IAM Policy. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    ARN assigned by AWS to this policy.
    attachmentCount Number
    Number of entities (users, groups, and roles) that the policy is attached to.
    description String
    Description of the IAM policy.
    name String
    Name of the policy. If omitted, the 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 |
    Policy document. This is a JSON formatted string. For more information about building AWS IAM policy documents, see the AWS IAM Policy Document Guide
    policyId String
    Policy's ID.
    tags Map<String>
    Map of resource tags for the IAM Policy. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Import

    Using pulumi import, import IAM Policies using the arn. For example:

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

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.41.0 published on Tuesday, Jun 18, 2024 by Pulumi