L2 Construct

UserPoolIdentityProviderApple

Represents an identity provider that integrates with Apple.

Import

import { UserPoolIdentityProviderApple } from 'aws-cdk-lib/aws-cognito';

Or use the module namespace:

import * as cognito from 'aws-cdk-lib/aws-cognito';
// cognito.UserPoolIdentityProviderApple

Configuration passed to the constructor as UserPoolIdentityProviderAppleProps.

clientIdRequired

string

The client id recognized by Apple APIs.

keyIdRequired

string

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

teamIdRequired

string

The teamId for Apple APIs to authenticate the client.

privateKeyOptionalDeprecated

string

The privateKey content for Apple APIs to authenticate the client.

Default: none

Deprecated: use privateKeyValue

privateKeyValueOptional

SecretValue

The privateKey content for Apple APIs to authenticate the client.

Default: none

scopesOptional

string[]

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

Default: [ name ]

2 properties inherited from UserPoolIdentityProviderProps

userPoolRequiredinherited from UserPoolIdentityProviderProps

IUserPool

The user pool to which this construct provides identities.

attributeMappingOptionalinherited from UserPoolIdentityProviderProps

AttributeMapping

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

Default: - no attribute mapping

Everything you need to know about Amazon Cognito on one page. HD quality, print-friendly.

LevelL2 (Higher-level)

Moduleaws-cognito

Properties8