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

Class IdentityPoolRoleMapping.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<IdentityPoolRoleMapping>

Enclosing interface:

IdentityPoolRoleMapping

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

A builder for IdentityPoolRoleMapping

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
IdentityPoolRoleMapping	build()	Builds the configured instance.
IdentityPoolRoleMapping.Builder	mappingKey(String mappingKey)	Sets the value of IdentityPoolRoleMapping.getMappingKey()
IdentityPoolRoleMapping.Builder	providerUrl(IdentityPoolProviderUrl providerUrl)	Sets the value of IdentityPoolRoleMapping.getProviderUrl()
IdentityPoolRoleMapping.Builder	resolveAmbiguousRoles(Boolean resolveAmbiguousRoles)	Sets the value of IdentityPoolRoleMapping.getResolveAmbiguousRoles()
IdentityPoolRoleMapping.Builder	rules(List<? extends RoleMappingRule> rules)	Sets the value of IdentityPoolRoleMapping.getRules()
IdentityPoolRoleMapping.Builder	useToken(Boolean useToken)	Sets the value of IdentityPoolRoleMapping.getUseToken()

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

providerUrl

@Stability(Stable)
public IdentityPoolRoleMapping.Builder providerUrl(IdentityPoolProviderUrl providerUrl)

Sets the value of IdentityPoolRoleMapping.getProviderUrl()

Parameters:

providerUrl - The url of the Provider for which the role is mapped. This parameter is required.

Returns:

this

mappingKey

@Stability(Stable)
public IdentityPoolRoleMapping.Builder mappingKey(String mappingKey)

Sets the value of IdentityPoolRoleMapping.getMappingKey()

Parameters:

mappingKey - The key used for the role mapping in the role mapping hash. Required if the providerUrl is a token.

Returns:

this

resolveAmbiguousRoles

@Stability(Stable)
public IdentityPoolRoleMapping.Builder resolveAmbiguousRoles(Boolean resolveAmbiguousRoles)

Sets the value of IdentityPoolRoleMapping.getResolveAmbiguousRoles()

Parameters:

resolveAmbiguousRoles - Allow for role assumption when results of role mapping are ambiguous.

Returns:

this

rules

@Stability(Stable)
public IdentityPoolRoleMapping.Builder rules(List<? extends RoleMappingRule> rules)

Sets the value of IdentityPoolRoleMapping.getRules()

Parameters:

rules - The claim and value that must be matched in order to assume the role. Required if useToken is false

Returns:

this

useToken

@Stability(Stable)
public IdentityPoolRoleMapping.Builder useToken(Boolean useToken)

Sets the value of IdentityPoolRoleMapping.getUseToken()

Parameters:

useToken - If true then mapped roles must be passed through the cognito:roles or cognito:preferred_role claims from Identity Provider.

Returns:

this

build

@Stability(Stable)
public IdentityPoolRoleMapping build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of IdentityPoolRoleMapping

Throws:

NullPointerException - if any required attribute was not provided