software.amazon.awscdk.services.cognito.identitypool

Interface IdentityPoolRoleMapping

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

IdentityPoolRoleMapping.Jsii$Proxy

@Generated(value="jsii-pacmak/1.70.0 (build 03c2f6f)",
           date="2022-11-01T13:16:45.324Z")
 @Stability(value=Experimental)
public interface IdentityPoolRoleMapping
extends software.amazon.jsii.JsiiSerializable

(experimental) Map roles to users in the identity pool based on claims from the Identity Provider.

Example:

 import software.amazon.awscdk.services.cognito.identitypool.IdentityPoolRoleMapping;
 IdentityPool identityPool;
 IdentityPoolRoleMapping myAddedRoleMapping1;
 IdentityPoolRoleMapping myAddedRoleMapping2;
 IdentityPoolRoleMapping myAddedRoleMapping3;
 identityPool.addRoleMappings(myAddedRoleMapping1, myAddedRoleMapping2, myAddedRoleMapping3);
 

See Also:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-identitypoolroleattachment.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IdentityPoolRoleMapping.Builder A builder for IdentityPoolRoleMapping
static class	IdentityPoolRoleMapping.Jsii$Proxy An implementation for IdentityPoolRoleMapping

Method Summary

Modifier and Type	Method and Description
static IdentityPoolRoleMapping.Builder	builder()
IdentityPoolProviderUrl	getProviderUrl() (experimental) The url of the provider of for which the role is mapped.
default Boolean	getResolveAmbiguousRoles() (experimental) Allow for role assumption when results of role mapping are ambiguous.
default List<RoleMappingRule>	getRules() (experimental) The claim and value that must be matched in order to assume the role.
default Boolean	getUseToken() (experimental) If true then mapped roles must be passed through the cognito:roles or cognito:preferred_role claims from identity provider.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getProviderUrl

@Stability(value=Experimental)
 @NotNull
IdentityPoolProviderUrl getProviderUrl()

(experimental) The url of the provider of for which the role is mapped.

getResolveAmbiguousRoles

@Stability(value=Experimental)
 @Nullable
default Boolean getResolveAmbiguousRoles()

(experimental) Allow for role assumption when results of role mapping are ambiguous.

Default: false - Ambiguous role resolutions will lead to requester being denied

getRules

@Stability(value=Experimental)
 @Nullable
default List<RoleMappingRule> getRules()

(experimental) The claim and value that must be matched in order to assume the role.

Required if useToken is false

Default: - No Rule Mapping Rule

getUseToken

@Stability(value=Experimental)
 @Nullable
default Boolean getUseToken()

(experimental) If true then mapped roles must be passed through the cognito:roles or cognito:preferred_role claims from identity provider.

Default: false

See Also:

https://docs.aws.amazon.com/cognito/latest/developerguide/role-based-access-control.html#using-tokens-to-assign-roles-to-users

builder

@Stability(value=Experimental)
static IdentityPoolRoleMapping.Builder builder()

Returns:

a IdentityPoolRoleMapping.Builder of IdentityPoolRoleMapping