UserPoolIdentityProviderOidc L2 construct
Represents an identity provider that integrates with OpenID Connect.
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_cognito as cognito } from 'aws-cdk-lib';
declare const providerAttribute: cognito.ProviderAttribute;
declare const userPool: cognito.UserPool;
const userPoolIdentityProviderOidc = new cognito.UserPoolIdentityProviderOidc(this, 'MyUserPoolIdentityProviderOidc', {
clientId: 'clientId',
clientSecret: 'clientSecret',
issuerUrl: 'issuerUrl',
userPool: userPool,
// the properties below are optional
attributeMapping: {
address: providerAttribute,
birthdate: providerAttribute,
custom: {
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,
},
attributeRequestMethod: cognito.OidcAttributeRequestMethod.GET,
endpoints: {
authorization: 'authorization',
jwksUri: 'jwksUri',
token: 'token',
userInfo: 'userInfo',
},
identifiers: ['identifiers'],
name: 'name',
scopes: ['scopes'],
});
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_cognito as cognito
# provider_attribute: cognito.ProviderAttribute
# user_pool: cognito.UserPool
user_pool_identity_provider_oidc = cognito.UserPoolIdentityProviderOidc(self, "MyUserPoolIdentityProviderOidc",
client_id="clientId",
client_secret="clientSecret",
issuer_url="issuerUrl",
user_pool=user_pool,
# the properties below are optional
attribute_mapping=cognito.AttributeMapping(
address=provider_attribute,
birthdate=provider_attribute,
custom={
"custom_key": provider_attribute
},
email=provider_attribute,
email_verified=provider_attribute,
family_name=provider_attribute,
fullname=provider_attribute,
gender=provider_attribute,
given_name=provider_attribute,
last_update_time=provider_attribute,
locale=provider_attribute,
middle_name=provider_attribute,
nickname=provider_attribute,
phone_number=provider_attribute,
preferred_username=provider_attribute,
profile_page=provider_attribute,
profile_picture=provider_attribute,
timezone=provider_attribute,
website=provider_attribute
),
attribute_request_method=cognito.OidcAttributeRequestMethod.GET,
endpoints=cognito.OidcEndpoints(
authorization="authorization",
jwks_uri="jwksUri",
token="token",
user_info="userInfo"
),
identifiers=["identifiers"],
name="name",
scopes=["scopes"]
)
java
// 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();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Cognito;
ProviderAttribute providerAttribute;
UserPool userPool;
var userPoolIdentityProviderOidc = new UserPoolIdentityProviderOidc(this, "MyUserPoolIdentityProviderOidc", new UserPoolIdentityProviderOidcProps {
ClientId = "clientId",
ClientSecret = "clientSecret",
IssuerUrl = "issuerUrl",
UserPool = userPool,
// the properties below are optional
AttributeMapping = new AttributeMapping {
Address = providerAttribute,
Birthdate = providerAttribute,
Custom = new Dictionary<string, ProviderAttribute> {
{ "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
},
AttributeRequestMethod = OidcAttributeRequestMethod.GET,
Endpoints = new OidcEndpoints {
Authorization = "authorization",
JwksUri = "jwksUri",
Token = "token",
UserInfo = "userInfo"
},
Identifiers = new [] { "identifiers" },
Name = "name",
Scopes = new [] { "scopes" }
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
var providerAttribute ProviderAttribute
var userPool UserPool
userPoolIdentityProviderOidc := awscdk.Aws_cognito.NewUserPoolIdentityProviderOidc(this, jsii.String("MyUserPoolIdentityProviderOidc"), &UserPoolIdentityProviderOidcProps{
ClientId: jsii.String("clientId"),
ClientSecret: jsii.String("clientSecret"),
IssuerUrl: jsii.String("issuerUrl"),
UserPool: userPool,
// the properties below are optional
AttributeMapping: &AttributeMapping{
Address: providerAttribute,
Birthdate: providerAttribute,
Custom: map[string]ProviderAttribute{
"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,
},
AttributeRequestMethod: awscdk.*Aws_cognito.OidcAttributeRequestMethod_GET,
Endpoints: &OidcEndpoints{
Authorization: jsii.String("authorization"),
JwksUri: jsii.String("jwksUri"),
Token: jsii.String("token"),
UserInfo: jsii.String("userInfo"),
},
Identifiers: []*string{
jsii.String("identifiers"),
},
Name: jsii.String("name"),
Scopes: []*string{
jsii.String("scopes"),
},
})
Initializer
ts
new UserPoolIdentityProviderOidc(scope: Construct, id: string, props: UserPoolIdentityProviderOidcProps)
python
UserPoolIdentityProviderOidc(scope: Construct, id: str, props: UserPoolIdentityProviderOidcProps)
java
new UserPoolIdentityProviderOidc(Construct scope, String id, UserPoolIdentityProviderOidcProps props)
csharp
new UserPoolIdentityProviderOidc(Construct scope, string id, UserPoolIdentityProviderOidcProps props)
go
NewUserPoolIdentityProviderOidc(Scope Construct, Id *string, Props UserPoolIdentityProviderOidcProps)
Construct Props
attributeMappingAttributeMappingattribute_mappingAttributeMappingattributeMappingAttributeMappingAttributeMappingAttributeMappingAttributeMappingAttributeMapping= no attribute mapping#Mapping attributes from the identity provider to standard and custom attributes of the user pool.
attributeRequestMethodOidcAttributeRequestMethodattribute_request_methodOidcAttributeRequestMethodattributeRequestMethodOidcAttributeRequestMethodAttributeRequestMethodOidcAttributeRequestMethodAttributeRequestMethodOidcAttributeRequestMethod= OidcAttributeRequestMethod.GET#The method to use to request attributes.
The client id.
The client secret.
endpointsOidcEndpointsendpointsOidcEndpointsendpointsOidcEndpointsEndpointsOidcEndpointsEndpointsOidcEndpoints= auto discovered with issuer URL#OpenID connect endpoints.
identifiersstring[]identifierstyping.List[str]identifiersList<String>Identifiersstring[]Identifiers*[]*string= no identifiers used#Identifiers.
Identifiers can be used to redirect users to the correct IdP in multitenant apps.
Issuer URL.
The name of the provider.
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.
Properties
envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironmentrequired#The environment this resource belongs to.
notes
For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.
For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.
PROPERTY_INJECTION_IDstringproperty_injection_idstrPROPERTY_INJECTION_IDStringPROPERTY_INJECTION_IDstringPROPERTY_INJECTION_ID*stringrequiredstatic#Uniquely identifies this class.
The primary identifier of this identity provider.
The stack in which this resource is defined.
userPoolIdentityProviderRefUserPoolIdentityProviderReferenceuser_pool_identity_provider_refUserPoolIdentityProviderReferenceuserPoolIdentityProviderRefUserPoolIdentityProviderReferenceUserPoolIdentityProviderRefUserPoolIdentityProviderReferenceUserPoolIdentityProviderRefUserPoolIdentityProviderReferencerequired#A reference to a UserPoolIdentityProvider resource.
Methods
applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#Override the cross-stack reference strength for this resource.
notes · 1 parameter
When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.
Parameters
strengthstrengthstrengthstrengthStrength— - The reference strength to use for this resource.
applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#Apply the given removal policy to this resource.
notes
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.
The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).
isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#Checks if `x` is a construct.
notes · 1 parameter · returns
Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.
Parameters
xxxxX— Any object.
Returns: true if x is an object created from a class which extends Construct.
isOwnedResource(construct: IConstruct): boolean@staticmethod def is_owned_resource(construct: IConstruct) -> boolpublic static Boolean isOwnedResource(IConstruct construct)public static bool IsOwnedResource(IConstruct construct)func IsOwnedResource(Construct IConstruct) *boolstatic#Returns true if the construct was created by CDK, and false otherwise.
isResource(construct: IConstruct): boolean@staticmethod def is_resource(construct: IConstruct) -> boolpublic static Boolean isResource(IConstruct construct)public static bool IsResource(IConstruct construct)func IsResource(Construct IConstruct) *boolstatic#Check whether the given construct is a Resource.
toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#Returns a string representation of this construct.
with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.