com.amazonaws.services.cognitoidentity.model

Class RoleMapping

java.lang.Object

com.amazonaws.services.cognitoidentity.model.RoleMapping

All Implemented Interfaces:

java.io.Serializable

public class RoleMapping
extends java.lang.Object
implements java.io.Serializable

A role mapping.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
RoleMapping()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getAmbiguousRoleResolution() If you specify Token or Rules as the Type, AmbiguousRoleResolution is required.
RulesConfigurationType	getRulesConfiguration() The rules to be used for mapping users to roles.
java.lang.String	getType() The role mapping type.
int	hashCode()
void	setAmbiguousRoleResolution(AmbiguousRoleResolutionType ambiguousRoleResolution) If you specify Token or Rules as the Type, AmbiguousRoleResolution is required.
void	setAmbiguousRoleResolution(java.lang.String ambiguousRoleResolution) If you specify Token or Rules as the Type, AmbiguousRoleResolution is required.
void	setRulesConfiguration(RulesConfigurationType rulesConfiguration) The rules to be used for mapping users to roles.
void	setType(RoleMappingType type) The role mapping type.
void	setType(java.lang.String type) The role mapping type.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
RoleMapping	withAmbiguousRoleResolution(AmbiguousRoleResolutionType ambiguousRoleResolution) If you specify Token or Rules as the Type, AmbiguousRoleResolution is required.
RoleMapping	withAmbiguousRoleResolution(java.lang.String ambiguousRoleResolution) If you specify Token or Rules as the Type, AmbiguousRoleResolution is required.
RoleMapping	withRulesConfiguration(RulesConfigurationType rulesConfiguration) The rules to be used for mapping users to roles.
RoleMapping	withType(RoleMappingType type) The role mapping type.
RoleMapping	withType(java.lang.String type) The role mapping type.

Methods inherited from class java.lang.Object

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

Constructor Detail

RoleMapping

public RoleMapping()

Method Detail

getType

public java.lang.String getType()

The role mapping type. Token will use cognito:roles and cognito:preferred_role claims from the Cognito identity provider token to map groups to roles. Rules will attempt to match claims from the token to map to a role.

Constraints:
Allowed Values: Token, Rules

Returns:

The role mapping type. Token will use cognito:roles and cognito:preferred_role claims from the Cognito identity provider token to map groups to roles. Rules will attempt to match claims from the token to map to a role.

See Also:

RoleMappingType

setType

public void setType(java.lang.String type)

The role mapping type. Token will use cognito:roles and cognito:preferred_role claims from the Cognito identity provider token to map groups to roles. Rules will attempt to match claims from the token to map to a role.

Constraints:
Allowed Values: Token, Rules

Parameters:

type -

The role mapping type. Token will use cognito:roles and cognito:preferred_role claims from the Cognito identity provider token to map groups to roles. Rules will attempt to match claims from the token to map to a role.

See Also:

RoleMappingType

withType

public RoleMapping withType(java.lang.String type)

The role mapping type. Token will use cognito:roles and cognito:preferred_role claims from the Cognito identity provider token to map groups to roles. Rules will attempt to match claims from the token to map to a role.

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

Constraints:
Allowed Values: Token, Rules

Parameters:

type -

The role mapping type. Token will use cognito:roles and cognito:preferred_role claims from the Cognito identity provider token to map groups to roles. Rules will attempt to match claims from the token to map to a role.

Returns:

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

See Also:

RoleMappingType

setType

public void setType(RoleMappingType type)

The role mapping type. Token will use cognito:roles and cognito:preferred_role claims from the Cognito identity provider token to map groups to roles. Rules will attempt to match claims from the token to map to a role.

Constraints:
Allowed Values: Token, Rules

Parameters:

type -

The role mapping type. Token will use cognito:roles and cognito:preferred_role claims from the Cognito identity provider token to map groups to roles. Rules will attempt to match claims from the token to map to a role.

See Also:

RoleMappingType

withType

public RoleMapping withType(RoleMappingType type)

The role mapping type. Token will use cognito:roles and cognito:preferred_role claims from the Cognito identity provider token to map groups to roles. Rules will attempt to match claims from the token to map to a role.

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

Constraints:
Allowed Values: Token, Rules

Parameters:

type -

The role mapping type. Token will use cognito:roles and cognito:preferred_role claims from the Cognito identity provider token to map groups to roles. Rules will attempt to match claims from the token to map to a role.

Returns:

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

See Also:

RoleMappingType

getAmbiguousRoleResolution

public java.lang.String getAmbiguousRoleResolution()

If you specify Token or Rules as the Type, AmbiguousRoleResolution is required.

Specifies the action to be taken if either no rules match the claim value for the Rules type, or there is no cognito:preferred_role claim and there are multiple cognito:roles matches for the Token type.

Constraints:
Allowed Values: AuthenticatedRole, Deny

Returns:

If you specify Token or Rules as the Type, AmbiguousRoleResolution is required.

Specifies the action to be taken if either no rules match the claim value for the Rules type, or there is no cognito:preferred_role claim and there are multiple cognito:roles matches for the Token type.

See Also:

AmbiguousRoleResolutionType

setAmbiguousRoleResolution

public void setAmbiguousRoleResolution(java.lang.String ambiguousRoleResolution)

If you specify Token or Rules as the Type, AmbiguousRoleResolution is required.

Specifies the action to be taken if either no rules match the claim value for the Rules type, or there is no cognito:preferred_role claim and there are multiple cognito:roles matches for the Token type.

Constraints:
Allowed Values: AuthenticatedRole, Deny

Parameters:

ambiguousRoleResolution -

If you specify Token or Rules as the Type, AmbiguousRoleResolution is required.

Specifies the action to be taken if either no rules match the claim value for the Rules type, or there is no cognito:preferred_role claim and there are multiple cognito:roles matches for the Token type.

See Also:

AmbiguousRoleResolutionType

withAmbiguousRoleResolution

public RoleMapping withAmbiguousRoleResolution(java.lang.String ambiguousRoleResolution)

If you specify Token or Rules as the Type, AmbiguousRoleResolution is required.

Specifies the action to be taken if either no rules match the claim value for the Rules type, or there is no cognito:preferred_role claim and there are multiple cognito:roles matches for the Token type.

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

Constraints:
Allowed Values: AuthenticatedRole, Deny

Parameters:

ambiguousRoleResolution -

If you specify Token or Rules as the Type, AmbiguousRoleResolution is required.

Specifies the action to be taken if either no rules match the claim value for the Rules type, or there is no cognito:preferred_role claim and there are multiple cognito:roles matches for the Token type.

Returns:

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

See Also:

AmbiguousRoleResolutionType

setAmbiguousRoleResolution

public void setAmbiguousRoleResolution(AmbiguousRoleResolutionType ambiguousRoleResolution)

If you specify Token or Rules as the Type, AmbiguousRoleResolution is required.

Specifies the action to be taken if either no rules match the claim value for the Rules type, or there is no cognito:preferred_role claim and there are multiple cognito:roles matches for the Token type.

Constraints:
Allowed Values: AuthenticatedRole, Deny

Parameters:

ambiguousRoleResolution -

If you specify Token or Rules as the Type, AmbiguousRoleResolution is required.

Specifies the action to be taken if either no rules match the claim value for the Rules type, or there is no cognito:preferred_role claim and there are multiple cognito:roles matches for the Token type.

See Also:

AmbiguousRoleResolutionType

withAmbiguousRoleResolution

public RoleMapping withAmbiguousRoleResolution(AmbiguousRoleResolutionType ambiguousRoleResolution)

If you specify Token or Rules as the Type, AmbiguousRoleResolution is required.

Specifies the action to be taken if either no rules match the claim value for the Rules type, or there is no cognito:preferred_role claim and there are multiple cognito:roles matches for the Token type.

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

Constraints:
Allowed Values: AuthenticatedRole, Deny

Parameters:

ambiguousRoleResolution -

If you specify Token or Rules as the Type, AmbiguousRoleResolution is required.

Specifies the action to be taken if either no rules match the claim value for the Rules type, or there is no cognito:preferred_role claim and there are multiple cognito:roles matches for the Token type.

Returns:

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

See Also:

AmbiguousRoleResolutionType

getRulesConfiguration

public RulesConfigurationType getRulesConfiguration()

The rules to be used for mapping users to roles.

If you specify Rules as the role mapping type, RulesConfiguration is required.

Returns:

The rules to be used for mapping users to roles.

If you specify Rules as the role mapping type, RulesConfiguration is required.

setRulesConfiguration

public void setRulesConfiguration(RulesConfigurationType rulesConfiguration)

The rules to be used for mapping users to roles.

If you specify Rules as the role mapping type, RulesConfiguration is required.

Parameters:

rulesConfiguration -

The rules to be used for mapping users to roles.

If you specify Rules as the role mapping type, RulesConfiguration is required.

withRulesConfiguration

public RoleMapping withRulesConfiguration(RulesConfigurationType rulesConfiguration)

The rules to be used for mapping users to roles.

If you specify Rules as the role mapping type, RulesConfiguration is required.

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

Parameters:

rulesConfiguration -

The rules to be used for mapping users to roles.

If you specify Rules as the role mapping type, RulesConfiguration is required.

Returns:

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

toString

public java.lang.String toString()

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

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object