Skip to content

Commit

Permalink
chore: update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
nrwiersma committed Nov 4, 2024
1 parent d9442df commit 208ed26
Show file tree
Hide file tree
Showing 16 changed files with 648 additions and 0 deletions.
51 changes: 51 additions & 0 deletions docs/data-sources/core_location.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "ec_core_location Data Source - terraform-provider-ec"
subcategory: ""
description: |-
Use this data source to access information about an existing Location.
---

# ec_core_location (Data Source)

Use this data source to access information about an existing Location.



<!-- schema generated by tfplugindocs -->
## Schema

### Optional

- `instance` (String) Name is an instance name configured in the provider.
- `metadata` (Block List, Max: 1) Standard object's metadata. (see [below for nested schema](#nestedblock--metadata))
- `spec` (Block List, Max: 1) Spec defines the desired location configuration. (see [below for nested schema](#nestedblock--spec))

### Read-Only

- `id` (String) The ID of this resource.

<a id="nestedblock--metadata"></a>
### Nested Schema for `metadata`

Optional:

- `annotations` (Map of String) An unstructured map of keys and values stored on an object.
- `environment` (String) The name of the environment the object belongs to.
- `labels` (Map of String) A map of keys and values that can be used to organize and categorize objects.
- `name` (String) The unique object name within its scope.

Read-Only:

- `revision` (String) An opaque resource revision.
- `uid` (String) A unique identifier for each an object.


<a id="nestedblock--spec"></a>
### Nested Schema for `spec`

Optional:

- `region` (String) Region is the location region.
- `sites` (List of String) Sites are the site names that makes up the location.
- `type` (String) Type is the type of the datacenter, e.g. cloud or bare metal.
51 changes: 51 additions & 0 deletions docs/data-sources/core_location_v1.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "ec_core_location_v1 Data Source - terraform-provider-ec"
subcategory: ""
description: |-
Use this data source to access information about an existing Location.
---

# ec_core_location_v1 (Data Source)

Use this data source to access information about an existing Location.



<!-- schema generated by tfplugindocs -->
## Schema

### Optional

- `instance` (String) Name is an instance name configured in the provider.
- `metadata` (Block List, Max: 1) Standard object's metadata. (see [below for nested schema](#nestedblock--metadata))
- `spec` (Block List, Max: 1) Spec defines the desired location configuration. (see [below for nested schema](#nestedblock--spec))

### Read-Only

- `id` (String) The ID of this resource.

<a id="nestedblock--metadata"></a>
### Nested Schema for `metadata`

Optional:

- `annotations` (Map of String) An unstructured map of keys and values stored on an object.
- `environment` (String) The name of the environment the object belongs to.
- `labels` (Map of String) A map of keys and values that can be used to organize and categorize objects.
- `name` (String) The unique object name within its scope.

Read-Only:

- `revision` (String) An opaque resource revision.
- `uid` (String) A unique identifier for each an object.


<a id="nestedblock--spec"></a>
### Nested Schema for `spec`

Optional:

- `region` (String) Region is the location region.
- `sites` (List of String) Sites are the site names that makes up the location.
- `type` (String) Type is the type of the datacenter, e.g. cloud or bare metal.
1 change: 1 addition & 0 deletions docs/data-sources/core_region.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@ Required:

Optional:

- `locations` (List of String) Locations defines the locations for a type.
- `template` (Block List, Max: 1) Template is the optional configuration to apply to all fleets in this region. (see [below for nested schema](#nestedblock--spec--types--template))

<a id="nestedblock--spec--types--template"></a>
Expand Down
1 change: 1 addition & 0 deletions docs/data-sources/core_region_v1.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@ Required:

Optional:

- `locations` (List of String) Locations defines the locations for a type.
- `template` (Block List, Max: 1) Template is the optional configuration to apply to all fleets in this region. (see [below for nested schema](#nestedblock--spec--types--template))

<a id="nestedblock--spec--types--template"></a>
Expand Down
54 changes: 54 additions & 0 deletions docs/data-sources/protection_gatewaypolicy.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "ec_protection_gatewaypolicy Data Source - terraform-provider-ec"
subcategory: ""
description: |-
Use this data source to access information about an existing Gateway Policy.
---

# ec_protection_gatewaypolicy (Data Source)

Use this data source to access information about an existing Gateway Policy.



<!-- schema generated by tfplugindocs -->
## Schema

### Optional

- `instance` (String) Name is an instance name configured in the provider.
- `metadata` (Block List, Max: 1) Standard object's metadata. (see [below for nested schema](#nestedblock--metadata))
- `spec` (Block List, Max: 1) Spec defines the desired gateway policy. (see [below for nested schema](#nestedblock--spec))

### Read-Only

- `id` (String) The ID of this resource.

<a id="nestedblock--metadata"></a>
### Nested Schema for `metadata`

Optional:

- `annotations` (Map of String) An unstructured map of keys and values stored on an object.
- `environment` (String) The name of the environment the object belongs to.
- `labels` (Map of String) A map of keys and values that can be used to organize and categorize objects.
- `name` (String) The unique object name within its scope.

Read-Only:

- `revision` (String) An opaque resource revision.
- `uid` (String) A unique identifier for each an object.


<a id="nestedblock--spec"></a>
### Nested Schema for `spec`

Required:

- `destination_cidrs` (List of String) DestinationCIDRs contain the CIDRs that should use the gateway.

Optional:

- `description` (String) Description is the optional gateway policy description.
- `display_name` (String) DisplayName is the display name of the gateway policy.
54 changes: 54 additions & 0 deletions docs/data-sources/protection_gatewaypolicy_v1alpha1.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "ec_protection_gatewaypolicy_v1alpha1 Data Source - terraform-provider-ec"
subcategory: ""
description: |-
Use this data source to access information about an existing Gateway Policy.
---

# ec_protection_gatewaypolicy_v1alpha1 (Data Source)

Use this data source to access information about an existing Gateway Policy.



<!-- schema generated by tfplugindocs -->
## Schema

### Optional

- `instance` (String) Name is an instance name configured in the provider.
- `metadata` (Block List, Max: 1) Standard object's metadata. (see [below for nested schema](#nestedblock--metadata))
- `spec` (Block List, Max: 1) Spec defines the desired gateway policy. (see [below for nested schema](#nestedblock--spec))

### Read-Only

- `id` (String) The ID of this resource.

<a id="nestedblock--metadata"></a>
### Nested Schema for `metadata`

Optional:

- `annotations` (Map of String) An unstructured map of keys and values stored on an object.
- `environment` (String) The name of the environment the object belongs to.
- `labels` (Map of String) A map of keys and values that can be used to organize and categorize objects.
- `name` (String) The unique object name within its scope.

Read-Only:

- `revision` (String) An opaque resource revision.
- `uid` (String) A unique identifier for each an object.


<a id="nestedblock--spec"></a>
### Nested Schema for `spec`

Required:

- `destination_cidrs` (List of String) DestinationCIDRs contain the CIDRs that should use the gateway.

Optional:

- `description` (String) Description is the optional gateway policy description.
- `display_name` (String) DisplayName is the display name of the gateway policy.
59 changes: 59 additions & 0 deletions docs/data-sources/protection_migration.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "ec_protection_migration Data Source - terraform-provider-ec"
subcategory: ""
description: |-
Use this data source to access information about an existing Migration.
---

# ec_protection_migration (Data Source)

Use this data source to access information about an existing Migration.



<!-- schema generated by tfplugindocs -->
## Schema

### Optional

- `instance` (String) Name is an instance name configured in the provider.
- `metadata` (Block List, Max: 1) Standard object's metadata. (see [below for nested schema](#nestedblock--metadata))
- `spec` (Block List, Max: 1) Spec defines the desired mitigation configuration. (see [below for nested schema](#nestedblock--spec))

### Read-Only

- `id` (String) The ID of this resource.

<a id="nestedblock--metadata"></a>
### Nested Schema for `metadata`

Optional:

- `annotations` (Map of String) An unstructured map of keys and values stored on an object.
- `environment` (String) The name of the environment the object belongs to.
- `labels` (Map of String) A map of keys and values that can be used to organize and categorize objects.
- `name` (String) The unique object name within its scope.

Read-Only:

- `revision` (String) An opaque resource revision.
- `uid` (String) A unique identifier for each an object.


<a id="nestedblock--spec"></a>
### Nested Schema for `spec`

Optional:

- `description` (String) Description is the optional description of the mitigation.
- `display_name` (String) DisplayName is the user-friendly name of the mitigation.
- `sts` (Block List, Max: 1) StS configures SteelShield for this mitigation. (see [below for nested schema](#nestedblock--spec--sts))

<a id="nestedblock--spec--sts"></a>
### Nested Schema for `spec.sts`

Optional:

- `action` (String) Action is the configured SteelShield action.
- `protocol` (String) Protocol is the protocol that the mitigation supports.
59 changes: 59 additions & 0 deletions docs/data-sources/protection_migration_v1alpha1.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "ec_protection_migration_v1alpha1 Data Source - terraform-provider-ec"
subcategory: ""
description: |-
Use this data source to access information about an existing Migration.
---

# ec_protection_migration_v1alpha1 (Data Source)

Use this data source to access information about an existing Migration.



<!-- schema generated by tfplugindocs -->
## Schema

### Optional

- `instance` (String) Name is an instance name configured in the provider.
- `metadata` (Block List, Max: 1) Standard object's metadata. (see [below for nested schema](#nestedblock--metadata))
- `spec` (Block List, Max: 1) Spec defines the desired mitigation configuration. (see [below for nested schema](#nestedblock--spec))

### Read-Only

- `id` (String) The ID of this resource.

<a id="nestedblock--metadata"></a>
### Nested Schema for `metadata`

Optional:

- `annotations` (Map of String) An unstructured map of keys and values stored on an object.
- `environment` (String) The name of the environment the object belongs to.
- `labels` (Map of String) A map of keys and values that can be used to organize and categorize objects.
- `name` (String) The unique object name within its scope.

Read-Only:

- `revision` (String) An opaque resource revision.
- `uid` (String) A unique identifier for each an object.


<a id="nestedblock--spec"></a>
### Nested Schema for `spec`

Optional:

- `description` (String) Description is the optional description of the mitigation.
- `display_name` (String) DisplayName is the user-friendly name of the mitigation.
- `sts` (Block List, Max: 1) StS configures SteelShield for this mitigation. (see [below for nested schema](#nestedblock--spec--sts))

<a id="nestedblock--spec--sts"></a>
### Nested Schema for `spec.sts`

Optional:

- `action` (String) Action is the configured SteelShield action.
- `protocol` (String) Protocol is the protocol that the mitigation supports.
Loading

0 comments on commit 208ed26

Please sign in to comment.