@openfabr/cdf / Exports / pulumi
Namespace: pulumi
Table of contents
For project creators
For project creators
• ProjectComponent<IPC, GC, NC, CC, SC, RC>: Object
Component as top-level construct with pulumi 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/pulumi/component.ts:37
• ProjectComponentOpts<IPC, GC, NC, CC, SC, RC>: Object
Properties for ProjectComponent.
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/pulumi/component.ts:20
initProjectComponent
▸ initProjectComponent<IPC, GC, NC, CC, SC, RC>(config, planner, modules, name?, handler?): ProjectComponent<IPC, GC, NC, CC, SC, RC>
Convenient function that constructs a top-level component with pulumi 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 |
|---|---|---|
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 component. |
handler? | ResultHandler | Optionally the result handler. |
Returns
ProjectComponent<IPC, GC, NC, CC, SC, RC>
A top-level component to be provisioned in a project.