Package software.amazon.awscdk.services.cognito

Class CfnUserPoolIdentityProvider

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.cognito.CfnUserPoolIdentityProvider
All Implemented Interfaces:
IEnvironmentAware, IInspectable, IUserPoolIdentityProviderRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)", date="2025-11-10T13:40:01.201Z") @Stability(Stable) public class CfnUserPoolIdentityProvider extends CfnResource implements IInspectable, IUserPoolIdentityProviderRef
The AWS::Cognito::UserPoolIdentityProvider resource creates an identity provider for a user pool.

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;
 CfnUserPoolIdentityProvider cfnUserPoolIdentityProvider = CfnUserPoolIdentityProvider.Builder.create(this, "MyCfnUserPoolIdentityProvider")
         .providerDetails(providerDetails)
         .providerName("providerName")
         .providerType("providerType")
         .userPoolId("userPoolId")
         // the properties below are optional
         .attributeMapping(attributeMapping)
         .idpIdentifiers(List.of("idpIdentifiers"))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnUserPoolIdentityProvider

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

    • CfnUserPoolIdentityProvider

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

    • CfnUserPoolIdentityProvider

      @Stability(Stable) public CfnUserPoolIdentityProvider(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnUserPoolIdentityProviderProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getUserPoolIdentityProviderRef

      @Stability(Stable) @NotNull public UserPoolIdentityProviderReference getUserPoolIdentityProviderRef()
      A reference to a UserPoolIdentityProvider resource.
      Specified by:
      getUserPoolIdentityProviderRef in interface IUserPoolIdentityProviderRef

    • getProviderDetails

      @Stability(Stable) @NotNull public Object getProviderDetails()
      The scopes, URLs, and identifiers for your external identity provider.

    • setProviderDetails

      @Stability(Stable) public void setProviderDetails(@NotNull Object value)
      The scopes, URLs, and identifiers for your external identity provider.

    • getProviderName

      @Stability(Stable) @NotNull public String getProviderName()
      The name that you want to assign to the IdP.

    • setProviderName

      @Stability(Stable) public void setProviderName(@NotNull String value)
      The name that you want to assign to the IdP.

    • getProviderType

      @Stability(Stable) @NotNull public String getProviderType()
      The type of IdP that you want to add.

    • setProviderType

      @Stability(Stable) public void setProviderType(@NotNull String value)
      The type of IdP that you want to add.

    • getUserPoolId

      @Stability(Stable) @NotNull public String getUserPoolId()
      The Id of the user pool where you want to create an IdP.

    • setUserPoolId

      @Stability(Stable) public void setUserPoolId(@NotNull String value)
      The Id of the user pool where you want to create an IdP.

    • getAttributeMapping

      @Stability(Stable) @Nullable public Object getAttributeMapping()
      A mapping of IdP attributes to standard and custom user pool attributes.

    • setAttributeMapping

      @Stability(Stable) public void setAttributeMapping(@Nullable Object value)
      A mapping of IdP attributes to standard and custom user pool attributes.

    • getIdpIdentifiers

      @Stability(Stable) @Nullable public List<String> getIdpIdentifiers()
      An array of IdP identifiers, for example "IdPIdentifiers": [ "MyIdP", "MyIdP2" ] .

    • setIdpIdentifiers

      @Stability(Stable) public void setIdpIdentifiers(@Nullable List<String> value)
      An array of IdP identifiers, for example "IdPIdentifiers": [ "MyIdP", "MyIdP2" ] .