Class Resource

Hierarchy (view full)

Block
- Resource

Index

Constructors

Properties

blockNames blockType name type

Accessors

Methods

asArgument attr deleteArgument getArgument getArguments getInnerBlocks getProvisioners isInsideTerraformBlock setArgument setArguments setInnerBlocks setProvisioners toData toTerraform

Constructors

constructor

new Resource(type, name, args?, provisioners?): Resource
Construct resource.

Refer to Terraform documentation on what can be put as type & arguments.
Parameters
- type: string
  type
- name: string
  name
- Optional args: TerraformArgs
  arguments
- Optional provisioners: Provisioner[]
  provisioners
Returns Resource
Overrides Block.constructor

Properties

`Readonly` blockNames

blockNames: string[]

`Readonly` blockType

blockType: string

`Readonly` name

name: string

`Readonly` type

type: string

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): any
Get argument by key.
Type Parameters
- K extends string
Parameters
- key: K
  key
Returns any
Inherited from Block.getArgument

getArguments

getArguments(): TerraformArgs
Get arguments.

Returns TerraformArgs
Inherited from Block.getArguments

`Protected` getInnerBlocks

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

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

getProvisioners

getProvisioners(): Provisioner[]
Get provisioners.

Returns Provisioner[]

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 string
Parameters
- key: K
  key
- value: any
  value
Returns this
Inherited from Block.setArgument

setArguments

setArguments(args): this
Set arguments.
Parameters
- args: Partial<TerraformArgs>
  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

setProvisioners

setProvisioners(provisioners): this
Set provisioners.
Parameters
- provisioners: undefined | Provisioner[]
Returns this

toData

toData(options, argNames, args?): Data
Convert resource into data source.

Refer to Terraform documentation on what can be put as arguments.
Parameters
- options: undefined | ResourceToDataOptions
  options
- argNames: (string | [string, string])[]
  names of resource arguments to converted into data source arguments; use array for name mapping, position 0 = original resource's argument name, position 1 = mapped data source's argument name
- Optional args: TerraformArgs
  extra arguments
Returns Data

toTerraform

toTerraform(): string
To Terraform representation.

Returns string
Inherited from Block.toTerraform