Package software.amazon.awscdk.services.cognito

Class UserPoolIdentityProviderGoogle.Builder

java.lang.Object

software.amazon.awscdk.services.cognito.UserPoolIdentityProviderGoogle.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<UserPoolIdentityProviderGoogle>

Enclosing class:

UserPoolIdentityProviderGoogle

@Stability(Stable)
public static final class UserPoolIdentityProviderGoogle.Builder
extends Object
implements software.amazon.jsii.Builder<UserPoolIdentityProviderGoogle>

A fluent builder for UserPoolIdentityProviderGoogle.

Method Summary

Modifier and Type	Method	Description
UserPoolIdentityProviderGoogle.Builder	attributeMapping(AttributeMapping attributeMapping)	Mapping attributes from the identity provider to standard and custom attributes of the user pool.
UserPoolIdentityProviderGoogle	build()
UserPoolIdentityProviderGoogle.Builder	clientId(String clientId)	The client id recognized by Google APIs.
UserPoolIdentityProviderGoogle.Builder	clientSecret(String clientSecret)	Deprecated. use clientSecretValue instead
UserPoolIdentityProviderGoogle.Builder	clientSecretValue(SecretValue clientSecretValue)	The client secret to be accompanied with clientId for Google APIs to authenticate the client as SecretValue.
static UserPoolIdentityProviderGoogle.Builder	create(software.constructs.Construct scope, String id)
UserPoolIdentityProviderGoogle.Builder	scopes(List<String> scopes)	The list of Google permissions to obtain for getting access to the Google profile.
UserPoolIdentityProviderGoogle.Builder	userPool(IUserPool userPool)	The user pool to which this construct provides identities.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static UserPoolIdentityProviderGoogle.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of UserPoolIdentityProviderGoogle.Builder.

userPool

@Stability(Stable)
public UserPoolIdentityProviderGoogle.Builder userPool(IUserPool userPool)

The user pool to which this construct provides identities.

Parameters:

userPool - The user pool to which this construct provides identities. This parameter is required.

Returns:

this

attributeMapping

@Stability(Stable)
public UserPoolIdentityProviderGoogle.Builder attributeMapping(AttributeMapping attributeMapping)

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

Default: - no attribute mapping

Parameters:

attributeMapping - Mapping attributes from the identity provider to standard and custom attributes of the user pool. This parameter is required.

Returns:

this

clientId

@Stability(Stable)
public UserPoolIdentityProviderGoogle.Builder clientId(String clientId)

The client id recognized by Google APIs.

Parameters:

clientId - The client id recognized by Google APIs. This parameter is required.

Returns:

this

See Also:

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

clientSecret

@Stability(Deprecated)
@Deprecated
public UserPoolIdentityProviderGoogle.Builder clientSecret(String clientSecret)

Deprecated.

use clientSecretValue instead

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

Default: none

Parameters:

clientSecret - The client secret to be accompanied with clientId for Google APIs to authenticate the client. This parameter is required.

Returns:

this

See Also:

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

clientSecretValue

@Stability(Stable)
public UserPoolIdentityProviderGoogle.Builder clientSecretValue(SecretValue clientSecretValue)

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

Default: none

Parameters:

clientSecretValue - The client secret to be accompanied with clientId for Google APIs to authenticate the client as SecretValue. This parameter is required.

Returns:

this

See Also:

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

scopes

@Stability(Stable)
public UserPoolIdentityProviderGoogle.Builder scopes(List<String> scopes)

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

Default: [ profile ]

Parameters:

scopes - The list of Google permissions to obtain for getting access to the Google profile. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public UserPoolIdentityProviderGoogle build()

Specified by:

build in interface software.amazon.jsii.Builder<UserPoolIdentityProviderGoogle>

Returns:

a newly built instance of UserPoolIdentityProviderGoogle.