AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

UpdateGroupInput

import "github.com/aws/aws-sdk-go/service/cognitoidentityprovider"

type UpdateGroupInput struct { Description *string `type:"string"` GroupName *string `min:"1" type:"string" required:"true"` Precedence *int64 `type:"integer"` RoleArn *string `min:"20" type:"string"` UserPoolId *string `min:"1" type:"string" required:"true"` }

Description

Type: *string

A string containing the new description of the group.

GroupName

Type: *string

The name of the group.

GroupName is a required field

Precedence

Type: *int64

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

RoleArn

Type: *string

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

UserPoolId

Type: *string

The user pool ID for the user pool.

UserPoolId is a required field

Method

GoString

func (s UpdateGroupInput) GoString() string

GoString returns the string representation

SetDescription

func (s *UpdateGroupInput) SetDescription(v string) *UpdateGroupInput

SetDescription sets the Description field's value.

SetGroupName

func (s *UpdateGroupInput) SetGroupName(v string) *UpdateGroupInput

SetGroupName sets the GroupName field's value.

SetPrecedence

func (s *UpdateGroupInput) SetPrecedence(v int64) *UpdateGroupInput

SetPrecedence sets the Precedence field's value.

SetRoleArn

func (s *UpdateGroupInput) SetRoleArn(v string) *UpdateGroupInput

SetRoleArn sets the RoleArn field's value.

SetUserPoolId

func (s *UpdateGroupInput) SetUserPoolId(v string) *UpdateGroupInput

SetUserPoolId sets the UserPoolId field's value.

String

func (s UpdateGroupInput) String() string

String returns the string representation

Validate

func (s *UpdateGroupInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

On this page: