Getting information about a WAF rule set

With Terraform, you can quickly create a cloud infrastructure in Yandex Cloud and manage it using configuration files. These files store the infrastructure description written in HashiCorp Configuration Language (HCL). If you change the configuration files, Terraform automatically detects which part of your configuration is already deployed, and what should be added or removed.

Terraform is distributed under the Business Source License. The Yandex Cloud provider for Terraform is distributed under the MPL-2.0 license.

For more information about the provider resources, see the guides on the Terraform website or its mirror.

If you do not have Terraform yet, install it and configure the Yandex Cloud provider.

To manage infrastructure using Terraform under a service account or user accounts (a Yandex account, a federated account, or a local user), authenticate using the appropriate method.

To get information about a WAF rule set using Terraform:

1. Add the data and output sections to the Terraform configuration file:

   data "yandex_sws_waf_rule_set_descriptor" "owasp4" {
     name    = "OWASP Core Ruleset"
     version = "4.0.0"
   }
   
   output "waf_rules" {
     value = data.yandex_sws_waf_rule_set_descriptor.owasp4.rules
   }
   

   Where:

   • data "yandex_sws_waf_rule_set_descriptor": Description of the WAF rule set as a data source:
     • name: Name of the WAF rule set.
     • version: Rule set version.
   • output "waf_rules": Output variable that contains information about the WAF rule set:
     • value: Return value.

   You can replace rules with another variable to get the information you need. For more on the properties of the yandex_sws_waf_rule_set_descriptor data source, see this provider guide.

2. Create the resources:

   1. In the terminal, navigate to the configuration file directory.

   2. Make sure the configuration is correct using this command:

      terraform validate
      

      If the configuration is valid, you will get this message:

      Success! The configuration is valid.
      

   3. Run this command:

      terraform plan
      

      You will see a list of resources and their properties. No changes will be made at this step. Terraform will show any errors in the configuration.

   4. Apply the configuration changes:

      terraform apply
      

   5. Type yes and press Enter to confirm the changes.

   Terraform will create all required resources and display their output variables. To check the results, run this command:

   terraform output
   

   Result:

   waf_rules = tolist([
     {
       "anomaly_score" = 5
       "id" = "owasp-crs-v4.0.0-id******-method-enforcement"
       "paranoia_level" = 1
     },
   ...
     {
       "anomaly_score" = 5
       "id" = "owasp-crs-v4.0.0-id******-attack-java"
       "paranoia_level" = 4
     },
   ])
   

Use the get REST API method for the WafProfile resource or the WafProfile/Get gRPC API call.