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

• #group_name ⇒ String

  The name of the group.

• #precedence ⇒ Integer

  The new precedence value for the group.

• #role_arn ⇒ String

  The new role Amazon Resource Name (ARN) for the group.

• #user_pool_id ⇒ String

  The user pool ID for the user pool.

Instance Attribute Details

#description ⇒ String

A string containing the new description of the group.

Returns:

• (String)

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

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)

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

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].

[1]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateGroup.html

Returns:

• (Integer)

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

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)

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

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)

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

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