software.amazon.awscdk.services.cognito.identitypool

Interface RoleMappingRule

All Known Implementing Classes:

RoleMappingRule.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:48.081Z")
public interface RoleMappingRule

(experimental) Represents an Identity Pool Role Attachment Role Mapping Rule.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.cognito.identitypool.*;
 import software.amazon.awscdk.services.iam.*;
 Role role;
 RoleMappingRule roleMappingRule = RoleMappingRule.builder()
         .claim("claim")
         .claimValue("claimValue")
         .mappedRole(role)
         // the properties below are optional
         .matchType(RoleMappingMatchType.EQUALS)
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static RoleMappingRule.Builder	builder()
java.lang.String	getClaim() (experimental) The key sent in the token by the federated identity provider.
java.lang.String	getClaimValue() (experimental) The value of the claim that must be matched.
IRole	getMappedRole() (experimental) The Role to be assumed when Claim Value is matched.
default RoleMappingMatchType	getMatchType() (experimental) How to match with the Claim value.

Method Detail

getClaim

java.lang.String getClaim()

(experimental) The key sent in the token by the federated identity provider.

getClaimValue

java.lang.String getClaimValue()

(experimental) The value of the claim that must be matched.

getMappedRole

IRole getMappedRole()

(experimental) The Role to be assumed when Claim Value is matched.

getMatchType

default RoleMappingMatchType getMatchType()

(experimental) How to match with the Claim value.

Default: RoleMappingMatchType.EQUALS

builder

static RoleMappingRule.Builder builder()

Returns:

a RoleMappingRule.Builder of RoleMappingRule