Class SyntheticsConfigVariable

Object defining a variable that can be used in your test configuration.

Hierarchy

  • SyntheticsConfigVariable

Constructors

constructor

Properties

additionalProperties? example? id? name pattern? secure? type

Constructors

constructor

Properties

Optional additionalProperties

additionalProperties?: {
    [key: string]: any;
}

A container for additional, undeclared properties. This is a holder for any undeclared properties as specified with the 'additionalProperties' keyword in the OAS document.

Type declaration

  • [key: string]: any

Optional example

example?: string

Example for the variable.

Optional id

id?: string

ID of the variable for global variables.

name

name: string

Name of the variable.

Optional pattern

pattern?: string

Pattern of the variable.

Optional secure

secure?: boolean

Whether the value of this variable will be obfuscated in test results. Only for config variables of type text.

type

type: SyntheticsConfigVariableType

Type of the configuration variable.

Settings

Member Visibility

Theme

Generated using TypeDoc