Package com.pulumi.aws.cognito

Class UserInGroup

  • public class UserInGroup
extends com.pulumi.resources.CustomResource
    Adds the specified user to the specified group. ## Example Usage 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.cognito.UserPool;
 import com.pulumi.aws.cognito.UserPoolArgs;
 import com.pulumi.aws.cognito.inputs.UserPoolPasswordPolicyArgs;
 import com.pulumi.aws.cognito.User;
 import com.pulumi.aws.cognito.UserArgs;
 import com.pulumi.aws.cognito.UserGroup;
 import com.pulumi.aws.cognito.UserGroupArgs;
 import com.pulumi.aws.cognito.UserInGroup;
 import com.pulumi.aws.cognito.UserInGroupArgs;
 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 example = new UserPool("example", UserPoolArgs.builder()
             .passwordPolicy(UserPoolPasswordPolicyArgs.builder()
                 .temporaryPasswordValidityDays(7)
                 .minimumLength(6)
                 .requireUppercase(false)
                 .requireSymbols(false)
                 .requireNumbers(false)
                 .build())
             .name("example")
             .build());
 
         var exampleUser = new User("exampleUser", UserArgs.builder()
             .userPoolId(example.id())
             .username("example")
             .build());
 
         var exampleUserGroup = new UserGroup("exampleUserGroup", UserGroupArgs.builder()
             .userPoolId(example.id())
             .name("example")
             .build());
 
         var exampleUserInGroup = new UserInGroup("exampleUserInGroup", UserInGroupArgs.builder()
             .userPoolId(example.id())
             .groupName(exampleUserGroup.name())
             .username(exampleUser.username())
             .build());
 
     }
 }
    ## Import Using `pulumi import`, import a Cognito Group User using a comma-delimited string concatenating the `userPoolId`, `groupName`, and `username` arguments. For example: ```sh $ pulumi import aws:cognito/userInGroup:UserInGroup example us-east-1_vG78M4goG,example-group,example-user ```

    • 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 UserInGroup get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, UserInGroupState 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.lang.String> groupName()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.lang.String> username()  
      com.pulumi.core.Output<java.lang.String> userPoolId()  

      • 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

      • UserInGroup

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

      • UserInGroup

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

      • UserInGroup

        public UserInGroup​(java.lang.String name,
                   UserInGroupArgs 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

      • groupName

        public com.pulumi.core.Output<java.lang.String> groupName()
        Returns:
        The name of the group to which the user is to be added.

      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

      • userPoolId

        public com.pulumi.core.Output<java.lang.String> userPoolId()
        Returns:
        The user pool ID of the user and group.

      • username

        public com.pulumi.core.Output<java.lang.String> username()
        Returns:
        The username of the user to be added to the group.

      • get

        public static UserInGroup get​(java.lang.String name,
                              com.pulumi.core.Output<java.lang.String> id,
                              @Nullable
                              UserInGroupState 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.