You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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.

Instance Attribute Summary collapse

Instance Attribute Details

#creation_dateTime

The date the group was created.

Returns:

  • (Time)


4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 4109

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

#descriptionString

A string containing the description of the group.

Returns:

  • (String)


4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 4109

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

#group_nameString

The name of the group.

Returns:

  • (String)


4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 4109

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

#last_modified_dateTime

The date the group was last modified.

Returns:

  • (Time)


4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 4109

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

#precedenceInteger

A nonnegative integer value that specifies the precedence of this group relative to the other groups that a user can belong to in the user pool. If a user belongs to two or more groups, it is the group with the highest precedence whose role ARN will be used in the cognito:roles and cognito:preferred_role claims in the user's tokens. Groups with higher Precedence values take precedence over groups with lower Precedence values or with null Precedence values.

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 is not set in users' tokens.

The default Precedence value is null.

Returns:

  • (Integer)


4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 4109

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

#role_arnString

The role ARN for the group.

Returns:

  • (String)


4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 4109

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

#user_pool_idString

The user pool ID for the user pool.

Returns:

  • (String)


4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 4109

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