Class GovernanceControlParameterDefinition

The definition of a configurable parameter on a control or mitigation.

Hierarchy

  • GovernanceControlParameterDefinition

Constructors

Properties

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
defaultValue: any

The default value of the parameter. The JSON type depends on the parameter's type.

description: string

A human-readable description of the parameter.

displayName: string

The human-readable name of the parameter.

name: string

The machine-readable name of the parameter.

required: boolean

Whether the parameter must be provided.

supportedValues: null | GovernanceControlSupportedValue[]

The supported values for an enumerated parameter. null when the parameter is not an enumerated type.

type: string

The type of the parameter, such as integer, string, boolean, enum, or pattern_list.

Generated using TypeDoc