Skip to main content

Pyrae::Policy::Policy Reference

Quick Type Reference​

export interface PyraePolicyPolicy {
    Name?: string;
    ObserverUrn: string;
    OwnerTeamUrn: string;
    PolicyDocumentUrn?: string;
    ExpressionType?: string;
    ExpressionString?: string;
}

PyraePolicyPolicy​

A Policy object evaluates its expression as soon as the associated Observer generates new Observances. The Policy expression decides if the observed Resource has any Violations.

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: $.PyraePolicyPolicy.Name

Type: export type Name = string;

ObserverUrn​

Description: The URN of the observer that this Policy relies upon. When the observer specified in this field executes and creates a new Observance, this policy should execute.

Required: Yes

Location: $.PyraePolicyPolicy.ObserverUrn

Type: export type ObserverUrn = string;

OwnerTeamUrn​

Description: The URN of the team that owns this Policy, and should resolve issues relating to it (eg, misconfiguration or error rate).

Required: Yes

Location: $.PyraePolicyPolicy.OwnerTeamUrn

Type: export type OwnerTeamUrn = string;

PolicyDocumentUrn​

Description: The 'document' concept is in need of substantial refactoring. Please do not use this for the time being.

Required: No

Location: $.PyraePolicyPolicy.PolicyDocumentUrn

Type: export type PolicyDocumentUrn = string;

ExpressionType​

Description: The engine used to execute the provided ExpressionString. The only supported value currently is denov1.

Required: No

Location: $.PyraePolicyPolicy.ExpressionType

Type: export type ExpressionType = string;

ExpressionString​

Description: The expression that's provided to the engine specified in ExpressionType.

Required: No

Location: $.PyraePolicyPolicy.ExpressionString

Type: export type ExpressionString = string;

JSON Schema​

{
  "$ref": "#/definitions/PyraePolicyPolicy",
  "definitions": {
    "PyraePolicyPolicy": {
      "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"
        },
        "ObserverUrn": {
          "anyOf": [
            {
              "type": "string"
            }
          ],
          "description": "The URN of the observer that this Policy relies upon. When the observer specified in this field executes and creates a new Observance, this policy should execute."
        },
        "OwnerTeamUrn": {
          "anyOf": [
            {
              "type": "string"
            }
          ],
          "description": "The URN of the team that owns this Policy, and should resolve issues relating to it (eg, misconfiguration or error rate)."
        },
        "PolicyDocumentUrn": {
          "anyOf": [
            {
              "type": "string"
            }
          ],
          "description": "The 'document' concept is in need of substantial refactoring. Please do not use this for the time being."
        },
        "ExpressionType": {
          "anyOf": [
            {
              "type": "string"
            }
          ],
          "description": "The engine used to execute the provided ExpressionString. The only supported value currently is `denov1`."
        },
        "ExpressionString": {
          "anyOf": [
            {
              "type": "string"
            }
          ],
          "description": "The expression that's provided to the engine specified in ExpressionType."
        }
      },
      "required": [
        "ObserverUrn",
        "OwnerTeamUrn"
      ],
      "additionalProperties": false,
      "description": "A Policy object evaluates its expression as soon as the associated Observer generates new Observances. The Policy expression decides if the observed Resource has any Violations."
    }
  },
  "$schema": "http://json-schema.org/draft-07/schema#"
}