Package software.amazon.awscdk.services.cognito

Interface CfnUserPoolIdentityProviderProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnUserPoolIdentityProviderProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.89.0 (build 2f74b3e)",
           date="2023-10-26T00:56:05.886Z")
@Stability(Stable)
public interface CfnUserPoolIdentityProviderProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnUserPoolIdentityProvider.

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.*;
 Object attributeMapping;
 Object providerDetails;
 CfnUserPoolIdentityProviderProps cfnUserPoolIdentityProviderProps = CfnUserPoolIdentityProviderProps.builder()
         .providerName("providerName")
         .providerType("providerType")
         .userPoolId("userPoolId")
         // the properties below are optional
         .attributeMapping(attributeMapping)
         .idpIdentifiers(List.of("idpIdentifiers"))
         .providerDetails(providerDetails)
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolidentityprovider.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnUserPoolIdentityProviderProps.Builder	A builder for CfnUserPoolIdentityProviderProps
static final class	CfnUserPoolIdentityProviderProps.Jsii$Proxy	An implementation for CfnUserPoolIdentityProviderProps

Method Summary

Modifier and Type	Method	Description
static CfnUserPoolIdentityProviderProps.Builder	builder()
default Object	getAttributeMapping()	A mapping of IdP attributes to standard and custom user pool attributes.
default List<String>	getIdpIdentifiers()	A list of IdP identifiers.
default Object	getProviderDetails()	The IdP details.
String	getProviderName()	The IdP name.
String	getProviderType()	The IdP type.
String	getUserPoolId()	The user pool ID.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getProviderName

@Stability(Stable)
@NotNull
String getProviderName()

The IdP name.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolidentityprovider.html#cfn-cognito-userpoolidentityprovider-providername

getProviderType

@Stability(Stable)
@NotNull
String getProviderType()

The IdP type.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolidentityprovider.html#cfn-cognito-userpoolidentityprovider-providertype

getUserPoolId

@Stability(Stable)
@NotNull
String getUserPoolId()

The user pool ID.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolidentityprovider.html#cfn-cognito-userpoolidentityprovider-userpoolid

getAttributeMapping

@Stability(Stable)
@Nullable
default Object getAttributeMapping()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolidentityprovider.html#cfn-cognito-userpoolidentityprovider-attributemapping

getIdpIdentifiers

@Stability(Stable)
@Nullable
default List<String> getIdpIdentifiers()

A list of IdP identifiers.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolidentityprovider.html#cfn-cognito-userpoolidentityprovider-idpidentifiers

getProviderDetails

@Stability(Stable)
@Nullable
default Object getProviderDetails()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cognito-userpoolidentityprovider.html#cfn-cognito-userpoolidentityprovider-providerdetails

builder

@Stability(Stable)
static CfnUserPoolIdentityProviderProps.Builder builder()

Returns:

a CfnUserPoolIdentityProviderProps.Builder of CfnUserPoolIdentityProviderProps