Skip to main content

Pyrae::Integration::Integration Reference

Quick Type Reference​

export interface PyraeIntegrationIntegration {
    Name?: string;
    OwnerTeamUrn: string;
    IntegrationType?: string;
    BaseIntegrationUrn?: string;
    MetadataJson?: string;
}

PyraeIntegrationIntegration​

An integration specifies how to interact with a third party service that we send events to.

Name​

Description: The resourceName of the URN. By default, one will be generated based on the logical ID with randomness appended to the end

Required: No

Location: $.PyraeIntegrationIntegration.Name

Type: export type Name = string;

OwnerTeamUrn​

Description: The URN of the Team that owns this Resource and is responsible for any violations arising from the Resource.

Required: Yes

Location: $.PyraeIntegrationIntegration.OwnerTeamUrn

Type: export type OwnerTeamUrn = string;

IntegrationType​

Description: Valid values are 'SLACK', 'SNS', 'OPSGENIE'

Required: No

Location: $.PyraeIntegrationIntegration.IntegrationType

Type: export type IntegrationType = string;

BaseIntegrationUrn​

Description: The URN of the base integration that you want to take the MetadataJson from and merge into this object. This allows you to extend the base integration's configuration.

Required: No

Location: $.PyraeIntegrationIntegration.BaseIntegrationUrn

Type: export type BaseIntegrationUrn = string;

MetadataJson​

Description: A JSON object to contain data specific to the integration, which will be passed to the integration handler. Eg, the slack token will be provided in this.

Required: No

Location: $.PyraeIntegrationIntegration.MetadataJson

Type: export type MetadataJson = string;

JSON Schema​

{
  "$ref": "#/definitions/PyraeIntegrationIntegration",
  "definitions": {
    "PyraeIntegrationIntegration": {
      "type": "object",
      "properties": {
        "Name": {
          "anyOf": [
            {
              "type": "string"
            }
          ],
          "description": "The resourceName of the URN. By default, one will be generated based on the logical ID with randomness appended to the end"
        },
        "OwnerTeamUrn": {
          "anyOf": [
            {
              "type": "string"
            }
          ],
          "description": "The URN of the Team that owns this Resource and is responsible for any violations arising from the Resource."
        },
        "IntegrationType": {
          "anyOf": [
            {
              "type": "string"
            }
          ],
          "description": "Valid values are 'SLACK', 'SNS', 'OPSGENIE'"
        },
        "BaseIntegrationUrn": {
          "anyOf": [
            {
              "type": "string"
            }
          ],
          "description": "The URN of the base integration that you want to take the MetadataJson from and merge into this object. This allows you to extend the base integration's configuration."
        },
        "MetadataJson": {
          "anyOf": [
            {
              "type": "string"
            }
          ],
          "description": "A JSON object to contain data specific to the integration, which will be passed to the integration handler. Eg, the slack token will be provided in this."
        }
      },
      "required": [
        "OwnerTeamUrn"
      ],
      "additionalProperties": false,
      "description": "An integration specifies how to interact with a third party service that we send events to."
    }
  },
  "$schema": "http://json-schema.org/draft-07/schema#"
}