software.amazon.awscdk.services.cognito.identitypool

Class RoleMappingRule.Builder

java.lang.Object

software.amazon.awscdk.services.cognito.identitypool.RoleMappingRule.Builder

Enclosing interface:

RoleMappingRule

public static final class RoleMappingRule.Builder
extends java.lang.Object

A builder for RoleMappingRule

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
RoleMappingRule	build() Builds the configured instance.
RoleMappingRule.Builder	claim(java.lang.String claim) Sets the value of RoleMappingRule.getClaim()
RoleMappingRule.Builder	claimValue(java.lang.String claimValue) Sets the value of RoleMappingRule.getClaimValue()
RoleMappingRule.Builder	mappedRole(IRole mappedRole) Sets the value of RoleMappingRule.getMappedRole()
RoleMappingRule.Builder	matchType(RoleMappingMatchType matchType) Sets the value of RoleMappingRule.getMatchType()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

claim

public RoleMappingRule.Builder claim(java.lang.String claim)

Sets the value of RoleMappingRule.getClaim()

Parameters:

claim - The key sent in the token by the federated identity provider. This parameter is required.

Returns:

this

claimValue

public RoleMappingRule.Builder claimValue(java.lang.String claimValue)

Sets the value of RoleMappingRule.getClaimValue()

Parameters:

claimValue - The value of the claim that must be matched. This parameter is required.

Returns:

this

mappedRole

public RoleMappingRule.Builder mappedRole(IRole mappedRole)

Sets the value of RoleMappingRule.getMappedRole()

Parameters:

mappedRole - The Role to be assumed when Claim Value is matched. This parameter is required.

Returns:

this

matchType

public RoleMappingRule.Builder matchType(RoleMappingMatchType matchType)

Sets the value of RoleMappingRule.getMatchType()

Parameters:

matchType - How to match with the Claim value.

Returns:

this

build

public RoleMappingRule build()

Builds the configured instance.

Returns:

a new instance of RoleMappingRule

Throws:

java.lang.NullPointerException - if any required attribute was not provided