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

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

AWS Classic v6.45.0 published on Tuesday, Jul 16, 2024 by Pulumi

aws.iam.RolePolicy

Explore with Pulumi AI

aws logo

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

AWS Classic v6.45.0 published on Tuesday, Jul 16, 2024 by Pulumi

    Provides an IAM role inline policy.

    NOTE: For a given role, this resource is incompatible with using the aws.iam.Role resource inline_policy argument. When using that argument and this resource, both will attempt to manage the role’s inline policies and the provider will show a permanent difference.

    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 testRole = new aws.iam.Role("test_role", {
        name: "test_role",
        assumeRolePolicy: JSON.stringify({
            Version: "2012-10-17",
            Statement: [{
                Action: "sts:AssumeRole",
                Effect: "Allow",
                Sid: "",
                Principal: {
                    Service: "ec2.amazonaws.com",
                },
            }],
        }),
    });
    const testPolicy = new aws.iam.RolePolicy("test_policy", {
        name: "test_policy",
        role: testRole.id,
        policy: JSON.stringify({
            Version: "2012-10-17",
            Statement: [{
                Action: ["ec2:Describe*"],
                Effect: "Allow",
                Resource: "*",
            }],
        }),
    });
    
    import pulumi
    import json
    import pulumi_aws as aws
    
    test_role = aws.iam.Role("test_role",
        name="test_role",
        assume_role_policy=json.dumps({
            "Version": "2012-10-17",
            "Statement": [{
                "Action": "sts:AssumeRole",
                "Effect": "Allow",
                "Sid": "",
                "Principal": {
                    "Service": "ec2.amazonaws.com",
                },
            }],
        }))
    test_policy = aws.iam.RolePolicy("test_policy",
        name="test_policy",
        role=test_role.id,
        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": "sts:AssumeRole",
    					"Effect": "Allow",
    					"Sid":    "",
    					"Principal": map[string]interface{}{
    						"Service": "ec2.amazonaws.com",
    					},
    				},
    			},
    		})
    		if err != nil {
    			return err
    		}
    		json0 := string(tmpJSON0)
    		testRole, err := iam.NewRole(ctx, "test_role", &iam.RoleArgs{
    			Name:             pulumi.String("test_role"),
    			AssumeRolePolicy: pulumi.String(json0),
    		})
    		if err != nil {
    			return err
    		}
    		tmpJSON1, 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
    		}
    		json1 := string(tmpJSON1)
    		_, err = iam.NewRolePolicy(ctx, "test_policy", &iam.RolePolicyArgs{
    			Name:   pulumi.String("test_policy"),
    			Role:   testRole.ID(),
    			Policy: pulumi.String(json1),
    		})
    		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 testRole = new Aws.Iam.Role("test_role", new()
        {
            Name = "test_role",
            AssumeRolePolicy = JsonSerializer.Serialize(new Dictionary<string, object?>
            {
                ["Version"] = "2012-10-17",
                ["Statement"] = new[]
                {
                    new Dictionary<string, object?>
                    {
                        ["Action"] = "sts:AssumeRole",
                        ["Effect"] = "Allow",
                        ["Sid"] = "",
                        ["Principal"] = new Dictionary<string, object?>
                        {
                            ["Service"] = "ec2.amazonaws.com",
                        },
                    },
                },
            }),
        });
    
        var testPolicy = new Aws.Iam.RolePolicy("test_policy", new()
        {
            Name = "test_policy",
            Role = testRole.Id,
            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 generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.iam.Role;
    import com.pulumi.aws.iam.RoleArgs;
    import com.pulumi.aws.iam.RolePolicy;
    import com.pulumi.aws.iam.RolePolicyArgs;
    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 testRole = new Role("testRole", RoleArgs.builder()
                .name("test_role")
                .assumeRolePolicy(serializeJson(
                    jsonObject(
                        jsonProperty("Version", "2012-10-17"),
                        jsonProperty("Statement", jsonArray(jsonObject(
                            jsonProperty("Action", "sts:AssumeRole"),
                            jsonProperty("Effect", "Allow"),
                            jsonProperty("Sid", ""),
                            jsonProperty("Principal", jsonObject(
                                jsonProperty("Service", "ec2.amazonaws.com")
                            ))
                        )))
                    )))
                .build());
    
            var testPolicy = new RolePolicy("testPolicy", RolePolicyArgs.builder()
                .name("test_policy")
                .role(testRole.id())
                .policy(serializeJson(
                    jsonObject(
                        jsonProperty("Version", "2012-10-17"),
                        jsonProperty("Statement", jsonArray(jsonObject(
                            jsonProperty("Action", jsonArray("ec2:Describe*")),
                            jsonProperty("Effect", "Allow"),
                            jsonProperty("Resource", "*")
                        )))
                    )))
                .build());
    
        }
    }
    
    resources:
      testPolicy:
        type: aws:iam:RolePolicy
        name: test_policy
        properties:
          name: test_policy
          role: ${testRole.id}
          policy:
            fn::toJSON:
              Version: 2012-10-17
              Statement:
                - Action:
                    - ec2:Describe*
                  Effect: Allow
                  Resource: '*'
      testRole:
        type: aws:iam:Role
        name: test_role
        properties:
          name: test_role
          assumeRolePolicy:
            fn::toJSON:
              Version: 2012-10-17
              Statement:
                - Action: sts:AssumeRole
                  Effect: Allow
                  Sid:
                  Principal:
                    Service: ec2.amazonaws.com
    

    Create RolePolicy Resource

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

    Constructor syntax

    new RolePolicy(name: string, args: RolePolicyArgs, opts?: CustomResourceOptions);
    @overload
    def RolePolicy(resource_name: str,
                   args: RolePolicyArgs,
                   opts: Optional[ResourceOptions] = None)
    
    @overload
    def RolePolicy(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   policy: Optional[str] = None,
                   role: Optional[str] = None,
                   name: Optional[str] = None,
                   name_prefix: Optional[str] = None)
    func NewRolePolicy(ctx *Context, name string, args RolePolicyArgs, opts ...ResourceOption) (*RolePolicy, error)
    public RolePolicy(string name, RolePolicyArgs args, CustomResourceOptions? opts = null)
    public RolePolicy(String name, RolePolicyArgs args)
    public RolePolicy(String name, RolePolicyArgs args, CustomResourceOptions options)
    
    type: aws:iam:RolePolicy
    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 RolePolicyArgs
    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 RolePolicyArgs
    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 RolePolicyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args RolePolicyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args RolePolicyArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

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

    var rolePolicyResource = new Aws.Iam.RolePolicy("rolePolicyResource", new()
    {
        Policy = "string",
        Role = "string",
        Name = "string",
        NamePrefix = "string",
    });
    
    example, err := iam.NewRolePolicy(ctx, "rolePolicyResource", &iam.RolePolicyArgs{
    	Policy:     pulumi.Any("string"),
    	Role:       pulumi.Any("string"),
    	Name:       pulumi.String("string"),
    	NamePrefix: pulumi.String("string"),
    })
    
    var rolePolicyResource = new RolePolicy("rolePolicyResource", RolePolicyArgs.builder()
        .policy("string")
        .role("string")
        .name("string")
        .namePrefix("string")
        .build());
    
    role_policy_resource = aws.iam.RolePolicy("rolePolicyResource",
        policy="string",
        role="string",
        name="string",
        name_prefix="string")
    
    const rolePolicyResource = new aws.iam.RolePolicy("rolePolicyResource", {
        policy: "string",
        role: "string",
        name: "string",
        namePrefix: "string",
    });
    
    type: aws:iam:RolePolicy
    properties:
        name: string
        namePrefix: string
        policy: string
        role: string
    

    RolePolicy 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 RolePolicy resource accepts the following input properties:

    Policy string | string
    The inline policy document. This is a JSON formatted string. For more information about building IAM policy documents with the provider, see the AWS IAM Policy Document Guide
    Role string | string
    The name of the IAM role to attach to the policy.
    Name string
    The name of the role 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.
    Policy string | string
    The inline policy document. This is a JSON formatted string. For more information about building IAM policy documents with the provider, see the AWS IAM Policy Document Guide
    Role string | string
    The name of the IAM role to attach to the policy.
    Name string
    The name of the role 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.
    policy String | String
    The inline policy document. This is a JSON formatted string. For more information about building IAM policy documents with the provider, see the AWS IAM Policy Document Guide
    role String | String
    The name of the IAM role to attach to the policy.
    name String
    The name of the role 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.
    policy string | PolicyDocument
    The inline policy document. This is a JSON formatted string. For more information about building IAM policy documents with the provider, see the AWS IAM Policy Document Guide
    role string | Role
    The name of the IAM role to attach to the policy.
    name string
    The name of the role 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.
    policy str | str
    The inline policy document. This is a JSON formatted string. For more information about building IAM policy documents with the provider, see the AWS IAM Policy Document Guide
    role str | str
    The name of the IAM role to attach to the policy.
    name str
    The name of the role 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.
    policy String |
    The inline policy document. This is a JSON formatted string. For more information about building IAM policy documents with the provider, see the AWS IAM Policy Document Guide
    role String |
    The name of the IAM role to attach to the policy.
    name String
    The name of the role 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.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing RolePolicy Resource

    Get an existing RolePolicy 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?: RolePolicyState, opts?: CustomResourceOptions): RolePolicy
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            name: Optional[str] = None,
            name_prefix: Optional[str] = None,
            policy: Optional[str] = None,
            role: Optional[str] = None) -> RolePolicy
    func GetRolePolicy(ctx *Context, name string, id IDInput, state *RolePolicyState, opts ...ResourceOption) (*RolePolicy, error)
    public static RolePolicy Get(string name, Input<string> id, RolePolicyState? state, CustomResourceOptions? opts = null)
    public static RolePolicy get(String name, Output<String> id, RolePolicyState 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:
    Name string
    The name of the role 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.
    Policy string | string
    The inline policy document. This is a JSON formatted string. For more information about building IAM policy documents with the provider, see the AWS IAM Policy Document Guide
    Role string | string
    The name of the IAM role to attach to the policy.
    Name string
    The name of the role 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.
    Policy string | string
    The inline policy document. This is a JSON formatted string. For more information about building IAM policy documents with the provider, see the AWS IAM Policy Document Guide
    Role string | string
    The name of the IAM role to attach to the policy.
    name String
    The name of the role 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.
    policy String | String
    The inline policy document. This is a JSON formatted string. For more information about building IAM policy documents with the provider, see the AWS IAM Policy Document Guide
    role String | String
    The name of the IAM role to attach to the policy.
    name string
    The name of the role 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.
    policy string | PolicyDocument
    The inline policy document. This is a JSON formatted string. For more information about building IAM policy documents with the provider, see the AWS IAM Policy Document Guide
    role string | Role
    The name of the IAM role to attach to the policy.
    name str
    The name of the role 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.
    policy str | str
    The inline policy document. This is a JSON formatted string. For more information about building IAM policy documents with the provider, see the AWS IAM Policy Document Guide
    role str | str
    The name of the IAM role to attach to the policy.
    name String
    The name of the role 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.
    policy String |
    The inline policy document. This is a JSON formatted string. For more information about building IAM policy documents with the provider, see the AWS IAM Policy Document Guide
    role String |
    The name of the IAM role to attach to the policy.

    Import

    Using pulumi import, import IAM Role Policies using the role_name:role_policy_name. For example:

    $ pulumi import aws:iam/rolePolicy:RolePolicy mypolicy role_of_mypolicy_name:mypolicy_name
    

    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.45.0 published on Tuesday, Jul 16, 2024 by Pulumi