aws-cdk-lib.aws_cognito.UserPoolIdentityProviderGoogleProps

interface UserPoolIdentityProviderGoogleProps

LanguageType name
.NETAmazon.CDK.AWS.Cognito.UserPoolIdentityProviderGoogleProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awscognito#UserPoolIdentityProviderGoogleProps
Javasoftware.amazon.awscdk.services.cognito.UserPoolIdentityProviderGoogleProps
Pythonaws_cdk.aws_cognito.UserPoolIdentityProviderGoogleProps
TypeScript (source)aws-cdk-lib » aws_cognito » UserPoolIdentityProviderGoogleProps

Properties to initialize UserPoolGoogleIdentityProvider.

Example

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

NameTypeDescription
clientIdstringThe client id recognized by Google APIs.
userPoolIUserPoolThe user pool to which this construct provides identities.
attributeMapping?AttributeMappingMapping attributes from the identity provider to standard and custom attributes of the user pool.
clientSecret?⚠️stringThe client secret to be accompanied with clientId for Google APIs to authenticate the client.
clientSecretValue?SecretValueThe client secret to be accompanied with clientId for Google APIs to authenticate the client as SecretValue.
scopes?string[]The list of google permissions to obtain for getting access to the google profile.

clientId

Type: string

The client id recognized by Google APIs.

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


userPool

Type: IUserPool

The user pool to which this construct provides identities.


attributeMapping?

Type: AttributeMapping (optional, default: no attribute mapping)

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


clientSecret?⚠️

⚠️ Deprecated: use clientSecretValue instead

Type: string (optional, default: none)

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


clientSecretValue?

Type: SecretValue (optional, default: none)

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

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


scopes?

Type: string[] (optional, default: [ profile ])

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

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