Package software.amazon.awscdk.services.cognito.identitypool.alpha

Class RoleMappingRule.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<RoleMappingRule>

Enclosing interface:

RoleMappingRule

@Stability(Experimental)
public static final class RoleMappingRule.Builder
extends Object
implements software.amazon.jsii.Builder<RoleMappingRule>

A builder for RoleMappingRule

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
RoleMappingRule	build()	Builds the configured instance.
RoleMappingRule.Builder	claim(String claim)	Sets the value of RoleMappingRule.getClaim()
RoleMappingRule.Builder	claimValue(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 Details

Builder

public Builder()

Method Details

claim

@Stability(Experimental)
public RoleMappingRule.Builder claim(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

@Stability(Experimental)
public RoleMappingRule.Builder claimValue(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

@Stability(Experimental)
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

@Stability(Experimental)
public RoleMappingRule.Builder matchType(RoleMappingMatchType matchType)

Sets the value of RoleMappingRule.getMatchType()

Parameters:

matchType - How to match with the Claim value.

Returns:

this

build

@Stability(Experimental)
public RoleMappingRule build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<RoleMappingRule>

Returns:

a new instance of RoleMappingRule

Throws:

NullPointerException - if any required attribute was not provided