An open API service indexing awesome lists of open source software.

https://github.com/terraform-yacloud-modules/terraform-yandex-audit-trails

Terraform module to manage Audit Trails resources within the Yandex.Cloud.
https://github.com/terraform-yacloud-modules/terraform-yandex-audit-trails

hacktoberfest yandex yandex-cloud

Last synced: 3 months ago
JSON representation

Terraform module to manage Audit Trails resources within the Yandex.Cloud.

Awesome Lists containing this project

README

          

# Yandex Cloud Audit Trails Terraform module

Terraform module which creates Yandex Cloud Audit Trails resources.

## Notes
Pay attention, that at one moment you can use only one destination: logging, storage or data_stream.

## Examples

Examples codified under
the [`examples`](https://github.com/terraform-yacloud-modules/terraform-yandex-module-template/tree/main/examples) are intended
to give users references for how to use the module(s) as well as testing/validating changes to the source code of the
module. If contributing to the project, please be sure to make any appropriate updates to the relevant examples to allow
maintainers to test your changes and to keep the examples up to date for users. Thank you!

## Requirements

| Name | Version |
|------|---------|
| [terraform](#requirement\_terraform) | >= 1.3 |
| [yandex](#requirement\_yandex) | >= 0.72.0 |

## Providers

| Name | Version |
|------|---------|
| [yandex](#provider\_yandex) | >= 0.72.0 |

## Modules

No modules.

## Resources

| Name | Type |
|------|------|
| [yandex_audit_trails_trail.main](https://registry.terraform.io/providers/yandex-cloud/yandex/latest/docs/resources/audit_trails_trail) | resource |
| [yandex_client_config.client](https://registry.terraform.io/providers/yandex-cloud/yandex/latest/docs/data-sources/client_config) | data source |

## Inputs

| Name | Description | Type | Default | Required |
|------|-------------|------|---------|:--------:|
| [data\_events\_filter](#input\_data\_events\_filter) | Data events list |

list(object({
service = string
resource_id = optional(string, null)
resource_type = string
included_events = optional(list(string), null)
excluded_events = optional(list(string), null)
}))
| `[]` | no |
| [data\_stream\_destination\_database\_id](#input\_data\_stream\_destination\_database\_id) | ID of the YDB hosting the destination data stream | `string` | `null` | no |
| [data\_stream\_destination\_stream\_name](#input\_data\_stream\_destination\_stream\_name) | Name of the YDS stream belonging to the specified YDB | `string` | `null` | no |
| [description](#input\_description) | Description of the trail | `string` | `""` | no |
| [folder\_id](#input\_folder\_id) | Folder ID | `string` | `null` | no |
| [labels](#input\_labels) | A set of labels | `map(string)` | `{}` | no |
| [logging\_destination\_log\_group\_id](#input\_logging\_destination\_log\_group\_id) | ID of the log group where logs will be sent | `string` | `null` | no |
| [management\_events\_filters](#input\_management\_events\_filters) | Management events list |
list(object({
resource_id = optional(string, null)
resource_type = string
}))
| `[]` | no |
| [name](#input\_name) | Trail name | `string` | n/a | yes |
| [service\_account\_id](#input\_service\_account\_id) | ID of the IAM service account that is used by the trail | `string` | n/a | yes |
| [storage\_destination\_bucket\_name](#input\_storage\_destination\_bucket\_name) | Name of the destination bucket | `string` | `null` | no |
| [storage\_destination\_object\_prefix](#input\_storage\_destination\_object\_prefix) | Additional prefix of the uploaded objects. If not specified, objects will be uploaded with prefix equal to trail\_id | `string` | `null` | no |

## Outputs

| Name | Description |
|------|-------------|
| [id](#output\_id) | ID of the created trail |
| [name](#output\_name) | Name of the created trail |

## License

Apache-2.0 Licensed.
See [LICENSE](https://github.com/terraform-yacloud-modules/terraform-yandex-module-template/blob/main/LICENSE).