Skip to main content

Pyrae::Violation::MarkAsByDesign Reference

Quick Type Reference​

export interface PyraeViolationMarkAsByDesign {
    Name?: string;
    PolicyUrn: string;
    ResourceUrn: string;
    
    ViolationTypeId?: string;
}

PyraeViolationMarkAsByDesign​

This object enables you to suppress a Policy for a resource. The Violation will still exist, but it will not trigger any Integrations.

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

Type: export type Name = string;

PolicyUrn​

Description: The URN of the Policy which should be suppressed.

Required: Yes

Location: $.PyraeViolationMarkAsByDesign.PolicyUrn

Type: export type PolicyUrn = string;

ResourceUrn​

Description: The URN of the Resource which should be suppressed.

Required: Yes

Location: $.PyraeViolationMarkAsByDesign.ResourceUrn

Type: export type ResourceUrn = string;

ViolationTypeId​

Description: If provided, this can be leveraged to suppress some Violation Types produced by a single Policy. If your Policy only emits one Violation Type, this can be omitted.

Required: No

Location: $.PyraeViolationMarkAsByDesign.ViolationTypeId

Type: 

/** If provided, this can be leveraged to suppress some Violation Types produced by a single Policy. If your Policy only emits one Violation Type, this can be omitted. */
export type ViolationTypeId = string;

JSON Schema​

{
  "$ref": "#/definitions/PyraeViolationMarkAsByDesign",
  "definitions": {
    "PyraeViolationMarkAsByDesign": {
      "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"
        },
        "PolicyUrn": {
          "anyOf": [
            {
              "type": "string"
            }
          ],
          "description": "The URN of the Policy which should be suppressed."
        },
        "ResourceUrn": {
          "anyOf": [
            {
              "type": "string"
            }
          ],
          "description": "The URN of the Resource which should be suppressed."
        },
        "ViolationTypeId": {
          "type": "string",
          "description": "If provided, this can be leveraged to suppress some Violation Types produced by a single Policy. If your Policy only emits one Violation Type, this can be omitted."
        }
      },
      "required": [
        "PolicyUrn",
        "ResourceUrn"
      ],
      "additionalProperties": false,
      "description": "This object enables you to suppress a Policy for a resource. The Violation will still exist, but it will not trigger any Integrations."
    }
  },
  "$schema": "http://json-schema.org/draft-07/schema#"
}