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.

CreateGroupInput

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

type CreateGroupInput 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 description of the group.

GroupName

Type: *string

The name of the group. Must be unique.

GroupName is a required field

Precedence

Type: *int64

A nonnegative integer value that specifies the precedence of this group relative to the other groups that a user can belong to in the user pool. Zero is the highest precedence value. Groups with lower Precedence values take precedence over groups with higher or null Precedence values. If a user belongs to two or more groups, it is the group with the lowest precedence value whose role ARN will be used in the cognito:roles and cognito:preferred_role claims in the user's tokens.

Two groups can have the same Precedence value. If this happens, neither group takes precedence over the other. If two groups with the same Precedence have the same role ARN, that role is used in the cognito:preferred_role claim in tokens for users in each group. If the two groups have different role ARNs, the cognito:preferred_role claim is not set in users' tokens.

The default Precedence value is null.

RoleArn

Type: *string

The role ARN for the group.

UserPoolId

Type: *string

The user pool ID for the user pool.

UserPoolId is a required field

Method

GoString

func (s CreateGroupInput) GoString() string

GoString returns the string representation

SetDescription

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

SetDescription sets the Description field's value.

SetGroupName

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

SetGroupName sets the GroupName field's value.

SetPrecedence

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

SetPrecedence sets the Precedence field's value.

SetRoleArn

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

SetRoleArn sets the RoleArn field's value.

SetUserPoolId

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

SetUserPoolId sets the UserPoolId field's value.

String

func (s CreateGroupInput) String() string

String returns the string representation

Validate

func (s *CreateGroupInput) Validate() error

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

On this page: