Creating an ARL profile

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 documentation on the Terraform website or mirror website.

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

To create an ARL profile:

1. In the Terraform configuration file, define the parameters of the resources you want to create:

   # ARL profile
   
   resource "yandex_sws_advanced_rate_limiter_profile" "arl-profile" {
     name        = "<profile_name>"
     description = "<profile_description>"
   
     # Rule 1
   
     advanced_rate_limiter_rule {
       name        = "<rule_name>"
       priority    = <rule_priority>
       description = "<rule_description>"
       dry_run     = true
   
       static_quota {
         action = "DENY"
         limit  = <rule_limit>
         period = <rule_period>
         condition {
           request_uri {
             path {
               exact_match = "/api"
             }
           }
         }
       }
     }
   }
   

   Where:

   • name: ARL profile name.
   • description: ARL profile description. This is an optional parameter.
   • labels: ARL profile labels. This is an optional parameter.
   • advanced_rate_limiter_rule: Rule section.
     • name: Rule name.
     • priority: Rule priority, a unique number from 1 to 999999. Rules with smaller numerical values apply first.
     • description: Rule description. This is an optional parameter.
     • dry_run: Dry run flag. Set to true to test the rule and estimate the load on your web service. Requests will not be blocked in this mode. However, rule triggering will be logged. This is an optional parameter.
     • static_quota: Request count mode where each request is counted individually without grouping. You can only specify one section, either static_quota or dynamic_quota.
       • action: Action if the limit is exceeded. The only available value is DENY.
       • limit: Maximum number of allowed queries per period.
       • period: Time period in seconds in which the limit applies.
       • condition: Condition for applying the rule. This is an optional parameter. For more information, see the advanced_rate_limiter_rule.static_quota.condition description in this provider article.
     • dynamic_quota: Request count mode where groups of requests sharing one or more properties are counted. You can only specify one section, either static_quota or dynamic_quota.
       • action: Action if the limit is exceeded. The only available value is DENY.
       • limit: Maximum number of allowed queries per period.
       • period: Time period in seconds in which the limit applies.
       • condition: Condition for applying the rule. This is an optional parameter. For more information, see the advanced_rate_limiter_rule.dynamic_quota.condition description in this provider article.
       • characteristic: Description of properties to group requests by. You can specify one section, either simple_characteristic or key_characteristic.
         • case_insensitive: Case insensitive, if true, or sensitive, if false.
         • key_characteristic: Section of parameters requiring a key (string) to group requests by.
           • type: Grouping type. The possible values are COOKIE_KEY, HEADER_KEY, and QUERY_KEY.
           • value: Key value (string) to group requests by.
         • simple_characteristic: Section with parameters for autogrouping, i.e., requests are automatically grouped by the specified parameter.
           • type: Grouping type. The possible values are REQUEST_PATH, HTTP_METHOD, IP, GEO, and HOST.

   For more information about the yandex_sws_advanced_rate_limiter_profile resource parameters, see the provider documentation.

2. Create the resources:

   1. In the terminal, change to the folder where you edited the configuration file.

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

      terraform validate
      

      If the configuration is correct, the following message is returned:

      Success! The configuration is valid.
      

   3. Run the command:

      terraform plan
      

      The terminal will display a list of resources with parameters. No changes are made at this step. If the configuration contains errors, Terraform will point them out.

   4. Apply the configuration changes:

      terraform apply
      

   5. Confirm the changes: type yes in the terminal and press Enter.

   Terraform will create all the required resources. You can check the new resources using the management console.

Once your ARL profile is created, you can add a rule to the profile.

Use the create REST API method for the AdvancedRateLimiterProfile resource or the AdvancedRateLimiterProfile/Create gRPC API call.