@Generated(value="software.amazon.awssdk:codegen") public class CreateGroupRequest extends CognitoIdentityProviderRequest implements ToCopyableBuilder<CreateGroupRequest.Builder,CreateGroupRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
CreateGroupRequest.Builder |
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.
|
requestOverrideConfig
copy
public String groupName()
The name of the group. Must be unique.
public String userPoolId()
The user pool ID for the user pool.
public String description()
A string containing the description of the group.
public String roleArn()
The role ARN for the group.
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.
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.
public CreateGroupRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<CreateGroupRequest.Builder,CreateGroupRequest>
toBuilder
in class CognitoIdentityProviderRequest
public static CreateGroupRequest.Builder builder()
public static Class<? extends CreateGroupRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
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.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.