Skip to main content

Pyrae::Test::Object Reference

Quick Type Reference​

export interface PyraeTestObject {
    Name?: string;
    FailToCreate?: boolean;
    FailToUpdate?: boolean;
    FailToDelete?: boolean;
    FailToRollback?: boolean;
}

PyraeTestObject​

This is a test object used to test changes to OrgFormation. You should not use this object because it can make certain lifecycle events break.

Name​

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

Location: $.PyraeTestObject.Name

Type: export type Name = string;

FailToCreate​

Description:

Location: $.PyraeTestObject.FailToCreate

Type: export type FailToCreate = boolean;

FailToUpdate​

Description:

Location: $.PyraeTestObject.FailToUpdate

Type: export type FailToUpdate = boolean;

FailToDelete​

Description:

Location: $.PyraeTestObject.FailToDelete

Type: export type FailToDelete = boolean;

FailToRollback​

Description:

Location: $.PyraeTestObject.FailToRollback

Type: export type FailToRollback = boolean;

JSON Schema​

{
  "$ref": "#/definitions/PyraeTestObject",
  "definitions": {
    "PyraeTestObject": {
      "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"
        },
        "FailToCreate": {
          "type": "boolean"
        },
        "FailToUpdate": {
          "type": "boolean"
        },
        "FailToDelete": {
          "type": "boolean"
        },
        "FailToRollback": {
          "type": "boolean"
        }
      },
      "additionalProperties": false,
      "description": "This is a test object used to test changes to OrgFormation. You should not use this object because it can make certain lifecycle events break."
    }
  },
  "$schema": "http://json-schema.org/draft-07/schema#"
}