Try AWS Native preview for resources not in the classic version.
aws.iam.Policy
Explore with Pulumi AI
Try AWS Native preview for resources not in the classic version.
Provides an IAM policy.
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
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)
@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)
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.
- 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.
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:
- Policy
Document 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, the provider will assign a random, unique name.
- Name
Prefix 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.
- 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
- 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, the provider will assign a random, unique name.
- Name
Prefix 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.
- 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
- 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, the provider will assign a random, unique name.
- name
Prefix 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.
- 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 | Policy
Document - 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, the provider will assign a random, unique name.
- name
Prefix 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.
- {[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
- 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, 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.
- 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 |
- 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, the provider will assign a random, unique name.
- name
Prefix 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.
- 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:
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,
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.
- 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, the provider will assign a random, unique name.
- Name
Prefix 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
Document string | string - The policy document. This is a JSON formatted string.
- Policy
Id string - The policy's ID.
- 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. - Dictionary<string, string>
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- 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, the provider will assign a random, unique name.
- Name
Prefix 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.
- Policy
Id string - The policy's ID.
- 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. - map[string]string
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- 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, the provider will assign a random, unique name.
- name
Prefix 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.
- policy
Id String - The policy's ID.
- 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. - Map<String,String>
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- 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, the provider will assign a random, unique name.
- name
Prefix 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 - The policy document. This is a JSON formatted string.
- policy
Id string - The policy's ID.
- {[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. - {[key: string]: string}
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- 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, 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
- The policy document. This is a JSON formatted string.
- policy_
id str - The policy's ID.
- 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. - Mapping[str, str]
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- 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, the provider will assign a random, unique name.
- name
Prefix 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 |
- The policy document. This is a JSON formatted string.
- policy
Id String - The policy's ID.
- 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. - Map<String>
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
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
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
aws
Terraform Provider.
Try AWS Native preview for resources not in the classic version.