software.amazon.awssdk.services.cognitoidentity.model

Class SetIdentityPoolRolesRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.cognitoidentity.model.CognitoIdentityRequest

software.amazon.awssdk.services.cognitoidentity.model.SetIdentityPoolRolesRequest

All Implemented Interfaces:

ToCopyableBuilder<SetIdentityPoolRolesRequest.Builder,SetIdentityPoolRolesRequest>

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

Input to the SetIdentityPoolRoles action.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SetIdentityPoolRolesRequest.Builder

Method Summary

Modifier and Type	Method and Description
static SetIdentityPoolRolesRequest.Builder	builder()
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.
int	hashCode()
String	identityPoolId() An identity pool ID in the format REGION:GUID.
Map<String,RoleMapping>	roleMappings() How users for a specific identity provider are to mapped to roles.
Map<String,String>	roles() The map of roles associated with this pool.
static Class<? extends SetIdentityPoolRolesRequest.Builder>	serializableBuilderClass()
SetIdentityPoolRolesRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

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

requestOverrideConfig

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

identityPoolId

public String identityPoolId()

An identity pool ID in the format REGION:GUID.

Returns:

An identity pool ID in the format REGION:GUID.

roles

public Map<String,String> roles()

The map of roles associated with this pool. For a given role, the key will be either "authenticated" or "unauthenticated" and the value will be the Role ARN.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

The map of roles associated with this pool. For a given role, the key will be either "authenticated" or "unauthenticated" and the value will be the Role ARN.

roleMappings

public Map<String,RoleMapping> roleMappings()

How users for a specific identity provider are to mapped to roles. This is a string to RoleMapping object map. The string identifies the identity provider, for example, "graph.facebook.com" or "cognito-idp-east-1.amazonaws.com/us-east-1_abcdefghi:app_client_id".

Up to 25 rules can be specified per identity provider.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

How users for a specific identity provider are to mapped to roles. This is a string to RoleMapping object map. The string identifies the identity provider, for example, "graph.facebook.com" or "cognito-idp-east-1.amazonaws.com/us-east-1_abcdefghi:app_client_id".

Up to 25 rules can be specified per identity provider.

toBuilder

public SetIdentityPoolRolesRequest.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<SetIdentityPoolRolesRequest.Builder,SetIdentityPoolRolesRequest>

Specified by:

toBuilder in class CognitoIdentityRequest

Returns:

a builder for type T

builder

public static SetIdentityPoolRolesRequest.Builder builder()

serializableBuilderClass

public static Class<? extends SetIdentityPoolRolesRequest.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