software.amazon.awssdk.services.cognitoidentityprovider.model

Class CreateGroupRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.cognitoidentityprovider.model.CognitoIdentityProviderRequest

software.amazon.awssdk.services.cognitoidentityprovider.model.CreateGroupRequest

All Implemented Interfaces:

ToCopyableBuilder<CreateGroupRequest.Builder,CreateGroupRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateGroupRequest
extends CognitoIdentityProviderRequest
implements ToCopyableBuilder<CreateGroupRequest.Builder,CreateGroupRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateGroupRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateGroupRequest.Builder	builder()
String	description() A string containing the description of the group.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
String	groupName() The name of the group.
int	hashCode()
Integer	precedence() 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.
String	roleArn() The role ARN for the group.
static Class<? extends CreateGroupRequest.Builder>	serializableBuilderClass()
CreateGroupRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
String	userPoolId() The user pool ID for the user pool.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

groupName

public String groupName()

The name of the group. Must be unique.

Returns:

The name of the group. Must be unique.

userPoolId

public String userPoolId()

The user pool ID for the user pool.

Returns:

The user pool ID for the user pool.

description

public String description()

A string containing the description of the group.

Returns:

A string containing the description of the group.

roleArn

public String roleArn()

The role ARN for the group.

Returns:

The role ARN for the group.

precedence

public Integer precedence()

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.

Returns:

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.

toBuilder

public CreateGroupRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<CreateGroupRequest.Builder,CreateGroupRequest>

Specified by:

toBuilder in class CognitoIdentityProviderRequest

Returns:

a builder for type T

builder

public static CreateGroupRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateGroupRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value