Package software.amazon.awscdk.services.cognito

Class CfnUserPoolIdentityProviderProps.Builder

java.lang.Object

software.amazon.awscdk.services.cognito.CfnUserPoolIdentityProviderProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnUserPoolIdentityProviderProps>

Enclosing interface:

CfnUserPoolIdentityProviderProps

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

A builder for CfnUserPoolIdentityProviderProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnUserPoolIdentityProviderProps.Builder	attributeMapping(Object attributeMapping)	Sets the value of CfnUserPoolIdentityProviderProps.getAttributeMapping()
CfnUserPoolIdentityProviderProps	build()	Builds the configured instance.
CfnUserPoolIdentityProviderProps.Builder	idpIdentifiers(List<String> idpIdentifiers)	Sets the value of CfnUserPoolIdentityProviderProps.getIdpIdentifiers()
CfnUserPoolIdentityProviderProps.Builder	providerDetails(Object providerDetails)	Sets the value of CfnUserPoolIdentityProviderProps.getProviderDetails()
CfnUserPoolIdentityProviderProps.Builder	providerName(String providerName)	Sets the value of CfnUserPoolIdentityProviderProps.getProviderName()
CfnUserPoolIdentityProviderProps.Builder	providerType(String providerType)	Sets the value of CfnUserPoolIdentityProviderProps.getProviderType()
CfnUserPoolIdentityProviderProps.Builder	userPoolId(String userPoolId)	Sets the value of CfnUserPoolIdentityProviderProps.getUserPoolId()

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

providerName

@Stability(Stable)
public CfnUserPoolIdentityProviderProps.Builder providerName(String providerName)

Sets the value of CfnUserPoolIdentityProviderProps.getProviderName()

Parameters:

providerName - The IdP name. This parameter is required.

Returns:

this

providerType

@Stability(Stable)
public CfnUserPoolIdentityProviderProps.Builder providerType(String providerType)

Sets the value of CfnUserPoolIdentityProviderProps.getProviderType()

Parameters:

providerType - The IdP type. This parameter is required.

Returns:

this

userPoolId

@Stability(Stable)
public CfnUserPoolIdentityProviderProps.Builder userPoolId(String userPoolId)

Sets the value of CfnUserPoolIdentityProviderProps.getUserPoolId()

Parameters:

userPoolId - The user pool ID. This parameter is required.

Returns:

this

attributeMapping

@Stability(Stable)
public CfnUserPoolIdentityProviderProps.Builder attributeMapping(Object attributeMapping)

Sets the value of CfnUserPoolIdentityProviderProps.getAttributeMapping()

Parameters:

attributeMapping - A mapping of IdP attributes to standard and custom user pool attributes.

Returns:

this

idpIdentifiers

@Stability(Stable)
public CfnUserPoolIdentityProviderProps.Builder idpIdentifiers(List<String> idpIdentifiers)

Sets the value of CfnUserPoolIdentityProviderProps.getIdpIdentifiers()

Parameters:

idpIdentifiers - A list of IdP identifiers.

Returns:

this

providerDetails

@Stability(Stable)
public CfnUserPoolIdentityProviderProps.Builder providerDetails(Object providerDetails)

Sets the value of CfnUserPoolIdentityProviderProps.getProviderDetails()

Parameters:

providerDetails - The IdP details. The following list describes the provider detail keys for each IdP type.

• For Google and Login with Amazon:
• client_id
• client_secret
• authorize_scopes
• For Facebook:
• client_id
• client_secret
• authorize_scopes
• api_version
• For Sign in with Apple:
• client_id
• team_id
• key_id
• private_key
• authorize_scopes
• For OpenID Connect (OIDC) providers:
• client_id
• client_secret
• attributes_request_method
• oidc_issuer
• authorize_scopes
• The following keys are only present if Amazon Cognito didn't discover them at the oidc_issuer URL.
• authorize_url
• token_url
• attributes_url
• jwks_uri
• Amazon Cognito sets the value of the following keys automatically. They are read-only.
• attributes_url_add_attributes
• For SAML providers:
• MetadataFile or MetadataURL
• IDPSignout optional

Returns:

this

build

@Stability(Stable)
public CfnUserPoolIdentityProviderProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnUserPoolIdentityProviderProps

Throws:

NullPointerException - if any required attribute was not provided