GroupMembership class

> WARNING: Multiple aws.iam.GroupMembership resources with the same group name will produce inconsistent behavior!

Provides a top level resource to manage IAM Group membership for IAM Users. For more information on managing IAM Groups or IAM Users, see IAM Groups or IAM Users

> Note: aws.iam.GroupMembership will conflict with itself if used more than once with the same group. To non-exclusively manage the users in a group, see the aws.iam.UserGroupMembership resource.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const group = new aws.iam.Group("group", {name: "test-group"});
const userOne = new aws.iam.User("user_one", {name: "test-user"});
const userTwo = new aws.iam.User("user_two", {name: "test-user-two"});
const team = new aws.iam.GroupMembership("team", {
    name: "tf-testing-group-membership",
    users: [
        userOne.name,
        userTwo.name,
    ],
    group: group.name,
});
import pulumi
import pulumi_aws as aws

group = aws.iam.Group("group", name="test-group")
user_one = aws.iam.User("user_one", name="test-user")
user_two = aws.iam.User("user_two", name="test-user-two")
team = aws.iam.GroupMembership("team",
    name="tf-testing-group-membership",
    users=[
        user_one.name,
        user_two.name,
    ],
    group=group.name)
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var @group = new Aws.Iam.Group("group", new()
    {
        Name = "test-group",
    });

    var userOne = new Aws.Iam.User("user_one", new()
    {
        Name = "test-user",
    });

    var userTwo = new Aws.Iam.User("user_two", new()
    {
        Name = "test-user-two",
    });

    var team = new Aws.Iam.GroupMembership("team", new()
    {
        Name = "tf-testing-group-membership",
        Users = new[]
        {
            userOne.Name,
            userTwo.Name,
        },
        Group = @group.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 {
		group, err := iam.NewGroup(ctx, "group", &iam.GroupArgs{
			Name: pulumi.String("test-group"),
		})
		if err != nil {
			return err
		}
		userOne, err := iam.NewUser(ctx, "user_one", &iam.UserArgs{
			Name: pulumi.String("test-user"),
		})
		if err != nil {
			return err
		}
		userTwo, err := iam.NewUser(ctx, "user_two", &iam.UserArgs{
			Name: pulumi.String("test-user-two"),
		})
		if err != nil {
			return err
		}
		_, err = iam.NewGroupMembership(ctx, "team", &iam.GroupMembershipArgs{
			Name: pulumi.String("tf-testing-group-membership"),
			Users: pulumi.StringArray{
				userOne.Name,
				userTwo.Name,
			},
			Group: group.Name,
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_iam_groupmembership" "team" {
  name  = "tf-testing-group-membership"
  users = [aws_iam_user.user_one.name, aws_iam_user.user_two.name]
  group = aws_iam_group.group.name
}
resource "aws_iam_group" "group" {
  name = "test-group"
}
resource "aws_iam_user" "user_one" {
  name = "test-user"
}
resource "aws_iam_user" "user_two" {
  name = "test-user-two"
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.iam.Group;
import com.pulumi.aws.iam.GroupArgs;
import com.pulumi.aws.iam.User;
import com.pulumi.aws.iam.UserArgs;
import com.pulumi.aws.iam.GroupMembership;
import com.pulumi.aws.iam.GroupMembershipArgs;
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 group = new Group("group", GroupArgs.builder()
            .name("test-group")
            .build());

        var userOne = new User("userOne", UserArgs.builder()
            .name("test-user")
            .build());

        var userTwo = new User("userTwo", UserArgs.builder()
            .name("test-user-two")
            .build());

        var team = new GroupMembership("team", GroupMembershipArgs.builder()
            .name("tf-testing-group-membership")
            .users(
                userOne.name(),
                userTwo.name())
            .group(group.name())
            .build());

    }
}
resources:
  team:
    type: aws:iam:GroupMembership
    properties:
      name: tf-testing-group-membership
      users:
        - ${userOne.name}
        - ${userTwo.name}
      group: ${group.name}
  group:
    type: aws:iam:Group
    properties:
      name: test-group
  userOne:
    type: aws:iam:User
    name: user_one
    properties:
      name: test-user
  userTwo:
    type: aws:iam:User
    name: user_two
    properties:
      name: test-user-two

Constructors

GroupMembership(String name, {GroupMembershipArgs? args, CustomResourceOptions? options})
Creates a new GroupMembership. name The Pulumi resource name. args Arguments used to configure this GroupMembership. The set of arguments for GroupMembership. options Resource options controlling this resource's behavior.
GroupMembership.reference(String urn)
Creates a typed reference to an existing GroupMembership resource.

Properties

childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
group ↔ Output<String>
The IAM Group name to attach the list of users 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
name ↔ Output<String>
The name to identify the Group Membership
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
users ↔ Output<List<String>>
A list of IAM User names to associate with the Group
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, {GroupMembershipState? state, CustomResourceOptions? options}) → GroupMembership
Gets an existing GroupMembership resource's state with the given name and id.