AWS CDK Reference

Appearance

v2.274.0

UserPoolIdentityProviderGoogleProps Struct ​

Properties to initialize UserPoolGoogleIdentityProvider.

Source
aws-cognito/lib/user-pool-idps/google.ts
Type last changed
v2.60.0 · 12 Jan 2023

Example ​

ts
const userpool = new cognito.UserPool(this, 'Pool');
const secret = secretsmanager.Secret.fromSecretAttributes(this, "CognitoClientSecret", {
    secretCompleteArn: "arn:aws:secretsmanager:xxx:xxx:secret:xxx-xxx"
}).secretValue

const provider = new cognito.UserPoolIdentityProviderGoogle(this, 'Google', {
  clientId: 'amzn-client-id',
  clientSecretValue: secret,
  userPool: userpool,
});

Properties ​

attributeMappingAttributeMappingattribute_mappingAttributeMappingattributeMappingAttributeMappingAttributeMappingAttributeMappingAttributeMappingAttributeMapping= no attribute mapping#
Mapping attributes from the identity provider to standard and custom attributes of the user pool.
clientIdstringclient_idstrclientIdStringClientIdstringClientId*stringrequired#
The client id recognized by Google APIs.
clientSecretstringclient_secretstrclientSecretStringClientSecretstringClientSecret*string= nonedeprecated#
use clientSecretValue instead
clientSecretValueSecretValueclient_secret_valueSecretValueclientSecretValueSecretValueClientSecretValueSecretValueClientSecretValueSecretValue= none#
The client secret to be accompanied with clientId for Google APIs to authenticate the client as SecretValue.
scopesstring[]scopestyping.List[str]scopesList<String>Scopesstring[]Scopes*[]*string= [ profile ]#
The list of Google permissions to obtain for getting access to the Google profile.
userPoolIUserPooluser_poolIUserPooluserPoolIUserPoolUserPoolIUserPoolUserPoolIUserPoolrequired#
The user pool to which this construct provides identities.

Used as props by ​