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

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#description ⇒ String

A string containing the new description of the group.

Returns:

  • (String) 


8535
8536
8537
8538
8539
8540
8541
8542
8543
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 8535

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.

Returns:

  • (String) 


8535
8536
8537
8538
8539
8540
8541
8542
8543
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 8535

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

#precedence ⇒ Integer

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

Returns:

  • (Integer) 


8535
8536
8537
8538
8539
8540
8541
8542
8543
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 8535

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

#role_arn ⇒ String

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

Returns:

  • (String) 


8535
8536
8537
8538
8539
8540
8541
8542
8543
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 8535

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

#user_pool_id ⇒ String

The user pool ID for the user pool.

Returns:

  • (String) 


8535
8536
8537
8538
8539
8540
8541
8542
8543
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 8535

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