NAME

Paws::CognitoIdp::CreateGroup - Arguments for method CreateGroup on Paws::CognitoIdp

DESCRIPTION

This class represents the parameters used for calling the method CreateGroup on the Amazon Cognito Identity Provider service. Use the attributes of this class as arguments to method CreateGroup.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateGroup.

SYNOPSIS

    my $cognito-idp = Paws->service('CognitoIdp');
    my $CreateGroupResponse = $cognito -idp->CreateGroup(
      GroupName   => 'MyGroupNameType',
      UserPoolId  => 'MyUserPoolIdType',
      Description => 'MyDescriptionType',    # OPTIONAL
      Precedence  => 1,                      # OPTIONAL
      RoleArn     => 'MyArnType',            # OPTIONAL
    );
    # Results:
    my $Group = $CreateGroupResponse->Group;
    # Returns a L<Paws::CognitoIdp::CreateGroupResponse> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see <https://docs.aws.amazon.com/goto/WebAPI/cognito-idp/CreateGroup>

ATTRIBUTES

Description => Str

A string containing the description of the group.

REQUIRED GroupName => Str

The name of the group. Must be unique.

Precedence => Int

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 => Str

The role ARN for the group.

REQUIRED UserPoolId => Str

The user pool ID for the user pool.

BUGS and CONTRIBUTIONS

The source code is located here: <https://github.com/pplu/aws-sdk-perl>

Please report bugs to: <https://github.com/pplu/aws-sdk-perl/issues>