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

Inherits:

Struct

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

Defined in:

gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb

Overview

The group type.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #creation_date ⇒ Time

  The date and time, in [ISO 8601][1] format, when the item was created.

• #description ⇒ String

  A string containing the description of the group.

• #group_name ⇒ String

  The name of the group.

• #last_modified_date ⇒ Time

  The date and time, in [ISO 8601][1] format, 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 role Amazon Resource Name (ARN) for the group.

• #user_pool_id ⇒ String

  The user pool ID for the user pool.

Instance Attribute Details

#creation_date ⇒ Time

The date and time, in ISO 8601 format, when the item was created.

Returns:

• (Time)

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

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 string containing the description of the group.

Returns:

• (String)

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

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 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 5211

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, in ISO 8601 format, when the item was modified.

Returns:

• (Time)

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

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 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 5211

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 role Amazon Resource Name (ARN) for the group.

Returns:

• (String)

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

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 user pool ID for the user pool.

Returns:

• (String)

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

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