@Generated(value="software.amazon.awssdk:codegen") public final class RoleMapping extends Object implements StructuredPojo, ToCopyableBuilder<RoleMapping.Builder,RoleMapping>
A role mapping.
Modifier and Type | Class and Description |
---|---|
static interface |
RoleMapping.Builder |
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.
|
copy
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()
.
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.RoleMappingType
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()
.
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.RoleMappingType
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()
.
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.
AmbiguousRoleResolutionType
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()
.
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.
AmbiguousRoleResolutionType
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.
If you specify Rules as the role mapping type, RulesConfiguration
is required.
public RoleMapping.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<RoleMapping.Builder,RoleMapping>
public static RoleMapping.Builder builder()
public static Class<? extends RoleMapping.Builder> serializableBuilderClass()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.