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

Inherits:

Struct

• Object
• Struct
• Aws::CognitoIdentityProvider::Types::GroupType

Includes:

Structure

Defined in:

lib/aws-sdk-cognitoidentityprovider/types.rb

Overview

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.

This data type is a response parameter of [AdminListGroupsForUser], [CreateGroup], [GetGroup], [ListGroups], and [UpdateGroup].

[1]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminListGroupsForUser.html [2]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateGroup.html [3]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_GetGroup.html [4]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ListGroups.html [5]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateGroup.html

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #creation_date ⇒ Time

  The date and time when the item was created.

• #description ⇒ String

  A friendly description of the group.

• #group_name ⇒ String

  The name of the group.

• #last_modified_date ⇒ Time

  The date and time when the item was modified.

• #precedence ⇒ Integer

  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.

• #role_arn ⇒ String

  The ARN of the IAM role associated with the group.

• #user_pool_id ⇒ String

  The ID of the user pool that contains the group.

Instance Attribute Details

#creation_date ⇒ Time

The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java ‘Date` object.

Returns:

• (Time)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 6662

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

#description ⇒ String

A friendly description of the group.

Returns:

• (String)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 6662

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

#group_name ⇒ String

The name of the group.

Returns:

• (String)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 6662

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_date ⇒ Time

The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java ‘Date` object.

Returns:

• (Time)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 6662

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

#precedence ⇒ Integer

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)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 6662

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

#role_arn ⇒ String

The ARN of the IAM role associated with the group. If a group has the highest priority of a user’s groups, users who authenticate with an identity pool get credentials for the ‘RoleArn` that’s associated with the group.

Returns:

• (String)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 6662

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_id ⇒ String

The ID of the user pool that contains the group.

Returns:

• (String)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 6662

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