API.md

API Reference

Constructs

RemixApp

Initializers

import { RemixApp } from '@rogerchi/cdk-remix-app'

new RemixApp(scope: Construct, id: string, __2: RemixAppProps)

Name	Type	Description
scope	constructs.Construct	No description.
id	string	No description.
__2	RemixAppProps	No description.

---

scope^Required

• Type: constructs.Construct

---

id^Required

• Type: string

---

__2^Required

• Type: RemixAppProps

---

Methods

Name	Description
toString	Returns a string representation of this construct.

---

toString

public toString(): string

Returns a string representation of this construct.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.

---

isConstruct

import { RemixApp } from '@rogerchi/cdk-remix-app'

RemixApp.isConstruct(x: any)

Checks if x is a construct.

x^Required

• Type: any

Any object.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
cdnDistributionId	string	No description.
cdnDomainName	string	No description.
handler	aws-cdk-lib.aws_lambda.Function	No description.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

cdnDistributionId^Required

public readonly cdnDistributionId: string;

• Type: string

---

cdnDomainName^Required

public readonly cdnDomainName: string;

• Type: string

---

handler^Required

public readonly handler: Function;

• Type: aws-cdk-lib.aws_lambda.Function

---

Structs

RemixAppProps

Initializer

import { RemixAppProps } from '@rogerchi/cdk-remix-app'

const remixAppProps: RemixAppProps = { ... }

Properties

Name	Type	Description
remixPath	string	No description.
cognitoAuth	RemixCognitoAuthProps	No description.
customDomain	RemixCustomDomainProps	No description.
ddbSessions	boolean	No description.
isDev	boolean	No description.

---

remixPath^Required

public readonly remixPath: string;

• Type: string

---

cognitoAuth^Optional

public readonly cognitoAuth: RemixCognitoAuthProps;

• Type: RemixCognitoAuthProps

---

customDomain^Optional

public readonly customDomain: RemixCustomDomainProps;

• Type: RemixCustomDomainProps

---

ddbSessions^Optional

public readonly ddbSessions: boolean;

• Type: boolean

---

isDev^Optional

public readonly isDev: boolean;

• Type: boolean

---

RemixCognitoAuthProps

Initializer

import { RemixCognitoAuthProps } from '@rogerchi/cdk-remix-app'

const remixCognitoAuthProps: RemixCognitoAuthProps = { ... }

Properties

Name	Type	Description
authDomain	string	No description.
userPool	aws-cdk-lib.aws_cognito.IUserPool	No description.

---

authDomain^Required

public readonly authDomain: string;

• Type: string

---

userPool^Required

public readonly userPool: IUserPool;

• Type: aws-cdk-lib.aws_cognito.IUserPool

---

RemixCustomDomainProps

Initializer

import { RemixCustomDomainProps } from '@rogerchi/cdk-remix-app'

const remixCustomDomainProps: RemixCustomDomainProps = { ... }

Properties

Name	Type	Description
certificate	aws-cdk-lib.aws_certificatemanager.ICertificate	No description.
domainName	string	No description.

---

certificate^Required

public readonly certificate: ICertificate;

• Type: aws-cdk-lib.aws_certificatemanager.ICertificate

---

domainName^Required

public readonly domainName: string;

• Type: string

---