AWS Fundamentals Logo
AWS Fundamentals
L2 Construct

UserPoolIdentityProviderGoogle

Represents an identity provider that integrates with Google.

Import

import { UserPoolIdentityProviderGoogle } from 'aws-cdk-lib/aws-cognito';

Or use the module namespace:

import * as cognito from 'aws-cdk-lib/aws-cognito';
// cognito.UserPoolIdentityProviderGoogle

Properties

Configuration passed to the constructor as UserPoolIdentityProviderGoogleProps.

clientIdRequired
string

The client id recognized by Google APIs.

clientSecretOptionalDeprecated
string

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

Default: none

Deprecated: use clientSecretValue instead

clientSecretValueOptional
SecretValue

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

Default: none

scopesOptional
string[]

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

Default: [ profile ]

2 properties inherited from UserPoolIdentityProviderProps
userPoolRequiredinherited from UserPoolIdentityProviderProps
IUserPool

The user pool to which this construct provides identities.

attributeMappingOptionalinherited from UserPoolIdentityProviderProps
AttributeMapping

Mapping attributes from the identity provider to standard and custom attributes of the user pool.

Default: - no attribute mapping

Get the Amazon Cognito Cheat Sheet

Everything you need to know about Amazon Cognito on one page. HD quality, print-friendly.

Download Free Infographic