Skip to content

Commit

Permalink
generated markdown
Browse files Browse the repository at this point in the history
  • Loading branch information
misterpantz committed Dec 18, 2024
1 parent 59267a8 commit ed99dbb
Show file tree
Hide file tree
Showing 25 changed files with 74 additions and 74 deletions.
10 changes: 5 additions & 5 deletions docs/resources/custom_framework.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@
page_title: "mondoo_custom_framework Resource - terraform-provider-mondoo"
subcategory: ""
description: |-
Set custom Compliance Frameworks for a Mondoo Space.
Set custom compliance frameworks for a Mondoo space.
---

# mondoo_custom_framework (Resource)

Set custom Compliance Frameworks for a Mondoo Space.
Set custom compliance frameworks for a Mondoo space.

## Example Usage

Expand All @@ -33,12 +33,12 @@ resource "mondoo_custom_framework" "custom_framework" {

### Required

- `data_url` (String) URL to the custom Compliance Framework data.
- `data_url` (String) URL to the custom compliance framework data.

### Optional

- `space_id` (String) Mondoo Space Identifier. If it is not provided, the provider space is used.
- `space_id` (String) Mondoo space identifier. If there's no space ID, the provider space is used.

### Read-Only

- `mrn` (String) Mondoo Resource Name.
- `mrn` (String) Mondoo resource name.
2 changes: 1 addition & 1 deletion docs/resources/custom_policy.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ resource "mondoo_policy_assignment" "space" {
- `content` (String, Sensitive) Data as string to be uploaded. Must be defined if source is not. Note: The content field is marked as sensitive. To view the raw contents of the object, please define an output.
- `overwrite` (Boolean) If set to true, existing policies are overwritten.
- `source` (String) A path to the data you want to upload. Must be defined if content is not.
- `space_id` (String) Mondoo Space Identifier. If it is not provided, the provider space is used.
- `space_id` (String) Mondoo space identifier. If there is no space ID, the provider space is used.

### Read-Only

Expand Down
2 changes: 1 addition & 1 deletion docs/resources/custom_querypack.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ resource "mondoo_querypack_assignment" "space" {
- `content` (String, Sensitive) Data as string to be uploaded. Must be defined if source is not. Note: The content field is marked as sensitive. To view the raw contents of the object, please define an output.
- `overwrite` (Boolean) If set to true, existing policies are overwritten.
- `source` (String) A path to the data you want to upload. Must be defined if content is not.
- `space_id` (String) Mondoo Space Identifier. If it is not provided, the provider space is used.
- `space_id` (String) Mondoo space identifier. If there is no space ID, the provider space is used.

### Read-Only

Expand Down
8 changes: 4 additions & 4 deletions docs/resources/exception.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@
page_title: "mondoo_exception Resource - terraform-provider-mondoo"
subcategory: ""
description: |-
Set custom exceptions for a Scope.
Set custom exceptions for a scope.
---

# mondoo_exception (Resource)

Set custom exceptions for a Scope.
Set custom exceptions for a scope.

## Example Usage

Expand Down Expand Up @@ -47,9 +47,9 @@ resource "mondoo_exception" "exception" {

### Optional

- `action` (String) The action to perform. Default is `SNOOZE`. Other options are `ENABLE`, `DISABLE`, `OUT_OF_SCOPE`.
- `action` (String) The action to perform. Default is `SNOOZE`. Other options are `ENABLE`, `DISABLE`, and `OUT_OF_SCOPE`.
- `check_mrns` (List of String) List of check MRNs to set exceptions for. If set, `vulnerability_mrns` must not be set.
- `justification` (String) Description why the exception is required.
- `scope_mrn` (String) The MRN of the scope (either asset mrn or space mrn).
- `valid_until` (String) The timestamp until the exception is valid.
- `valid_until` (String) The date when the exception is no longer valid.
- `vulnerability_mrns` (List of String) List of vulnerability MRNs to set exceptions for. If set, `check_mrns` must not be set.
10 changes: 5 additions & 5 deletions docs/resources/framework_assignment.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@
page_title: "mondoo_framework_assignment Resource - terraform-provider-mondoo"
subcategory: ""
description: |-
Set Compliance Frameworks for a Mondoo Space.
Set compliance frameworks for a Mondoo space.
---

# mondoo_framework_assignment (Resource)

Set Compliance Frameworks for a Mondoo Space.
Set compliance frameworks for a Mondoo space.

## Example Usage

Expand All @@ -31,9 +31,9 @@ resource "mondoo_framework_assignment" "framework_assignment" {

### Required

- `enabled` (Boolean) Enable or disable the Compliance Framework.
- `framework_mrn` (List of String) Compliance Framework MRN.
- `enabled` (Boolean) Enable or disable the compliance framework.
- `framework_mrn` (List of String) Compliance framework MRN.

### Optional

- `space_id` (String) Mondoo Space Identifier. If it is not provided, the provider space is used.
- `space_id` (String) Mondoo space identifier. If there's no ID, the provider space is used.
2 changes: 1 addition & 1 deletion docs/resources/integration_aws.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ resource "mondoo_integration_aws" "name" {

### Optional

- `space_id` (String) Mondoo Space Identifier. If it is not provided, the provider space is used.
- `space_id` (String) Mondoo space identifier. If there is no ID, the provider space is used.

### Read-Only

Expand Down
6 changes: 3 additions & 3 deletions docs/resources/integration_aws_serverless.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,10 +101,10 @@ resource "aws_cloudformation_stack" "mondoo_stack" {
### Optional

- `account_ids` (List of String) List of AWS account IDs.
- `console_sign_in_trigger` (Boolean) Enable console sign in trigger.
- `console_sign_in_trigger` (Boolean) Enable console sign-in trigger.
- `instance_state_change_trigger` (Boolean) Enable instance state change trigger.
- `is_organization` (Boolean) Is organization.
- `space_id` (String) Mondoo Space Identifier. If it is not provided, the provider space is used.
- `space_id` (String) Mondoo space identifier. If there is no ID, the provider space is used.

### Read-Only

Expand Down Expand Up @@ -136,7 +136,7 @@ Optional:
- `ebs_volume_scan` (Boolean) Enable EBS volume scan.
- `exclude_instance_ids_filter` (List of String) List of instance IDs to exclude.
- `exclude_regions_filter` (List of String) List of regions to exclude.
- `exclude_tags_filter` (Map of String) Excluded Tags filter.
- `exclude_tags_filter` (Map of String) Excluded tags filter.
- `instance_connect` (Boolean) Enable instance connect.
- `instance_ids_filter` (List of String) List of instance IDs filter.
- `regions_filter` (List of String) List of regions filter.
Expand Down
10 changes: 5 additions & 5 deletions docs/resources/integration_azure.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@
page_title: "mondoo_integration_azure Resource - terraform-provider-mondoo"
subcategory: ""
description: |-
Continuously scan Microsoft Azure subscriptions and resources for misconfigurations and vulnerabilities. See Mondoo documentation https://mondoo.com/docs/platform/infra/cloud/azure/azure-integration-scan-subscription/ for more details.
Continuously scan Microsoft Azure subscriptions and resources for misconfigurations and vulnerabilities. To learn more, read the Mondoo documentation https://mondoo.com/docs/platform/infra/cloud/azure/azure-integration-scan-subscription/.
---

# mondoo_integration_azure (Resource)

Continuously scan Microsoft Azure subscriptions and resources for misconfigurations and vulnerabilities. See [Mondoo documentation](https://mondoo.com/docs/platform/infra/cloud/azure/azure-integration-scan-subscription/) for more details.
Continuously scan Microsoft Azure subscriptions and resources for misconfigurations and vulnerabilities. To learn more, read the [Mondoo documentation](https://mondoo.com/docs/platform/infra/cloud/azure/azure-integration-scan-subscription/).

## Example Usage

Expand Down Expand Up @@ -278,15 +278,15 @@ resource "mondoo_integration_azure" "azure_integration" {

### Required

- `client_id` (String) Azure Client ID.
- `client_id` (String) Azure client ID.
- `credentials` (Attributes) (see [below for nested schema](#nestedatt--credentials))
- `name` (String) Name of the integration.
- `tenant_id` (String) Azure Tenant ID.
- `tenant_id` (String) Azure tenant ID.

### Optional

- `scan_vms` (Boolean) Scan VMs.
- `space_id` (String) Mondoo Space Identifier. If it is not provided, the provider space is used.
- `space_id` (String) Mondoo space identifier. If there is no space ID, the provider space is used.
- `subscription_allow_list` (List of String) List of Azure subscriptions to scan.
- `subscription_deny_list` (List of String) List of Azure subscriptions to exclude from scanning.

Expand Down
2 changes: 1 addition & 1 deletion docs/resources/integration_domain.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ resource "mondoo_integration_domain" "domain_integration" {

- `http` (Boolean) Enable HTTP port.
- `https` (Boolean) Enable HTTPS port.
- `space_id` (String) Mondoo Space Identifier. If it is not provided, the provider space is used.
- `space_id` (String) Mondoo space identifier. If there is no space ID, the provider space is used.

### Read-Only

Expand Down
10 changes: 5 additions & 5 deletions docs/resources/integration_email.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@
page_title: "mondoo_integration_email Resource - terraform-provider-mondoo"
subcategory: ""
description: |-
Send an email to your ticket system, or any recipient.
Send email to your ticket system or any recipient.
---

# mondoo_integration_email (Resource)

Send an email to your ticket system, or any recipient.
Send email to your ticket system or any recipient.

## Example Usage

Expand Down Expand Up @@ -53,7 +53,7 @@ resource "mondoo_integration_email" "email_integration" {

- `auto_close` (Boolean) Auto close tickets (defaults to false).
- `auto_create` (Boolean) Auto create tickets (defaults to false).
- `space_id` (String) Mondoo Space Identifier. If it is not provided, the provider space is used.
- `space_id` (String) Mondoo space identifier. If there is no space ID, the provider space is used.

### Read-Only

Expand All @@ -69,5 +69,5 @@ Required:

Optional:

- `is_default` (Boolean) Mark this recipient as default. This needs to be set if auto_create is enabled.
- `reference_url` (String) Reference URL for the recipient.
- `is_default` (Boolean) Mark this recipient as default. This must be set if auto_create is enabled.
- `reference_url` (String) Optional reference URL for the recipient.
8 changes: 4 additions & 4 deletions docs/resources/integration_gcp.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@
page_title: "mondoo_integration_gcp Resource - terraform-provider-mondoo"
subcategory: ""
description: |-
Continuously scan Google GCP organizations and projects for misconfigurations and vulnerabilities.
Continuously scan GCP organizations and projects for misconfigurations and vulnerabilities.
---

# mondoo_integration_gcp (Resource)

Continuously scan Google GCP organizations and projects for misconfigurations and vulnerabilities.
Continuously scan GCP organizations and projects for misconfigurations and vulnerabilities.

## Example Usage

Expand Down Expand Up @@ -78,8 +78,8 @@ resource "mondoo_integration_gcp" "name" {

### Optional

- `project_id` (String) GCP project id
- `space_id` (String) Mondoo Space Identifier. If it is not provided, the provider space is used.
- `project_id` (String) GCP project ID
- `space_id` (String) Mondoo space identifier. If there is no space ID, the provider space is used.

### Read-Only

Expand Down
6 changes: 3 additions & 3 deletions docs/resources/integration_github.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,14 +48,14 @@ resource "mondoo_integration_github" "gh_integration" {

- `credentials` (Attributes) (see [below for nested schema](#nestedatt--credentials))
- `name` (String) Name of the integration.
- `owner` (String) GitHub Owner.
- `owner` (String) GitHub owner.

### Optional

- `repository` (String) GitHub Repository.
- `repository` (String) GitHub repository.
- `repository_allow_list` (List of String) List of GitHub repositories to scan.
- `repository_deny_list` (List of String) List of GitHub repositories to exclude from scanning.
- `space_id` (String) Mondoo Space Identifier. If it is not provided, the provider space is used.
- `space_id` (String) Mondoo space identifier. If there is no space ID, the provider space is used.

### Read-Only

Expand Down
2 changes: 1 addition & 1 deletion docs/resources/integration_gitlab.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ resource "mondoo_integration_gitlab" "gitlab_integration" {
- `base_url` (String) Base URL of the GitLab instance (only set this if your instance is self-hosted).
- `discovery` (Attributes) (see [below for nested schema](#nestedatt--discovery))
- `group` (String) Group to assign the integration to (by default all groups are discovered).
- `space_id` (String) Mondoo Space Identifier. If it is not provided, the provider space is used.
- `space_id` (String) Mondoo space identifier. If there is no space ID, the provider space is used.

### Read-Only

Expand Down
8 changes: 4 additions & 4 deletions docs/resources/integration_jira.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@
page_title: "mondoo_integration_jira Resource - terraform-provider-mondoo"
subcategory: ""
description: |-
Integrate the Ticketing System Jira with Mondoo to automatically create and close issues based on Mondoo findings.
Integrate the Jira ticket system with Mondoo to automatically create and close Jira issues based on Mondoo findings.
---

# mondoo_integration_jira (Resource)

Integrate the Ticketing System Jira with Mondoo to automatically create and close issues based on Mondoo findings.
Integrate the Jira ticket system with Mondoo to automatically create and close Jira issues based on Mondoo findings.

## Example Usage

Expand Down Expand Up @@ -53,8 +53,8 @@ resource "mondoo_integration_jira" "jira_integration" {

- `auto_close` (Boolean) Automatically close Jira issues for resolved Mondoo findings
- `auto_create` (Boolean) Automatically create Jira issues for Mondoo findings.
- `default_project` (String) Default Jira project (is represented by the project key e.g. `MONDOO`).
- `space_id` (String) Mondoo Space Identifier. If it is not provided, the provider space is used.
- `default_project` (String) Default Jira project (represented by the project key, such as `SEC` or `SECURITY`).
- `space_id` (String) Mondoo space identifier. If there is no space ID, the provider space is used.

### Read-Only

Expand Down
12 changes: 6 additions & 6 deletions docs/resources/integration_ms365.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@
page_title: "mondoo_integration_ms365 Resource - terraform-provider-mondoo"
subcategory: ""
description: |-
Continuously monitor your Microsoft 365 resources for misconfigurations and vulnerabilities. See Mondoo documentation https://mondoo.com/docs/platform/infra/saas/ms365/ms365-auto/ for more details.
Continuously monitor your Microsoft 365 resources for misconfigurations and vulnerabilities. To learn more, read the Mondoo documentation https://mondoo.com/docs/platform/infra/saas/ms365/ms365-auto/.
---

# mondoo_integration_ms365 (Resource)

Continuously monitor your Microsoft 365 resources for misconfigurations and vulnerabilities. See [Mondoo documentation](https://mondoo.com/docs/platform/infra/saas/ms365/ms365-auto/) for more details.
Continuously monitor your Microsoft 365 resources for misconfigurations and vulnerabilities. To learn more, read the [Mondoo documentation](https://mondoo.com/docs/platform/infra/saas/ms365/ms365-auto/).

## Example Usage

Expand Down Expand Up @@ -188,14 +188,14 @@ resource "mondoo_integration_ms365" "ms365_integration" {

### Required

- `client_id` (String) Azure Client ID.
- `client_id` (String) Azure client ID.
- `credentials` (Attributes) (see [below for nested schema](#nestedatt--credentials))
- `name` (String) Name of the integration.
- `tenant_id` (String) Azure Tenant ID.
- `tenant_id` (String) Azure tenant ID.

### Optional

- `space_id` (String) Mondoo Space Identifier. If it is not provided, the provider space is used.
- `space_id` (String) Mondoo space identifier. If there is no space ID, the provider space is used.

### Read-Only

Expand All @@ -206,4 +206,4 @@ resource "mondoo_integration_ms365" "ms365_integration" {

Required:

- `pem_file` (String, Sensitive) PEM file for Ms365 integration.
- `pem_file` (String, Sensitive) PEM file for MS365 integration.
10 changes: 5 additions & 5 deletions docs/resources/integration_msdefender.md
Original file line number Diff line number Diff line change
Expand Up @@ -278,16 +278,16 @@ resource "mondoo_integration_msdefender" "msdefender_integration" {

### Required

- `client_id` (String) Azure Client ID.
- `client_id` (String) Azure client ID.
- `credentials` (Attributes) (see [below for nested schema](#nestedatt--credentials))
- `name` (String) Name of the integration.
- `tenant_id` (String) Azure Tenant ID.
- `tenant_id` (String) Azure tenant ID.

### Optional

- `space_id` (String) Mondoo Space Identifier. If it is not provided, the provider space is used.
- `subscription_allow_list` (List of String) List of Azure subscriptions to scan.
- `subscription_deny_list` (List of String) List of Azure subscriptions to exclude from scanning.
- `space_id` (String) Mondoo space identifier. If there is no space ID, the provider space is used.
- `subscription_allow_list` (List of String) List of Azure subscriptions from which to import Defender data.
- `subscription_deny_list` (List of String) List of Azure subscriptions to exclude from imports.

### Read-Only

Expand Down
6 changes: 3 additions & 3 deletions docs/resources/integration_oci_tenant.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@
page_title: "mondoo_integration_oci_tenant Resource - terraform-provider-mondoo"
subcategory: ""
description: |-
Example resource
Continuously monitor OCI tenancies and resources for misconfigurations and vulnerabilities.
---

# mondoo_integration_oci_tenant (Resource)

Example resource
Continuously monitor OCI tenancies and resources for misconfigurations and vulnerabilities.

## Example Usage

Expand Down Expand Up @@ -52,7 +52,7 @@ EOT
### Optional

- `name` (String) Name of the integration.
- `space_id` (String) Mondoo Space Identifier. If it is not provided, the provider space is used.
- `space_id` (String) Mondoo space identifier. If there is no space ID, the provider space is used.

### Read-Only

Expand Down
2 changes: 1 addition & 1 deletion docs/resources/integration_shodan.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ resource "mondoo_integration_shodan" "shodan_integration" {

### Optional

- `space_id` (String) Mondoo Space Identifier. If it is not provided, the provider space is used.
- `space_id` (String) Mondoo space identifier. If there is no space ID, the provider space is used.

### Read-Only

Expand Down
Loading

0 comments on commit ed99dbb

Please sign in to comment.