Class: Aws::CognitoIdentityProvider::Types::UpdateGroupRequest

Inherits:

Struct

• Object
• Struct
• Aws::CognitoIdentityProvider::Types::UpdateGroupRequest

Includes:

Structure

Defined in:

lib/aws-sdk-cognitoidentityprovider/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #description ⇒ String

  A new description of the existing group.

• #group_name ⇒ String

  The name of the group that you want to update.

• #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 Amazon Resource Name (ARN) of an IAM role that you want to associate with the group.

• #user_pool_id ⇒ String

  The ID of the user pool that contains the group you want to update.

Instance Attribute Details

#description ⇒ String

A new description of the existing group.

Returns:

• (String)

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

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

#group_name ⇒ String

The name of the group that you want to update.

Returns:

• (String)

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

class UpdateGroupRequest < Struct.new(
  :group_name,
  :user_pool_id,
  :description,
  :role_arn,
  :precedence)
  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 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.

The default ‘Precedence` value is null. The maximum `Precedence` value is `2^31-1`.

Returns:

• (Integer)

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

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

#role_arn ⇒ String

The Amazon Resource Name (ARN) of an IAM role that you want to associate with the group. The role assignment contributes to the ‘cognito:roles` and `cognito:preferred_role` claims in group members’ tokens.

Returns:

• (String)

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

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

#user_pool_id ⇒ String

The ID of the user pool that contains the group you want to update.

Returns:

• (String)

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

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