Package software.amazon.awscdk.services.cognito

Class UserPoolIdentityProviderApple

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.cognito.UserPoolIdentityProviderApple

All Implemented Interfaces:

IConstruct, IDependable, IResource, IUserPoolIdentityProvider, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:44.080Z")
@Stability(Stable)
public class UserPoolIdentityProviderApple
extends Resource
implements IUserPoolIdentityProvider

Represents a identity provider that integrates with 'Apple'.

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;
 UserPoolIdentityProviderApple userPoolIdentityProviderApple = UserPoolIdentityProviderApple.Builder.create(this, "MyUserPoolIdentityProviderApple")
         .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	Class	Description
static final class	UserPoolIdentityProviderApple.Builder	A fluent builder for UserPoolIdentityProviderApple.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IResource

IResource.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.cognito.IUserPoolIdentityProvider

IUserPoolIdentityProvider.Jsii$Default, IUserPoolIdentityProvider.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	UserPoolIdentityProviderApple(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	UserPoolIdentityProviderApple(software.amazon.jsii.JsiiObjectRef objRef)
	UserPoolIdentityProviderApple(software.constructs.Construct scope, String id, UserPoolIdentityProviderAppleProps props)

Method Summary

Modifier and Type	Method	Description
protected Object	configureAttributeMapping()
String	getProviderName()	The primary identifier of this identity provider.

Methods inherited from class software.amazon.awscdk.core.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isResource

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class software.constructs.Construct

toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awscdk.core.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.core.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

UserPoolIdentityProviderApple

protected UserPoolIdentityProviderApple(software.amazon.jsii.JsiiObjectRef objRef)

UserPoolIdentityProviderApple

protected UserPoolIdentityProviderApple(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

UserPoolIdentityProviderApple

@Stability(Stable)
public UserPoolIdentityProviderApple(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 UserPoolIdentityProviderAppleProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Details

configureAttributeMapping

@Stability(Stable)
@NotNull
protected Object configureAttributeMapping()

getProviderName

@Stability(Stable)
@NotNull
public String getProviderName()

The primary identifier of this identity provider.

Specified by:

getProviderName in interface IUserPoolIdentityProvider