Package software.amazon.awscdk.services.cognito

Interface UserPoolIdentityProviderAmazonProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, UserPoolIdentityProviderProps

All Known Implementing Classes:

UserPoolIdentityProviderAmazonProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-06T23:25:06.423Z")
@Stability(Stable)
public interface UserPoolIdentityProviderAmazonProps
extends software.amazon.jsii.JsiiSerializable, UserPoolIdentityProviderProps

Properties to initialize UserPoolAmazonIdentityProvider.

Example:

 UserPool pool = new UserPool(this, "Pool");
 UserPoolIdentityProviderAmazon provider = UserPoolIdentityProviderAmazon.Builder.create(this, "Amazon")
         .userPool(pool)
         .clientId("amzn-client-id")
         .clientSecret("amzn-client-secret")
         .build();
 UserPoolClient client = pool.addClient("app-client", UserPoolClientOptions.builder()
         // ...
         .supportedIdentityProviders(List.of(UserPoolClientIdentityProvider.AMAZON))
         .build());
 client.node.addDependency(provider);
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static UserPoolIdentityProviderAmazonProps.Builder	builder()
String	getClientId()	The client id recognized by Login with Amazon APIs.
String	getClientSecret()	The client secret to be accompanied with clientId for Login with Amazon APIs to authenticate the client.
default List<String>	getScopes()	The types of user profile data to obtain for the Amazon profile.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Methods inherited from interface software.amazon.awscdk.services.cognito.UserPoolIdentityProviderProps

getAttributeMapping, getUserPool

Method Details

getClientId

@Stability(Stable)
@NotNull
String getClientId()

The client id recognized by Login with Amazon APIs.

See Also:

• https://developer.amazon.com/docs/login-with-amazon/security-profile.html#client-identifier

getClientSecret

@Stability(Stable)
@NotNull
String getClientSecret()

The client secret to be accompanied with clientId for Login with Amazon APIs to authenticate the client.

See Also:

• https://developer.amazon.com/docs/login-with-amazon/security-profile.html#client-identifier

getScopes

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

The types of user profile data to obtain for the Amazon profile.

Default: [ profile ]

See Also:

• https://developer.amazon.com/docs/login-with-amazon/customer-profile.html

builder

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

Returns:

a UserPoolIdentityProviderAmazonProps.Builder of UserPoolIdentityProviderAmazonProps