Interface RoleMapping.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<RoleMapping.Builder,
,RoleMapping> SdkBuilder<RoleMapping.Builder,
,RoleMapping> SdkPojo
- Enclosing class:
RoleMapping
-
Method Summary
Modifier and TypeMethodDescriptionambiguousRoleResolution
(String ambiguousRoleResolution) If you specify Token or Rules as theType
,AmbiguousRoleResolution
is required.ambiguousRoleResolution
(AmbiguousRoleResolutionType ambiguousRoleResolution) If you specify Token or Rules as theType
,AmbiguousRoleResolution
is required.default RoleMapping.Builder
rulesConfiguration
(Consumer<RulesConfigurationType.Builder> rulesConfiguration) The rules to be used for mapping users to roles.rulesConfiguration
(RulesConfigurationType rulesConfiguration) The rules to be used for mapping users to roles.The role mapping type.type
(RoleMappingType type) The role mapping type.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
type
The role mapping type. Token will use
cognito:roles
andcognito: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 usecognito:roles
andcognito: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:
-
type
The role mapping type. Token will use
cognito:roles
andcognito: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 usecognito:roles
andcognito: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:
-
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 nocognito:preferred_role
claim and there are multiplecognito:roles
matches for theToken
type.- Parameters:
ambiguousRoleResolution
- If you specify Token or Rules as theType
,AmbiguousRoleResolution
is required.Specifies the action to be taken if either no rules match the claim value for the
Rules
type, or there is nocognito:preferred_role
claim and there are multiplecognito:roles
matches for theToken
type.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 nocognito:preferred_role
claim and there are multiplecognito:roles
matches for theToken
type.- Parameters:
ambiguousRoleResolution
- If you specify Token or Rules as theType
,AmbiguousRoleResolution
is required.Specifies the action to be taken if either no rules match the claim value for the
Rules
type, or there is nocognito:preferred_role
claim and there are multiplecognito:roles
matches for theToken
type.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
-
rulesConfiguration
default RoleMapping.Builder rulesConfiguration(Consumer<RulesConfigurationType.Builder> rulesConfiguration) The rules to be used for mapping users to roles.
If you specify Rules as the role mapping type,
This is a convenience method that creates an instance of theRulesConfiguration
is required.RulesConfigurationType.Builder
avoiding the need to create one manually viaRulesConfigurationType.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed torulesConfiguration(RulesConfigurationType)
.- Parameters:
rulesConfiguration
- a consumer that will call methods onRulesConfigurationType.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-