Package software.amazon.awscdk.services.cognito

Class CfnIdentityPoolRoleAttachment.RoleMappingProperty.Builder

java.lang.Object

software.amazon.awscdk.services.cognito.CfnIdentityPoolRoleAttachment.RoleMappingProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnIdentityPoolRoleAttachment.RoleMappingProperty>

Enclosing interface:

CfnIdentityPoolRoleAttachment.RoleMappingProperty

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

A builder for CfnIdentityPoolRoleAttachment.RoleMappingProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnIdentityPoolRoleAttachment.RoleMappingProperty.Builder	ambiguousRoleResolution(String ambiguousRoleResolution)	Sets the value of CfnIdentityPoolRoleAttachment.RoleMappingProperty.getAmbiguousRoleResolution()
CfnIdentityPoolRoleAttachment.RoleMappingProperty	build()	Builds the configured instance.
CfnIdentityPoolRoleAttachment.RoleMappingProperty.Builder	identityProvider(String identityProvider)	Sets the value of CfnIdentityPoolRoleAttachment.RoleMappingProperty.getIdentityProvider()
CfnIdentityPoolRoleAttachment.RoleMappingProperty.Builder	rulesConfiguration(IResolvable rulesConfiguration)	Sets the value of CfnIdentityPoolRoleAttachment.RoleMappingProperty.getRulesConfiguration()
CfnIdentityPoolRoleAttachment.RoleMappingProperty.Builder	rulesConfiguration(CfnIdentityPoolRoleAttachment.RulesConfigurationTypeProperty rulesConfiguration)	Sets the value of CfnIdentityPoolRoleAttachment.RoleMappingProperty.getRulesConfiguration()
CfnIdentityPoolRoleAttachment.RoleMappingProperty.Builder	type(String type)	Sets the value of CfnIdentityPoolRoleAttachment.RoleMappingProperty.getType()

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

type

@Stability(Stable)
public CfnIdentityPoolRoleAttachment.RoleMappingProperty.Builder type(String type)

Sets the value of CfnIdentityPoolRoleAttachment.RoleMappingProperty.getType()

Parameters:

type - The role-mapping type. This parameter is required. Token uses cognito:roles and cognito:preferred_role claims from the Amazon Cognito identity provider token to map groups to roles. Rules attempts to match claims from the token to map to a role.

Valid values are Token or Rules .

Returns:

this

ambiguousRoleResolution

@Stability(Stable)
public CfnIdentityPoolRoleAttachment.RoleMappingProperty.Builder ambiguousRoleResolution(String ambiguousRoleResolution)

Sets the value of CfnIdentityPoolRoleAttachment.RoleMappingProperty.getAmbiguousRoleResolution()

Parameters:

ambiguousRoleResolution - Specifies the action to be taken if either no rules match the claim value for the Rules type, or there is no cognito:preferred_role claim and there are multiple cognito:roles matches for the Token type. If you specify Token or Rules as the Type, AmbiguousRoleResolution is required.

Valid values are AuthenticatedRole or Deny .

Returns:

this

identityProvider

@Stability(Stable)
public CfnIdentityPoolRoleAttachment.RoleMappingProperty.Builder identityProvider(String identityProvider)

Sets the value of CfnIdentityPoolRoleAttachment.RoleMappingProperty.getIdentityProvider()

Parameters:

identityProvider - Identifier for the identity provider for which the role is mapped. For example: graph.facebook.com or cognito-idp.us-east-1.amazonaws.com/us-east-1_abcdefghi:app_client_id (http://cognito-idp.us-east-1.amazonaws.com/us-east-1_abcdefghi:app_client_id) . This is the identity provider that is used by the user for authentication.

If the identity provider property isn't provided, the key of the entry in the RoleMappings map is used as the identity provider.

Returns:

this

rulesConfiguration

@Stability(Stable)
public CfnIdentityPoolRoleAttachment.RoleMappingProperty.Builder rulesConfiguration(IResolvable rulesConfiguration)

Sets the value of CfnIdentityPoolRoleAttachment.RoleMappingProperty.getRulesConfiguration()

Parameters:

rulesConfiguration - The rules to be used for mapping users to roles. If you specify "Rules" as the role-mapping type, RulesConfiguration is required.

Returns:

this

rulesConfiguration

@Stability(Stable)
public CfnIdentityPoolRoleAttachment.RoleMappingProperty.Builder rulesConfiguration(CfnIdentityPoolRoleAttachment.RulesConfigurationTypeProperty rulesConfiguration)

Sets the value of CfnIdentityPoolRoleAttachment.RoleMappingProperty.getRulesConfiguration()

Parameters:

rulesConfiguration - The rules to be used for mapping users to roles. If you specify "Rules" as the role-mapping type, RulesConfiguration is required.

Returns:

this

build

@Stability(Stable)
public CfnIdentityPoolRoleAttachment.RoleMappingProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnIdentityPoolRoleAttachment.RoleMappingProperty>

Returns:

a new instance of CfnIdentityPoolRoleAttachment.RoleMappingProperty

Throws:

NullPointerException - if any required attribute was not provided