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
-
Method Summary
Modifier and TypeMethodDescriptionattributeMapping
(AttributeMapping attributeMapping) Sets the value ofUserPoolIdentityProviderProps.getAttributeMapping()
attributeRequestMethod
(OidcAttributeRequestMethod attributeRequestMethod) Sets the value ofUserPoolIdentityProviderOidcProps.getAttributeRequestMethod()
build()
Builds the configured instance.Sets the value ofUserPoolIdentityProviderOidcProps.getClientId()
clientSecret
(String clientSecret) Sets the value ofUserPoolIdentityProviderOidcProps.getClientSecret()
endpoints
(OidcEndpoints endpoints) Sets the value ofUserPoolIdentityProviderOidcProps.getEndpoints()
identifiers
(List<String> identifiers) Sets the value ofUserPoolIdentityProviderOidcProps.getIdentifiers()
Sets the value ofUserPoolIdentityProviderOidcProps.getIssuerUrl()
Sets the value ofUserPoolIdentityProviderOidcProps.getName()
Sets the value ofUserPoolIdentityProviderOidcProps.getScopes()
Sets the value ofUserPoolIdentityProviderProps.getUserPool()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
clientId
Sets the value ofUserPoolIdentityProviderOidcProps.getClientId()
- Parameters:
clientId
- The client id. This parameter is required.- Returns:
this
-
clientSecret
@Stability(Stable) public UserPoolIdentityProviderOidcProps.Builder clientSecret(String clientSecret) Sets the value ofUserPoolIdentityProviderOidcProps.getClientSecret()
- Parameters:
clientSecret
- The client secret. This parameter is required.- Returns:
this
-
issuerUrl
Sets the value ofUserPoolIdentityProviderOidcProps.getIssuerUrl()
- Parameters:
issuerUrl
- Issuer URL. This parameter is required.- Returns:
this
-
attributeRequestMethod
@Stability(Stable) public UserPoolIdentityProviderOidcProps.Builder attributeRequestMethod(OidcAttributeRequestMethod attributeRequestMethod) Sets the value ofUserPoolIdentityProviderOidcProps.getAttributeRequestMethod()
- Parameters:
attributeRequestMethod
- The method to use to request attributes.- Returns:
this
-
endpoints
@Stability(Stable) public UserPoolIdentityProviderOidcProps.Builder endpoints(OidcEndpoints endpoints) Sets the value ofUserPoolIdentityProviderOidcProps.getEndpoints()
- Parameters:
endpoints
- OpenID connect endpoints.- Returns:
this
-
identifiers
@Stability(Stable) public UserPoolIdentityProviderOidcProps.Builder identifiers(List<String> identifiers) Sets the value ofUserPoolIdentityProviderOidcProps.getIdentifiers()
- Parameters:
identifiers
- Identifiers. Identifiers can be used to redirect users to the correct IdP in multitenant apps.- Returns:
this
-
name
Sets the value ofUserPoolIdentityProviderOidcProps.getName()
- Parameters:
name
- The name of the provider.- Returns:
this
-
scopes
Sets the value ofUserPoolIdentityProviderOidcProps.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
Sets the value ofUserPoolIdentityProviderProps.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 ofUserPoolIdentityProviderProps.getAttributeMapping()
- Parameters:
attributeMapping
- Mapping attributes from the identity provider to standard and custom attributes of the user pool.- Returns:
this
-
build
Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<UserPoolIdentityProviderOidcProps>
- Returns:
- a new instance of
UserPoolIdentityProviderOidcProps
- Throws:
NullPointerException
- if any required attribute was not provided
-