RoleMapping (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.cognitoidentity.model.RoleMapping

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class RoleMapping
extends Object
implements Serializable, Cloneable, StructuredPojo

A role mapping.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

RoleMapping()

Constructors
Constructor and Description
`RoleMapping()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`RoleMapping`	`clone()`
`boolean`	`equals(Object obj)`
`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.
`String`	`getType()` The role mapping type.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAmbiguousRoleResolution(AmbiguousRoleResolutionType ambiguousRoleResolution)` If you specify Token or Rules as the `Type`, `AmbiguousRoleResolution` is required.
`void`	`setAmbiguousRoleResolution(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(String type)` The role mapping type.
`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(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(String type)` The role mapping type.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - RoleMapping
```
public RoleMapping()
```
- Method Detail
  - setType
```
public void setType(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.
    
    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
  - getType
```
public 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.
    
    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
  - withType
```
public RoleMapping withType(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.
    
    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:
    
    Returns a reference to this 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.
    
    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.
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    RoleMappingType
  - setAmbiguousRoleResolution
```
public void setAmbiguousRoleResolution(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.
    
    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
  - getAmbiguousRoleResolution
```
public 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.
    
    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
  - withAmbiguousRoleResolution
```
public RoleMapping withAmbiguousRoleResolution(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.
    
    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:
    
    Returns a reference to this 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.
    
    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.
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AmbiguousRoleResolutionType
  - 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.
  - 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.
  - 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.
    
    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:
    
    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()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public RoleMapping clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class RoleMapping

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RoleMapping

Method Detail

setType

getType

withType

setType

withType

setAmbiguousRoleResolution

getAmbiguousRoleResolution

withAmbiguousRoleResolution

setAmbiguousRoleResolution

withAmbiguousRoleResolution

setRulesConfiguration

getRulesConfiguration

withRulesConfiguration

toString

equals

hashCode

clone

marshall