Package software.amazon.awscdk.services.cognito

Class UserPoolIdentityProviderApple.Builder

java.lang.Object

software.amazon.awscdk.services.cognito.UserPoolIdentityProviderApple.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<UserPoolIdentityProviderApple>

Enclosing class:

UserPoolIdentityProviderApple

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

A fluent builder for UserPoolIdentityProviderApple.

Method Summary

Modifier and Type	Method	Description
UserPoolIdentityProviderApple.Builder	attributeMapping(AttributeMapping attributeMapping)	Mapping attributes from the identity provider to standard and custom attributes of the user pool.
UserPoolIdentityProviderApple	build()
UserPoolIdentityProviderApple.Builder	clientId(String clientId)	The client id recognized by Apple APIs.
static UserPoolIdentityProviderApple.Builder	create(software.constructs.Construct scope, String id)
UserPoolIdentityProviderApple.Builder	keyId(String keyId)	The keyId (of the same key, which content has to be later supplied as privateKey) for Apple APIs to authenticate the client.
UserPoolIdentityProviderApple.Builder	privateKey(String privateKey)	Deprecated. use privateKeyValue
UserPoolIdentityProviderApple.Builder	privateKeyValue(SecretValue privateKeyValue)	The privateKey content for Apple APIs to authenticate the client.
UserPoolIdentityProviderApple.Builder	scopes(List<String> scopes)	The list of apple permissions to obtain for getting access to the apple profile.
UserPoolIdentityProviderApple.Builder	teamId(String teamId)	The teamId for Apple APIs to authenticate the client.
UserPoolIdentityProviderApple.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 UserPoolIdentityProviderApple.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of UserPoolIdentityProviderApple.Builder.

userPool

@Stability(Stable)
public UserPoolIdentityProviderApple.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 UserPoolIdentityProviderApple.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 UserPoolIdentityProviderApple.Builder clientId(String clientId)

The client id recognized by Apple APIs.

Parameters:

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

Returns:

this

See Also:

• https://developer.apple.com/documentation/sign_in_with_apple/clientconfigi/3230948-clientid

keyId

@Stability(Stable)
public UserPoolIdentityProviderApple.Builder keyId(String keyId)

The keyId (of the same key, which content has to be later supplied as privateKey) for Apple APIs to authenticate the client.

Parameters:

keyId - The keyId (of the same key, which content has to be later supplied as privateKey) for Apple APIs to authenticate the client. This parameter is required.

Returns:

this

teamId

@Stability(Stable)
public UserPoolIdentityProviderApple.Builder teamId(String teamId)

The teamId for Apple APIs to authenticate the client.

Parameters:

teamId - The teamId for Apple APIs to authenticate the client. This parameter is required.

Returns:

this

privateKey

@Stability(Deprecated)
@Deprecated
public UserPoolIdentityProviderApple.Builder privateKey(String privateKey)

Deprecated.

use privateKeyValue

(deprecated) The privateKey content for Apple APIs to authenticate the client.

Default: none

Parameters:

privateKey - The privateKey content for Apple APIs to authenticate the client. This parameter is required.

Returns:

this

privateKeyValue

@Stability(Stable)
public UserPoolIdentityProviderApple.Builder privateKeyValue(SecretValue privateKeyValue)

The privateKey content for Apple APIs to authenticate the client.

Default: none

Parameters:

privateKeyValue - The privateKey content for Apple APIs to authenticate the client. This parameter is required.

Returns:

this

scopes

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

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

Default: [ name ]

Parameters:

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

Returns:

this

See Also:

• https://developer.apple.com/documentation/sign_in_with_apple/clientconfigi/3230955-scope

build

@Stability(Stable)
public UserPoolIdentityProviderApple build()

Specified by:

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

Returns:

a newly built instance of UserPoolIdentityProviderApple.