UserGroupMembership class
Provides a resource for adding an IAM User to IAM Groups. This resource can be used multiple times with the same user for non-overlapping groups.
To exclusively manage the users in a group, see the
aws.iam.GroupMembership resource.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const user1 = new aws.iam.User("user1", {name: "user1"});
const group1 = new aws.iam.Group("group1", {name: "group1"});
const group2 = new aws.iam.Group("group2", {name: "group2"});
const example1 = new aws.iam.UserGroupMembership("example1", {
user: user1.name,
groups: [
group1.name,
group2.name,
],
});
const group3 = new aws.iam.Group("group3", {name: "group3"});
const example2 = new aws.iam.UserGroupMembership("example2", {
user: user1.name,
groups: [group3.name],
});
import pulumi
import pulumi_aws as aws
user1 = aws.iam.User("user1", name="user1")
group1 = aws.iam.Group("group1", name="group1")
group2 = aws.iam.Group("group2", name="group2")
example1 = aws.iam.UserGroupMembership("example1",
user=user1.name,
groups=[
group1.name,
group2.name,
])
group3 = aws.iam.Group("group3", name="group3")
example2 = aws.iam.UserGroupMembership("example2",
user=user1.name,
groups=[group3.name])
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var user1 = new Aws.Iam.User("user1", new()
{
Name = "user1",
});
var group1 = new Aws.Iam.Group("group1", new()
{
Name = "group1",
});
var group2 = new Aws.Iam.Group("group2", new()
{
Name = "group2",
});
var example1 = new Aws.Iam.UserGroupMembership("example1", new()
{
User = user1.Name,
Groups = new[]
{
group1.Name,
group2.Name,
},
});
var group3 = new Aws.Iam.Group("group3", new()
{
Name = "group3",
});
var example2 = new Aws.Iam.UserGroupMembership("example2", new()
{
User = user1.Name,
Groups = new[]
{
group3.Name,
},
});
});
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 {
user1, err := iam.NewUser(ctx, "user1", &iam.UserArgs{
Name: pulumi.String("user1"),
})
if err != nil {
return err
}
group1, err := iam.NewGroup(ctx, "group1", &iam.GroupArgs{
Name: pulumi.String("group1"),
})
if err != nil {
return err
}
group2, err := iam.NewGroup(ctx, "group2", &iam.GroupArgs{
Name: pulumi.String("group2"),
})
if err != nil {
return err
}
_, err = iam.NewUserGroupMembership(ctx, "example1", &iam.UserGroupMembershipArgs{
User: user1.Name,
Groups: pulumi.StringArray{
group1.Name,
group2.Name,
},
})
if err != nil {
return err
}
group3, err := iam.NewGroup(ctx, "group3", &iam.GroupArgs{
Name: pulumi.String("group3"),
})
if err != nil {
return err
}
_, err = iam.NewUserGroupMembership(ctx, "example2", &iam.UserGroupMembershipArgs{
User: user1.Name,
Groups: pulumi.StringArray{
group3.Name,
},
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_iam_usergroupmembership" "example1" {
user = aws_iam_user.user1.name
groups = [aws_iam_group.group1.name, aws_iam_group.group2.name]
}
resource "aws_iam_usergroupmembership" "example2" {
user = aws_iam_user.user1.name
groups = [aws_iam_group.group3.name]
}
resource "aws_iam_user" "user1" {
name = "user1"
}
resource "aws_iam_group" "group1" {
name = "group1"
}
resource "aws_iam_group" "group2" {
name = "group2"
}
resource "aws_iam_group" "group3" {
name = "group3"
}
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.Group;
import com.pulumi.aws.iam.GroupArgs;
import com.pulumi.aws.iam.UserGroupMembership;
import com.pulumi.aws.iam.UserGroupMembershipArgs;
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 user1 = new User("user1", UserArgs.builder()
.name("user1")
.build());
var group1 = new Group("group1", GroupArgs.builder()
.name("group1")
.build());
var group2 = new Group("group2", GroupArgs.builder()
.name("group2")
.build());
var example1 = new UserGroupMembership("example1", UserGroupMembershipArgs.builder()
.user(user1.name())
.groups(
group1.name(),
group2.name())
.build());
var group3 = new Group("group3", GroupArgs.builder()
.name("group3")
.build());
var example2 = new UserGroupMembership("example2", UserGroupMembershipArgs.builder()
.user(user1.name())
.groups(group3.name())
.build());
}
}
resources:
example1:
type: aws:iam:UserGroupMembership
properties:
user: ${user1.name}
groups:
- ${group1.name}
- ${group2.name}
example2:
type: aws:iam:UserGroupMembership
properties:
user: ${user1.name}
groups:
- ${group3.name}
user1:
type: aws:iam:User
properties:
name: user1
group1:
type: aws:iam:Group
properties:
name: group1
group2:
type: aws:iam:Group
properties:
name: group2
group3:
type: aws:iam:Group
properties:
name: group3
Import
Using pulumi import, import IAM user group membership using the user name and group names separated by /. For example:
$ pulumi import aws:iam/userGroupMembership:UserGroupMembership example1 user1/group1/group2
Constructors
- UserGroupMembership(String name, {UserGroupMembershipArgs? args, CustomResourceOptions? options})
-
Creates a new UserGroupMembership.
nameThe Pulumi resource name.argsArguments used to configure this UserGroupMembership. The set of arguments for UserGroupMembership.optionsResource options controlling this resource's behavior. - UserGroupMembership.reference(String urn)
- Creates a typed reference to an existing UserGroupMembership resource.
Properties
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
groups
↔ Output<
List< String> > -
A list of IAM Groups to add the user to
latefinal
- 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
-
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 name of the IAM User to add to groups
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, {UserGroupMembershipState? state, CustomResourceOptions? options}) → UserGroupMembership -
Gets an existing UserGroupMembership resource's state with the given
nameandid.