Package software.amazon.awscdk.services.cognito

Interface UserPoolIdentityProviderAppleProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, UserPoolIdentityProviderProps

All Known Implementing Classes:

UserPoolIdentityProviderAppleProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-22T02:23:59.189Z")
@Stability(Stable)
public interface UserPoolIdentityProviderAppleProps
extends software.amazon.jsii.JsiiSerializable, UserPoolIdentityProviderProps

Properties to initialize UserPoolAppleIdentityProvider.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.*;
 import software.amazon.awscdk.services.cognito.*;
 ProviderAttribute providerAttribute;
 SecretValue secretValue;
 UserPool userPool;
 UserPoolIdentityProviderAppleProps userPoolIdentityProviderAppleProps = UserPoolIdentityProviderAppleProps.builder()
         .clientId("clientId")
         .keyId("keyId")
         .teamId("teamId")
         .userPool(userPool)
         // the properties below are optional
         .attributeMapping(AttributeMapping.builder()
                 .address(providerAttribute)
                 .birthdate(providerAttribute)
                 .custom(Map.of(
                         "customKey", providerAttribute))
                 .email(providerAttribute)
                 .emailVerified(providerAttribute)
                 .familyName(providerAttribute)
                 .fullname(providerAttribute)
                 .gender(providerAttribute)
                 .givenName(providerAttribute)
                 .lastUpdateTime(providerAttribute)
                 .locale(providerAttribute)
                 .middleName(providerAttribute)
                 .nickname(providerAttribute)
                 .phoneNumber(providerAttribute)
                 .preferredUsername(providerAttribute)
                 .profilePage(providerAttribute)
                 .profilePicture(providerAttribute)
                 .timezone(providerAttribute)
                 .website(providerAttribute)
                 .build())
         .privateKey("privateKey")
         .privateKeyValue(secretValue)
         .scopes(List.of("scopes"))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	UserPoolIdentityProviderAppleProps.Builder	A builder for UserPoolIdentityProviderAppleProps
static final class	UserPoolIdentityProviderAppleProps.Jsii$Proxy	An implementation for UserPoolIdentityProviderAppleProps

Method Summary

Modifier and Type	Method	Description
static UserPoolIdentityProviderAppleProps.Builder	builder()
String	getClientId()	The client id recognized by Apple APIs.
String	getKeyId()	The keyId (of the same key, which content has to be later supplied as privateKey) for Apple APIs to authenticate the client.
default String	getPrivateKey()	Deprecated. use privateKeyValue
default SecretValue	getPrivateKeyValue()	The privateKey content for Apple APIs to authenticate the client.
default List<String>	getScopes()	The list of apple permissions to obtain for getting access to the apple profile.
String	getTeamId()	The teamId for Apple APIs to authenticate the client.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Methods inherited from interface software.amazon.awscdk.services.cognito.UserPoolIdentityProviderProps

getAttributeMapping, getUserPool

Method Details

getClientId

@Stability(Stable)
@NotNull
String getClientId()

The client id recognized by Apple APIs.

See Also:

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

getKeyId

@Stability(Stable)
@NotNull
String getKeyId()

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

getTeamId

@Stability(Stable)
@NotNull
String getTeamId()

The teamId for Apple APIs to authenticate the client.

getPrivateKey

@Stability(Deprecated)
@Deprecated
@Nullable
default String getPrivateKey()

Deprecated.

use privateKeyValue

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

Default: none

getPrivateKeyValue

@Stability(Stable)
@Nullable
default SecretValue getPrivateKeyValue()

The privateKey content for Apple APIs to authenticate the client.

Default: none

getScopes

@Stability(Stable)
@Nullable
default List<String> getScopes()

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

Default: [ name ]

See Also:

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

builder

@Stability(Stable)
static UserPoolIdentityProviderAppleProps.Builder builder()

Returns:

a UserPoolIdentityProviderAppleProps.Builder of UserPoolIdentityProviderAppleProps