com.pulumi.aws.iam.kotlin.GroupMembership.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
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.
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.aws.iam.kotlin
import com.pulumi.core.Output
import com.pulumi.kotlin.KotlinCustomResource
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.ResourceMapper
import com.pulumi.kotlin.options.CustomResourceOptions
import com.pulumi.kotlin.options.CustomResourceOptionsBuilder
import com.pulumi.resources.Resource
import kotlin.Boolean
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.collections.List
/**
* Builder for [GroupMembership].
*/
@PulumiTagMarker
public class GroupMembershipResourceBuilder internal constructor() {
public var name: String? = null
public var args: GroupMembershipArgs = GroupMembershipArgs()
public var opts: CustomResourceOptions = CustomResourceOptions()
/**
* @param name The _unique_ name of the resulting resource.
*/
public fun name(`value`: String) {
this.name = value
}
/**
* @param block The arguments to use to populate this resource's properties.
*/
public suspend fun args(block: suspend GroupMembershipArgsBuilder.() -> Unit) {
val builder = GroupMembershipArgsBuilder()
block(builder)
this.args = builder.build()
}
/**
* @param block A bag of options that control this resource's behavior.
*/
public suspend fun opts(block: suspend CustomResourceOptionsBuilder.() -> Unit) {
this.opts = com.pulumi.kotlin.options.CustomResourceOptions.opts(block)
}
internal fun build(): GroupMembership {
val builtJavaResource = com.pulumi.aws.iam.GroupMembership(
this.name,
this.args.toJava(),
this.opts.toJava(),
)
return GroupMembership(builtJavaResource)
}
}
/**
* > **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
* ```
*
*/
public class GroupMembership internal constructor(
override val javaResource: com.pulumi.aws.iam.GroupMembership,
) : KotlinCustomResource(javaResource, GroupMembershipMapper) {
/**
* The IAM Group name to attach the list of `users` to
*/
public val group: Output
get() = javaResource.group().applyValue({ args0 -> args0 })
/**
* The name to identify the Group Membership
*/
public val name: Output
get() = javaResource.name().applyValue({ args0 -> args0 })
/**
* A list of IAM User names to associate with the Group
*/
public val users: Output>
get() = javaResource.users().applyValue({ args0 -> args0.map({ args0 -> args0 }) })
}
public object GroupMembershipMapper : ResourceMapper {
override fun supportsMappingOfType(javaResource: Resource): Boolean =
com.pulumi.aws.iam.GroupMembership::class == javaResource::class
override fun map(javaResource: Resource): GroupMembership = GroupMembership(
javaResource as
com.pulumi.aws.iam.GroupMembership,
)
}
/**
* @see [GroupMembership].
* @param name The _unique_ name of the resulting resource.
* @param block Builder for [GroupMembership].
*/
public suspend fun groupMembership(
name: String,
block: suspend GroupMembershipResourceBuilder.() -> Unit,
): GroupMembership {
val builder = GroupMembershipResourceBuilder()
builder.name(name)
block(builder)
return builder.build()
}
/**
* @see [GroupMembership].
* @param name The _unique_ name of the resulting resource.
*/
public fun groupMembership(name: String): GroupMembership {
val builder = GroupMembershipResourceBuilder()
builder.name(name)
return builder.build()
}