TerraformInjectorClass | cdktf-injector

Hierarchy

TerraformInjectorClass

Implements

TerraformInjectorCommon

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new TerraformInjectorClass(scope: Construct, useAsync: boolean, caller: string, description?: string): TerraformInjectorClass

- Defined in components/core/classes/terraform-injector.class.ts:46
Parameters
- scope: Construct
- useAsync: boolean
- caller: string
- Optional description: string
Returns TerraformInjectorClass

Properties

Optional _defaultConfigure

_defaultConfigure?: ((id: string, className: string, description?: string) => {})

Type declaration

- (id: string, className: string, description?: string): {}
- Parameters
  - id: string
  - className: string
  - Optional description: string
  Returns {}
  - [x: string]: any

caller

caller: string

Optional description

description?: string

elementMap

elementMap: Map<string, TerraformInjectorElementContainerClass<any, any, any>> = ...

onNewElementInjectedCallbackArray

onNewElementInjectedCallbackArray: ((element: TerraformElement) => void)[] = ...

scope

scope: Construct

useAsync

useAsync: boolean

Accessors

defaultConfigure

get defaultConfigure(): undefined | ((id: string, className: string, description?: string) => {})

- Defined in components/core/classes/terraform-injector.class.ts:41
Returns undefined | ((id: string, className: string, description?: string) => {})

isInjected

get isInjected(): boolean

- Defined in components/core/classes/terraform-injector.class.ts:248
Returns boolean

Methods

backend

backend<TerraformBackendType, PropsType, SharedType>(terraformBackendClass: TerraformInjectorElementClassWithoutIdType<TerraformBackendType, PropsType>, configure: TerraformInjectorConfigureCallbackType<PropsType, SharedType> | TerraformInjectorConfigureCallbackAsyncType<PropsType, SharedType>, description?: string): TerraformInjectorElementContainerAsync<TerraformBackendType, SharedType>

Implementation of TerraformInjectorCommon.backend
- Defined in components/core/classes/terraform-injector.class.ts:65
Set backend of the injector. You cannot provide multiple backend elements to the injector and only one backend could be provided for one stack each.

Type Parameters
- TerraformBackendType extends TerraformBackend<TerraformBackendType>
- PropsType
- SharedType = undefined
Parameters
- terraformBackendClass: TerraformInjectorElementClassWithoutIdType<TerraformBackendType, PropsType>
- configure: TerraformInjectorConfigureCallbackType<PropsType, SharedType> | TerraformInjectorConfigureCallbackAsyncType<PropsType, SharedType>
- Optional description: string
Returns TerraformInjectorElementContainerAsync<TerraformBackendType, SharedType>

inject

inject(): void | Promise<void>

- Defined in components/core/classes/terraform-injector.class.ts:244
Returns void | Promise<void>

onNewElementInjected

onNewElementInjected(onNewElementInjectedCallback: ((element: TerraformElement) => void)): TerraformInjectorClass

Implementation of TerraformInjectorCommon.onNewElementInjected
- Defined in components/core/classes/terraform-injector.class.ts:237
Parameters
- onNewElementInjectedCallback: ((element: TerraformElement) => void)
  - - (element: TerraformElement): void
    - Parameters
      - element: TerraformElement
      Returns void
Returns TerraformInjectorClass

provide

provide<TerraformElementType, ConfigType, SharedType>(terraformElementClass: TerraformInjectorElementClassType<TerraformElementType, ConfigType>, id: string, configure: TerraformInjectorConfigureCallbackType<ConfigType, SharedType> | TerraformInjectorConfigureCallbackAsyncType<ConfigType, SharedType>, useDefaultConfig?: boolean, description?: string): TerraformInjectorElementContainerAsync<TerraformElementType, SharedType>

Implementation of TerraformInjectorCommon.provide
- Defined in components/core/classes/terraform-injector.class.ts:97
Provide an element to the injector.

Type Parameters
- TerraformElementType extends TerraformElement<TerraformElementType>
- ConfigType
- SharedType = undefined
Parameters
- terraformElementClass: TerraformInjectorElementClassType<TerraformElementType, ConfigType>
- id: string
- configure: TerraformInjectorConfigureCallbackType<ConfigType, SharedType> | TerraformInjectorConfigureCallbackAsyncType<ConfigType, SharedType>
- useDefaultConfig: boolean = true
- Optional description: string
Returns TerraformInjectorElementContainerAsync<TerraformElementType, SharedType>

provideLazily

provideLazily<NestedTerraformElementType, NestedConfigType, NestedSharedType, SharedType>(nestedTerraformElementClass: TerraformInjectorElementClassType<NestedTerraformElementType, NestedConfigType>, id: string, configure: TerraformInjectorNestedConfigureCallbackAsyncType<NestedConfigType, NestedSharedType, SharedType> | TerraformInjectorNestedConfigureCallbackType<NestedConfigType, NestedSharedType, SharedType>, useDefaultConfig?: boolean, description?: string): TerraformInjectorElementContainerAsync<TerraformLazyElementAsync<NestedTerraformElementType, NestedConfigType, NestedSharedType>, SharedType> | TerraformInjectorElementContainer<TerraformLazyElement<NestedTerraformElementType, NestedConfigType, NestedSharedType>, SharedType>

Implementation of TerraformInjectorCommon.provideLazily
- Defined in components/core/classes/terraform-injector.class.ts:135
Type Parameters
- NestedTerraformElementType extends TerraformElement<NestedTerraformElementType>
- NestedConfigType
- NestedSharedType = undefined
- SharedType = undefined
Parameters
- nestedTerraformElementClass: TerraformInjectorElementClassType<NestedTerraformElementType, NestedConfigType>
- id: string
- configure: TerraformInjectorNestedConfigureCallbackAsyncType<NestedConfigType, NestedSharedType, SharedType> | TerraformInjectorNestedConfigureCallbackType<NestedConfigType, NestedSharedType, SharedType>
- useDefaultConfig: boolean = true
- Optional description: string
Returns TerraformInjectorElementContainerAsync<TerraformLazyElementAsync<NestedTerraformElementType, NestedConfigType, NestedSharedType>, SharedType> | TerraformInjectorElementContainer<TerraformLazyElement<NestedTerraformElementType, NestedConfigType, NestedSharedType>, SharedType>

setDefaultConfigure

setDefaultConfigure(defaultConfigure: ((id: string, className: string, description?: string) => {})): TerraformInjectorClass

Implementation of TerraformInjectorCommon.setDefaultConfigure
- Defined in components/core/classes/terraform-injector.class.ts:226
Parameters
- defaultConfigure: ((id: string, className: string, description?: string) => {})
  - - (id: string, className: string, description?: string): {}
    - Parameters
      - id: string
      - className: string
      - Optional description: string
      Returns {}
      - [x: string]: any
Returns TerraformInjectorClass

toString

toString(): string

- Defined in components/core/classes/terraform-injector.class.ts:55
Returns string

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

scope: Construct

useAsync: boolean

caller: string

Optional description: string

Returns TerraformInjectorClass

Properties

Optional _defaultConfigure

Type declaration

Parameters

id: string

className: string

Optional description: string

Returns {}

[x: string]: any

caller

Optional description

elementMap

onNewElementInjectedCallbackArray

scope

useAsync

Accessors

defaultConfigure

Returns undefined | ((id: string, className: string, description?: string) => {})

isInjected

Returns boolean

Methods

backend

Type Parameters

TerraformBackendType extends TerraformBackend<TerraformBackendType>

PropsType

SharedType = undefined

Parameters

terraformBackendClass: TerraformInjectorElementClassWithoutIdType<TerraformBackendType, PropsType>

configure: TerraformInjectorConfigureCallbackType<PropsType, SharedType> | TerraformInjectorConfigureCallbackAsyncType<PropsType, SharedType>

Optional description: string

Returns TerraformInjectorElementContainerAsync<TerraformBackendType, SharedType>

inject

Returns void | Promise<void>

onNewElementInjected

Parameters

onNewElementInjectedCallback: ((element: TerraformElement) => void)

Parameters

element: TerraformElement

Returns void

Returns TerraformInjectorClass

provide

Type Parameters

TerraformElementType extends TerraformElement<TerraformElementType>

ConfigType

SharedType = undefined

Parameters

terraformElementClass: TerraformInjectorElementClassType<TerraformElementType, ConfigType>

id: string

configure: TerraformInjectorConfigureCallbackType<ConfigType, SharedType> | TerraformInjectorConfigureCallbackAsyncType<ConfigType, SharedType>

useDefaultConfig: boolean = true

Optional description: string

Returns TerraformInjectorElementContainerAsync<TerraformElementType, SharedType>

provideLazily

Type Parameters

NestedTerraformElementType extends TerraformElement<NestedTerraformElementType>

NestedConfigType

NestedSharedType = undefined

SharedType = undefined

Parameters

nestedTerraformElementClass: TerraformInjectorElementClassType<NestedTerraformElementType, NestedConfigType>

id: string

configure: TerraformInjectorNestedConfigureCallbackAsyncType<NestedConfigType, NestedSharedType, SharedType> | TerraformInjectorNestedConfigureCallbackType<NestedConfigType, NestedSharedType, SharedType>

useDefaultConfig: boolean = true

Optional description: string

Returns TerraformInjectorElementContainerAsync<TerraformLazyElementAsync<NestedTerraformElementType, NestedConfigType, NestedSharedType>, SharedType> | TerraformInjectorElementContainer<TerraformLazyElement<NestedTerraformElementType, NestedConfigType, NestedSharedType>, SharedType>