Class CfnUserPoolGroup

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
All Implemented Interfaces:
IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)", date="2024-07-22T22:42:49.306Z") @Stability(Stable) public class CfnUserPoolGroup extends CfnResource implements IInspectable
A user pool group that you can add a user to.

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)
      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

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

      @Stability(Stable) @NotNull public String getUserPoolId()
      The user pool ID for the user pool.
    • setUserPoolId

      @Stability(Stable) public void setUserPoolId(@NotNull String value)
      The user pool ID for the user pool.
    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      A string containing the description of the group.
    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      A string containing the description of the group.
    • getGroupName

      @Stability(Stable) @Nullable public String getGroupName()
      The name of the group.
    • setGroupName

      @Stability(Stable) public void setGroupName(@Nullable String value)
      The name of 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 role Amazon Resource Name (ARN) for the group.
    • setRoleArn

      @Stability(Stable) public void setRoleArn(@Nullable String value)
      The role Amazon Resource Name (ARN) for the group.