Skip to content

@openfabr/cdf / Exports / pulumi / ProjectComponent

Class: ProjectComponent<IPC, GC, NC, CC, SC, RC>

pulumi.ProjectComponent

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

Hierarchy

  • ComponentResource

ProjectComponent

Table of contents

Constructors

Properties

Methods

Constructors

constructor

new ProjectComponent<IPC, GC, NC, CC, SC, RC>(name, props)

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
name string
props ProjectComponentOpts<IPC, GC, NC, CC, SC, RC>

Overrides

ComponentResource.constructor

Defined in

src/lib/bootstrap/pulumi/component.ts:45

Properties

urn

Readonly urn: Output<string>

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Inherited from

ComponentResource.urn

Defined in

node_modules/@pulumi/pulumi/resource.d.ts:18

Methods

getData

Protected getData(): Promise<any>

Retrieves the data produces by [initialize]. The data is immediately available in a derived class's constructor after the super(...) call to ComponentResource.

Returns

Promise<any>

Inherited from

ComponentResource.getData

Defined in

node_modules/@pulumi/pulumi/resource.d.ts:367


getProvider

getProvider(moduleMember): undefined | ProviderResource

Parameters

Name Type
moduleMember string

Returns

undefined | ProviderResource

Inherited from

ComponentResource.getProvider

Defined in

node_modules/@pulumi/pulumi/resource.d.ts:20


initialize

Protected initialize(args): Promise<any>

Can be overridden by a subclass to asynchronously initialize data for this Component automatically when constructed. The data will be available immediately for subclass constructors to use. To access the data use .getData.

Parameters

Name Type
args Inputs

Returns

Promise<any>

Inherited from

ComponentResource.initialize

Defined in

node_modules/@pulumi/pulumi/resource.d.ts:362


registerOutputs

Protected registerOutputs(outputs?): void

registerOutputs registers synthetic outputs that a component has initialized, usually by allocating other child sub-resources and propagating their resulting property values.

ComponentResources can call this at the end of their constructor to indicate that they are done creating child resources. This is not strictly necessary as this will automatically be called after the initialize method completes.

Parameters

Name Type
outputs? Inputs | Promise<Inputs> | Output<Inputs>

Returns

void

Inherited from

ComponentResource.registerOutputs

Defined in

node_modules/@pulumi/pulumi/resource.d.ts:376


isInstance

Static isInstance(obj): obj is ComponentResource<any>

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

Parameters

Name Type
obj any

Returns

obj is ComponentResource<any>

Inherited from

ComponentResource.isInstance

Defined in

node_modules/@pulumi/pulumi/resource.d.ts:342