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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing UpdateGroupRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  group_name: "GroupNameType", # required
  user_pool_id: "UserPoolIdType", # required
  description: "DescriptionType",
  role_arn: "ArnType",
  precedence: 1,
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#description ⇒ String

A string containing the new description of the group.

Returns:

  • (String) —

    A string containing the new description of the group.

#group_name ⇒ String

The name of the group.

Returns:

  • (String) —

    The name of the group.

#precedence ⇒ Integer

The new precedence value for the group. For more information about this parameter, see CreateGroup.

Returns:

  • (Integer) —

    The new precedence value for the group.

#role_arn ⇒ String

The new role ARN for the group. This is used for setting the cognito:roles and cognito:preferred_role claims in the token.

Returns:

  • (String) —

    The new role ARN for the group.

#user_pool_id ⇒ String

The user pool ID for the user pool.

Returns:

  • (String) —

    The user pool ID for the user pool.