AWS Classic

Pulumi Official
Package maintained by Pulumi
v5.9.1 published on Tuesday, Jun 21, 2022 by Pulumi

UserPolicyAttachment

Attaches a Managed IAM Policy to an IAM user

NOTE: The usage of this resource conflicts with the aws.iam.PolicyAttachment resource and will permanently show a difference if both are defined.

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var user = new Aws.Iam.User("user", new Aws.Iam.UserArgs
        {
        });
        var policy = new Aws.Iam.Policy("policy", new Aws.Iam.PolicyArgs
        {
            Description = "A test policy",
            Policy = "{ ... policy JSON ... }",
        });
        var test_attach = new Aws.Iam.UserPolicyAttachment("test-attach", new Aws.Iam.UserPolicyAttachmentArgs
        {
            User = user.Name,
            PolicyArn = policy.Arn,
        });
    }

}
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v5/go/aws"
	"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/iam"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		user, err := iam.NewUser(ctx, "user", nil)
		if err != nil {
			return err
		}
		policy, err := iam.NewPolicy(ctx, "policy", &iam.PolicyArgs{
			Description: pulumi.String("A test policy"),
			Policy:      pulumi.Any("{ ... policy JSON ... }"),
		})
		if err != nil {
			return err
		}
		_, err = iam.NewUserPolicyAttachment(ctx, "test-attach", &iam.UserPolicyAttachmentArgs{
			User:      user.Name,
			PolicyArn: policy.Arn,
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var user = new User("user");

        var policy = new Policy("policy", PolicyArgs.builder()        
            .description("A test policy")
            .policy("{ ... policy JSON ... }")
            .build());

        var test_attach = new UserPolicyAttachment("test-attach", UserPolicyAttachmentArgs.builder()        
            .user(user.name())
            .policyArn(policy.arn())
            .build());

    }
}
import pulumi
import pulumi_aws as aws

user = aws.iam.User("user")
policy = aws.iam.Policy("policy",
    description="A test policy",
    policy="{ ... policy JSON ... }")
test_attach = aws.iam.UserPolicyAttachment("test-attach",
    user=user.name,
    policy_arn=policy.arn)
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const user = new aws.iam.User("user", {});
const policy = new aws.iam.Policy("policy", {
    description: "A test policy",
    policy: "{ ... policy JSON ... }",
});
const test_attach = new aws.iam.UserPolicyAttachment("test-attach", {
    user: user.name,
    policyArn: policy.arn,
});
resources:
  user:
    type: aws:iam:User
  policy:
    type: aws:iam:Policy
    properties:
      description: A test policy
      policy: '{ ... policy JSON ... }'
  test-attach:
    type: aws:iam:UserPolicyAttachment
    properties:
      user: ${user.name}
      policyArn: ${policy.arn}

Create a UserPolicyAttachment Resource

new UserPolicyAttachment(name: string, args: UserPolicyAttachmentArgs, opts?: CustomResourceOptions);
@overload
def UserPolicyAttachment(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         policy_arn: Optional[str] = None,
                         user: Optional[str] = None)
@overload
def UserPolicyAttachment(resource_name: str,
                         args: UserPolicyAttachmentArgs,
                         opts: Optional[ResourceOptions] = None)
func NewUserPolicyAttachment(ctx *Context, name string, args UserPolicyAttachmentArgs, opts ...ResourceOption) (*UserPolicyAttachment, error)
public UserPolicyAttachment(string name, UserPolicyAttachmentArgs args, CustomResourceOptions? opts = null)
public UserPolicyAttachment(String name, UserPolicyAttachmentArgs args)
public UserPolicyAttachment(String name, UserPolicyAttachmentArgs args, CustomResourceOptions options)
type: aws:iam:UserPolicyAttachment
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

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

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

PolicyArn string

The ARN of the policy you want to apply

User string | string

The user the policy should be applied to

PolicyArn string

The ARN of the policy you want to apply

User string | string

The user the policy should be applied to

policyArn String

The ARN of the policy you want to apply

user String | String

The user the policy should be applied to

policyArn ARN

The ARN of the policy you want to apply

user string | User

The user the policy should be applied to

policy_arn str

The ARN of the policy you want to apply

user str | str

The user the policy should be applied to

policyArn

The ARN of the policy you want to apply

user String |

The user the policy should be applied to

Outputs

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

Get an existing UserPolicyAttachment 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?: UserPolicyAttachmentState, opts?: CustomResourceOptions): UserPolicyAttachment
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        policy_arn: Optional[str] = None,
        user: Optional[str] = None) -> UserPolicyAttachment
func GetUserPolicyAttachment(ctx *Context, name string, id IDInput, state *UserPolicyAttachmentState, opts ...ResourceOption) (*UserPolicyAttachment, error)
public static UserPolicyAttachment Get(string name, Input<string> id, UserPolicyAttachmentState? state, CustomResourceOptions? opts = null)
public static UserPolicyAttachment get(String name, Output<String> id, UserPolicyAttachmentState 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:
PolicyArn string

The ARN of the policy you want to apply

User string | string

The user the policy should be applied to

PolicyArn string

The ARN of the policy you want to apply

User string | string

The user the policy should be applied to

policyArn String

The ARN of the policy you want to apply

user String | String

The user the policy should be applied to

policyArn ARN

The ARN of the policy you want to apply

user string | User

The user the policy should be applied to

policy_arn str

The ARN of the policy you want to apply

user str | str

The user the policy should be applied to

policyArn

The ARN of the policy you want to apply

user String |

The user the policy should be applied to

Import

IAM user policy attachments can be imported using the user name and policy arn separated by /.

 $ pulumi import aws:iam/userPolicyAttachment:UserPolicyAttachment test-attach test-user/arn:aws:iam::xxxxxxxxxxxx:policy/test-policy

Package Details

Repository
https://github.com/pulumi/pulumi-aws
License
Apache-2.0
Notes

This Pulumi package is based on the aws Terraform Provider.