Package software.amazon.awscdk.services.cognito

Class CfnUserPoolGroup

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.cognito.CfnUserPoolGroup
All Implemented Interfaces:
IInspectable, IUserPoolGroupRef, IEnvironmentAware, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)", date="2025-12-05T22:26:33.294Z") @Stability(Stable) public class CfnUserPoolGroup extends CfnResource implements IInspectable, IUserPoolGroupRef
A user pool group.

Contains details about the group and the way that it contributes to IAM role decisions with identity pools. Identity pools can make decisions about the IAM role to assign based on groups: users get credentials for the role associated with their highest-priority group.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.cognito.*;
 CfnUserPoolGroup cfnUserPoolGroup = CfnUserPoolGroup.Builder.create(this, "MyCfnUserPoolGroup")
         .userPoolId("userPoolId")
         // the properties below are optional
         .description("description")
         .groupName("groupName")
         .precedence(123)
         .roleArn("roleArn")
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnUserPoolGroup

      protected CfnUserPoolGroup(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnUserPoolGroup

      protected CfnUserPoolGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnUserPoolGroup

      @Stability(Stable) public CfnUserPoolGroup(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnUserPoolGroupProps props)
      Create a new AWS::Cognito::UserPoolGroup.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • isCfnUserPoolGroup

      @Stability(Stable) @NotNull public static Boolean isCfnUserPoolGroup(@NotNull Object x)
      Checks whether the given object is a CfnUserPoolGroup.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getUserPoolGroupRef

      @Stability(Stable) @NotNull public UserPoolGroupReference getUserPoolGroupRef()
      A reference to a UserPoolGroup resource.
      Specified by:
      getUserPoolGroupRef in interface IUserPoolGroupRef

    • getUserPoolId

      @Stability(Stable) @NotNull public String getUserPoolId()
      The ID of the user pool where you want to create a user group.

    • setUserPoolId

      @Stability(Stable) public void setUserPoolId(@NotNull String value)
      The ID of the user pool where you want to create a user group.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      A description of the group that you're creating.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      A description of the group that you're creating.

    • getGroupName

      @Stability(Stable) @Nullable public String getGroupName()
      A name for the group.

    • setGroupName

      @Stability(Stable) public void setGroupName(@Nullable String value)
      A name for the group.

    • getPrecedence

      @Stability(Stable) @Nullable public Number getPrecedence()
      A non-negative integer value that specifies the precedence of this group relative to the other groups that a user can belong to in the user pool.

    • setPrecedence

      @Stability(Stable) public void setPrecedence(@Nullable Number value)
      A non-negative integer value that specifies the precedence of this group relative to the other groups that a user can belong to in the user pool.

    • getRoleArn

      @Stability(Stable) @Nullable public String getRoleArn()
      The Amazon Resource Name (ARN) for the IAM role that you want to associate with the group.

    • setRoleArn

      @Stability(Stable) public void setRoleArn(@Nullable String value)
      The Amazon Resource Name (ARN) for the IAM role that you want to associate with the group.