From 1896792f437d067899c8aca0257cf1c5c9ec236e Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Tue, 23 Jul 2024 16:41:34 +0000 Subject: [PATCH] terraform-docs: automated action --- .../README.md | 14 ++++++++++++++ .../README.md | 14 ++++++++++++++ examples/onboard-aws-rds-aurora-mysql/README.md | 14 ++++++++++++++ .../README.md | 17 ++++++++++++++++- .../onboard-aws-rds-aurora-postgresql/README.md | 9 ++++++++- modules/aws-kms-key/README.md | 4 ++++ 6 files changed, 70 insertions(+), 2 deletions(-) diff --git a/examples/onboard-aws-rds-aurora-mysql-kinesis/README.md b/examples/onboard-aws-rds-aurora-mysql-kinesis/README.md index 06ad80a..b68fbcc 100644 --- a/examples/onboard-aws-rds-aurora-mysql-kinesis/README.md +++ b/examples/onboard-aws-rds-aurora-mysql-kinesis/README.md @@ -10,7 +10,13 @@ It creates both 'aws' and 'dsfhub' resources. More information regarding authent An AWS account asset will need to be onboarded to your DSF hub prior to using this module. The account asset will need to be granted permissions to be able to read from the newly created kinesis stream. +## Requirements +No requirements. + +## Providers + +No providers. ## Modules @@ -19,10 +25,18 @@ An AWS account asset will need to be onboarded to your DSF hub prior to using th | [aws-aurora-mysql-kinesis](#module\_aws-aurora-mysql-kinesis) | ../../modules/onboard-aws-rds-aurora-mysql-kinesis | n/a | | [aws-default-account-asset](#module\_aws-default-account-asset) | imperva/agentless-onboarding/dsfhub//modules/dsfhub-aws-cloud-account | n/a | +## Resources + +No resources. + ## Inputs | Name | Description | Type | Default | Required | |------|-------------|------|---------|:--------:| | [dsfhub\_host](#input\_dsfhub\_host) | n/a | `any` | n/a | yes | | [dsfhub\_token](#input\_dsfhub\_token) | n/a | `any` | n/a | yes | + +## Outputs + +No outputs. \ No newline at end of file diff --git a/examples/onboard-aws-rds-aurora-mysql-slowquery/README.md b/examples/onboard-aws-rds-aurora-mysql-slowquery/README.md index a69ea57..64d2213 100644 --- a/examples/onboard-aws-rds-aurora-mysql-slowquery/README.md +++ b/examples/onboard-aws-rds-aurora-mysql-slowquery/README.md @@ -10,7 +10,13 @@ This example creates both 'aws' and 'dsfhub' resources. More information regardi An AWS account asset will need to be onboarded to your DSF hub prior to using this module. The account asset will need to be granted permissions to be able to read from the newly created CloudWatch log group. +## Requirements +No requirements. + +## Providers + +No providers. ## Modules @@ -19,10 +25,18 @@ An AWS account asset will need to be onboarded to your DSF hub prior to using th | [aws-aurora-mysql-slowquery](#module\_aws-aurora-mysql-slowquery) | ../../modules/onboard-aws-rds-aurora-mysql-slowquery | n/a | | [aws-default-account-asset](#module\_aws-default-account-asset) | imperva/agentless-onboarding/dsfhub//modules/dsfhub-aws-cloud-account | n/a | +## Resources + +No resources. + ## Inputs | Name | Description | Type | Default | Required | |------|-------------|------|---------|:--------:| | [dsfhub\_host](#input\_dsfhub\_host) | n/a | `any` | n/a | yes | | [dsfhub\_token](#input\_dsfhub\_token) | n/a | `any` | n/a | yes | + +## Outputs + +No outputs. \ No newline at end of file diff --git a/examples/onboard-aws-rds-aurora-mysql/README.md b/examples/onboard-aws-rds-aurora-mysql/README.md index 2a8c882..cc807c1 100644 --- a/examples/onboard-aws-rds-aurora-mysql/README.md +++ b/examples/onboard-aws-rds-aurora-mysql/README.md @@ -10,7 +10,13 @@ This example creates both 'aws' and 'dsfhub' resources. More information regardi An AWS account asset will need to be onboarded to your DSF hub prior to using this module. The account asset will need to be granted permissions to be able to read from the newly created CloudWatch log group. +## Requirements +No requirements. + +## Providers + +No providers. ## Modules @@ -19,10 +25,18 @@ An AWS account asset will need to be onboarded to your DSF hub prior to using th | [aws-aurora-mysql](#module\_aws-aurora-mysql) | ../../modules/onboard-aws-rds-aurora-mysql | n/a | | [aws-default-account-asset](#module\_aws-default-account-asset) | imperva/agentless-onboarding/dsfhub//modules/dsfhub-aws-cloud-account | n/a | +## Resources + +No resources. + ## Inputs | Name | Description | Type | Default | Required | |------|-------------|------|---------|:--------:| | [dsfhub\_host](#input\_dsfhub\_host) | n/a | `any` | n/a | yes | | [dsfhub\_token](#input\_dsfhub\_token) | n/a | `any` | n/a | yes | + +## Outputs + +No outputs. \ No newline at end of file diff --git a/examples/onboard-aws-rds-aurora-postgresql-kinesis/README.md b/examples/onboard-aws-rds-aurora-postgresql-kinesis/README.md index c819706..474c17c 100644 --- a/examples/onboard-aws-rds-aurora-postgresql-kinesis/README.md +++ b/examples/onboard-aws-rds-aurora-postgresql-kinesis/README.md @@ -10,19 +10,34 @@ It creates both 'aws' and 'dsfhub' resources. More information regarding authent An AWS account asset will need to be onboarded to your DSF hub prior to using this module. The account asset will need to be granted permissions to be able to read from the newly created kinesis stream. +## Requirements +No requirements. + +## Providers + +No providers. ## Modules | Name | Source | Version | |------|--------|---------| -| [aws-aurora-postgresql-kinesis](#module\_aws-aurora-postgresql-kinesis) | ../../modules/onboard-aws-rds-aurora-postgresql-kinesis | n/a | +| [aws-aurora-postgresql-kinesis-1](#module\_aws-aurora-postgresql-kinesis-1) | ../../modules/onboard-aws-rds-aurora-postgresql-kinesis | n/a | +| [aws-aurora-postgresql-kinesis-2](#module\_aws-aurora-postgresql-kinesis-2) | ../../modules/onboard-aws-rds-aurora-postgresql-kinesis | n/a | | [aws-default-account-asset](#module\_aws-default-account-asset) | imperva/agentless-onboarding/dsfhub//modules/dsfhub-aws-cloud-account | n/a | +## Resources + +No resources. + ## Inputs | Name | Description | Type | Default | Required | |------|-------------|------|---------|:--------:| | [dsfhub\_host](#input\_dsfhub\_host) | n/a | `any` | n/a | yes | | [dsfhub\_token](#input\_dsfhub\_token) | n/a | `any` | n/a | yes | + +## Outputs + +No outputs. \ No newline at end of file diff --git a/examples/onboard-aws-rds-aurora-postgresql/README.md b/examples/onboard-aws-rds-aurora-postgresql/README.md index 7f0b482..0a4c600 100644 --- a/examples/onboard-aws-rds-aurora-postgresql/README.md +++ b/examples/onboard-aws-rds-aurora-postgresql/README.md @@ -15,7 +15,9 @@ Part of the onboarding process involves connecting to your Aurora PostgreSQL clu **Note:** This example requires the ``psql`` client to be installed, as well as for the newly created Aurora cluster to be accessible from your local machine. +## Requirements +No requirements. ## Providers @@ -27,7 +29,8 @@ Part of the onboarding process involves connecting to your Aurora PostgreSQL clu | Name | Source | Version | |------|--------|---------| -| [aurora-postgresql](#module\_aurora-postgresql) | ../../modules/onboard-aws-rds-aurora-postgresql | n/a | +| [aurora-postgresql-1](#module\_aurora-postgresql-1) | ../../modules/onboard-aws-rds-aurora-postgresql | n/a | +| [aurora-postgresql-2](#module\_aurora-postgresql-2) | ../../modules/onboard-aws-rds-aurora-postgresql | n/a | | [aws-default-account-asset](#module\_aws-default-account-asset) | imperva/agentless-onboarding/dsfhub//modules/dsfhub-aws-cloud-account | n/a | ## Resources @@ -42,4 +45,8 @@ Part of the onboarding process involves connecting to your Aurora PostgreSQL clu |------|-------------|------|---------|:--------:| | [dsfhub\_host](#input\_dsfhub\_host) | n/a | `any` | n/a | yes | | [dsfhub\_token](#input\_dsfhub\_token) | n/a | `any` | n/a | yes | + +## Outputs + +No outputs. \ No newline at end of file diff --git a/modules/aws-kms-key/README.md b/modules/aws-kms-key/README.md index 36de536..9014eb7 100644 --- a/modules/aws-kms-key/README.md +++ b/modules/aws-kms-key/README.md @@ -9,6 +9,10 @@ No requirements. |------|---------| | [aws](#provider\_aws) | n/a | +## Modules + +No modules. + ## Resources | Name | Type |