Package 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:

SdkPojo, ToCopyableBuilder<CreateGroupRequest.Builder,CreateGroupRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateGroupRequest.Builder

Method Summary

Modifier and Type	Method	Description
static CreateGroupRequest.Builder	builder()
String	description()	A string containing the description of the group.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
String	groupName()	The name of the group.
int	hashCode()
Integer	precedence()	A non-negative 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 Amazon Resource Name (ARN) for the group.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateGroupRequest.Builder>	serializableBuilderClass()
CreateGroupRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
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

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

groupName

public final String groupName()

The name of the group. Must be unique.

Returns:

The name of the group. Must be unique.

userPoolId

public final String userPoolId()

The user pool ID for the user pool.

Returns:

The user pool ID for the user pool.

description

public final String description()

A string containing the description of the group.

Returns:

A string containing the description of the group.

roleArn

public final String roleArn()

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

Returns:

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

precedence

public final Integer precedence()

A non-negative 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 is given in the user's tokens for the cognito:roles and cognito:preferred_role claims.

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 isn't set in users' tokens.

The default Precedence value is null. The maximum Precedence value is 2^31-1.

Returns:

A non-negative 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 is given in the user's tokens for the cognito:roles and cognito:preferred_role claims.

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 isn't set in users' tokens.

The default Precedence value is null. The maximum Precedence value is 2^31-1.

toBuilder

public CreateGroupRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateGroupRequest.Builder,CreateGroupRequest>

Specified by:

toBuilder in class CognitoIdentityProviderRequest

builder

public static CreateGroupRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

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

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo