Class Provisioner

Hierarchy (view full)

Block<FileProvisionerArgs | LocalExecProvisionerArgs | RemoteExecProvisionerArgs>
- Provisioner

Index

Constructors

Properties

blockNames blockType type

Accessors

Methods

asArgument attr deleteArgument getArgument getArguments getInnerBlocks isInsideTerraformBlock setArgument setArguments setInnerBlocks toTerraform

Constructors

constructor

new Provisioner(type, args): Provisioner
Construct provisioner.

Refer to Terraform documentation on what can be put as type & arguments.
Parameters
- type: "file"
  type
- args: FileProvisionerArgs
  arguments
Returns Provisioner
Overrides Block.constructor
new Provisioner(type, args): Provisioner
Parameters
- type: "local-exec"
- args: LocalExecProvisionerArgs
Returns Provisioner
Overrides Block<FileProvisionerArgs | LocalExecProvisionerArgs | RemoteExecProvisionerArgs>.constructor
new Provisioner(type, args): Provisioner
Parameters
- type: "remote-exec"
- args: RemoteExecProvisionerArgs
Returns Provisioner
Overrides Block<FileProvisionerArgs | LocalExecProvisionerArgs | RemoteExecProvisionerArgs>.constructor

Properties

`Readonly` blockNames

blockNames: string[]

`Readonly` blockType

blockType: string

`Readonly` type

type: "file" | "local-exec" | "remote-exec"

Accessors

id

get id(): Attribute
Block's id attribute.

Returns Attribute
Inherited from Block.id

Methods

asArgument

asArgument(): Argument<string>
Represent block as argument.

Returns Argument<string>
Overrides Block.asArgument

attr

attr(_name): Attribute
Get block's attribute.
Parameters
- _name: string
  attribute name
Returns Attribute
Overrides Block.attr

deleteArgument

deleteArgument(key): this
Delete argument by key.
Parameters
- key: string
  key
Returns this
Inherited from Block.deleteArgument

getArgument

getArgument<K>(key): (FileProvisionerArgs | LocalExecProvisionerArgs | RemoteExecProvisionerArgs)[K]
Get argument by key.
Type Parameters
- K extends "when" | "on_failure"
Parameters
- key: K
  key
Returns (FileProvisionerArgs | LocalExecProvisionerArgs | RemoteExecProvisionerArgs)[K]
Inherited from Block.getArgument

getArguments

getArguments(): FileProvisionerArgs | LocalExecProvisionerArgs | RemoteExecProvisionerArgs
Get arguments.

Returns FileProvisionerArgs | LocalExecProvisionerArgs | RemoteExecProvisionerArgs
Inherited from Block.getArguments

`Protected` getInnerBlocks

getInnerBlocks(): Block<TerraformArgs>[]
Get inner blocks.

Returns Block<TerraformArgs>[]
Inherited from Block.getInnerBlocks

isInsideTerraformBlock

isInsideTerraformBlock(): boolean
Is this block to be placed inside top-level terraform block.

Returns boolean
Inherited from Block.isInsideTerraformBlock

setArgument

setArgument<K>(key, value): this
Set argument.
Type Parameters
- K extends "when" | "on_failure"
Parameters
- key: K
  key
- value: (FileProvisionerArgs | LocalExecProvisionerArgs | RemoteExecProvisionerArgs)[K]
  value
Returns this
Inherited from Block.setArgument

setArguments

setArguments(args): this
Set arguments.
Parameters
- args: Partial<FileProvisionerArgs | LocalExecProvisionerArgs | RemoteExecProvisionerArgs>
  arguments
Returns this
Inherited from Block.setArguments

`Protected` setInnerBlocks

setInnerBlocks(innerBlocks): this
Set inner blocks.
Parameters
- innerBlocks: undefined | Block<TerraformArgs>[]
Returns this
Inherited from Block.setInnerBlocks

toTerraform

toTerraform(): string
To Terraform representation.

Returns string
Inherited from Block.toTerraform