Skip to main content
Tunnel represents a secure tunnel connection for applications. It enables connectivity between applications and external services within a parent.

Schema

Required

  • parent_id (String) Identifier of the parent resource to which the resource belongs.

Optional

  • description (String) Arbitrary description of the tunnel provided by the user.
  • labels (Map of String) Labels associated with the resource.
  • metadata (Attributes) : Resource metadata containing identification and hierarchy information.

    Inner value description

    Common resource metadata. (see below for nested schema)
  • name (String) Human readable name for the resource.
  • title (String) Human-readable display name for the tunnel.

Read-Only

  • created_at (String) : Timestamp indicating when the resource was created. A string representing a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ or YYYY-MM-DDTHH:MM:SS.SSS±HH:MM
  • id (String) Identifier for the resource, unique for its resource type.
  • resource_version (Number) : Version of the resource for safe concurrent modifications and consistent reads. Positive and monotonically increases on each resource spec change (but not on each change of the resource’s container(s) or status). Service allows zero value or current.
  • status (Attributes) : Current status of the tunnel.

    Inner value description

    TunnelStatus represents the current state of the tunnel. (see below for nested schema)
  • updated_at (String) : Timestamp indicating when the resource was last updated. A string representing a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ or YYYY-MM-DDTHH:MM:SS.SSS±HH:MM

Nested Schema for metadata

Nested Schema for status

Read-Only:
  • state (String) : Current lifecycle state of the tunnel.

    Supported values

    State represents the lifecycle state of the tunnel. Possible values:
    • UNSPECIFIED - Default unspecified state.
    • CREATED - The tunnel has been created and is active.
    • DELETED - The tunnel has been deleted.