@openfabr/cdf / Exports / awscdk
Namespace: awscdk
Table of contents
For project creators
For project creators
• ProjectStack<IPC, GC, NC, CC, SC, RC>: Object
Stack as top-level construct with AWS CDK as IaC runtime.
Type parameters
| Name | Type |
|---|---|
IPC | extends InfraPlanConstructs |
GC | extends GeneralConfig |
NC | extends NetworkConfig |
CC | extends ComponentConfig |
SC | extends ServiceConfig |
RC | extends RelationConfig |
Defined in
src/lib/bootstrap/awscdk/stack.ts:37
• ProjectStackProps<IPC, GC, NC, CC, SC, RC>: Object
Properties for ProjectStack.
Type parameters
| Name | Type |
|---|---|
IPC | extends InfraPlanConstructs |
GC | extends GeneralConfig |
NC | extends NetworkConfig |
CC | extends ComponentConfig |
SC | extends ServiceConfig |
RC | extends RelationConfig |
Defined in
src/lib/bootstrap/awscdk/stack.ts:21
initProjectStack
▸ initProjectStack<IPC, GC, NC, CC, SC, RC>(scope, config, planner, modules, name?): ProjectStack<IPC, GC, NC, CC, SC, RC>
Convenient function that constructs a top-level stack with AWS CDK as IaC runtime.
Type parameters
| Name | Type |
|---|---|
IPC | extends InfraPlanConstructs |
GC | extends GeneralConfig |
NC | extends NetworkConfig |
CC | extends ComponentConfig |
SC | extends ServiceConfig |
RC | extends RelationConfig |
Parameters
| Name | Type | Description |
|---|---|---|
scope | App | Parent construct, usually an App instance in AWS CDK. |
config | InfraConfig<GC, NC, CC, SC, RC> | The project configuration. |
planner | Planner<IPC, GC, NC, CC, SC, RC> | The planner offered by the package. |
modules | Custom<IPC, GC, NC, CC, SC, RC>[] | Custom code modules for the project. |
name? | string | Optionally the name of the resulting stack. |
Returns
ProjectStack<IPC, GC, NC, CC, SC, RC>
A top-level stack to be provisioned in a project.