software.amazon.awscdk.services.cognito

Interface UserPoolIdentityProviderGoogleProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, UserPoolIdentityProviderProps

All Known Implementing Classes:

UserPoolIdentityProviderGoogleProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-12-07T17:24:44.644Z")
 @Stability(value=Stable)
public interface UserPoolIdentityProviderGoogleProps
extends software.amazon.jsii.JsiiSerializable, 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()
String	getClientId() The client id recognized by Google APIs.
String	getClientSecret() The client secret to be accompanied with clientId for Google APIs to authenticate the client.
default List<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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getClientId

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

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

@Stability(value=Stable)
 @Nullable
default List<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

@Stability(value=Stable)
static UserPoolIdentityProviderGoogleProps.Builder builder()

Specified by:

builder in interface UserPoolIdentityProviderProps

Returns:

a UserPoolIdentityProviderGoogleProps.Builder of UserPoolIdentityProviderGoogleProps