Package com.pulumi.aws.cognito

Class UserGroup

  • public class UserGroup
extends com.pulumi.resources.CustomResource
    Provides a Cognito User Group resource. ## 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.iam.IamFunctions;
 import com.pulumi.aws.iam.inputs.GetPolicyDocumentArgs;
 import com.pulumi.aws.iam.inputs.GetPolicyDocumentStatementArgs;
 import com.pulumi.aws.iam.inputs.GetPolicyDocumentStatementConditionArgs;
 import com.pulumi.aws.iam.inputs.GetPolicyDocumentStatementPrincipalArgs;
 import com.pulumi.aws.iam.Role;
 import com.pulumi.aws.iam.RoleArgs;
 import com.pulumi.aws.cognito.UserGroup;
 import com.pulumi.aws.cognito.UserGroupArgs;
 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 main = new UserPool("main", UserPoolArgs.builder()
             .name("identity pool")
             .build());
 
         final var groupRole = IamFunctions.getPolicyDocument(GetPolicyDocumentArgs.builder()
             .statements(GetPolicyDocumentStatementArgs.builder()
                 .conditions(                
                     GetPolicyDocumentStatementConditionArgs.builder()
                         .test("StringEquals")
                         .variable("cognito-identity.amazonaws.com:aud")
                         .values("us-east-1:12345678-dead-beef-cafe-123456790ab")
                         .build(),
                     GetPolicyDocumentStatementConditionArgs.builder()
                         .test("ForAnyValue:StringLike")
                         .variable("cognito-identity.amazonaws.com:amr")
                         .values("authenticated")
                         .build())
                 .principals(GetPolicyDocumentStatementPrincipalArgs.builder()
                     .type("Federated")
                     .identifiers("cognito-identity.amazonaws.com")
                     .build())
                 .effect("Allow")
                 .actions("sts:AssumeRoleWithWebIdentity")
                 .build())
             .build());
 
         var groupRoleRole = new Role("groupRoleRole", RoleArgs.builder()
             .name("user-group-role")
             .assumeRolePolicy(groupRole.json())
             .build());
 
         var mainUserGroup = new UserGroup("mainUserGroup", UserGroupArgs.builder()
             .name("user-group")
             .userPoolId(main.id())
             .description("Managed by Pulumi")
             .precedence(42)
             .roleArn(groupRoleRole.arn())
             .build());
 
     }
 }
    ## Import Using `pulumi import`, import Cognito User Groups using the `userPoolId`/`name` attributes concatenated. For example: ```sh $ pulumi import aws:cognito/userGroup:UserGroup group us-east-1_vG78M4goG/user-group ```

    • 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

    • Constructor Summary

      Constructors 
      Constructor Description
      UserGroup​(java.lang.String name)  
      UserGroup​(java.lang.String name, UserGroupArgs args)  
      UserGroup​(java.lang.String name, UserGroupArgs args, com.pulumi.resources.CustomResourceOptions options)  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()  
      static UserGroup get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, UserGroupState 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> name()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Integer>> precedence()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> roleArn()  
      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

      • UserGroup

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

      • UserGroup

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

      • UserGroup

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

      • description

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()
        Returns:
        The description of the user group.

      • name

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

      • precedence

        public com.pulumi.core.Output<java.util.Optional<java.lang.Integer>> precedence()
        Returns:
        The precedence of the user group.

      • 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.

      • roleArn

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> roleArn()
        Returns:
        The ARN of the IAM role to be associated with the user group.

      • userPoolId

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

      • get

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