generated from hashicorp/terraform-provider-scaffolding-framework
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
6 changed files
with
660 additions
and
100 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,136 @@ | ||
--- | ||
# generated by https://github.com/hashicorp/terraform-plugin-docs | ||
page_title: "meshstack_buildingblock Resource - terraform-provider-meshstack" | ||
subcategory: "" | ||
description: |- | ||
Manage Building Block assignment. | ||
--- | ||
|
||
# meshstack_buildingblock (Resource) | ||
|
||
Manage Building Block assignment. | ||
|
||
## Example Usage | ||
|
||
```terraform | ||
resource "meshstack_buildingblock" "my_buildingblock" { | ||
metadata = { | ||
definition_uuid = "f012248e-dda9-4763-8706-641a35de6c62" | ||
definition_version = 1 | ||
tenant_identifier = "my-workspace.my-project-dev.my-platform.my-location" | ||
} | ||
spec = { | ||
display_name = "my-buildingblock" | ||
inputs = { | ||
name = { value_string = "my-name" } | ||
size = { value_int = 16 } | ||
} | ||
} | ||
} | ||
``` | ||
|
||
<!-- schema generated by tfplugindocs --> | ||
## Schema | ||
|
||
### Required | ||
|
||
- `metadata` (Attributes) Building Block metadata. (see [below for nested schema](#nestedatt--metadata)) | ||
- `spec` (Attributes) Building Block specification. (see [below for nested schema](#nestedatt--spec)) | ||
|
||
### Read-Only | ||
|
||
- `api_version` (String) Building block datatype version | ||
- `kind` (String) meshObject type, always `meshBuildingBlock`. | ||
- `status` (Attributes) Current Building Block status. (see [below for nested schema](#nestedatt--status)) | ||
|
||
<a id="nestedatt--metadata"></a> | ||
### Nested Schema for `metadata` | ||
|
||
Required: | ||
|
||
- `definition_uuid` (String) UUID of the Building Block Definition this Building Block is based on. | ||
- `definition_version` (Number) Version number of the Building Block Definition this Building Block is based on | ||
- `tenant_identifier` (String) Full tenant identifier of the tenant this Building Block is assigned to. | ||
|
||
Read-Only: | ||
|
||
- `created_on` (String) Timestamp of Building Block creation. | ||
- `force_purge` (Boolean) Indicates whether an operator has requested purging of this Building Block. | ||
- `marked_for_deletion_by` (String) For deleted Building Blocks: user who requested deletion. | ||
- `marked_for_deletion_on` (String) For deleted Building Blocks: timestamp of deletion. | ||
- `uuid` (String) UUID which uniquely identifies the Building Block. | ||
|
||
|
||
<a id="nestedatt--spec"></a> | ||
### Nested Schema for `spec` | ||
|
||
Required: | ||
|
||
- `display_name` (String) Display name for the Building Block as shown in meshPanel. | ||
|
||
Optional: | ||
|
||
- `inputs` (Attributes Map) Building Block user inputs. Each input has exactly one value. Use the value attribute that corresponds to the desired input type, e.g. `value_int` to set an integer input, and leave the remaining attributes empty. (see [below for nested schema](#nestedatt--spec--inputs)) | ||
- `parent_building_blocks` (Attributes List) List of parent Building Blocks. (see [below for nested schema](#nestedatt--spec--parent_building_blocks)) | ||
|
||
Read-Only: | ||
|
||
- `combined_inputs` (Attributes Map) Contains all Building Block inputs. Each input has exactly one value attribute set according to its' type. (see [below for nested schema](#nestedatt--spec--combined_inputs)) | ||
|
||
<a id="nestedatt--spec--inputs"></a> | ||
### Nested Schema for `spec.inputs` | ||
|
||
Optional: | ||
|
||
- `value_bool` (Boolean) | ||
- `value_file` (String) | ||
- `value_int` (Number) | ||
- `value_list` (String) JSON encoded list of objects. | ||
- `value_single_select` (String) | ||
- `value_string` (String) | ||
|
||
|
||
<a id="nestedatt--spec--parent_building_blocks"></a> | ||
### Nested Schema for `spec.parent_building_blocks` | ||
|
||
Required: | ||
|
||
- `buildingblock_uuid` (String) UUID of the parent Building Block. | ||
- `definition_uuid` (String) UUID of the parent Building Block definition. | ||
|
||
|
||
<a id="nestedatt--spec--combined_inputs"></a> | ||
### Nested Schema for `spec.combined_inputs` | ||
|
||
Read-Only: | ||
|
||
- `value_bool` (Boolean) | ||
- `value_file` (String) | ||
- `value_int` (Number) | ||
- `value_list` (String) JSON encoded list of objects. | ||
- `value_single_select` (String) | ||
- `value_string` (String) | ||
|
||
|
||
|
||
<a id="nestedatt--status"></a> | ||
### Nested Schema for `status` | ||
|
||
Read-Only: | ||
|
||
- `outputs` (Attributes Map) Building Block outputs. Each output has exactly one value attribute set. (see [below for nested schema](#nestedatt--status--outputs)) | ||
- `status` (String) Execution status. One of `WAITING_FOR_DEPENDENT_INPUT`, `WAITING_FOR_OPERATOR_INPUT`, `PENDING`, `IN_PROGRESS`, `SUCCEEDED`, `FAILED`. | ||
|
||
<a id="nestedatt--status--outputs"></a> | ||
### Nested Schema for `status.outputs` | ||
|
||
Read-Only: | ||
|
||
- `value_bool` (Boolean) | ||
- `value_file` (String) | ||
- `value_int` (Number) | ||
- `value_list` (String) JSON encoded list of objects. | ||
- `value_single_select` (String) | ||
- `value_string` (String) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
resource "meshstack_buildingblock" "my_buildingblock" { | ||
metadata = { | ||
definition_uuid = "f012248e-dda9-4763-8706-641a35de6c62" | ||
definition_version = 1 | ||
tenant_identifier = "my-workspace.my-project-dev.my-platform.my-location" | ||
} | ||
|
||
spec = { | ||
display_name = "my-buildingblock" | ||
|
||
inputs = { | ||
name = { value_string = "my-name" } | ||
size = { value_int = 16 } | ||
} | ||
} | ||
} |
Oops, something went wrong.