Class: Aws::CognitoIdentityProvider::Types::GroupType

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb

Overview

The group type.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#creation_dateTime

The date the group was created.

Returns:

  • (Time)


5765
5766
5767
5768
5769
5770
5771
5772
5773
5774
5775
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 5765

class GroupType < Struct.new(
  :group_name,
  :user_pool_id,
  :description,
  :role_arn,
  :precedence,
  :last_modified_date,
  :creation_date)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

A string containing the description of the group.

Returns:

  • (String)


5765
5766
5767
5768
5769
5770
5771
5772
5773
5774
5775
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 5765

class GroupType < Struct.new(
  :group_name,
  :user_pool_id,
  :description,
  :role_arn,
  :precedence,
  :last_modified_date,
  :creation_date)
  SENSITIVE = []
  include Aws::Structure
end

#group_nameString

The name of the group.

Returns:

  • (String)


5765
5766
5767
5768
5769
5770
5771
5772
5773
5774
5775
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 5765

class GroupType < Struct.new(
  :group_name,
  :user_pool_id,
  :description,
  :role_arn,
  :precedence,
  :last_modified_date,
  :creation_date)
  SENSITIVE = []
  include Aws::Structure
end

#last_modified_dateTime

The date the group was last modified.

Returns:

  • (Time)


5765
5766
5767
5768
5769
5770
5771
5772
5773
5774
5775
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 5765

class GroupType < Struct.new(
  :group_name,
  :user_pool_id,
  :description,
  :role_arn,
  :precedence,
  :last_modified_date,
  :creation_date)
  SENSITIVE = []
  include Aws::Structure
end

#precedenceInteger

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

The default Precedence value is null.

Returns:

  • (Integer)


5765
5766
5767
5768
5769
5770
5771
5772
5773
5774
5775
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 5765

class GroupType < Struct.new(
  :group_name,
  :user_pool_id,
  :description,
  :role_arn,
  :precedence,
  :last_modified_date,
  :creation_date)
  SENSITIVE = []
  include Aws::Structure
end

#role_arnString

The role Amazon Resource Name (ARN) for the group.

Returns:

  • (String)


5765
5766
5767
5768
5769
5770
5771
5772
5773
5774
5775
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 5765

class GroupType < Struct.new(
  :group_name,
  :user_pool_id,
  :description,
  :role_arn,
  :precedence,
  :last_modified_date,
  :creation_date)
  SENSITIVE = []
  include Aws::Structure
end

#user_pool_idString

The user pool ID for the user pool.

Returns:

  • (String)


5765
5766
5767
5768
5769
5770
5771
5772
5773
5774
5775
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 5765

class GroupType < Struct.new(
  :group_name,
  :user_pool_id,
  :description,
  :role_arn,
  :precedence,
  :last_modified_date,
  :creation_date)
  SENSITIVE = []
  include Aws::Structure
end