UserPolicyAttachment class
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
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const user = new aws.iam.User("user", {name: "test-user"});
const policy = new aws.iam.Policy("policy", {
name: "test-policy",
description: "A test policy",
policy: "{ ... policy JSON ... }",
});
const test_attach = new aws.iam.UserPolicyAttachment("test-attach", {
user: user.name,
policyArn: policy.arn,
});
import pulumi
import pulumi_aws as aws
user = aws.iam.User("user", name="test-user")
policy = aws.iam.Policy("policy",
name="test-policy",
description="A test policy",
policy="{ ... policy JSON ... }")
test_attach = aws.iam.UserPolicyAttachment("test-attach",
user=user.name,
policy_arn=policy.arn)
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var user = new Aws.Iam.User("user", new()
{
Name = "test-user",
});
var policy = new Aws.Iam.Policy("policy", new()
{
Name = "test-policy",
Description = "A test policy",
PolicyDocument = "{ ... policy JSON ... }",
});
var test_attach = new Aws.Iam.UserPolicyAttachment("test-attach", new()
{
User = user.Name,
PolicyArn = policy.Arn,
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/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", &iam.UserArgs{
Name: pulumi.String("test-user"),
})
if err != nil {
return err
}
policy, err := iam.NewPolicy(ctx, "policy", &iam.PolicyArgs{
Name: pulumi.String("test-policy"),
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
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_iam_user" "user" {
name = "test-user"
}
resource "aws_iam_policy" "policy" {
name = "test-policy"
description = "A test policy"
policy = "{ ... policy JSON ... }"
}
resource "aws_iam_userpolicyattachment" "test-attach" {
user = aws_iam_user.user.name
policy_arn = aws_iam_policy.policy.arn
}
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.Policy;
import com.pulumi.aws.iam.PolicyArgs;
import com.pulumi.aws.iam.UserPolicyAttachment;
import com.pulumi.aws.iam.UserPolicyAttachmentArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 user = new User("user", UserArgs.builder()
.name("test-user")
.build());
var policy = new Policy("policy", PolicyArgs.builder()
.name("test-policy")
.description("A test policy")
.policy("{ ... policy JSON ... }")
.build());
var test_attach = new UserPolicyAttachment("test-attach", UserPolicyAttachmentArgs.builder()
.user(user.name())
.policyArn(policy.arn())
.build());
}
}
resources:
user:
type: aws:iam:User
properties:
name: test-user
policy:
type: aws:iam:Policy
properties:
name: test-policy
description: A test policy
policy: '{ ... policy JSON ... }'
test-attach:
type: aws:iam:UserPolicyAttachment
properties:
user: ${user.name}
policyArn: ${policy.arn}
Import
Identity Schema
Required
user(String) Name of the IAM user.policyArn(String) ARN of the IAM policy.
Optional
accountId(String) AWS Account where this resource is managed.
Using pulumi import, import IAM user policy attachments using the user name and policy arn separated by /. For example:
$ pulumi import aws:iam/userPolicyAttachment:UserPolicyAttachment example test-user/arn:aws:iam::xxxxxxxxxxxx:policy/test-policy
Constructors
- UserPolicyAttachment(String name, {UserPolicyAttachmentArgs? args, CustomResourceOptions? options})
-
Creates a new UserPolicyAttachment.
nameThe Pulumi resource name.argsArguments used to configure this UserPolicyAttachment. The set of arguments for UserPolicyAttachment.optionsResource options controlling this resource's behavior. - UserPolicyAttachment.reference(String urn)
- Creates a typed reference to an existing UserPolicyAttachment resource.
Properties
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
policyArn
↔ Output<
String> -
The ARN of the policy you want to apply
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
-
user
↔ Output<
String> -
The user the policy should be applied to
latefinal
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
get(
String name, Input< String> id, {UserPolicyAttachmentState? state, CustomResourceOptions? options}) → UserPolicyAttachment -
Gets an existing UserPolicyAttachment resource's state with the given
nameandid.