# Packages
Package clbackbone provdes constructs for interacting with the backbone platform infrastructure.
No description provided by the author
No description provided by the author
No description provided by the author
# Functions
BaseZoneAndCerts implements the logic for returing HostedZone and certificate constructs from just attrbutes (without lookups).
EnvironmentFromScope retrieves the instance name from the context or an empty string.
FormatDockerImageTag standardizes how docker images in the repositories are called given the project qualifier, the dockerTarget name and the version.
InstanceFromScope retrieves the instance name from the context or an empty string.
NewConfig initializes a config implementation given the provided values.
NewConventions inits a convention instance.
NewInstancedStack standardizes the creation of a stack based on three context string parameters: qualifier, instance and environment.
NewInstancedStackV1 requires a "instance" context variable to allow different copies of the stack to exist in the same AWS account.
NewRegionalInstancedStack represents a stack of which multiple may exist per region.
NewRegionalSingletonStack represents a stack of which only one exists per region but multiple may exist per account.
NewSingletonStackV1 requires a "instance" context variable to allow different copies of the stack to exist in the same AWS account.
NewStagingConfig provides a config that provides easy-to-use defeaults for a staging environment.
QualifierFromScope retrieves the qualifier from the context or an empty string.
VersionFromScope retrieves the instance name from the context or an empty string.
WithDeletionProtection config.
WithDomainRecordTTL config.
WithEdgeCertificateArn config.
WithGatewayDisableExecuteApi config.
WithGatewayDomain will setup a domain for the gateway on the provided hosted zone.
WithGatewayThrottlingBurstLimit config.
WithGatewayThrottlingRateLimit config.
WithLambdaApplicationLogLevel config.
WithLambdaProvisionedConcurrency config.
WithLambdaReservedConcurrency config.
WithLambdaSystemLogLevel config.
WithLambdaTimeout config.
WithLogRetention config.
WithMainDomainHostedZoneID config.
WithMainDomainName config.
WithMainIPSpace config.
WithNativeLambda creates a lambda for code that compiles Natively (such as Go).
WithNetwork sets up our vpc and other networking.
WithNodeLambbda creates a NodeJS lambda with a default alias.
WithOpenApiGateway creates a gateway that is defined by an OpenAPI definition while proxying all requests to a single Lambda Handler.
withPostgresInstance will ensure an AWS RDS postgres instance is either created or imported.
WithPostgresTenant creates a tenant with.
WithProxyGateway will setup a gateway that proxies all requests to a Lambda, with logging and tracing enabled.
WithRegionalCertificateArn config.
WithRemovalPolicy config.
WithRemovalPolicyIfSnapshotable config.
# Variables
RegionAcronyms holds acronyms for building CDK identifiers.
# Interfaces
Config describes the providing of resource configuration that is often convenient to be shared between branches of the resource tree.
Conventions describes the interface for retrieving info that needs to be consistent between the stack and the other programs, i.e: magefiles.
PostgresTenant provides an interface to retrieve information on a unique tenant in a postgres database.