terraform-provider-stackitp.../docs/resources/argus_scrapeconfig.md
João Palet 82b0c6ff6c
Document resource's internal ID structure and create foundation for migration guide (#12)
* Add internal ID structure to DSA instance descriptions

* Add internal ID structure to DSA credential descriptions

* Add internal ID structure to Argus descriptions

* Add internal ID structure to DNS descriptions

* Add internal ID structure to PostgresFlex descriptions

* Add internal ID structure to ResourceManager descriptions

* Add internal ID structure to SKE descriptions

* Generate updated docs

* Add first basis for migration guide
2023-09-08 18:03:26 +01:00

2.2 KiB

page_title subcategory description
stackit_argus_scrapeconfig Resource - stackit

stackit_argus_scrapeconfig (Resource)

Example Usage

resource "stackit_argus_scrapeconfig" "example" {
  project_id   = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
  instance_id  = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
  name         = "example-job"
  metrics_path = "/my-metrics"
  saml2 = {
    enable_url_parameters = true
  }
  targets = [
    {
      urls = ["url1", "urls2"]
      labels = {
        "url1" = "dev"
      }
    }
  ]
}

Schema

Required

  • instance_id (String) Argus instance ID to which the scraping job is associated.
  • metrics_path (String) Specifies the job scraping url path. E.g. /metrics.
  • name (String) Specifies the name of the scraping job.
  • project_id (String) STACKIT project ID to which the scraping job is associated.
  • targets (Attributes List) The targets list (specified by the static config). (see below for nested schema)

Optional

  • basic_auth (Attributes) A basic authentication block. (see below for nested schema)
  • saml2 (Attributes) A SAML2 configuration block. (see below for nested schema)
  • scheme (String) Specifies the http scheme. E.g. https.
  • scrape_interval (String) Specifies the scrape interval as duration string. E.g. 5m.
  • scrape_timeout (String) Specifies the scrape timeout as duration string. E.g.2m.

Read-Only

  • id (String) Terraform's internal resource ID. It is structured as "project_id,instance_id,name".

Nested Schema for targets

Required:

  • urls (List of String) Specifies target URLs.

Optional:

  • labels (Map of String) Specifies labels.

Nested Schema for basic_auth

Required:

  • password (String, Sensitive) Specifies basic auth password.
  • username (String) Specifies basic auth username.

Nested Schema for saml2

Optional:

  • enable_url_parameters (Boolean) Are URL parameters be enabled?