Package software.amazon.awscdk.services.cognito

Class UserPoolIdentityProviderAmazon.Builder

java.lang.Object

software.amazon.awscdk.services.cognito.UserPoolIdentityProviderAmazon.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<UserPoolIdentityProviderAmazon>

Enclosing class:

UserPoolIdentityProviderAmazon

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

A fluent builder for UserPoolIdentityProviderAmazon.

Method Summary

Modifier and Type	Method	Description
UserPoolIdentityProviderAmazon.Builder	attributeMapping(AttributeMapping attributeMapping)	Mapping attributes from the identity provider to standard and custom attributes of the user pool.
UserPoolIdentityProviderAmazon	build()
UserPoolIdentityProviderAmazon.Builder	clientId(String clientId)	The client id recognized by Login with Amazon APIs.
UserPoolIdentityProviderAmazon.Builder	clientSecret(String clientSecret)	The client secret to be accompanied with clientId for Login with Amazon APIs to authenticate the client.
static UserPoolIdentityProviderAmazon.Builder	create(software.constructs.Construct scope, String id)
UserPoolIdentityProviderAmazon.Builder	scopes(List<String> scopes)	The types of user profile data to obtain for the Amazon profile.
UserPoolIdentityProviderAmazon.Builder	userPool(IUserPool userPool)	The user pool to which this construct provides identities.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static UserPoolIdentityProviderAmazon.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of UserPoolIdentityProviderAmazon.Builder.

userPool

@Stability(Stable)
public UserPoolIdentityProviderAmazon.Builder userPool(IUserPool userPool)

The user pool to which this construct provides identities.

Parameters:

userPool - The user pool to which this construct provides identities. This parameter is required.

Returns:

this

attributeMapping

@Stability(Stable)
public UserPoolIdentityProviderAmazon.Builder attributeMapping(AttributeMapping attributeMapping)

Mapping attributes from the identity provider to standard and custom attributes of the user pool.

Default: - no attribute mapping

Parameters:

attributeMapping - Mapping attributes from the identity provider to standard and custom attributes of the user pool. This parameter is required.

Returns:

this

clientId

@Stability(Stable)
public UserPoolIdentityProviderAmazon.Builder clientId(String clientId)

The client id recognized by Login with Amazon APIs.

Parameters:

clientId - The client id recognized by Login with Amazon APIs. This parameter is required.

Returns:

this

See Also:

• https://developer.amazon.com/docs/login-with-amazon/security-profile.html#client-identifier

clientSecret

@Stability(Stable)
public UserPoolIdentityProviderAmazon.Builder clientSecret(String clientSecret)

The client secret to be accompanied with clientId for Login with Amazon APIs to authenticate the client.

Parameters:

clientSecret - The client secret to be accompanied with clientId for Login with Amazon APIs to authenticate the client. This parameter is required.

Returns:

this

See Also:

• https://developer.amazon.com/docs/login-with-amazon/security-profile.html#client-identifier

scopes

@Stability(Stable)
public UserPoolIdentityProviderAmazon.Builder scopes(List<String> scopes)

The types of user profile data to obtain for the Amazon profile.

Default: [ profile ]

Parameters:

scopes - The types of user profile data to obtain for the Amazon profile. This parameter is required.

Returns:

this

See Also:

• https://developer.amazon.com/docs/login-with-amazon/customer-profile.html

build

@Stability(Stable)
public UserPoolIdentityProviderAmazon build()

Specified by:

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

Returns:

a newly built instance of UserPoolIdentityProviderAmazon.