Package software.amazon.awscdk.services.cognito

Class UserPoolIdentityProviderAppleProps.Builder

java.lang.Object

software.amazon.awscdk.services.cognito.UserPoolIdentityProviderAppleProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<UserPoolIdentityProviderAppleProps>

Enclosing interface:

UserPoolIdentityProviderAppleProps

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

A builder for UserPoolIdentityProviderAppleProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
UserPoolIdentityProviderAppleProps.Builder	attributeMapping(AttributeMapping attributeMapping)	Sets the value of UserPoolIdentityProviderProps.getAttributeMapping()
UserPoolIdentityProviderAppleProps	build()	Builds the configured instance.
UserPoolIdentityProviderAppleProps.Builder	clientId(String clientId)	Sets the value of UserPoolIdentityProviderAppleProps.getClientId()
UserPoolIdentityProviderAppleProps.Builder	keyId(String keyId)	Sets the value of UserPoolIdentityProviderAppleProps.getKeyId()
UserPoolIdentityProviderAppleProps.Builder	privateKey(String privateKey)	Deprecated. use privateKeyValue
UserPoolIdentityProviderAppleProps.Builder	privateKeyValue(SecretValue privateKeyValue)	Sets the value of UserPoolIdentityProviderAppleProps.getPrivateKeyValue()
UserPoolIdentityProviderAppleProps.Builder	scopes(List<String> scopes)	Sets the value of UserPoolIdentityProviderAppleProps.getScopes()
UserPoolIdentityProviderAppleProps.Builder	teamId(String teamId)	Sets the value of UserPoolIdentityProviderAppleProps.getTeamId()
UserPoolIdentityProviderAppleProps.Builder	userPool(IUserPool userPool)	Sets the value of UserPoolIdentityProviderProps.getUserPool()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

clientId

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

Sets the value of UserPoolIdentityProviderAppleProps.getClientId()

Parameters:

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

Returns:

this

keyId

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

Sets the value of UserPoolIdentityProviderAppleProps.getKeyId()

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 UserPoolIdentityProviderAppleProps.Builder teamId(String teamId)

Sets the value of UserPoolIdentityProviderAppleProps.getTeamId()

Parameters:

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

Returns:

this

privateKey

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

Deprecated.

use privateKeyValue

Sets the value of UserPoolIdentityProviderAppleProps.getPrivateKey()

Parameters:

privateKey - The privateKey content for Apple APIs to authenticate the client.

Returns:

this

privateKeyValue

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

Sets the value of UserPoolIdentityProviderAppleProps.getPrivateKeyValue()

Parameters:

privateKeyValue - The privateKey content for Apple APIs to authenticate the client.

Returns:

this

scopes

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

Sets the value of UserPoolIdentityProviderAppleProps.getScopes()

Parameters:

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

Returns:

this

userPool

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

Sets the value of UserPoolIdentityProviderProps.getUserPool()

Parameters:

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

Returns:

this

attributeMapping

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

Sets the value of UserPoolIdentityProviderProps.getAttributeMapping()

Parameters:

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

Returns:

this

build

@Stability(Stable)
public UserPoolIdentityProviderAppleProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of UserPoolIdentityProviderAppleProps

Throws:

NullPointerException - if any required attribute was not provided