Meta Properties

In addition to resource specific properties, all jumppad resources have the following properties.

  • Name
    depends_on
    Type
    ([]string: [])
    Required
    Readonly
    Description

    An array of resources that this resource depends on. Jumppad will ensure that all resources referenced in depends_on are created before the resource.

    For example, the resource "mine" would be created after the resource "myother".

      resource "container" "mine" {
        depends_on = ["resource.container.myother"]
      }
      
      resource "container" "myother" {
    
      }
    

    Where possible Jumppad attempts to automatically create a dependency graph by using interpolated properties. For example, the previous scenario could have been written without using depends_on by using interpolated properties.

      resource "container" "mine" {
        image {
          name = resource.container.myother.image.name
        }
      }
      
      resource "container" "myother" {
        image {
          name = "myimage:version"
        }
      }
    
  • Name
    disabled
    Type
    (bool: false)
    Required
    Readonly
    Description

    If set to false the resource will not be created.

  • Name
    meta
    Type
    (meta: {})
    Required
    Readonly
    Description

    Metadata regarding the resource.

meta

  • Name
    id
    Type
    (string: "")
    Required
    Readonly
    readonly
    Description

    The unique id for the resource, this value can be used in interpolation syntax to reference properties for a resource.

      resource.container.nic
      ouput.myoutput
      module.mine.submodule.resource.container.nic
      module.mine.submodule.ouput.myoutput
    
  • Name
    name
    Type
    (string: "")
    Required
    Readonly
    readonly
    Description

    The name of the resource, note: this value is not unique and does not take into account if the resource is embedded in a module.

    This value is the same as the name field of the resource. i.e "mine".

      resource "container" "mine" {}
    
  • Name
    type
    Type
    (string: "")
    Required
    required
    Readonly
    readonly
    Description

    The string type of the resource.

    This value is the same as the type field of the resource. i.e. "container"

      resource "container" "mine" {}
    
  • Name
    module
    Type
    (string: "")
    Required
    Readonly
    readonly
    Description

    The full module path for the resource. Should the resource be included in a module, this value will be the name of the module and any parent modules that the resource is embedded in.

    For example, given the following structure, the module value would be "mymodule.mysubmodule".

      resource "container" "mine" {}
    
      ## included in
    
      module "mysubmodule" {}
      
      ## included in
    
      module "mymodule" {}
    
  • Name
    file
    Type
    (string: "")
    Required
    Readonly
    readonly
    Description

    The absolute path of the file that contains this resource