Skip to content

Commit

Permalink
docs: update reference docs
Browse files Browse the repository at this point in the history
  • Loading branch information
tjanczuk committed Dec 20, 2023
1 parent 5310a6f commit ff4b0b2
Show file tree
Hide file tree
Showing 73 changed files with 357 additions and 286 deletions.
32 changes: 17 additions & 15 deletions docs/reference/letsgo-constants/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ Parameters that control the creation of an App Runner service and related AWS re

#### Defined in

[index.ts:510](https://github.com/47chapters/letsgo/blob/11c7e19/packages/constants/src/index.ts#L510)
[index.ts:520](https://github.com/47chapters/letsgo/blob/5310a6f/packages/constants/src/index.ts#L520)

___

Expand Down Expand Up @@ -108,11 +108,13 @@ configuration settings controling.
| `WorkerFunctionTimeout` | `string` | The maximum time in seconds the Lambda function of the _worker_ component can run before it is terminated. |
| `WorkerMessageRetentionPeriod` | `string` | The maximum time in seconds an unconsumed message can stay in the SQS queue of the _worker_ component before it is discarded. |
| `WorkerReceiveMessageWaitTime` | `string` | The time in seconds a request for a message from the SQS queue remains pending if no message is available to read. |
| `WorkerSchedule` | `string` | The EventBridge Scheduler expression that controls the timing of the scheduled invocation of the worker. Valid values are `cron({cron_expression})` and `rate({rate_expression})`, as documented in [CreateScheduleCommand](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-scheduler/Class/CreateScheduleCommand/). |
| `WorkerScheduleTimezone` | `string` | The time zone used by the EventBridge Scheduler expression that controls the timing of the scheduled invocation of the worker. Valid values are [IANA time zone IDs](https://nodatime.org/TimeZones). |
| `WorkerVisibilityTimeout` | `string` | The time in seconds a message remains invisible in the SQS queue of the _worker_ component if it did not confirm its processing. |

#### Defined in

[index.ts:76](https://github.com/47chapters/letsgo/blob/11c7e19/packages/constants/src/index.ts#L76)
[index.ts:76](https://github.com/47chapters/letsgo/blob/5310a6f/packages/constants/src/index.ts#L76)

___

Expand All @@ -124,7 +126,7 @@ Parameters that control the creation of the _database_ component.

#### Defined in

[index.ts:581](https://github.com/47chapters/letsgo/blob/11c7e19/packages/constants/src/index.ts#L581)
[index.ts:591](https://github.com/47chapters/letsgo/blob/5310a6f/packages/constants/src/index.ts#L591)

___

Expand All @@ -136,7 +138,7 @@ The default LetsGo deployment name used by LetsGo CLI commands.

#### Defined in

[index.ts:28](https://github.com/47chapters/letsgo/blob/11c7e19/packages/constants/src/index.ts#L28)
[index.ts:28](https://github.com/47chapters/letsgo/blob/5310a6f/packages/constants/src/index.ts#L28)

___

Expand All @@ -148,7 +150,7 @@ The default AWS region used by LetsGo CLI commands.

#### Defined in

[index.ts:23](https://github.com/47chapters/letsgo/blob/11c7e19/packages/constants/src/index.ts#L23)
[index.ts:23](https://github.com/47chapters/letsgo/blob/5310a6f/packages/constants/src/index.ts#L23)

___

Expand All @@ -160,7 +162,7 @@ Default validity period of the invitations to join a tenant.

#### Defined in

[index.ts:39](https://github.com/47chapters/letsgo/blob/11c7e19/packages/constants/src/index.ts#L39)
[index.ts:39](https://github.com/47chapters/letsgo/blob/5310a6f/packages/constants/src/index.ts#L39)

___

Expand All @@ -173,7 +175,7 @@ used when creating JWTs using the built-in PKI issuer.

#### Defined in

[index.ts:34](https://github.com/47chapters/letsgo/blob/11c7e19/packages/constants/src/index.ts#L34)
[index.ts:34](https://github.com/47chapters/letsgo/blob/5310a6f/packages/constants/src/index.ts#L34)

___

Expand All @@ -185,7 +187,7 @@ Default version of of Stripe APIs called and Stripe webhooks accepted.

#### Defined in

[index.ts:44](https://github.com/47chapters/letsgo/blob/11c7e19/packages/constants/src/index.ts#L44)
[index.ts:44](https://github.com/47chapters/letsgo/blob/5310a6f/packages/constants/src/index.ts#L44)

___

Expand All @@ -197,7 +199,7 @@ The name of the Stripe metadata tag that contains the LetsGo identity ID added t

#### Defined in

[index.ts:54](https://github.com/47chapters/letsgo/blob/11c7e19/packages/constants/src/index.ts#L54)
[index.ts:54](https://github.com/47chapters/letsgo/blob/5310a6f/packages/constants/src/index.ts#L54)

___

Expand All @@ -209,7 +211,7 @@ The name of the Stripe metadata tag that contains the LetsGo plan ID added to St

#### Defined in

[index.ts:59](https://github.com/47chapters/letsgo/blob/11c7e19/packages/constants/src/index.ts#L59)
[index.ts:59](https://github.com/47chapters/letsgo/blob/5310a6f/packages/constants/src/index.ts#L59)

___

Expand All @@ -221,7 +223,7 @@ The name of the Stripe metadata tag that contains the LetsGo tenant ID added to

#### Defined in

[index.ts:49](https://github.com/47chapters/letsgo/blob/11c7e19/packages/constants/src/index.ts#L49)
[index.ts:49](https://github.com/47chapters/letsgo/blob/5310a6f/packages/constants/src/index.ts#L49)

___

Expand All @@ -243,7 +245,7 @@ Names of AWS tags added to all AWS resources created by LetsGo.

#### Defined in

[index.ts:64](https://github.com/47chapters/letsgo/blob/11c7e19/packages/constants/src/index.ts#L64)
[index.ts:64](https://github.com/47chapters/letsgo/blob/5310a6f/packages/constants/src/index.ts#L64)

___

Expand All @@ -257,7 +259,7 @@ Changing this value once the artifacts had been deployed is not supported.

#### Defined in

[index.ts:18](https://github.com/47chapters/letsgo/blob/11c7e19/packages/constants/src/index.ts#L18)
[index.ts:18](https://github.com/47chapters/letsgo/blob/5310a6f/packages/constants/src/index.ts#L18)

___

Expand All @@ -269,7 +271,7 @@ Parameters that control the creation of an App Runner service and related AWS re

#### Defined in

[index.ts:537](https://github.com/47chapters/letsgo/blob/11c7e19/packages/constants/src/index.ts#L537)
[index.ts:547](https://github.com/47chapters/letsgo/blob/5310a6f/packages/constants/src/index.ts#L547)

___

Expand All @@ -281,4 +283,4 @@ Parameters that control the creation of AWS resources related to the _worker_ co

#### Defined in

[index.ts:711](https://github.com/47chapters/letsgo/blob/11c7e19/packages/constants/src/index.ts#L711)
[index.ts:741](https://github.com/47chapters/letsgo/blob/5310a6f/packages/constants/src/index.ts#L741)
24 changes: 12 additions & 12 deletions docs/reference/letsgo-constants/interfaces/AppRunnerSettings.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ The name of the component for which an AppRunner service is created (`web` or `a

#### Defined in

[index.ts:342](https://github.com/47chapters/letsgo/blob/11c7e19/packages/constants/src/index.ts#L342)
[index.ts:352](https://github.com/47chapters/letsgo/blob/5310a6f/packages/constants/src/index.ts#L352)

___

Expand All @@ -43,7 +43,7 @@ Returns the default configuration settings for the component.

#### Defined in

[index.ts:415](https://github.com/47chapters/letsgo/blob/11c7e19/packages/constants/src/index.ts#L415)
[index.ts:425](https://github.com/47chapters/letsgo/blob/5310a6f/packages/constants/src/index.ts#L425)

___

Expand Down Expand Up @@ -71,7 +71,7 @@ AppRunner Auto Scaling Configuration name

#### Defined in

[index.ts:400](https://github.com/47chapters/letsgo/blob/11c7e19/packages/constants/src/index.ts#L400)
[index.ts:410](https://github.com/47chapters/letsgo/blob/5310a6f/packages/constants/src/index.ts#L410)

___

Expand Down Expand Up @@ -99,7 +99,7 @@ AppRunner service name

#### Defined in

[index.ts:394](https://github.com/47chapters/letsgo/blob/11c7e19/packages/constants/src/index.ts#L394)
[index.ts:404](https://github.com/47chapters/letsgo/blob/5310a6f/packages/constants/src/index.ts#L404)

___

Expand Down Expand Up @@ -127,7 +127,7 @@ ECR repository name

#### Defined in

[index.ts:382](https://github.com/47chapters/letsgo/blob/11c7e19/packages/constants/src/index.ts#L382)
[index.ts:392](https://github.com/47chapters/letsgo/blob/5310a6f/packages/constants/src/index.ts#L392)

___

Expand Down Expand Up @@ -158,7 +158,7 @@ IAM inline policy document

#### Defined in

[index.ts:365](https://github.com/47chapters/letsgo/blob/11c7e19/packages/constants/src/index.ts#L365)
[index.ts:375](https://github.com/47chapters/letsgo/blob/5310a6f/packages/constants/src/index.ts#L375)

___

Expand Down Expand Up @@ -186,7 +186,7 @@ Local Docker image name (without the tag)

#### Defined in

[index.ts:388](https://github.com/47chapters/letsgo/blob/11c7e19/packages/constants/src/index.ts#L388)
[index.ts:398](https://github.com/47chapters/letsgo/blob/5310a6f/packages/constants/src/index.ts#L398)

___

Expand Down Expand Up @@ -215,7 +215,7 @@ Number of days to retain CloudWatch logs.

#### Defined in

[index.ts:407](https://github.com/47chapters/letsgo/blob/11c7e19/packages/constants/src/index.ts#L407)
[index.ts:417](https://github.com/47chapters/letsgo/blob/5310a6f/packages/constants/src/index.ts#L417)

___

Expand Down Expand Up @@ -244,7 +244,7 @@ Array of managed IAM policy ARNs

#### Defined in

[index.ts:376](https://github.com/47chapters/letsgo/blob/11c7e19/packages/constants/src/index.ts#L376)
[index.ts:386](https://github.com/47chapters/letsgo/blob/5310a6f/packages/constants/src/index.ts#L386)

___

Expand Down Expand Up @@ -273,7 +273,7 @@ IAM policy name

#### Defined in

[index.ts:356](https://github.com/47chapters/letsgo/blob/11c7e19/packages/constants/src/index.ts#L356)
[index.ts:366](https://github.com/47chapters/letsgo/blob/5310a6f/packages/constants/src/index.ts#L366)

___

Expand Down Expand Up @@ -302,7 +302,7 @@ IAM role name

#### Defined in

[index.ts:349](https://github.com/47chapters/letsgo/blob/11c7e19/packages/constants/src/index.ts#L349)
[index.ts:359](https://github.com/47chapters/letsgo/blob/5310a6f/packages/constants/src/index.ts#L359)

___

Expand All @@ -314,4 +314,4 @@ Returns the name of the environment variable containing the public URL of the Ap

#### Defined in

[index.ts:411](https://github.com/47chapters/letsgo/blob/11c7e19/packages/constants/src/index.ts#L411)
[index.ts:421](https://github.com/47chapters/letsgo/blob/5310a6f/packages/constants/src/index.ts#L421)
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ The amount of CPU allocated to a single instance of the component.

#### Defined in

[index.ts:306](https://github.com/47chapters/letsgo/blob/11c7e19/packages/constants/src/index.ts#L306)
[index.ts:316](https://github.com/47chapters/letsgo/blob/5310a6f/packages/constants/src/index.ts#L316)

___

Expand All @@ -47,7 +47,7 @@ The number of consecutive successful health checks before the instance of the co

#### Defined in

[index.ts:328](https://github.com/47chapters/letsgo/blob/11c7e19/packages/constants/src/index.ts#L328)
[index.ts:338](https://github.com/47chapters/letsgo/blob/5310a6f/packages/constants/src/index.ts#L338)

___

Expand All @@ -59,7 +59,7 @@ Frequency in seconds of the App Runner health check for the component.

#### Defined in

[index.ts:319](https://github.com/47chapters/letsgo/blob/11c7e19/packages/constants/src/index.ts#L319)
[index.ts:329](https://github.com/47chapters/letsgo/blob/5310a6f/packages/constants/src/index.ts#L329)

___

Expand All @@ -72,7 +72,7 @@ if the instance of the component is healthy.

#### Defined in

[index.ts:315](https://github.com/47chapters/letsgo/blob/11c7e19/packages/constants/src/index.ts#L315)
[index.ts:325](https://github.com/47chapters/letsgo/blob/5310a6f/packages/constants/src/index.ts#L325)

___

Expand All @@ -85,7 +85,7 @@ it is considered failed.

#### Defined in

[index.ts:324](https://github.com/47chapters/letsgo/blob/11c7e19/packages/constants/src/index.ts#L324)
[index.ts:334](https://github.com/47chapters/letsgo/blob/5310a6f/packages/constants/src/index.ts#L334)

___

Expand All @@ -97,7 +97,7 @@ The number of consecutive failed health checks before the instance of the compon

#### Defined in

[index.ts:332](https://github.com/47chapters/letsgo/blob/11c7e19/packages/constants/src/index.ts#L332)
[index.ts:342](https://github.com/47chapters/letsgo/blob/5310a6f/packages/constants/src/index.ts#L342)

___

Expand All @@ -109,7 +109,7 @@ The maximum number of concurrent HTTP requests processed by a single instance of

#### Defined in

[index.ts:302](https://github.com/47chapters/letsgo/blob/11c7e19/packages/constants/src/index.ts#L302)
[index.ts:312](https://github.com/47chapters/letsgo/blob/5310a6f/packages/constants/src/index.ts#L312)

___

Expand All @@ -121,7 +121,7 @@ The maxium number of instances of the component.

#### Defined in

[index.ts:298](https://github.com/47chapters/letsgo/blob/11c7e19/packages/constants/src/index.ts#L298)
[index.ts:308](https://github.com/47chapters/letsgo/blob/5310a6f/packages/constants/src/index.ts#L308)

___

Expand All @@ -133,7 +133,7 @@ The amount of memory allocated to a single instance of the component.

#### Defined in

[index.ts:310](https://github.com/47chapters/letsgo/blob/11c7e19/packages/constants/src/index.ts#L310)
[index.ts:320](https://github.com/47chapters/letsgo/blob/5310a6f/packages/constants/src/index.ts#L320)

___

Expand All @@ -145,4 +145,4 @@ The minimum number of instances of the component to keep running at all times.

#### Defined in

[index.ts:294](https://github.com/47chapters/letsgo/blob/11c7e19/packages/constants/src/index.ts#L294)
[index.ts:304](https://github.com/47chapters/letsgo/blob/5310a6f/packages/constants/src/index.ts#L304)
2 changes: 1 addition & 1 deletion docs/reference/letsgo-constants/interfaces/DBSettings.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,4 +36,4 @@ DynamoDB table name

#### Defined in

[index.ts:575](https://github.com/47chapters/letsgo/blob/11c7e19/packages/constants/src/index.ts#L575)
[index.ts:585](https://github.com/47chapters/letsgo/blob/5310a6f/packages/constants/src/index.ts#L585)
Loading

0 comments on commit ff4b0b2

Please sign in to comment.