Package software.amazon.awscdk.services.cognito

Class UserPoolIdentityProviderOidcProps.Builder

java.lang.Object

software.amazon.awscdk.services.cognito.UserPoolIdentityProviderOidcProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<UserPoolIdentityProviderOidcProps>

Enclosing interface:

UserPoolIdentityProviderOidcProps

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

A builder for UserPoolIdentityProviderOidcProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
UserPoolIdentityProviderOidcProps.Builder	attributeMapping(AttributeMapping attributeMapping)	Sets the value of UserPoolIdentityProviderProps.getAttributeMapping()
UserPoolIdentityProviderOidcProps.Builder	attributeRequestMethod(OidcAttributeRequestMethod attributeRequestMethod)	Sets the value of UserPoolIdentityProviderOidcProps.getAttributeRequestMethod()
UserPoolIdentityProviderOidcProps	build()	Builds the configured instance.
UserPoolIdentityProviderOidcProps.Builder	clientId(String clientId)	Sets the value of UserPoolIdentityProviderOidcProps.getClientId()
UserPoolIdentityProviderOidcProps.Builder	clientSecret(String clientSecret)	Sets the value of UserPoolIdentityProviderOidcProps.getClientSecret()
UserPoolIdentityProviderOidcProps.Builder	endpoints(OidcEndpoints endpoints)	Sets the value of UserPoolIdentityProviderOidcProps.getEndpoints()
UserPoolIdentityProviderOidcProps.Builder	identifiers(List<String> identifiers)	Sets the value of UserPoolIdentityProviderOidcProps.getIdentifiers()
UserPoolIdentityProviderOidcProps.Builder	issuerUrl(String issuerUrl)	Sets the value of UserPoolIdentityProviderOidcProps.getIssuerUrl()
UserPoolIdentityProviderOidcProps.Builder	name(String name)	Sets the value of UserPoolIdentityProviderOidcProps.getName()
UserPoolIdentityProviderOidcProps.Builder	scopes(List<String> scopes)	Sets the value of UserPoolIdentityProviderOidcProps.getScopes()
UserPoolIdentityProviderOidcProps.Builder	userPool(IUserPool userPool)	Sets the value of UserPoolIdentityProviderProps.getUserPool()

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

clientId

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

Sets the value of UserPoolIdentityProviderOidcProps.getClientId()

Parameters:

clientId - The client id. This parameter is required.

Returns:

this

clientSecret

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

Sets the value of UserPoolIdentityProviderOidcProps.getClientSecret()

Parameters:

clientSecret - The client secret. This parameter is required.

Returns:

this

issuerUrl

@Stability(Stable)
public UserPoolIdentityProviderOidcProps.Builder issuerUrl(String issuerUrl)

Sets the value of UserPoolIdentityProviderOidcProps.getIssuerUrl()

Parameters:

issuerUrl - Issuer URL. This parameter is required.

Returns:

this

attributeRequestMethod

@Stability(Stable)
public UserPoolIdentityProviderOidcProps.Builder attributeRequestMethod(OidcAttributeRequestMethod attributeRequestMethod)

Sets the value of UserPoolIdentityProviderOidcProps.getAttributeRequestMethod()

Parameters:

attributeRequestMethod - The method to use to request attributes.

Returns:

this

endpoints

@Stability(Stable)
public UserPoolIdentityProviderOidcProps.Builder endpoints(OidcEndpoints endpoints)

Sets the value of UserPoolIdentityProviderOidcProps.getEndpoints()

Parameters:

endpoints - OpenID connect endpoints.

Returns:

this

identifiers

@Stability(Stable)
public UserPoolIdentityProviderOidcProps.Builder identifiers(List<String> identifiers)

Sets the value of UserPoolIdentityProviderOidcProps.getIdentifiers()

Parameters:

identifiers - Identifiers. Identifiers can be used to redirect users to the correct IdP in multitenant apps.

Returns:

this

name

@Stability(Stable)
public UserPoolIdentityProviderOidcProps.Builder name(String name)

Sets the value of UserPoolIdentityProviderOidcProps.getName()

Parameters:

name - The name of the provider.

Returns:

this

scopes

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

Sets the value of UserPoolIdentityProviderOidcProps.getScopes()

Parameters:

scopes - The OAuth 2.0 scopes that you will request from OpenID Connect. Scopes are groups of OpenID Connect user attributes to exchange with your app.

Returns:

this

userPool

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

Sets the value of UserPoolIdentityProviderProps.getUserPool()

Parameters:

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

Returns:

this

attributeMapping

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

Sets the value of UserPoolIdentityProviderProps.getAttributeMapping()

Parameters:

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

Returns:

this

build

@Stability(Stable)
public UserPoolIdentityProviderOidcProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of UserPoolIdentityProviderOidcProps

Throws:

NullPointerException - if any required attribute was not provided