The attributes of a governance control.

Hierarchy

  • GovernanceControlAttributes

Constructors

Properties

activeDetectionsCount: number

The number of active detections for the control.

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
category: string

The value driver the control is grouped under, such as security or cost.

createdAt: Date

The time the control configuration was created.

createdBy: string

The UUID of the user who created the control configuration.

description: string

A human-readable description of what the control detects.

detectionFrequency: string

How often detections are evaluated for the control.

detectionParameters: {
    [key: string]: any;
}

A free-form map of parameter names to their configured values.

Type declaration

  • [key: string]: any
detectionType: string

The detection type that uniquely identifies the control.

featureFlags: string[]

The feature flags that gate the control.

insights: string[]

The insight slugs associated with the control.

lastDetectionAt: null | Date

The time of the most recent detection for the control. null when there are no detections.

mitigatedDetectionsCount: number

The number of mitigated detections for the control.

mitigationParameters: {
    [key: string]: any;
}

A free-form map of parameter names to their configured values.

Type declaration

  • [key: string]: any
mitigationType: string

The configured mitigation type for the control. Empty when not configured.

The mitigations available for a control.

name: string

Human-readable name of the control.

nextSteps: string

Guidance on the next steps to remediate detections for the control.

notificationFrequency: string

The configured notification frequency for the control. Empty when not configured.

notificationParameters: {
    [key: string]: any;
}

A free-form map of parameter names to their configured values.

Type declaration

  • [key: string]: any
notificationType: string

The configured notification type for the control. Empty when not configured.

priority: string

The priority of the control, such as High.

product: string

The product the control belongs to.

releaseStatus: string

The release status of the control, such as prod or beta.

resourceType: string

The type of resource the control evaluates.

resourceTypeDisplayName: string

The human-readable name of the resource type.

supportedDetectionParameters: GovernanceControlParameterDefinition[]

An array of parameter definitions.

supportedNotificationParameters: GovernanceControlParameterDefinition[]

An array of parameter definitions.

task: string

A short description of the remediation task for the control.

type: string

The control type, such as Proactive or Detection.

usageConcern: string

The usage concern the control addresses, such as Security or Cost Optimization.

Generated using TypeDoc