Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. iam
  5. UserPolicy
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-aws

aws.iam.UserPolicy

Explore with Pulumi AI

aws logo
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-aws

    Provides an IAM policy attached to a user.

    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 lb = new aws.iam.User("lb", {
    name: "loadbalancer",
    path: "/system/",
});
const lbRo = new aws.iam.UserPolicy("lb_ro", {
    name: "test",
    user: lb.name,
    policy: JSON.stringify({
        Version: "2012-10-17",
        Statement: [{
            Action: ["ec2:Describe*"],
            Effect: "Allow",
            Resource: "*",
        }],
    }),
});
const lbAccessKey = new aws.iam.AccessKey("lb", {user: lb.name});

    import pulumi
import json
import pulumi_aws as aws

lb = aws.iam.User("lb",
    name="loadbalancer",
    path="/system/")
lb_ro = aws.iam.UserPolicy("lb_ro",
    name="test",
    user=lb.name,
    policy=json.dumps({
        "Version": "2012-10-17",
        "Statement": [{
            "Action": ["ec2:Describe*"],
            "Effect": "Allow",
            "Resource": "*",
        }],
    }))
lb_access_key = aws.iam.AccessKey("lb", user=lb.name)

    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 {
		lb, err := iam.NewUser(ctx, "lb", &iam.UserArgs{
			Name: pulumi.String("loadbalancer"),
			Path: pulumi.String("/system/"),
		})
		if err != nil {
			return err
		}
		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.NewUserPolicy(ctx, "lb_ro", &iam.UserPolicyArgs{
			Name:   pulumi.String("test"),
			User:   lb.Name,
			Policy: pulumi.String(json0),
		})
		if err != nil {
			return err
		}
		_, err = iam.NewAccessKey(ctx, "lb", &iam.AccessKeyArgs{
			User: lb.Name,
		})
		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 lb = new Aws.Iam.User("lb", new()
    {
        Name = "loadbalancer",
        Path = "/system/",
    });

    var lbRo = new Aws.Iam.UserPolicy("lb_ro", new()
    {
        Name = "test",
        User = lb.Name,
        Policy = JsonSerializer.Serialize(new Dictionary<string, object?>
        {
            ["Version"] = "2012-10-17",
            ["Statement"] = new[]
            {
                new Dictionary<string, object?>
                {
                    ["Action"] = new[]
                    {
                        "ec2:Describe*",
                    },
                    ["Effect"] = "Allow",
                    ["Resource"] = "*",
                },
            },
        }),
    });

    var lbAccessKey = new Aws.Iam.AccessKey("lb", new()
    {
        User = lb.Name,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.iam.User;
import com.pulumi.aws.iam.UserArgs;
import com.pulumi.aws.iam.UserPolicy;
import com.pulumi.aws.iam.UserPolicyArgs;
import com.pulumi.aws.iam.AccessKey;
import com.pulumi.aws.iam.AccessKeyArgs;
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 lb = new User("lb", UserArgs.builder()
            .name("loadbalancer")
            .path("/system/")
            .build());

        var lbRo = new UserPolicy("lbRo", UserPolicyArgs.builder()
            .name("test")
            .user(lb.name())
            .policy(serializeJson(
                jsonObject(
                    jsonProperty("Version", "2012-10-17"),
                    jsonProperty("Statement", jsonArray(jsonObject(
                        jsonProperty("Action", jsonArray("ec2:Describe*")),
                        jsonProperty("Effect", "Allow"),
                        jsonProperty("Resource", "*")
                    )))
                )))
            .build());

        var lbAccessKey = new AccessKey("lbAccessKey", AccessKeyArgs.builder()
            .user(lb.name())
            .build());

    }
}

    resources:
  lbRo:
    type: aws:iam:UserPolicy
    name: lb_ro
    properties:
      name: test
      user: ${lb.name}
      policy:
        fn::toJSON:
          Version: 2012-10-17
          Statement:
            - Action:
                - ec2:Describe*
              Effect: Allow
              Resource: '*'
  lb:
    type: aws:iam:User
    properties:
      name: loadbalancer
      path: /system/
  lbAccessKey:
    type: aws:iam:AccessKey
    name: lb
    properties:
      user: ${lb.name}

    Create UserPolicy Resource

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

    Constructor syntax

    new UserPolicy(name: string, args: UserPolicyArgs, opts?: CustomResourceOptions);
    @overload
def UserPolicy(resource_name: str,
               args: UserPolicyArgs,
               opts: Optional[ResourceOptions] = None)

@overload
def UserPolicy(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               policy: Optional[str] = None,
               user: Optional[str] = None,
               name: Optional[str] = None,
               name_prefix: Optional[str] = None)
    func NewUserPolicy(ctx *Context, name string, args UserPolicyArgs, opts ...ResourceOption) (*UserPolicy, error)
    public UserPolicy(string name, UserPolicyArgs args, CustomResourceOptions? opts = null)
    public UserPolicy(String name, UserPolicyArgs args)
public UserPolicy(String name, UserPolicyArgs args, CustomResourceOptions options)

    type: aws:iam:UserPolicy
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 UserPolicyArgs
    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 UserPolicyArgs
    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 UserPolicyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args UserPolicyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args UserPolicyArgs
    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 userPolicyResource = new Aws.Iam.UserPolicy("userPolicyResource", new()
{
    Policy = "string",
    User = "string",
    Name = "string",
    NamePrefix = "string",
});

    example, err := iam.NewUserPolicy(ctx, "userPolicyResource", &iam.UserPolicyArgs{
	Policy:     pulumi.Any("string"),
	User:       pulumi.String("string"),
	Name:       pulumi.String("string"),
	NamePrefix: pulumi.String("string"),
})

    var userPolicyResource = new UserPolicy("userPolicyResource", UserPolicyArgs.builder()
    .policy("string")
    .user("string")
    .name("string")
    .namePrefix("string")
    .build());

    user_policy_resource = aws.iam.UserPolicy("userPolicyResource",
    policy="string",
    user="string",
    name="string",
    name_prefix="string")

    const userPolicyResource = new aws.iam.UserPolicy("userPolicyResource", {
    policy: "string",
    user: "string",
    name: "string",
    namePrefix: "string",
});

    type: aws:iam:UserPolicy
properties:
    name: string
    namePrefix: string
    policy: string
    user: string

    UserPolicy Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The UserPolicy resource accepts the following input properties:

    Policy string | string
    The policy document. This is a JSON formatted string.
    User string
    IAM user to which to attach this policy.
    Name string
    The 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.
    Policy string | string
    The policy document. This is a JSON formatted string.
    User string
    IAM user to which to attach this policy.
    Name string
    The 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.
    policy String | String
    The policy document. This is a JSON formatted string.
    user String
    IAM user to which to attach this policy.
    name String
    The 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.
    policy string | PolicyDocument
    The policy document. This is a JSON formatted string.
    user string
    IAM user to which to attach this policy.
    name string
    The 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.
    policy str | str
    The policy document. This is a JSON formatted string.
    user str
    IAM user to which to attach this 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.
    policy String |
    The policy document. This is a JSON formatted string.
    user String
    IAM user to which to attach this policy.
    name String
    The 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.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the UserPolicy 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 UserPolicy Resource

    Get an existing UserPolicy 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?: UserPolicyState, opts?: CustomResourceOptions): UserPolicy
    @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,
        user: Optional[str] = None) -> UserPolicy
    func GetUserPolicy(ctx *Context, name string, id IDInput, state *UserPolicyState, opts ...ResourceOption) (*UserPolicy, error)
    public static UserPolicy Get(string name, Input<string> id, UserPolicyState? state, CustomResourceOptions? opts = null)
    public static UserPolicy get(String name, Output<String> id, UserPolicyState 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 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.
    Policy string | string
    The policy document. This is a JSON formatted string.
    User string
    IAM user to which to attach this policy.
    Name string
    The 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.
    Policy string | string
    The policy document. This is a JSON formatted string.
    User string
    IAM user to which to attach this policy.
    name String
    The 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.
    policy String | String
    The policy document. This is a JSON formatted string.
    user String
    IAM user to which to attach this policy.
    name string
    The 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.
    policy string | PolicyDocument
    The policy document. This is a JSON formatted string.
    user string
    IAM user to which to attach this 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.
    policy str | str
    The policy document. This is a JSON formatted string.
    user str
    IAM user to which to attach this policy.
    name String
    The 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.
    policy String |
    The policy document. This is a JSON formatted string.
    user String
    IAM user to which to attach this policy.

    Import

    Using pulumi import, import IAM User Policies using the user_name:user_policy_name. For example:

    $ pulumi import aws:iam/userPolicy:UserPolicy mypolicy user_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
    AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
    pulumi/pulumi-aws