almaforge_pagerduty_connector Data Source

Read an AlmaForge PagerdutyConnector resource by name.

This data source reads existing cluster resources. It does not create, change, or delete them. Authenticate using the Terraform setup guide. Your identity needs permission to read the selected resources.

The built-in PagerDuty integration reads the connector named pagerduty. See PagerDuty integration for services and on-call matching. Secret fields are redacted by the API and returned as null.

See the configuration reference for the resource manifest and field context.

Set name to the existing object's metadata.name. The result is available in metadata and spec. A missing object produces an error.

Example Usage

Save this configuration in a new directory. Replace the example name with the existing object you want to read. Review the plan before applying it. Applying this data-only configuration saves the outputs without changing cluster resources.

Terminal

terraform initterraform plan -out=plan.tfplanterraform apply plan.tfplanterraform output

HCL

terraform {
  required_providers {
    almaforge = {
      source = "get.almaforge.com/almaforge/almaforge"
    }
  }
}

provider "almaforge" {}

data "almaforge_pagerduty_connector" "existing" {
  name = "pagerduty"
}

output "name" {
  value = data.almaforge_pagerduty_connector.existing.metadata.name
}

To manage changes instead of only reading, use the resource. Read resources versus data sources before choosing ownership.

Schema

Required

• name (String) Name of the resource to read.

Read-Only

• metadata (Attributes) (see below for nested schema)
• spec (Attributes) Spec contains the resource configuration. (see below for nested schema)

Nested Schema for metadata

Read-Only:

• labels (Map of String) Labels attached to the resource.
• name (String) Resource name. Changing this name replaces the resource.
• resource_version (String) Server revision used to detect concurrent changes.

Nested Schema for spec

Read-Only:

• api_key (String, Sensitive) APIKey is the Pagerduty REST API key. Accepts a literal value or a value-expansion reference such as "${file:/etc/pagerduty/key}" or "${env:PAGERDUTY_API_KEY}".
• api_url (String) APIURL overrides the Pagerduty REST API base URL. Defaults to https://api.pagerduty.com when empty.
• approve_on_call (Boolean) ApproveOnCall enables auto-approval of access requests when the requester is currently on call for one of the configured Pagerduty services. Off by default. Opt in by setting true. When false (or unset), the plugin still creates the Pagerduty incident but leaves the access request for human review.
• user_email (String) UserEmail is the Pagerduty user email the plugin authenticates as for REST API calls (From: header).