com.amazonaws.services.cognitoidentity.model

Class SetIdentityPoolRolesRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cognitoidentity.model.SetIdentityPoolRolesRequest

All Implemented Interfaces:

Serializable, Cloneable

public class SetIdentityPoolRolesRequest
extends AmazonWebServiceRequest
implements Serializable

Sets the roles for an identity pool. These roles are used when making calls to GetCredentialsForIdentity action.

You must use AWS Developer credentials to call this API.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SetIdentityPoolRolesRequest()

Method Summary

Modifier and Type	Method and Description
SetIdentityPoolRolesRequest	addRoleMappingsEntry(String key, RoleMapping value) How users for a specific identity provider are to mapped to roles.
SetIdentityPoolRolesRequest	addRolesEntry(String key, String value) The map of roles associated with this pool.
SetIdentityPoolRolesRequest	clearRoleMappingsEntries() Removes all the entries added into RoleMappings.
SetIdentityPoolRolesRequest	clearRolesEntries() Removes all the entries added into Roles.
boolean	equals(Object obj)
String	getIdentityPoolId() An identity pool ID in the format REGION:GUID.
Map<String,RoleMapping>	getRoleMappings() How users for a specific identity provider are to mapped to roles.
Map<String,String>	getRoles() The map of roles associated with this pool.
int	hashCode()
void	setIdentityPoolId(String identityPoolId) An identity pool ID in the format REGION:GUID.
void	setRoleMappings(Map<String,RoleMapping> roleMappings) How users for a specific identity provider are to mapped to roles.
void	setRoles(Map<String,String> roles) The map of roles associated with this pool.
String	toString() Returns a string representation of this object; useful for testing and debugging.
SetIdentityPoolRolesRequest	withIdentityPoolId(String identityPoolId) An identity pool ID in the format REGION:GUID.
SetIdentityPoolRolesRequest	withRoleMappings(Map<String,RoleMapping> roleMappings) How users for a specific identity provider are to mapped to roles.
SetIdentityPoolRolesRequest	withRoles(Map<String,String> roles) The map of roles associated with this pool.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

clone, copyBaseTo, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

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

Constructor Detail

SetIdentityPoolRolesRequest

public SetIdentityPoolRolesRequest()

Method Detail

getIdentityPoolId

public String getIdentityPoolId()

An identity pool ID in the format REGION:GUID.

Constraints:
Length: 1 - 55
Pattern: [\w-]+:[0-9a-f-]+

Returns:

An identity pool ID in the format REGION:GUID.

setIdentityPoolId

public void setIdentityPoolId(String identityPoolId)

An identity pool ID in the format REGION:GUID.

Constraints:
Length: 1 - 55
Pattern: [\w-]+:[0-9a-f-]+

Parameters:

identityPoolId -

An identity pool ID in the format REGION:GUID.

withIdentityPoolId

public SetIdentityPoolRolesRequest withIdentityPoolId(String identityPoolId)

An identity pool ID in the format REGION:GUID.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 55
Pattern: [\w-]+:[0-9a-f-]+

Parameters:

identityPoolId -

An identity pool ID in the format REGION:GUID.

Returns:

A reference to this updated object so that method calls can be chained together.

getRoles

public Map<String,String> getRoles()

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.

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.

setRoles

public void setRoles(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.

Parameters:

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.

withRoles

public SetIdentityPoolRolesRequest withRoles(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.

Returns a reference to this object so that method calls can be chained together.

Parameters:

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.

Returns:

A reference to this updated object so that method calls can be chained together.

addRolesEntry

public SetIdentityPoolRolesRequest addRolesEntry(String key,
                                                 String value)

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.

The method adds a new key-value pair into Roles parameter, and returns a reference to this object so that method calls can be chained together.

Parameters:

key - The key of the entry to be added into Roles.

value - The corresponding value of the entry to be added into Roles.

Returns:

A reference to this updated object so that method calls can be chained together.

clearRolesEntries

public SetIdentityPoolRolesRequest clearRolesEntries()

Removes all the entries added into Roles.

Returns a reference to this object so that method calls can be chained together.

getRoleMappings

public Map<String,RoleMapping> getRoleMappings()

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.

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.

setRoleMappings

public void setRoleMappings(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.

Parameters:

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.

withRoleMappings

public SetIdentityPoolRolesRequest withRoleMappings(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.

Returns a reference to this object so that method calls can be chained together.

Parameters:

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.

Returns:

A reference to this updated object so that method calls can be chained together.

addRoleMappingsEntry

public SetIdentityPoolRolesRequest addRoleMappingsEntry(String key,
                                                        RoleMapping value)

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.

The method adds a new key-value pair into RoleMappings parameter, and returns a reference to this object so that method calls can be chained together.

Parameters:

key - The key of the entry to be added into RoleMappings.

value - The corresponding value of the entry to be added into RoleMappings.

Returns:

A reference to this updated object so that method calls can be chained together.

clearRoleMappingsEntries

public SetIdentityPoolRolesRequest clearRoleMappingsEntries()

Removes all the entries added into RoleMappings.

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object