Package software.amazon.awscdk.services.cognito

Class UserPoolIdentityProviderOidc

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.cognito.UserPoolIdentityProviderOidc

All Implemented Interfaces:

IResource, IUserPoolIdentityProvider, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)",
           date="2025-10-24T13:34:34.142Z")
@Stability(Stable)
public class UserPoolIdentityProviderOidc
extends Resource
implements IUserPoolIdentityProvider

Represents an identity provider that integrates with OpenID Connect.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.cognito.*;
 ProviderAttribute providerAttribute;
 UserPool userPool;
 UserPoolIdentityProviderOidc userPoolIdentityProviderOidc = UserPoolIdentityProviderOidc.Builder.create(this, "MyUserPoolIdentityProviderOidc")
         .clientId("clientId")
         .clientSecret("clientSecret")
         .issuerUrl("issuerUrl")
         .userPool(userPool)
         // the properties below are optional
         .attributeMapping(AttributeMapping.builder()
                 .address(providerAttribute)
                 .birthdate(providerAttribute)
                 .custom(Map.of(
                         "customKey", providerAttribute))
                 .email(providerAttribute)
                 .emailVerified(providerAttribute)
                 .familyName(providerAttribute)
                 .fullname(providerAttribute)
                 .gender(providerAttribute)
                 .givenName(providerAttribute)
                 .lastUpdateTime(providerAttribute)
                 .locale(providerAttribute)
                 .middleName(providerAttribute)
                 .nickname(providerAttribute)
                 .phoneNumber(providerAttribute)
                 .preferredUsername(providerAttribute)
                 .profilePage(providerAttribute)
                 .profilePicture(providerAttribute)
                 .timezone(providerAttribute)
                 .website(providerAttribute)
                 .build())
         .attributeRequestMethod(OidcAttributeRequestMethod.GET)
         .endpoints(OidcEndpoints.builder()
                 .authorization("authorization")
                 .jwksUri("jwksUri")
                 .token("token")
                 .userInfo("userInfo")
                 .build())
         .identifiers(List.of("identifiers"))
         .name("name")
         .scopes(List.of("scopes"))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	UserPoolIdentityProviderOidc.Builder	A fluent builder for UserPoolIdentityProviderOidc.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource

IResource.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.cognito.IUserPoolIdentityProvider

IUserPoolIdentityProvider.Jsii$Default, IUserPoolIdentityProvider.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROPERTY_INJECTION_ID	Uniquely identifies this class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	UserPoolIdentityProviderOidc(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	UserPoolIdentityProviderOidc(software.amazon.jsii.JsiiObjectRef objRef)
	UserPoolIdentityProviderOidc(software.constructs.Construct scope, String id, UserPoolIdentityProviderOidcProps props)

Method Summary

Modifier and Type	Method	Description
protected Object	configureAttributeMapping()
String	getProviderName()	The primary identifier of this identity provider.

Methods inherited from class software.amazon.awscdk.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResource

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

PROPERTY_INJECTION_ID

@Stability(Stable)
public static final String PROPERTY_INJECTION_ID

Uniquely identifies this class.

Constructor Details

UserPoolIdentityProviderOidc

protected UserPoolIdentityProviderOidc(software.amazon.jsii.JsiiObjectRef objRef)

UserPoolIdentityProviderOidc

protected UserPoolIdentityProviderOidc(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

UserPoolIdentityProviderOidc

@Stability(Stable)
public UserPoolIdentityProviderOidc(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 UserPoolIdentityProviderOidcProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Details

configureAttributeMapping

@Stability(Stable)
@NotNull
protected Object configureAttributeMapping()

getProviderName

@Stability(Stable)
@NotNull
public String getProviderName()

The primary identifier of this identity provider.

Specified by:

getProviderName in interface IUserPoolIdentityProvider