@letsgo/constants
This package defines constants that change infrequently:
- naming patterns of AWS resources created by LetsGo,
- IAM policies for the components created by LetsGo,
- default values for configuration settings,
- other infrequently changing configuration values.
- AppRunnerSettings
- AppRunnerSettingsDefaultConfig
- DBSettings
- DefaultConfig
- WorkerSettings
- WorkerSettingsDefaultConfig
- ApiConfiguration
- ConfigSettings
- DBConfiguration
- DefaultDeployment
- DefaultRegion
- InvitationTtl
- StaticJwtAudience
- StripeApiVersion
- StripeIdentityIdMetadataKey
- StripePlanIdMetadataKey
- StripeTenantIdMetadataKey
- TagKeys
- VendorPrefix
- WebConfiguration
- WorkerConfiguration
• Const ApiConfiguration: AppRunnerSettings
Parameters that control the creation of an App Runner service and related AWS resources for the API component.
• Const ConfigSettings: Object
Names of environment variables regognized by LetsGo components which contain configuration settings controling.
| Name | Type | Description |
|---|---|---|
ApiAppRunnerAudience |
string |
The OAuth audience value expected in the access tokens used to access the HTTP API. |
ApiAppRunnerCpu |
string |
The amount of CPU allocated to a single instance of the API component. |
ApiAppRunnerHealthHealthyThreshold |
string |
The number of consecutive successful health checks before the instance of the API component is considered healthy. |
ApiAppRunnerHealthInterval |
string |
Frequency in seconds of the App Runner health check for the API component. |
ApiAppRunnerHealthPath |
string |
The path of the HTTP endpoint used by the App Runner health check to determine if the instance of the API component is healthy. |
ApiAppRunnerHealthTimeout |
string |
The maximum time in seconds the App Runner healh check for the _API component can take before it is considered failed. |
ApiAppRunnerHealthUnhealthyThreshold |
string |
The number of consecutive failed health checks before the instance of the API component is considered unhealthy. |
ApiAppRunnerMaxConcurrency |
string |
The maximum number of concurrent HTTP requests processed by a single instance of the API component. |
ApiAppRunnerMaxSize |
string |
The maxium number of instances of the API component. |
ApiAppRunnerMemory |
string |
The amount of memory allocated to a single instance of the API component. |
ApiAppRunnerMinSize |
string |
The minimum number of instances of the API component to keep running at all times. |
ApiAppRunnerUrl |
string |
Public URL of the API component. |
Auth0Audience |
string |
The OAuth audience value expected in the access tokens used to access the web component. |
Auth0BaseUrl |
string |
The base URL of the web component Auth0 uses to redirect the user to after completed authentication. |
Auth0ClientId |
string |
The OAuth client ID of the Auth0 application used by the web component to authenticate users. |
Auth0ClientSecret |
string |
The OAuth client secret of the Auth0 application used by the web component to authenticate users. |
Auth0IssuerBaseUrl |
string |
The base URL of the Auth0 tenant used by the web component to authenticate users. |
Auth0Scope |
string |
The OAuth scope value requested from Auth0 when initiating the login transaction. |
Auth0Secret |
string |
A secret used to encrypt the Auth0 cookie used by the web component to represent a logged in user. |
SlackUrl |
string |
The Slack incoming webhook URL used by LetsGo to send notifications. |
StripeLiveMode |
string |
Determines if the Stripe live or test mode us used. Any value other than 1 means the test mode is used. |
StripeLivePublicKey |
string |
The Stripe public key used by LetsGo when running in live mode. |
StripeLiveSecretKey |
string |
The Stripe secret key used by LetsGo when running in live mode. |
StripeLiveWebhookKey |
string |
The Stripe webhook secret used by LetsGo when running in live mode. |
StripeTestPublicKey |
string |
The Stripe public key used by LetsGo when running in test mode. |
StripeTestSecretKey |
string |
The Stripe secret key used by LetsGo when running in test mode. |
StripeTestWebhookKey |
string |
The Stripe webhook secret used by LetsGo when running in test mode. |
WebAppRunnerCpu |
string |
The amount of CPU allocated to a single instance of the web component. |
WebAppRunnerHealthHealthyThreshold |
string |
The number of consecutive successful health checks before the instance of the web component is considered healthy. |
WebAppRunnerHealthInterval |
string |
Frequency in seconds of the App Runner health check for the web component. |
WebAppRunnerHealthPath |
string |
The path of the HTTP endpoint used by the App Runner health check to determine if the instance of the web component is healthy. |
WebAppRunnerHealthTimeout |
string |
The maximum time in seconds the App Runner healh check for the web component can take before it is considered failed. |
WebAppRunnerHealthUnhealthyThreshold |
string |
The number of consecutive failed health checks before the instance of the web component is considered unhealthy. |
WebAppRunnerMaxConcurrency |
string |
The maximum number of concurrent HTTP requests processed by a single instance of the web component. |
WebAppRunnerMaxSize |
string |
The maxium number of instances of the web component. |
WebAppRunnerMemory |
string |
The amount of memory allocated to a single instance of the web component. |
WebAppRunnerMinSize |
string |
The minimum number of instances of the web component to keep running at all times. |
WebAppRunnerUrl |
string |
The public URL of the Web component. |
WorkerBatchSize |
string |
The maximum number of messages the worker component can process in a single invocation of the Lambda function. |
WorkerBatchingWindow |
string |
The maximum time in seconds the worker component waits for more messages to arrive before processing the batch. |
WorkerCuncurrency |
string |
The maximum number of concurrent instances of the worker component. This number multipled by the WorkerBatchSize is the upper bound on the number of concurrently processed messages. |
WorkerFunctionEphemeralStorage |
string |
The amount of ephemeral storage allocated to the Lambda function of the worker component, available in the /tmp directory. |
WorkerFunctionMemory |
string |
The amount of memory allocated to the Lambda function of the worker component. |
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. |
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. |
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. |
• Const DBConfiguration: DBSettings
Parameters that control the creation of the database component.
• Const DefaultDeployment: string
The default LetsGo deployment name used by LetsGo CLI commands.
• Const DefaultRegion: string
The default AWS region used by LetsGo CLI commands.
• Const InvitationTtl: number
Default validity period of the invitations to join a tenant.
• Const StaticJwtAudience: "letsgo:service"
The default OAuth audience value expected in the access tokens, as well as the default audience value
used when creating JWTs using the built-in PKI issuer.
• Const StripeApiVersion: "2023-10-16"
Default version of of Stripe APIs called and Stripe webhooks accepted.
• Const StripeIdentityIdMetadataKey: "letsgo-identityId"
The name of the Stripe metadata tag that contains the LetsGo identity ID added to Stripe subscriptions.
• Const StripePlanIdMetadataKey: "letsgo-planId"
The name of the Stripe metadata tag that contains the LetsGo plan ID added to Stripe subscriptions.
• Const StripeTenantIdMetadataKey: "letsgo-tenantId"
The name of the Stripe metadata tag that contains the LetsGo tenant ID added to Stripe subscriptions.
• Const TagKeys: Object
Names of AWS tags added to all AWS resources created by LetsGo.
| Name | Type |
|---|---|
LetsGoComponent |
string |
LetsGoDeployment |
string |
LetsGoRegion |
string |
LetsGoUpdated |
string |
LetsGoVersion |
string |
• Const VendorPrefix: "letsgo"
The prefix of the name of all AWS resources created by LetsGo. You may want to change it to something unique to your organization or application. However, you can only do so before you create your first deployment. Changing this value once the artifacts had been deployed is not supported.
• Const WebConfiguration: AppRunnerSettings
Parameters that control the creation of an App Runner service and related AWS resources for the web component.
• Const WorkerConfiguration: WorkerSettings
Parameters that control the creation of AWS resources related to the worker component.