Skip to main content
Version: 19.x (unreleased)

Reference for the teleport_classifier Terraform resource

Report an IssueView as Markdown

This page describes the supported values of the teleport_classifier resource of the Teleport Terraform provider.

Schema​

Required​

  • metadata (Attributes) Metadata is the resource metadata. (see below for nested schema)
  • spec (Attributes) Spec selects the sessions that this classifier applies to and defines what the classifier matches. (see below for nested schema)

Optional​

  • sub_kind (String) SubKind is the resource sub-kind. Should be empty.
  • version (String) Version is the resource version. Should be set to "v1".

Nested Schema for metadata​

Required:

  • name (String) name is an object name.

Optional:

  • description (String) description is object description.
  • expires (String) expires is a global expiry time header can be set on any resource in the system.
  • labels (Map of String) labels is a set of labels.

Nested Schema for spec​

Required:

  • criteria (String) Criteria is a natural-language description of what this classifier matches. It is evaluated by the inference model against the session summary and, when available, the per-command analysis.
  • kinds (List of String) Kinds are session kinds matched by this classifier, e.g., "ssh", "k8s", "db".

Optional:

  • actions (Attributes) Actions configures the effects of a match. If unset, a match is only recorded on the stored session summary. (see below for nested schema)
  • filter (String) Filter is an optional filter expression using Teleport Predicate Language that selects the sessions this classifier applies to. It supports the same language and matching context as the inference policy filter, e.g., equals(resource.metadata.labels["env"], "prod"). If empty, the classifier applies to all sessions of matching kinds.

Nested Schema for spec.actions​

Optional:

  • emit_audit_event (Boolean) EmitAuditEvent, if enabled, emits an audit event when a session matches this classifier.
  • flag_for_review (Boolean) FlagForReview, if enabled, marks the session as needing further review on match. Only applies to summaries that carry an EnhancedSummary.
  • risk_level_floor (String) RiskLevelFloor, if set, raises the session's risk level (and risk score) to at least this level on match. It never lowers the risk level. Leaving it unspecified means a match does not change the risk level. Only applies to summaries that carry an EnhancedSummary.