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.71.0 (build f1f58ae)",
           date="2022-12-07T17:24:44.638Z")
 @Stability(value=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.services.cognito.*;
 ProviderAttribute providerAttribute;
 UserPool userPool;
 UserPoolIdentityProviderAppleProps userPoolIdentityProviderAppleProps = UserPoolIdentityProviderAppleProps.builder()
         .clientId("clientId")
         .keyId("keyId")
         .privateKey("privateKey")
         .teamId("teamId")
         .userPool(userPool)
         // the properties below are optional
         .attributeMapping(AttributeMapping.builder()
                 .address(providerAttribute)
                 .birthdate(providerAttribute)
                 .custom(Map.of(
                         "customKey", providerAttribute))
                 .email(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())
         .scopes(List.of("scopes"))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and 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.
String	getPrivateKey() 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.awscdk.services.cognito.UserPoolIdentityProviderProps

getAttributeMapping, getUserPool

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getClientId

@Stability(value=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(value=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.

getPrivateKey

@Stability(value=Stable)
 @NotNull
String getPrivateKey()

The privateKey content for Apple APIs to authenticate the client.

getTeamId

@Stability(value=Stable)
 @NotNull
String getTeamId()

The teamId for Apple APIs to authenticate the client.

getScopes

@Stability(value=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(value=Stable)
static UserPoolIdentityProviderAppleProps.Builder builder()

Specified by:

builder in interface UserPoolIdentityProviderProps

Returns:

a UserPoolIdentityProviderAppleProps.Builder of UserPoolIdentityProviderAppleProps