From 5026a855bf6a683c41daa30e37597b5a250b2b0d Mon Sep 17 00:00:00 2001 From: VladyslavLukyanenko Date: Sun, 29 Oct 2023 11:56:06 +0100 Subject: [PATCH] add doc --- docs/resources/datastore.md | 1 + docs/resources/default_field_encryption.md | 4 ++++ docs/resources/group.md | 4 ++++ docs/resources/native_role.md | 1 + docs/resources/native_role_link.md | 4 ++++ docs/resources/policy.md | 4 ++++ docs/resources/satellite.md | 2 ++ docs/resources/sidecar.md | 2 ++ docs/resources/user.md | 1 + 9 files changed, 23 insertions(+) diff --git a/docs/resources/datastore.md b/docs/resources/datastore.md index 5cbf6869..2e4d2a72 100644 --- a/docs/resources/datastore.md +++ b/docs/resources/datastore.md @@ -28,6 +28,7 @@ Registering a Datastore with Formal. - `environment` (String) Environment for the datastore, options: DEV, TEST, QA, UAT, EI, PRE, STG, NON_PROD, PROD, CORP. - `health_check_db_name` (String) Database name to use for health checks. Default `postgres`. - `port` (Number) The port your Datastore is listening on. +- `termination_protection` (Boolean) If set to true, the datastore cannot be deleted. - `timeouts` (Block, Optional) (see [below for nested schema](#nestedblock--timeouts)) ### Read-Only diff --git a/docs/resources/default_field_encryption.md b/docs/resources/default_field_encryption.md index d97a87f7..7f85908e 100644 --- a/docs/resources/default_field_encryption.md +++ b/docs/resources/default_field_encryption.md @@ -21,6 +21,10 @@ Creating Field Encryptions in Formal. - `encryption_alg` (String) Encryption Algorithm to use. Supported values are `aes_random` and `aes_deterministic`. For highest security, `aes_random` is recommended, but `aes_deterministic` is required to enable search (WHERE clauses) over underlying data in encrypted fields. - `kms_key_id` (String) Formal ID of the encryption key to be used for this field encryption. This encryption key will be used to encrypt the data key. Read about envelope encryption here: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#enveloping +### Optional + +- `termination_protection` (Boolean) If set to true, this field encryption policy cannot be deleted. + ### Read-Only - `id` (String) The ID of this resource. diff --git a/docs/resources/group.md b/docs/resources/group.md index 361f07df..d1f9dcf4 100644 --- a/docs/resources/group.md +++ b/docs/resources/group.md @@ -20,6 +20,10 @@ Creating a Group in Formal. - `description` (String) Description for this Group. - `name` (String) Friendly Name for this Group. +### Optional + +- `termination_protection` (Boolean) If set to true, this Group cannot be deleted. + ### Read-Only - `id` (String) The Formal ID for this Group. diff --git a/docs/resources/native_role.md b/docs/resources/native_role.md index 3f2f2dc7..dd551c67 100644 --- a/docs/resources/native_role.md +++ b/docs/resources/native_role.md @@ -23,6 +23,7 @@ This resource creates a Native Role. ### Optional +- `termination_protection` (Boolean) If set to true, this Native Role cannot be deleted. - `use_as_default` (Boolean) The password of the Native Role. ### Read-Only diff --git a/docs/resources/native_role_link.md b/docs/resources/native_role_link.md index 859002bd..1580ef02 100644 --- a/docs/resources/native_role_link.md +++ b/docs/resources/native_role_link.md @@ -22,6 +22,10 @@ This resource creates assigns a Native Role to a Formal Identity. - `formal_identity_type` (String) The type of Formal Identity to be linked. Accepted values are `role` and `group`. - `native_role_id` (String) The Native Role ID of the Native Role. +### Optional + +- `termination_protection` (Boolean) If set to true, this Native Role link cannot be deleted. + ### Read-Only - `id` (String) The ID of this resource. diff --git a/docs/resources/policy.md b/docs/resources/policy.md index 16fbf561..86411972 100644 --- a/docs/resources/policy.md +++ b/docs/resources/policy.md @@ -25,6 +25,10 @@ Creating a Policy in Formal. - `owners` (List of String) Owners of this policy. - `status` (String) Defines the current status of the policy. It can be one of the following: 'draft', 'dry-run', or 'active'. +### Optional + +- `termination_protection` (Boolean) If set to true, this Policy cannot be deleted. + ### Read-Only - `created_at` (String) When the policy was created. diff --git a/docs/resources/satellite.md b/docs/resources/satellite.md index fecd768f..fada5de1 100644 --- a/docs/resources/satellite.md +++ b/docs/resources/satellite.md @@ -21,10 +21,12 @@ Registering a Satellite ### Optional +- `termination_protection` (Boolean) If set to true, this Satellite cannot be deleted. - `timeouts` (Block, Optional) (see [below for nested schema](#nestedblock--timeouts)) ### Read-Only +- `api_key` (String, Sensitive) Api key of the Satellite. - `id` (String) The ID of the Satellite. - `tls_cert` (String) TLS certificate of the Satellite. diff --git a/docs/resources/sidecar.md b/docs/resources/sidecar.md index 84b148fd..e489aa93 100644 --- a/docs/resources/sidecar.md +++ b/docs/resources/sidecar.md @@ -29,11 +29,13 @@ Registering a Sidecar with Formal. - `fail_open` (Boolean) Configure DNS failover from the sidecar to the original datastore. In the unlikely case where the sidecar is unhealthy, having this value of `true` will forward traffic to the original database. Default `false`. - `formal_hostname` (String) The hostname of the created sidecar. - `network_type` (String) Configure the sidecar network type. Value can be `internet-facing`, `internal` or `internet-and-internal`. +- `termination_protection` (Boolean) If set to true, this Sidecar cannot be deleted. - `timeouts` (Block, Optional) (see [below for nested schema](#nestedblock--timeouts)) - `version` (String) Version of the Sidecar to deploy for `managed`. ### Read-Only +- `api_key` (String, Sensitive) Api key for the deployed Sidecar. - `created_at` (Number) Creation time of the sidecar. - `formal_control_plane_tls_certificate` (String, Sensitive) If deployment_type is onprem, this is the Control Plane TLS Certificate to add to the deployed Sidecar. - `id` (String) The ID of this Sidecar. diff --git a/docs/resources/user.md b/docs/resources/user.md index b0c388d4..8b29557b 100644 --- a/docs/resources/user.md +++ b/docs/resources/user.md @@ -28,6 +28,7 @@ User in Formal. - `first_name` (String) For human users, their first name. - `last_name` (String) For human users, their last name. - `name` (String) For machine users, the name of the user. +- `termination_protection` (Boolean) If set to true, this User cannot be deleted. ### Read-Only