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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb

Overview

Note:

When making an API call, you may pass UpdateGroupRequest data as a hash:

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

Instance Attribute Summary collapse

Instance Attribute Details

#descriptionString

A string containing the new description of the group.

Returns:

  • (String)


6447
6448
6449
6450
6451
6452
6453
6454
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 6447

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

#group_nameString

The name of the group.

Returns:

  • (String)


6447
6448
6449
6450
6451
6452
6453
6454
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 6447

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

#precedenceInteger

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

Returns:

  • (Integer)


6447
6448
6449
6450
6451
6452
6453
6454
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 6447

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

#role_arnString

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)


6447
6448
6449
6450
6451
6452
6453
6454
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 6447

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

#user_pool_idString

The user pool ID for the user pool.

Returns:

  • (String)


6447
6448
6449
6450
6451
6452
6453
6454
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 6447

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