Hierarchy
- TerraformStack
- TerraformInjectorStack
Implements
Index
Constructors
Properties
Constructors
constructor
Parameters
scope: Construct
name: string
injectorDescription: string = ...
Returns TerraformInjectorStack
Properties
backend
Type declaration
- +
Hierarchy
- TerraformStack
- TerraformInjectorStack
Implements
Index
Constructors
Properties
Constructors
constructor
Parameters
scope: Construct
name: string
injectorDescription: string = ...
Returns TerraformInjectorStack
Properties
backend
Type declaration
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.
Optional description: string
Optional description string.
-Returns TerraformInjectorElementContainer<TerraformBackendType, SharedType>
inject
Type declaration
- +
Returns TerraformInjectorElementContainer<TerraformBackendType, SharedType>
inject
Type declaration
Commit dependency injection for all the elements below the scope level.
-Returns void
provide
Type declaration
- +
Returns void
provide
Type declaration
Provide an element to the injector.
Type parameters
TerraformElementType: TerraformElement<TerraformElementType>
ConfigType
SharedType = undefined
Parameters
terraformElementClass: TerraformInjectorElementClassType<TerraformElementType, ConfigType>
diff --git a/docs/classes/TerraformInjectorStackAsync.html b/docs/classes/TerraformInjectorStackAsync.html index f529081..684e05b 100644 --- a/docs/classes/TerraformInjectorStackAsync.html +++ b/docs/classes/TerraformInjectorStackAsync.html @@ -1,6 +1,6 @@TerraformInjectorStackAsync | cdktf-injector Class TerraformInjectorStackAsync
Stack class extends
-TerraformStackand implementing TerraformInjectorAsync.Hierarchy
- TerraformStack
- TerraformInjectorStackAsync
Implements
Index
Constructors
Properties
Constructors
constructor
Parameters
scope: Construct
name: string
injectorDescription: string = ...
Returns TerraformInjectorStackAsync
Properties
backend
Type declaration
- +
Hierarchy
- TerraformStack
- TerraformInjectorStackAsync
Implements
Index
Constructors
Properties
Constructors
constructor
Parameters
scope: Construct
name: string
injectorDescription: string = ...
Returns TerraformInjectorStackAsync
Properties
backend
Type declaration
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.
- TerraformStack
Optional description: string
Optional description string.
-
Returns TerraformInjectorElementContainerAsync<TerraformBackendType, SharedType>
inject
Type declaration
- +
Returns TerraformInjectorElementContainerAsync<TerraformBackendType, SharedType>
inject
Type declaration
Commit dependency injection for all the elements below the scope level.
-Returns Promise<void>
provide
Type declaration
- +
Returns Promise<void>
provide
Type declaration
Provide an element to the injector.
Type parameters
TerraformElementType: TerraformElement<TerraformElementType>
ConfigType
SharedType = {}
Parameters
terraformElementClass: TerraformInjectorElementClassType<TerraformElementType, ConfigType>
diff --git a/docs/index.html b/docs/index.html index a8f9745..cb94e65 100644 --- a/docs/index.html +++ b/docs/index.html @@ -83,7 +83,7 @@Using terraform only (resource "aws_vpc" "my-vpc" {
cidr_block = "10.1.0.0/16"
}
resource "aws_subnet" "my-subnet" {
vpc_id = aws_vpc.my-vpc.id
cidr_block = "10.1.1.0/24"
}
resource "aws_instance" "my-ec2-instance" {
subnet_id = aws_subnet.my-subnet.id
ami = "ami-2757f631"
instance_type = "t2.micro"
}
output "instance-ip" {
value = aws_instance.my-ec2-instance.public_ip
}As you can see, there are 4 terraform resources declared up above and their relationships are as follow.
-
+
instance-ipdepends onmy-ec2-instance
@@ -105,7 +105,7 @@
Using cdktf in TypeScript
In cdktf, every resource is a class instance. Thoese are pretty straight forward. Constructing resources using
newkeyword, passing id string and its config, you can build real world infrastructure.However unlike
-hcl, it is a sequencial language. You cannot create instance refering to another one that is not defined yet.
+
When you attempt to declare
subnetbeforevpc, it'll say "Hey, you cannot usevpcbefore it's been initialized!"And that's where the
diff --git a/docs/interfaces/Reference.TerraformInjectorCommon.html b/docs/interfaces/Reference.TerraformInjectorCommon.html index ce4d64d..1908e4b 100644 --- a/docs/interfaces/Reference.TerraformInjectorCommon.html +++ b/docs/interfaces/Reference.TerraformInjectorCommon.html @@ -3,7 +3,7 @@cdktf-injectorcomes in.You can provide any elements inheriting
TerraformElementwithprovidemethod.And there is a special
backendmethod only for providing anTerraformBackendelement.You can later inject all the dependencies below the scope level of the instance by using
-injectmethod.Hierarchy
- TerraformInjectorCommon
Index
Methods
backend
- +
Hierarchy
- TerraformInjectorCommon
Index
Methods
backend
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.
Optional description: string
Optional description string.
-Returns TerraformInjectorElementContainerAsync<TerraformBackendType, SharedType>
provide
- +
Returns TerraformInjectorElementContainerAsync<TerraformBackendType, SharedType>
provide
Provide an element to the injector.
Type parameters
TerraformElementType: TerraformElement<TerraformElementType>
ConfigType
SharedType = undefined
Parameters
terraformElementClass: TerraformInjectorElementClassType<TerraformElementType, ConfigType>
diff --git a/docs/interfaces/TerraformInjector.html b/docs/interfaces/TerraformInjector.html index 98865fc..1d8bfc5 100644 --- a/docs/interfaces/TerraformInjector.html +++ b/docs/interfaces/TerraformInjector.html @@ -3,7 +3,7 @@You can provide any elements inheriting
TerraformElementwithprovidemethod.And there is a special
backendmethod only for providing anTerraformBackendelement.You can later inject all the dependencies below the scope level of the instance by using
-injectmethod.
Hierarchy
- TerraformInjectorCommon
- TerraformInjector
Implemented by
Index
Methods
backend
- +
Hierarchy
- TerraformInjectorCommon
- TerraformInjector
Implemented by
Index
Methods
backend
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.
Optional description: string
Optional description string.
-Returns TerraformInjectorElementContainer<TerraformBackendType, SharedType>
inject
- +
Returns TerraformInjectorElementContainer<TerraformBackendType, SharedType>
inject
Commit dependency injection for all the elements below the scope level.
-Returns void
provide
- +
Returns void
provide
Provide an element to the injector.
Type parameters
TerraformElementType: TerraformElement<TerraformElementType>
ConfigType
SharedType = undefined
Parameters
terraformElementClass: TerraformInjectorElementClassType<TerraformElementType, ConfigType>
diff --git a/docs/interfaces/TerraformInjectorAsync.html b/docs/interfaces/TerraformInjectorAsync.html index 27e86db..cb40ef8 100644 --- a/docs/interfaces/TerraformInjectorAsync.html +++ b/docs/interfaces/TerraformInjectorAsync.html @@ -3,7 +3,7 @@You can provide any elements inheriting
TerraformElementwithprovidemethod.And there is a special
backendmethod only for providing anTerraformBackendelement.You can later inject all the dependencies below the scope level of the instance by using
-injectmethod.
Hierarchy
- TerraformInjectorCommon
- TerraformInjectorAsync
Implemented by
Index
Methods
backend
- +
Hierarchy
- TerraformInjectorCommon
- TerraformInjectorAsync
Implemented by
Index
Methods
backend
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.
Optional description: string
Optional description string.
-Returns TerraformInjectorElementContainerAsync<TerraformBackendType, SharedType>
inject
- +
Returns TerraformInjectorElementContainerAsync<TerraformBackendType, SharedType>
inject
Commit dependency injection for all the elements below the scope level.
-Returns Promise<void>
provide
- +
Returns Promise<void>
provide
Provide an element to the injector.
Type parameters
TerraformElementType: TerraformElement<TerraformElementType>
ConfigType
SharedType = undefined
Parameters
terraformElementClass: TerraformInjectorElementClassType<TerraformElementType, ConfigType>
diff --git a/docs/interfaces/TerraformInjectorElementContainer.html b/docs/interfaces/TerraformInjectorElementContainer.html index a29644b..3c74793 100644 --- a/docs/interfaces/TerraformInjectorElementContainer.html +++ b/docs/interfaces/TerraformInjectorElementContainer.html @@ -1,13 +1,13 @@TerraformInjectorElementContainer | cdktf-injector Interface TerraformInjectorElementContainer<TerraformElementType, SharedType>
Injectable terraform element container. You cannot instantiate directly, only by
-yourInjector.provideoryourInjector.backend(for backend only).Type parameters
TerraformElementType: TerraformElement
SharedType
Hierarchy
- TerraformInjectorElementContainerAsync<TerraformElementType, SharedType>
- TerraformInjectorElementContainer
Index
Accessors
Methods
Accessors
element
- +
Type parameters
TerraformElementType: TerraformElement
SharedType
Hierarchy
- TerraformInjectorElementContainerAsync<TerraformElementType, SharedType>
- TerraformInjectorElementContainer
Index
Accessors
Methods
Accessors
element
Get terraform element.
Returns TerraformElementType
shared
- +
Returns TerraformElementType
shared
Get shared object.
Returns SharedType
Methods
add
Output outputConfig: (element: TerraformElementType, shared: SharedType) => TerraformOutputConfig
Configuration callbak for
-TerraformOutputclass.Parameters
element: TerraformElementType
shared: SharedType
Returns TerraformOutputConfig
Returns TerraformInjectorElementContainer<TerraformElementType, SharedType>
after
Dependencies Injected - +
Parameters
element: TerraformElementType
shared: SharedType
Returns TerraformOutputConfig
Returns TerraformInjectorElementContainer<TerraformElementType, SharedType>
after
Dependencies Injected Add
after dependencies injected callback. Callback will run after dependency injection process is completed.You can add multiple callbacks, then they will be executed in sequence.
Parameters
afterDependenciesInjectedCallback: (element: TerraformElementType, shared: SharedType) => void
Action block to execute after di process
-Parameters
element: TerraformElementType
shared: SharedType
Returns void
Returns TerraformInjectorElementContainer<TerraformElementType, SharedType>
after
Init Element - +
Parameters
element: TerraformElementType
shared: SharedType
Returns void
Returns TerraformInjectorElementContainer<TerraformElementType, SharedType>
after
Init Element Add
after init callback. Callbacks will run right after this element is initialized.You can add multiple callbacks, then they will be executed in sequence.
Parameters
afterInitCallback: (element: TerraformElementType, shared: SharedType) => void
diff --git a/docs/interfaces/TerraformInjectorElementContainerAsync.html b/docs/interfaces/TerraformInjectorElementContainerAsync.html index 7afe9e6..3994d65 100644 --- a/docs/interfaces/TerraformInjectorElementContainerAsync.html +++ b/docs/interfaces/TerraformInjectorElementContainerAsync.html @@ -1,13 +1,13 @@TerraformInjectorElementContainerAsync | cdktf-injector Interface TerraformInjectorElementContainerAsync<TerraformElementType, SharedType>
Injectable terraform element container. You cannot instantiate directly, only by
-yourInjector.provideoryourInjector.backend(for backend only).Type parameters
TerraformElementType: TerraformElement
SharedType
Hierarchy
- TerraformInjectorElementContainerAsync
Index
Accessors
Methods
Accessors
element
- +
Type parameters
TerraformElementType: TerraformElement
SharedType
Hierarchy
- TerraformInjectorElementContainerAsync
Index
Accessors
Methods
Accessors
element
Get terraform element.
Returns TerraformElementType
shared
- +
Returns TerraformElementType
shared
Get shared object.
Returns SharedType
Methods
add
Output outputConfig: (element: TerraformElementType, shared: SharedType) => TerraformOutputConfig
Configuration callbak for
-TerraformOutputclass.Parameters
element: TerraformElementType
shared: SharedType
Returns TerraformOutputConfig
Returns TerraformInjectorElementContainerAsync<TerraformElementType, SharedType>
after
Dependencies Injected - +
Parameters
element: TerraformElementType
shared: SharedType
Returns TerraformOutputConfig
Returns TerraformInjectorElementContainerAsync<TerraformElementType, SharedType>
after
Dependencies Injected Add
after dependencies injected callback. Callback will run after dependency injection process is completed.You can add multiple callbacks, then they will be executed in sequence.
Parameters
afterDependenciesInjectedCallback: (element: TerraformElementType, shared: SharedType) => void | Promise<void>
Action block to execute after di process
-Parameters
element: TerraformElementType
shared: SharedType
Returns void | Promise<void>
Returns TerraformInjectorElementContainerAsync<TerraformElementType, SharedType>
after
Init Element - +
Parameters
element: TerraformElementType
shared: SharedType
Returns void | Promise<void>
Returns TerraformInjectorElementContainerAsync<TerraformElementType, SharedType>
after
Init Element Add
after init callback. Callbacks will run right after this element is initialized.You can add multiple callbacks, then they will be executed in sequence.
Parameters
afterInitCallback: (element: TerraformElementType, shared: SharedType) => void | Promise<void>
diff --git a/docs/modules.html b/docs/modules.html index 8aeb543..f22d373 100644 --- a/docs/modules.html +++ b/docs/modules.html @@ -1,4 +1,4 @@ -cdktf-injector cdktf-injector
Index
Variables
Const Terraform
Injector Factory +cdktf-injector cdktf-injector
Index
Variables
Const Terraform
Injector Factory Constant object for creating TerraformInjector or TerraformInjectorAsync instance. You can use only one of
scopesOnorscopesOnAsyncfunction for one Construct instance, not both.
- TerraformStack
- TerraformStack
Stack class extends
TerraformStackand implementing TerraformInjector.https://www.terraform.io/cdktf/concepts/stacks
-