aws-cdk-lib.aws_cognito.UserPoolIdentityProviderApple

class UserPoolIdentityProviderApple (construct)

LanguageType name
.NETAmazon.CDK.AWS.Cognito.UserPoolIdentityProviderApple
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awscognito#UserPoolIdentityProviderApple
Javasoftware.amazon.awscdk.services.cognito.UserPoolIdentityProviderApple
Pythonaws_cdk.aws_cognito.UserPoolIdentityProviderApple
TypeScript (source)aws-cdk-lib » aws_cognito » UserPoolIdentityProviderApple

Implements IConstruct, IDependable, IResource, 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 { aws_cognito as cognito } from 'aws-cdk-lib';

declare const providerAttribute: cognito.ProviderAttribute;
declare const userPool: cognito.UserPool;
const userPoolIdentityProviderApple = new cognito.UserPoolIdentityProviderApple(this, 'MyUserPoolIdentityProviderApple', {
  clientId: 'clientId',
  keyId: 'keyId',
  privateKey: 'privateKey',
  teamId: 'teamId',
  userPool: userPool,

  // the properties below are optional
  attributeMapping: {
    address: providerAttribute,
    birthdate: providerAttribute,
    custom: {
      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,
  },
  scopes: ['scopes'],
});

Initializer

new UserPoolIdentityProviderApple(scope: Construct, id: string, props: UserPoolIdentityProviderAppleProps)

Parameters

  • scope Construct
  • id string
  • props UserPoolIdentityProviderAppleProps

Construct Props

NameTypeDescription
clientIdstringThe client id recognized by Apple APIs.
keyIdstringThe keyId (of the same key, which content has to be later supplied as privateKey) for Apple APIs to authenticate the client.
privateKeystringThe privateKey content for Apple APIs to authenticate the client.
teamIdstringThe teamId for Apple APIs to authenticate the client.
userPoolIUserPoolThe user pool to which this construct provides identities.
attributeMapping?AttributeMappingMapping attributes from the identity provider to standard and custom attributes of the user pool.
scopes?string[]The list of apple permissions to obtain for getting access to the apple profile.

clientId

Type: string

The client id recognized by Apple APIs.

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


keyId

Type: string

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


privateKey

Type: string

The privateKey content for Apple APIs to authenticate the client.


teamId

Type: string

The teamId for Apple APIs to authenticate the client.


userPool

Type: IUserPool

The user pool to which this construct provides identities.


attributeMapping?

Type: AttributeMapping (optional, default: no attribute mapping)

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


scopes?

Type: string[] (optional, default: [ name ])

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

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

Properties

NameTypeDescription
envResourceEnvironmentThe environment this resource belongs to.
nodeNodeThe tree node.
providerNamestringThe primary identifier of this identity provider.
stackStackThe stack in which this resource is defined.

env

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.


node

Type: Node

The tree node.


providerName

Type: string

The primary identifier of this identity provider.


stack

Type: Stack

The stack in which this resource is defined.

Methods

NameDescription
applyRemovalPolicy(policy)Apply the given removal policy to this resource.
toString()Returns a string representation of this construct.
protected configureAttributeMapping()

applyRemovalPolicy(policy)

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

  • policy RemovalPolicy

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).


toString()

public toString(): string

Returns

  • string

Returns a string representation of this construct.


protected configureAttributeMapping()

protected configureAttributeMapping(): any

Returns

  • any