UserPoolIdentityProviderOidc
- class aws_cdk.aws_cognito.UserPoolIdentityProviderOidc(scope, id, *, client_id, client_secret, issuer_url, attribute_request_method=None, endpoints=None, identifiers=None, name=None, scopes=None, user_pool, attribute_mapping=None)
Bases:
Resource
Represents an identity provider that integrates with OpenID Connect.
- Resource:
AWS::Cognito::UserPoolIdentityProvider
- ExampleMetadata:
fixture=_generated
Example:
# 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, 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"] )
- Parameters:
scope (
Construct
) –id (
str
) –client_id (
str
) – The client id.client_secret (
str
) – The client secret.issuer_url (
str
) – Issuer URL.attribute_request_method (
Optional
[OidcAttributeRequestMethod
]) – The method to use to request attributes. Default: OidcAttributeRequestMethod.GETendpoints (
Union
[OidcEndpoints
,Dict
[str
,Any
],None
]) – OpenID connect endpoints. Default: - auto discovered with issuer URLidentifiers (
Optional
[Sequence
[str
]]) – Identifiers. Identifiers can be used to redirect users to the correct IdP in multitenant apps. Default: - no identifiers usedname (
Optional
[str
]) – The name of the provider. Default: - the unique ID of the constructscopes (
Optional
[Sequence
[str
]]) – 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. Default: [‘openid’]user_pool (
IUserPool
) – The user pool to which this construct provides identities.attribute_mapping (
Union
[AttributeMapping
,Dict
[str
,Any
],None
]) – Mapping attributes from the identity provider to standard and custom attributes of the user pool. Default: - no attribute mapping
Methods
- apply_removal_policy(policy)
Apply the given removal policy to this resource.
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
).- Parameters:
policy (
RemovalPolicy
) –- Return type:
None
- to_string()
Returns a string representation of this construct.
- Return type:
str
Attributes
- env
The environment this resource belongs to.
For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.
- node
The tree node.
- provider_name
The primary identifier of this identity provider.
- stack
The stack in which this resource is defined.
Static Methods
- classmethod is_construct(x)
Checks if
x
is a construct.Use this method instead of
instanceof
to properly detectConstruct
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 classConstruct
in each copy of theconstructs
library is seen as a different class, and an instance of one class will not test asinstanceof
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 theconstructs
library can be accidentally installed, andinstanceof
will behave unpredictably. It is safest to avoid usinginstanceof
, and using this type-testing method instead.- Parameters:
x (
Any
) – Any object.- Return type:
bool
- Returns:
true if
x
is an object created from a class which extendsConstruct
.
- classmethod is_owned_resource(construct)
Returns true if the construct was created by CDK, and false otherwise.
- Parameters:
construct (
IConstruct
) –- Return type:
bool
- classmethod is_resource(construct)
Check whether the given construct is a Resource.
- Parameters:
construct (
IConstruct
) –- Return type:
bool