API.md

API Reference

Classes

Name	Description
UserPoolIdentityProviderGithub	GitHub OpenID Connect Wrapper for Cognito.

Interfaces

Name	Description
IUserPoolIdentityProviderGithubProps	No description

class UserPoolIdentityProviderGithub

GitHub OpenID Connect Wrapper for Cognito.

Implements: IConstruct, IConstruct, IConstruct, IDependable Extends: Construct

Initializer

new UserPoolIdentityProviderGithub(scope: Construct, id: string, props: IUserPoolIdentityProviderGithubProps)

• scope (Construct) No description
• id (string) No description
• props (IUserPoolIdentityProviderGithubProps) No description

Properties

Name	Type	Description
userPoolIdentityProvider	CfnUserPoolIdentityProvider

interface IUserPoolIdentityProviderGithubProps

Properties

Name	Type	Description
clientId	string	The client id recognized by Github APIs.
clientSecret	string	The client secret to be accompanied with clientId for Github APIs to authenticate the client.
cognitoHostedUiDomain	string	The Cognito hosted UI domain.
userPool	UserPool	The user pool.
gitBranch?	string	The branch of ther Git repository to clone for the GitHub wrapper. Optional
gitUrl?	string	The URL of the Git repository for the GitHub wrapper. Optional