Package com.pulumi.aws.iam

Class UserGroupMembership

  • public class UserGroupMembership
extends com.pulumi.resources.CustomResource
    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 <!--Start PulumiCodeChooser --> 
     
 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.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 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());
 
     }
 }
    <!--End PulumiCodeChooser --> ## Import Using `pulumi import`, import IAM user group membership using the user name and group names separated by `/`. For example: ```sh $ pulumi import aws:iam/userGroupMembership:UserGroupMembership example1 user1/group1/group2 ```

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal

      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static UserGroupMembership get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, UserGroupMembershipState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.util.List<java.lang.String>> groups()  
      com.pulumi.core.Output<java.lang.String> user()  

      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture

      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • UserGroupMembership

        public UserGroupMembership​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • UserGroupMembership

        public UserGroupMembership​(java.lang.String name,
                           UserGroupMembershipArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • UserGroupMembership

        public UserGroupMembership​(java.lang.String name,
                           UserGroupMembershipArgs args,
                           @Nullable
                           com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.

    • Method Detail

      • groups

        public com.pulumi.core.Output<java.util.List<java.lang.String>> groups()
        Returns:
        A list of IAM Groups to add the user to

      • user

        public com.pulumi.core.Output<java.lang.String> user()
        Returns:
        The name of the IAM User to add to groups

      • get

        public static UserGroupMembership get​(java.lang.String name,
                                      com.pulumi.core.Output<java.lang.String> id,
                                      @Nullable
                                      UserGroupMembershipState state,
                                      @Nullable
                                      com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.