-
Couldn't load subscription status.
- Fork 121
Add Support for Kibana Security Detection Rules #1291
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Closed
Closed
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
0b2e3eb
Initial plan
Copilot 32d0255
Create basic structure for Kibana Security Detection Rules resource
Copilot ccbd16d
Implement HTTP client and CRUD operations for security detection rules
Copilot eb0b1ad
Fix linting issues and add changelog entry
Copilot a0d49ba
Add auto-generated documentation for security detection rule resource
Copilot cc0b67b
Use generated Kibana API client for detection rules and add comprehen…
Copilot File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,65 @@ | ||
| --- | ||
| # generated by https://github.com/hashicorp/terraform-plugin-docs | ||
| page_title: "elasticstack_kibana_security_detection_rule Resource - terraform-provider-elasticstack" | ||
| subcategory: "" | ||
| description: |- | ||
| Creates or updates a Kibana security detection rule. See https://www.elastic.co/guide/en/security/current/rules-api-create.html | ||
| --- | ||
|
|
||
| # elasticstack_kibana_security_detection_rule (Resource) | ||
|
|
||
| Creates or updates a Kibana security detection rule. See https://www.elastic.co/guide/en/security/current/rules-api-create.html | ||
|
|
||
|
|
||
|
|
||
| <!-- schema generated by tfplugindocs --> | ||
| ## Schema | ||
|
|
||
| ### Required | ||
|
|
||
| - `description` (String) The description of the detection rule. | ||
| - `name` (String) The name of the detection rule. | ||
| - `severity` (String) The severity of the rule. Valid values are: low, medium, high, critical. | ||
| - `type` (String) The rule type. Valid values are: eql, query, machine_learning, threshold, threat_match, new_terms. | ||
|
|
||
| ### Optional | ||
|
|
||
| - `author` (List of String) String array containing the rule's author(s). | ||
| - `enabled` (Boolean) Determines whether the rule is enabled. | ||
| - `exceptions_list` (List of String) List of exceptions that prevent alerts from being generated. | ||
| - `false_positives` (List of String) String array describing common reasons why the rule may issue false-positive alerts. | ||
| - `from` (String) Time from which data is analyzed each time the rule executes, using date math syntax. | ||
| - `index` (List of String) A list of index patterns to search. | ||
| - `interval` (String) How often the rule executes. | ||
| - `kibana_connection` (Block List) Kibana connection configuration block. (see [below for nested schema](#nestedblock--kibana_connection)) | ||
| - `language` (String) The query language. Valid values are: kuery, lucene, eql. | ||
| - `license` (String) The rule's license. | ||
| - `max_signals` (Number) Maximum number of alerts the rule can produce during a single execution. | ||
| - `meta` (String) Optional metadata about the rule as a JSON string. | ||
| - `note` (String) Notes to help investigate alerts produced by the rule. | ||
| - `query` (String) The query that the rule will use to generate alerts. | ||
| - `references` (List of String) String array containing notes about or references to relevant information about the rule. | ||
| - `risk` (Number) A numerical representation of the alert's severity from 1-100. | ||
| - `rule_id` (String) The identifier for the rule. If not provided, an ID is randomly generated. | ||
| - `rule_name_override` (String) Sets the source field for the alert's rule name. | ||
| - `space_id` (String) An identifier for the space. If space_id is not provided, the default space is used. | ||
| - `tags` (List of String) String array containing words and phrases to help categorize, filter, and search rules. | ||
| - `timestamp_override` (String) Sets the time field used to query indices. | ||
| - `to` (String) Time to which data is analyzed each time the rule executes, using date math syntax. | ||
| - `version` (Number) The rule's version number. | ||
|
|
||
| ### Read-Only | ||
|
|
||
| - `id` (String) Internal identifier of the resource | ||
|
|
||
| <a id="nestedblock--kibana_connection"></a> | ||
| ### Nested Schema for `kibana_connection` | ||
|
|
||
| Optional: | ||
|
|
||
| - `api_key` (String, Sensitive) API Key to use for authentication to Kibana | ||
| - `ca_certs` (List of String) A list of paths to CA certificates to validate the certificate presented by the Kibana server. | ||
| - `endpoints` (List of String, Sensitive) A comma-separated list of endpoints where the terraform provider will point to, this must include the http(s) schema and port number. | ||
| - `insecure` (Boolean) Disable TLS certificate validation | ||
| - `password` (String, Sensitive) Password to use for API authentication to Kibana. | ||
| - `username` (String) Username to use for API authentication to Kibana. | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Add a terraform usage example