CfnUserPoolIdentityProviderProps

All Known Implementing Classes:: CfnUserPoolIdentityProviderProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-31T18:36:57.309Z")
public interface CfnUserPoolIdentityProviderProps

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();

Nested Class Summary

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

Method Summary

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

- Method Detail
  - getProviderName
```
java.lang.String getProviderName()
```
    The IdP name.
  - getProviderType
```
java.lang.String getProviderType()
```
    The IdP type.
  - getUserPoolId
```
java.lang.String getUserPoolId()
```
    The user pool ID.
  - getAttributeMapping
```
default java.lang.Object getAttributeMapping()
```
    A mapping of IdP attributes to standard and custom user pool attributes.
  - getIdpIdentifiers
```
default java.util.List<java.lang.String> getIdpIdentifiers()
```
    A list of IdP identifiers.
  - getProviderDetails
```
default java.lang.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
  - builder
```
static CfnUserPoolIdentityProviderProps.Builder builder()
```
    Returns:
    
    a CfnUserPoolIdentityProviderProps.Builder of CfnUserPoolIdentityProviderProps

Interface CfnUserPoolIdentityProviderProps

Nested Class Summary

Method Summary

Method Detail

getProviderName

getProviderType

getUserPoolId

getAttributeMapping

getIdpIdentifiers

getProviderDetails

builder