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:

SdkPojo, ToCopyableBuilder<SetIdentityPoolRolesRequest.Builder,SetIdentityPoolRolesRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final 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)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasRoleMappings() For responses, this returns true if the service returned a value for the RoleMappings property.
boolean	hasRoles() For responses, this returns true if the service returned a value for the Roles property.
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.
List<SdkField<?>>	sdkFields()
static Class<? extends SetIdentityPoolRolesRequest.Builder>	serializableBuilderClass()
SetIdentityPoolRolesRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

identityPoolId

public final String identityPoolId()

An identity pool ID in the format REGION:GUID.

Returns:

An identity pool ID in the format REGION:GUID.

hasRoles

public final boolean hasRoles()

For responses, this returns true if the service returned a value for the Roles property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

roles

public final 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.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasRoles() method.

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.

hasRoleMappings

public final boolean hasRoleMappings()

For responses, this returns true if the service returned a value for the RoleMappings property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

roleMappings

public final 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.us-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.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasRoleMappings() method.

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.us-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()

Specified by:

toBuilder in interface ToCopyableBuilder<SetIdentityPoolRolesRequest.Builder,SetIdentityPoolRolesRequest>

Specified by:

toBuilder in class CognitoIdentityRequest

builder

public static SetIdentityPoolRolesRequest.Builder builder()

serializableBuilderClass

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