Skip to main content

​
Retrieving the Data Source

This data source can be retrieved by one of ID or name.
Retrieve by ID
To retrieve by ID, fill in only the id field: 
data ... {
    id = "your-ID"
}
Retrieve by Name
To retrieve by name, fill in only the name and parent_id fields: 
data ... {
    name      = "your name"
    parent_id = "data-source-parent-id"
}

​
Schema

​
Optional

  • id (String) Identifier for the resource, unique for its resource type.
  • name (String) Human readable name for the resource.
  • parent_id (String) Identifier of the parent resource to which the resource belongs.

​
Read-Only

  • cidrs (Attributes List) CIDR blocks. (see below for nested schema)
  • 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
  • labels (Map of String) : Labels associated with the resource.
  • metadata (Attributes) : Metadata associated with the Pool. metadata.parent_id represents the Project.

    ​
    Inner value description

    Common resource metadata. (see below for nested schema)
  • 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.
  • source_pool_id (String) : ID of source pool. Current pool will be created with the same scope. Cannot be set alongside source_scope_id.
  • source_scope_id (String) : ID of the scope. Pool will be considered as top-level pool within scope. Cannot be set alongside source_pool_id.
  • status (Attributes) Status information for the Pool. (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
  • version (String) : IP version for the Pool.

    ​
    Supported values

    Possible values:
    • IP_VERSION_UNSPECIFIED - Default, unspecified IP version.
    • IPV4 - IPv4 address.
    • IPV6 - IPv6 address.

​
Nested Schema for cidrs

Read-Only:
  • allowed_mask (Number) Maximum mask length for allocation from this IP pool including creation of sub-pools
  • cidr (String) : CIDR block. May be a prefix length (such as /24) for non-top-level pools or a CIDR-formatted string (such as 10.1.2.0/24).
  • state (String) : State of the Cidr.

    ​
    Supported values

    Possible values:
    • STATE_UNSPECIFIED - Default, unspecified state.
    • AVAILABLE - Allocation from range is available.
    • DISABLED - New allocation would not be created.

​
Nested Schema for metadata

​
Nested Schema for status

Read-Only:
  • cidrs (List of String) CIDR blocks.
  • scope_id (String) ID of the scope
  • state (String) : Current state of the Pool.

    ​
    Supported values

    Possible states of the Pool. Possible values:
    • STATE_UNSPECIFIED - Default, unspecified state.
    • CREATING - Pool is being created.
    • READY - Pool is ready for use.
    • DELETING - Pool is being deleted.