Skip to content

Commit

Permalink
Update required vs optional attributes
Browse files Browse the repository at this point in the history
  • Loading branch information
atburke committed Sep 20, 2024
1 parent 1d06d2c commit 2ed0b60
Show file tree
Hide file tree
Showing 4 changed files with 36 additions and 37 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -15,14 +15,27 @@ description: This page describes the supported values of the teleport_static_hos

### Required

- `metadata` (Attributes) metadata is resource metadata. (see [below for nested schema](#nested-schema-for-metadata))
- `spec` (Attributes) spec is the static host user spec. (see [below for nested schema](#nested-schema-for-spec))

### Optional

- `metadata` (Attributes) metadata is resource metadata. (see [below for nested schema](#nested-schema-for-metadata))
- `sub_kind` (String) sub_kind is an optional resource sub kind, used in some resources.
- `version` (String) version is the resource version. It must be specified. Supported values are: `v2`.

### Nested Schema for `metadata`

Required:

- `name` (String) name is an object name.

Optional:

- `description` (String) description is object description.
- `expires` (String)
- `labels` (Map of String) labels is a set of labels.


### Nested Schema for `spec`

Required:
Expand All @@ -43,23 +56,8 @@ Optional:

### Nested Schema for `spec.matchers.node_labels`

Optional:
Required:

- `name` (String) The name of the label.
- `values` (List of String) The values associated with the label.




### Nested Schema for `metadata`

Required:

- `name` (String) name is an object name.

Optional:

- `description` (String) description is object description.
- `expires` (String)
- `labels` (Map of String) labels is a set of labels.

Original file line number Diff line number Diff line change
Expand Up @@ -42,14 +42,27 @@ resource "teleport_static_host_user" "test" {

### Required

- `metadata` (Attributes) metadata is resource metadata. (see [below for nested schema](#nested-schema-for-metadata))
- `spec` (Attributes) spec is the static host user spec. (see [below for nested schema](#nested-schema-for-spec))

### Optional

- `metadata` (Attributes) metadata is resource metadata. (see [below for nested schema](#nested-schema-for-metadata))
- `sub_kind` (String) sub_kind is an optional resource sub kind, used in some resources.
- `version` (String) version is the resource version. It must be specified. Supported values are: `v2`.

### Nested Schema for `metadata`

Required:

- `name` (String) name is an object name.

Optional:

- `description` (String) description is object description.
- `expires` (String)
- `labels` (Map of String) labels is a set of labels.


### Nested Schema for `spec`

Required:
Expand All @@ -70,23 +83,8 @@ Optional:

### Nested Schema for `spec.matchers.node_labels`

Optional:
Required:

- `name` (String) The name of the label.
- `values` (List of String) The values associated with the label.




### Nested Schema for `metadata`

Required:

- `name` (String) name is an object name.

Optional:

- `description` (String) description is object description.
- `expires` (String)
- `labels` (Map of String) labels is a set of labels.

Original file line number Diff line number Diff line change
Expand Up @@ -42,9 +42,12 @@ computed_fields:

# These fields will be marked as Required: true
required_fields:
- "StaticHostUser.metadata"
- "StaticHostUser.metadata.name"
- "StaticHostUser.spec"
- "StaticHostUser.spec.matchers"
- "StaticHostUser.spec.matchers.node_labels.name"
- "StaticHostUser.spec.matchers.node_labels.values"

plan_modifiers:
# Force to recreate resource if it's name changes
Expand Down

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 2ed0b60

Please sign in to comment.