software.amazon.awscdk.services.cognito

Interface UserPoolIdentityProviderGoogleProps

All Superinterfaces:

UserPoolIdentityProviderProps

All Known Implementing Classes:

UserPoolIdentityProviderGoogleProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:46.907Z")
public interface UserPoolIdentityProviderGoogleProps
extends UserPoolIdentityProviderProps

Properties to initialize UserPoolGoogleIdentityProvider.

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.*;
 ProviderAttribute providerAttribute;
 UserPool userPool;
 UserPoolIdentityProviderGoogleProps userPoolIdentityProviderGoogleProps = UserPoolIdentityProviderGoogleProps.builder()
         .clientId("clientId")
         .clientSecret("clientSecret")
         .userPool(userPool)
         // the properties below are optional
         .attributeMapping(AttributeMapping.builder()
                 .address(providerAttribute)
                 .birthdate(providerAttribute)
                 .custom(Map.of(
                         "customKey", providerAttribute))
                 .email(providerAttribute)
                 .familyName(providerAttribute)
                 .fullname(providerAttribute)
                 .gender(providerAttribute)
                 .givenName(providerAttribute)
                 .lastUpdateTime(providerAttribute)
                 .locale(providerAttribute)
                 .middleName(providerAttribute)
                 .nickname(providerAttribute)
                 .phoneNumber(providerAttribute)
                 .preferredUsername(providerAttribute)
                 .profilePage(providerAttribute)
                 .profilePicture(providerAttribute)
                 .timezone(providerAttribute)
                 .website(providerAttribute)
                 .build())
         .scopes(List.of("scopes"))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static UserPoolIdentityProviderGoogleProps.Builder	builder()
java.lang.String	getClientId() The client id recognized by Google APIs.
java.lang.String	getClientSecret() The client secret to be accompanied with clientId for Google APIs to authenticate the client.
default java.util.List<java.lang.String>	getScopes() The list of google permissions to obtain for getting access to the google 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 Google APIs.

See Also:

https://developers.google.com/identity/sign-in/web/sign-in#specify_your_apps_client_id

getClientSecret

java.lang.String getClientSecret()

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

See Also:

https://developers.google.com/identity/sign-in/web/sign-in

getScopes

default java.util.List<java.lang.String> getScopes()

The list of google permissions to obtain for getting access to the google profile.

Default: [ profile ]

See Also:

https://developers.google.com/identity/sign-in/web/sign-in

builder

static UserPoolIdentityProviderGoogleProps.Builder builder()

Specified by:

builder in interface UserPoolIdentityProviderProps

Returns:

a UserPoolIdentityProviderGoogleProps.Builder of UserPoolIdentityProviderGoogleProps