com.pulumi.aws.iam.kotlin.GroupMembershipArgs.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-aws-kotlin Show documentation
Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.
There is a newer version: 6.57.0.0
Show newest version
@file:Suppress("NAME_SHADOWING", "DEPRECATION")

package com.pulumi.aws.iam.kotlin

import com.pulumi.aws.iam.GroupMembershipArgs.builder
import com.pulumi.core.Output
import com.pulumi.core.Output.of
import com.pulumi.kotlin.ConvertibleToJava
import com.pulumi.kotlin.PulumiTagMarker
import kotlin.String
import kotlin.Suppress
import kotlin.collections.List
import kotlin.jvm.JvmName

/**
 * > **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
 * 
 * ```typescript
 * 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,
 * });
 * ```
 * ```python
 * 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)
 * ```
 * ```csharp
 * 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,
 *     });
 * });
 * ```
 * ```go
 * package main
 * import (
 * 	"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 {
 * 		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
 * 	})
 * }
 * ```
 * ```java
 * 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.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 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());
 *     }
 * }
 * ```
 * ```yaml
 * 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
 * ```
 * 
 * @property group The IAM Group name to attach the list of `users` to
 * @property name The name to identify the Group Membership
 * @property users A list of IAM User names to associate with the Group
 */
public data class GroupMembershipArgs(
    public val group: Output? = null,
    public val name: Output? = null,
    public val users: Output>? = null,
) : ConvertibleToJava {
    override fun toJava(): com.pulumi.aws.iam.GroupMembershipArgs =
        com.pulumi.aws.iam.GroupMembershipArgs.builder()
            .group(group?.applyValue({ args0 -> args0 }))
            .name(name?.applyValue({ args0 -> args0 }))
            .users(users?.applyValue({ args0 -> args0.map({ args0 -> args0 }) })).build()
}

/**
 * Builder for [GroupMembershipArgs].
 */
@PulumiTagMarker
public class GroupMembershipArgsBuilder internal constructor() {
    private var group: Output? = null

    private var name: Output? = null

    private var users: Output>? = null

    /**
     * @param value The IAM Group name to attach the list of `users` to
     */
    @JvmName("icxovxnwgwarrakw")
    public suspend fun group(`value`: Output) {
        this.group = value
    }

    /**
     * @param value The name to identify the Group Membership
     */
    @JvmName("gyvxphaqburbuoas")
    public suspend fun name(`value`: Output) {
        this.name = value
    }

    /**
     * @param value A list of IAM User names to associate with the Group
     */
    @JvmName("ieaxlishipeyjwjt")
    public suspend fun users(`value`: Output>) {
        this.users = value
    }

    @JvmName("oevbssewhcqagdxb")
    public suspend fun users(vararg values: Output) {
        this.users = Output.all(values.asList())
    }

    /**
     * @param values A list of IAM User names to associate with the Group
     */
    @JvmName("bcssurdktndvmtoe")
    public suspend fun users(values: List>) {
        this.users = Output.all(values)
    }

    /**
     * @param value The IAM Group name to attach the list of `users` to
     */
    @JvmName("xjrqhqaovnyflbfs")
    public suspend fun group(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.group = mapped
    }

    /**
     * @param value The name to identify the Group Membership
     */
    @JvmName("ktgxgpnjacitqqlv")
    public suspend fun name(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.name = mapped
    }

    /**
     * @param value A list of IAM User names to associate with the Group
     */
    @JvmName("lwsdkdudaoxaklha")
    public suspend fun users(`value`: List?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.users = mapped
    }

    /**
     * @param values A list of IAM User names to associate with the Group
     */
    @JvmName("cjnnannpykvieugw")
    public suspend fun users(vararg values: String) {
        val toBeMapped = values.toList()
        val mapped = toBeMapped.let({ args0 -> of(args0) })
        this.users = mapped
    }

    internal fun build(): GroupMembershipArgs = GroupMembershipArgs(
        group = group,
        name = name,
        users = users,
    )
}