Class UserPoolIdentityProviderApple

Represents an identity provider that integrates with Apple.

Inheritance

object

Resource

UserPoolIdentityProviderApple

Implements

IUserPoolIdentityProvider

IResource

IConstruct

IDependable

IEnvironmentAware

Inherited Members

Resource.IsOwnedResource(IConstruct)

Resource.IsResource(IConstruct)

Resource.ApplyRemovalPolicy(RemovalPolicy)

Resource.GeneratePhysicalName()

Resource.GetResourceArnAttribute(string, IArnComponents)

Resource.GetResourceNameAttribute(string)

Resource.Env

Resource.PhysicalName

Resource.Stack

Namespace: Amazon.CDK.AWS.Cognito

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class UserPoolIdentityProviderApple : Resource, IUserPoolIdentityProvider, IResource, IConstruct, IDependable, IEnvironmentAware

Syntax (vb)

Public Class UserPoolIdentityProviderApple Inherits Resource Implements IUserPoolIdentityProvider, IResource, IConstruct, IDependable, IEnvironmentAware

Remarks

Resource: AWS::Cognito::UserPoolIdentityProvider

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK;
             using Amazon.CDK.AWS.Cognito;

             ProviderAttribute providerAttribute;
             SecretValue secretValue;
             UserPool userPool;

             var userPoolIdentityProviderApple = new UserPoolIdentityProviderApple(this, "MyUserPoolIdentityProviderApple", new UserPoolIdentityProviderAppleProps {
                 ClientId = "clientId",
                 KeyId = "keyId",
                 TeamId = "teamId",
                 UserPool = userPool,

                 // the properties below are optional
                 AttributeMapping = new AttributeMapping {
                     Address = providerAttribute,
                     Birthdate = providerAttribute,
                     Custom = new Dictionary<string, ProviderAttribute> {
                         { "customKey", providerAttribute }
                     },
                     Email = providerAttribute,
                     EmailVerified = 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
                 },
                 PrivateKey = "privateKey",
                 PrivateKeyValue = secretValue,
                 Scopes = new [] { "scopes" }
             });

Synopsis

Constructors

UserPoolIdentityProviderApple(Construct, string, IUserPoolIdentityProviderAppleProps)

Represents an identity provider that integrates with Apple.

Properties

PROPERTY_INJECTION_ID	Uniquely identifies this class.
ProviderName	The primary identifier of this identity provider.

Methods

ConfigureAttributeMapping()

Represents an identity provider that integrates with Apple.

Constructors

UserPoolIdentityProviderApple(Construct, string, IUserPoolIdentityProviderAppleProps)

Represents an identity provider that integrates with Apple.

public UserPoolIdentityProviderApple(Construct scope, string id, IUserPoolIdentityProviderAppleProps props)

Parameters

scope Construct

id string

props IUserPoolIdentityProviderAppleProps

Remarks

Resource: AWS::Cognito::UserPoolIdentityProvider

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK;
             using Amazon.CDK.AWS.Cognito;

             ProviderAttribute providerAttribute;
             SecretValue secretValue;
             UserPool userPool;

             var userPoolIdentityProviderApple = new UserPoolIdentityProviderApple(this, "MyUserPoolIdentityProviderApple", new UserPoolIdentityProviderAppleProps {
                 ClientId = "clientId",
                 KeyId = "keyId",
                 TeamId = "teamId",
                 UserPool = userPool,

                 // the properties below are optional
                 AttributeMapping = new AttributeMapping {
                     Address = providerAttribute,
                     Birthdate = providerAttribute,
                     Custom = new Dictionary<string, ProviderAttribute> {
                         { "customKey", providerAttribute }
                     },
                     Email = providerAttribute,
                     EmailVerified = 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
                 },
                 PrivateKey = "privateKey",
                 PrivateKeyValue = secretValue,
                 Scopes = new [] { "scopes" }
             });

Properties

PROPERTY_INJECTION_ID

Uniquely identifies this class.

public static string PROPERTY_INJECTION_ID { get; }

Property Value

string

Remarks

Resource: AWS::Cognito::UserPoolIdentityProvider

ExampleMetadata: fixture=_generated

ProviderName

The primary identifier of this identity provider.

public virtual string ProviderName { get; }

Property Value

string

Remarks

Resource: AWS::Cognito::UserPoolIdentityProvider

ExampleMetadata: fixture=_generated

Methods

ConfigureAttributeMapping()

Represents an identity provider that integrates with Apple.

protected virtual object ConfigureAttributeMapping()

Returns

object

Remarks

Resource: AWS::Cognito::UserPoolIdentityProvider

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK;
             using Amazon.CDK.AWS.Cognito;

             ProviderAttribute providerAttribute;
             SecretValue secretValue;
             UserPool userPool;

             var userPoolIdentityProviderApple = new UserPoolIdentityProviderApple(this, "MyUserPoolIdentityProviderApple", new UserPoolIdentityProviderAppleProps {
                 ClientId = "clientId",
                 KeyId = "keyId",
                 TeamId = "teamId",
                 UserPool = userPool,

                 // the properties below are optional
                 AttributeMapping = new AttributeMapping {
                     Address = providerAttribute,
                     Birthdate = providerAttribute,
                     Custom = new Dictionary<string, ProviderAttribute> {
                         { "customKey", providerAttribute }
                     },
                     Email = providerAttribute,
                     EmailVerified = 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
                 },
                 PrivateKey = "privateKey",
                 PrivateKeyValue = secretValue,
                 Scopes = new [] { "scopes" }
             });

Implements

IUserPoolIdentityProvider

IResource

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware