software.amazon.awscdk.services.cognito

Interface UserPoolIdentityProviderAmazonProps

All Superinterfaces:

UserPoolIdentityProviderProps

All Known Implementing Classes:

UserPoolIdentityProviderAmazonProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-28T21:34:26.108Z")
public interface UserPoolIdentityProviderAmazonProps
extends 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 and Description
static class	UserPoolIdentityProviderAmazonProps.Builder A builder for UserPoolIdentityProviderAmazonProps
static class	UserPoolIdentityProviderAmazonProps.Jsii$Proxy An implementation for UserPoolIdentityProviderAmazonProps

Method Summary

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

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

getAttributeMapping, getUserPool

Method Detail

getClientId

java.lang.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

java.lang.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

default java.util.List<java.lang.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

static UserPoolIdentityProviderAmazonProps.Builder builder()

Specified by:

builder in interface UserPoolIdentityProviderProps

Returns:

a UserPoolIdentityProviderAmazonProps.Builder of UserPoolIdentityProviderAmazonProps