Package software.amazon.awscdk.services.cognito

Class UserPoolGroupProps.Jsii$Proxy

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.cognito.UserPoolGroupProps.Jsii$Proxy
All Implemented Interfaces:
UserPoolGroupOptions, UserPoolGroupProps, software.amazon.jsii.JsiiSerializable
Enclosing interface:
UserPoolGroupProps
@Stability(Stable) @Internal public static final class UserPoolGroupProps.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements UserPoolGroupProps
An implementation for UserPoolGroupProps

  • Nested Class Summary

    Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

    software.amazon.jsii.JsiiObject.InitializationMode

    Nested classes/interfaces inherited from interface software.amazon.awscdk.services.cognito.UserPoolGroupProps

    UserPoolGroupProps.Builder, UserPoolGroupProps.Jsii$Proxy

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    Jsii$Proxy(UserPoolGroupProps.Builder builder)
    Constructor that initializes the object based on literal property values passed by the UserPoolGroupProps.Builder.
    protected
    Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
    Constructor that initializes the object based on values retrieved from the JsiiObject.

  • Method Summary

    Modifier and Type
    Method
    Description
    com.fasterxml.jackson.databind.JsonNode
    $jsii$toJson()
     
    final boolean
    equals(Object o)
     
    final String
    getDescription()
    A string containing the description of the group.
    final String
    getGroupName()
    The name of the group.
    final 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.
    final IRoleRef
    getRole()
    The role for the group.
    final IUserPool
    getUserPool()
    The user pool to which this group is associated.
    final int
    hashCode()
     

    Methods inherited from class software.amazon.jsii.JsiiObject

    jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • Jsii$Proxy

      protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
      Constructor that initializes the object based on values retrieved from the JsiiObject.
      Parameters:
      objRef - Reference to the JSII managed object.

    • Jsii$Proxy

      protected Jsii$Proxy(UserPoolGroupProps.Builder builder)
      Constructor that initializes the object based on literal property values passed by the UserPoolGroupProps.Builder.

  • Method Details

    • getUserPool

      public final IUserPool getUserPool()
      Description copied from interface: UserPoolGroupProps
      The user pool to which this group is associated.
      Specified by:
      getUserPool in interface UserPoolGroupProps

    • getDescription

      public final String getDescription()
      Description copied from interface: UserPoolGroupOptions
      A string containing the description of the group.

      Default: - no description

      Specified by:
      getDescription in interface UserPoolGroupOptions

    • getGroupName

      public final String getGroupName()
      Description copied from interface: UserPoolGroupOptions
      The name of the group.

      Must be unique.

      Default: - auto generate a name

      Specified by:
      getGroupName in interface UserPoolGroupOptions

    • getPrecedence

      public final Number getPrecedence()
      Description copied from interface: UserPoolGroupOptions
      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.

      Zero is the highest precedence value.

      Groups with lower Precedence values take precedence over groups with higher or null Precedence values. If a user belongs to two or more groups, it is the group with the lowest precedence value whose role ARN is given in the user's tokens for the cognito:roles and cognito:preferred_role claims.

      Two groups can have the same Precedence value. If this happens, neither group takes precedence over the other. If two groups with the same Precedence have the same role ARN, that role is used in the cognito:preferred_role claim in tokens for users in each group. If the two groups have different role ARNs, the cognito:preferred_role claim isn't set in users' tokens.

      Default: - null

      Specified by:
      getPrecedence in interface UserPoolGroupOptions

    • getRole

      public final IRoleRef getRole()
      Description copied from interface: UserPoolGroupOptions
      The role for the group.

      Default: - no description

      Specified by:
      getRole in interface UserPoolGroupOptions

    • $jsii$toJson

      @Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
      Specified by:
      $jsii$toJson in interface software.amazon.jsii.JsiiSerializable

    • equals

      public final boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object