Skip to content

index.md

Latest commit

 

History

History
55 lines (43 loc) · 3.72 KB

index.md

File metadata and controls

55 lines (43 loc) · 3.72 KB
Raw
layout wallarm
page_title Provider: Wallarm
description The Wallarm provider is used to interact with the Wallarm platform resources. The provider needs to be configured with the proper authentication credentials before it can be used.

Wallarm Provider

The Wallarm provider is used to interact with the Wallarm platform resources. The provider needs to be configured with the proper authentication credentials before it can be used.

Use the navigation to the left to read about the available resources.

Example Usage

terraform {
  required_version = ">= 1.5"
  required_providers {
    wallarm = {
      source = "wallarm/wallarm"
    }
  }
}

# Sets up Wallarm authentication credentials
# You can use environment variables instead
provider "wallarm" {
  api_token = "yXccqbq8o0zznJ5wMxzGmjvQ2RvmFAJZ6mFKF5Ka6n8fFpYaZBJHWIFBNXdeDhIG"
  api_host = "https://api.wallarm.com"
  client_id = 1111
}


# Creates a rule to block the requests
resource "wallarm_rule_vpatch" "vpatch" {
  # ...
}

Argument Reference

The following arguments are supported in provider "wallarm":

  • api_token - (required) your Wallarm API token. Note that the most operations with Wallarm API are allowed only for the users with the Administrator role. Managing disable_stamp rules (false positive suppression by signature) requires the Administrator (extended) or Global Administrator (extended) role. This can also be specified with the WALLARM_API_TOKEN shell environment variable.
  • api_host - (optional) Wallarm API URL. Can be: https://us1.api.wallarm.com for the US Cloud, https://api.wallarm.com for the EU Cloud. This can also be specified with the WALLARM_API_HOST shell environment variable. Default: https://api.wallarm.com.
  • client_id - (optional) ID of the client (tenant). The value is required for multi-tenant scenarios. This can also be specified with the WALLARM_API_CLIENT_ID shell environment variable. Default: client ID of the authenticated user defined by api_token.
  • retries - (optional) maximum number of retries to perform when an API request fails. Default: 12. This can also be specified with the WALLARM_API_RETRIES shell environment variable.
  • min_backoff - (optional) minimum backoff period in seconds after failed API calls. Default: 1. This can also be specified with the WALLARM_API_MIN_BACKOFF shell environment variable.
  • max_backoff - (optional) maximum backoff period in seconds after failed API calls. Default: 5. This can also be specified with the WALLARM_API_MAX_BACKOFF shell environment variable.
  • api_client_logging - (optional) whether to print logs from the API client (using the default log library logger). Default: false. This can also be specified with the WALLARM_API_CLIENT_LOGGING shell environment variable.
  • hint_prefetch - (optional) enable bulk prefetching of hints (rules) during plan/refresh to reduce API calls. When enabled, the first rule read triggers a bulk fetch of all hints for the client, and subsequent reads are served from an in-memory cache. Default: true. This can also be specified with the WALLARM_HINT_PREFETCH shell environment variable.
  • require_explicit_client_id - (optional) when true, every resource must set client_id explicitly. Prevents accidental cross-tenant operations for Global Administrator tokens managing multiple tenants. Default: false. This can also be specified with the WALLARM_REQUIRE_EXPLICIT_CLIENT_ID shell environment variable.