Interface UserPoolIdentityProviderAppleProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
,UserPoolIdentityProviderProps
- All Known Implementing Classes:
UserPoolIdentityProviderAppleProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.102.0 (build e354887)",
date="2024-09-06T01:36:25.614Z")
@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.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 ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forUserPoolIdentityProviderAppleProps
static final class
An implementation forUserPoolIdentityProviderAppleProps
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
The client id recognized by Apple APIs.getKeyId()
The keyId (of the same key, which content has to be later supplied asprivateKey
) for Apple APIs to authenticate the client.The privateKey content for Apple APIs to authenticate the client.The list of apple permissions to obtain for getting access to the apple profile.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
The client id recognized by Apple APIs.- See Also:
-
getKeyId
The keyId (of the same key, which content has to be later supplied asprivateKey
) for Apple APIs to authenticate the client. -
getPrivateKey
The privateKey content for Apple APIs to authenticate the client. -
getTeamId
The teamId for Apple APIs to authenticate the client. -
getScopes
The list of apple permissions to obtain for getting access to the apple profile.Default: [ name ]
- See Also:
-
builder
-