software.amazon.awssdk.services.cognitoidentity.model

Class RoleMapping

java.lang.Object

software.amazon.awssdk.services.cognitoidentity.model.RoleMapping

All Implemented Interfaces:

StructuredPojo, ToCopyableBuilder<RoleMapping.Builder,RoleMapping>

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

A role mapping.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	RoleMapping.Builder

Method Summary

Modifier and Type	Method and Description
AmbiguousRoleResolutionType	ambiguousRoleResolution() If you specify Token or Rules as the Type, AmbiguousRoleResolution is required.
String	ambiguousRoleResolutionAsString() If you specify Token or Rules as the Type, AmbiguousRoleResolution is required.
static RoleMapping.Builder	builder()
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
RulesConfigurationType	rulesConfiguration() The rules to be used for mapping users to roles.
static Class<? extends RoleMapping.Builder>	serializableBuilderClass()
RoleMapping.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
RoleMappingType	type() The role mapping type.
String	typeAsString() The role mapping type.

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

type

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

If the service returns an enum value that is not available in the current SDK version, type will return RoleMappingType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

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

typeAsString

public String typeAsString()

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.

If the service returns an enum value that is not available in the current SDK version, type will return RoleMappingType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

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

ambiguousRoleResolution

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

If the service returns an enum value that is not available in the current SDK version, ambiguousRoleResolution will return AmbiguousRoleResolutionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from ambiguousRoleResolutionAsString().

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

ambiguousRoleResolutionAsString

public String ambiguousRoleResolutionAsString()

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.

If the service returns an enum value that is not available in the current SDK version, ambiguousRoleResolution will return AmbiguousRoleResolutionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from ambiguousRoleResolutionAsString().

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

rulesConfiguration

public 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:

The rules to be used for mapping users to roles.

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

toBuilder

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

Returns:

a builder for type T

builder

public static RoleMapping.Builder builder()

serializableBuilderClass

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

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.