Package software.amazon.awscdk.services.cognito

Class CfnUserPoolIdentityProvider

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.cognito.CfnUserPoolIdentityProvider
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:43.951Z") @Stability(Stable) public class CfnUserPoolIdentityProvider extends CfnResource implements IInspectable
A CloudFormation AWS::Cognito::UserPoolIdentityProvider.

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

  • 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 Construct scope, @NotNull String id, @NotNull CfnUserPoolIdentityProviderProps props)
      Create a new AWS::Cognito::UserPoolIdentityProvider.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      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

    • getAttributeMapping

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

    • setAttributeMapping

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

    • getProviderDetails

      @Stability(Stable) @NotNull public 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

    • setProviderDetails

      @Stability(Stable) public void setProviderDetails(@NotNull Object value)
      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

    • getProviderName

      @Stability(Stable) @NotNull public String getProviderName()
      The IdP name.

    • setProviderName

      @Stability(Stable) public void setProviderName(@NotNull String value)
      The IdP name.

    • getProviderType

      @Stability(Stable) @NotNull public String getProviderType()
      The IdP type.

    • setProviderType

      @Stability(Stable) public void setProviderType(@NotNull String value)
      The IdP type.

    • getUserPoolId

      @Stability(Stable) @NotNull public String getUserPoolId()
      The user pool ID.

    • setUserPoolId

      @Stability(Stable) public void setUserPoolId(@NotNull String value)
      The user pool ID.

    • getIdpIdentifiers

      @Stability(Stable) @Nullable public List<String> getIdpIdentifiers()
      A list of IdP identifiers.

    • setIdpIdentifiers

      @Stability(Stable) public void setIdpIdentifiers(@Nullable List<String> value)
      A list of IdP identifiers.