Added missing pricing endpoint docs (#1638)

linode · Nov 6, 2024 · 5060b81 · 5060b81
1 parent 6bd5690
commit 5060b81
Show file tree

Hide file tree

Showing 4 changed files with 324 additions and 0 deletions.
diff --git a/docs/data-sources/lke_types.md b/docs/data-sources/lke_types.md
@@ -0,0 +1,81 @@
+---
+page_title: "Linode: linode_lke_types"
+description: |-
+  Provides information about Linode LKE types that match a set of filters.
+---
+
+# Data Source: linode_lke_types
+
+Provides information about Linode LKE types that match a set of filters.
+For more information, see the [Linode APIv4 docs](https://techdocs.akamai.com/linode-api/reference/get-lke-types).
+
+## Example Usage
+
+Get information about all Linode LKE types with a certain label:
+
+```hcl
+data "linode_lke_types" "specific-label" {
+  filter {
+    name = "label"
+    values = "LKE Standard Availability"
+  }
+}
+
+output "type_id" {
+  value = data.linode_lke_types.specific-label.id
+}
+```
+
+Get information about all Linode LKE types:
+
+```hcl
+data "linode_lke_types" "all-types" {}
+
+output "type_id" {
+  value = data.linode_lke_types.all-types.*.id
+}
+```
+
+## Argument Reference
+
+The following arguments are supported:
+
+* [`filter`](#filter) - (Optional) A set of filters used to select Linode LKE types that meet certain requirements.
+
+* `order_by` - (Optional) The attribute to order the results by. See the [Filterable Fields section](#filterable-fields) for a list of valid fields.
+
+* `order` - (Optional) The order in which results should be returned. (`asc`, `desc`; default `asc`)
+
+### Filter
+
+* `name` - (Required) The name of the field to filter by. See the [Filterable Fields section](#filterable-fields) for a complete list of filterable fields.
+
+* `values` - (Required) A list of values for the filter to allow. These values should all be in string form.
+
+* `match_by` - (Optional) The method to match the field by. (`exact`, `regex`, `substring`; default `exact`)
+
+## Attributes Reference
+
+Each Linode LKE type will export the following attributes:
+
+* `id` - The ID representing the Kubernetes type.
+
+* `label` - The Kubernetes type label is for display purposes only.
+
+* `price.0.hourly` -  Cost (in US dollars) per hour.
+
+* `price.0.monthly` - Cost (in US dollars) per month.
+
+* `region_prices.*.id` - The Region ID for these prices.
+
+* `region_prices.*.hourly` - Cost per hour for this region, in US dollars.
+
+* `region_prices.*.monthly` - Cost per month for this region, in US dollars.
+
+* `transfer` - The monthly outbound transfer amount, in MB.
+
+## Filterable Fields
+
+* `label`
+
+* `transfer`
diff --git a/docs/data-sources/network_transfer_prices.md b/docs/data-sources/network_transfer_prices.md
@@ -0,0 +1,81 @@
+---
+page_title: "Linode: linode_network_transfer_prices"
+description: |-
+  Provides information about Linode Network Transfer Prices that match a set of filters.
+---
+
+# Data Source: linode_network_transfer_prices
+
+Provides information about Linode Network Transfer Prices that match a set of filters.
+For more information, see the [Linode APIv4 docs](https://techdocs.akamai.com/linode-api/reference/get-network-transfer-prices).
+
+## Example Usage
+
+Get information about all Linode Network Transfer Prices with a certain label:
+
+```hcl
+data "linode_network_transfer_prices" "specific-label" {
+  filter {
+    name = "label"
+    values = "Network Transfer"
+  }
+}
+
+output "price_id" {
+  value = data.linode_network_transfer_prices.specific-label.id
+}
+```
+
+Get information about all Linode Network Transfer Prices:
+
+```hcl
+data "linode_network_transfer_prices" "all-prices" {}
+
+output "price_id" {
+  value = data.linode_network_transfer_prices.all-prices.*.id
+}
+```
+
+## Argument Reference
+
+The following arguments are supported:
+
+* [`filter`](#filter) - (Optional) A set of filters used to select Linode Network Transfer Prices that meet certain requirements.
+
+* `order_by` - (Optional) The attribute to order the results by. See the [Filterable Fields section](#filterable-fields) for a list of valid fields.
+
+* `order` - (Optional) The order in which results should be returned. (`asc`, `desc`; default `asc`)
+
+### Filter
+
+* `name` - (Required) The name of the field to filter by. See the [Filterable Fields section](#filterable-fields) for a complete list of filterable fields.
+
+* `values` - (Required) A list of values for the filter to allow. These values should all be in string form.
+
+* `match_by` - (Optional) The method to match the field by. (`exact`, `regex`, `substring`; default `exact`)
+
+## Attributes Reference
+
+Each Linode Network Transfer Price will export the following attributes:
+
+* `id` - The ID representing the Network Transfer Price.
+
+* `label` - The Network Transfer Price label is for display purposes only.
+
+* `price.0.hourly` -  Cost (in US dollars) per hour.
+
+* `price.0.monthly` - Cost (in US dollars) per month.
+
+* `region_prices.*.id` - The Region ID for these prices.
+
+* `region_prices.*.hourly` - Cost per hour for this region, in US dollars.
+
+* `region_prices.*.monthly` - Cost per month for this region, in US dollars.
+
+* `transfer` - The monthly outbound transfer amount, in MB.
+
+## Filterable Fields
+
+* `label`
+
+* `transfer`
diff --git a/docs/data-sources/nodebalancer_types.md b/docs/data-sources/nodebalancer_types.md
@@ -0,0 +1,81 @@
+---
+page_title: "Linode: linode_nb_types"
+description: |-
+  Provides information about Linode Node Balancer types that match a set of filters.
+---
+
+# Data Source: linode_nb_types
+
+Provides information about Linode Node Balancer types that match a set of filters.
+For more information, see the [Linode APIv4 docs](https://techdocs.akamai.com/linode-api/reference/get-node-balancer-types).
+
+## Example Usage
+
+Get information about all Linode Node Balancer types with a certain label:
+
+```hcl
+data "linode_nb_types" "specific-label" {
+  filter {
+    name = "label"
+    values = "NodeBalancer"
+  }
+}
+
+output "type_id" {
+  value = data.linode_nb_types.specific-label.id
+}
+```
+
+Get information about all Linode Node Balancer types:
+
+```hcl
+data "linode_nb_types" "all-types" {}
+
+output "type_id" {
+  value = data.linode_nb_types.all-types.*.id
+}
+```
+
+## Argument Reference
+
+The following arguments are supported:
+
+* [`filter`](#filter) - (Optional) A set of filters used to select Linode Node Balancer types that meet certain requirements.
+
+* `order_by` - (Optional) The attribute to order the results by. See the [Filterable Fields section](#filterable-fields) for a list of valid fields.
+
+* `order` - (Optional) The order in which results should be returned. (`asc`, `desc`; default `asc`)
+
+### Filter
+
+* `name` - (Required) The name of the field to filter by. See the [Filterable Fields section](#filterable-fields) for a complete list of filterable fields.
+
+* `values` - (Required) A list of values for the filter to allow. These values should all be in string form.
+
+* `match_by` - (Optional) The method to match the field by. (`exact`, `regex`, `substring`; default `exact`)
+
+## Attributes Reference
+
+Each Linode Node Balancer type will export the following attributes:
+
+* `id` - The ID representing the Node Balancer type.
+
+* `label` - The Node Balancer type label is for display purposes only.
+
+* `price.0.hourly` -  Cost (in US dollars) per hour.
+
+* `price.0.monthly` - Cost (in US dollars) per month.
+
+* `region_prices.*.id` - The Region ID for these prices.
+
+* `region_prices.*.hourly` - Cost per hour for this region, in US dollars.
+
+* `region_prices.*.monthly` - Cost per month for this region, in US dollars.
+
+* `transfer` - The monthly outbound transfer amount, in MB.
+
+## Filterable Fields
+
+* `label`
+
+* `transfer`
diff --git a/docs/data-sources/volume_types.md b/docs/data-sources/volume_types.md
@@ -0,0 +1,81 @@
+---
+page_title: "Linode: linode_volume_types"
+description: |-
+  Provides information about Linode Volume types that match a set of filters.
+---
+
+# Data Source: linode_volume_types
+
+Provides information about Linode Volume types that match a set of filters.
+For more information, see the [Linode APIv4 docs](https://techdocs.akamai.com/linode-api/reference/get-volume-types).
+
+## Example Usage
+
+Get information about all Linode Volume types with a certain label:
+
+```hcl
+data "linode_volume_types" "specific-label" {
+  filter {
+    name = "label"
+    values = "Storage Volume"
+  }
+}
+
+output "type_id" {
+  value = data.linode_volume_types.specific-label.id
+}
+```
+
+Get information about all Linode Volume types:
+
+```hcl
+data "linode_volume_types" "all-types" {}
+
+output "type_id" {
+  value = data.linode_volume_types.all-types.*.id
+}
+```
+
+## Argument Reference
+
+The following arguments are supported:
+
+* [`filter`](#filter) - (Optional) A set of filters used to select Linode Volume types that meet certain requirements.
+
+* `order_by` - (Optional) The attribute to order the results by. See the [Filterable Fields section](#filterable-fields) for a list of valid fields.
+
+* `order` - (Optional) The order in which results should be returned. (`asc`, `desc`; default `asc`)
+
+### Filter
+
+* `name` - (Required) The name of the field to filter by. See the [Filterable Fields section](#filterable-fields) for a complete list of filterable fields.
+
+* `values` - (Required) A list of values for the filter to allow. These values should all be in string form.
+
+* `match_by` - (Optional) The method to match the field by. (`exact`, `regex`, `substring`; default `exact`)
+
+## Attributes Reference
+
+Each Linode Volume type will export the following attributes:
+
+* `id` - The ID representing the Volume type.
+
+* `label` - The Volume type label is for display purposes only.
+
+* `price.0.hourly` -  Cost (in US dollars) per hour.
+
+* `price.0.monthly` - Cost (in US dollars) per month.
+
+* `region_prices.*.id` - The Region ID for these prices.
+
+* `region_prices.*.hourly` - Cost per hour for this region, in US dollars.
+
+* `region_prices.*.monthly` - Cost per month for this region, in US dollars.
+
+* `transfer` - The monthly outbound transfer amount, in MB.
+
+## Filterable Fields
+
+* `label`
+
+* `transfer`