TerraformInjectorCommon | cdktf-injector

Terraform DI class interface.

You can provide any elements inheriting TerraformElement with provide method.

And there is a special backend method only for providing an TerraformBackend element.

You can later inject all the dependencies below the scope level of the instance by using inject method.

Hierarchy

TerraformInjectorCommon
- TerraformInjector
- TerraformInjectorAsync

Implemented by

TerraformInjectorClass

Index

Methods

backend

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

- Defined in components/core/interfaces/terraform-injector.common.interface.ts:41
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.

see
https://www.terraform.io/cdktf/concepts/remote-backends

Type Parameters
- TerraformBackendType extends TerraformBackend<TerraformBackendType>
- PropsType
- SharedType = undefined
Parameters
- terraformBackendClass: TerraformInjectorElementClassWithoutIdType<TerraformBackendType, PropsType>
  
  Remote backend class to instantiate.
- configure: TerraformInjectorConfigureCallbackType<PropsType, SharedType> | TerraformInjectorConfigureCallbackAsyncType<PropsType, SharedType>
  
  Configuration callbak for certain backend class.
- Optional description: string
  
  Optional description string.
Returns TerraformInjectorElementContainerAsync<TerraformBackendType, SharedType>

onNewElementInjected

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

- Defined in components/core/interfaces/terraform-injector.common.interface.ts:25
Parameters
- onNewElementInjectedCallback: ((element: TerraformElement) => void)
  - - (element: TerraformElement): void
    - Parameters
      - element: TerraformElement
      Returns void
Returns TerraformInjectorCommon

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>

- Defined in components/core/interfaces/terraform-injector.common.interface.ts:71
Provide an element to the injector.

see
https://www.terraform.io/cdktf/concepts/providers-and-resources

Type Parameters
- TerraformElementType extends TerraformElement<TerraformElementType>
- ConfigType
- SharedType = undefined
Parameters
- terraformElementClass: TerraformInjectorElementClassType<TerraformElementType, ConfigType>
  
  Terraform element class to instantiate.
- id: string
  
  The scoped construct ID. Must be unique amongst siblings in the same scope.
- configure: TerraformInjectorConfigureCallbackType<ConfigType, SharedType> | TerraformInjectorConfigureCallbackAsyncType<ConfigType, SharedType>
  
  Configuration callbak for certain element class.
- Optional useDefaultConfig: boolean
  
  Set false to ignore default config of the injector. Default is true.
- Optional description: string
  
  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>

- Defined in components/core/interfaces/terraform-injector.common.interface.ts:88
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>
- Optional useDefaultConfig: boolean
- 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) => {})): TerraformInjectorCommon

- Defined in components/core/interfaces/terraform-injector.common.interface.ts:130
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 TerraformInjectorCommon

Hierarchy

Implemented by

Index

Methods

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>

onNewElementInjected

Parameters

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

Parameters

element: TerraformElement

Returns void

Returns TerraformInjectorCommon

provide

Type Parameters

TerraformElementType extends TerraformElement<TerraformElementType>

ConfigType

SharedType = undefined

Parameters

terraformElementClass: TerraformInjectorElementClassType<TerraformElementType, ConfigType>

id: string

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

Optional useDefaultConfig: boolean

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>

Optional useDefaultConfig: boolean

Optional description: string

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

setDefaultConfigure

Parameters

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

Parameters

id: string

className: string

Optional description: string

Returns {}

[x: string]: any

Returns TerraformInjectorCommon