# Reference for the teleport\_autoupdate\_version Terraform resource

This page describes the supported values of the teleport\_autoupdate\_version resource of the Teleport Terraform provider.

## Example Usage

```
resource "teleport_autoupdate_version" "test" {
  version = "v1"
  spec = {
    tools = {
      target_version = "1.2.3"
    }
    agents = {
      start_version  = "1.2.3"
      target_version = "1.2.4"
      schedule       = "regular"
      mode           = "enabled"
    }
  }
}

```

## Schema

### Required

- `spec` (Attributes) (see [below for nested schema](#nested-schema-for-spec))
- `version` (String)

### Optional

- `metadata` (Attributes) (see [below for nested schema](#nested-schema-for-metadata))
- `sub_kind` (String)

### Nested Schema for `spec`

Optional:

- `agents` (Attributes) (see [below for nested schema](#nested-schema-for-specagents))
- `tools` (Attributes) (see [below for nested schema](#nested-schema-for-spectools))

### Nested Schema for `spec.agents`

Optional:

- `mode` (String) autoupdate\_mode to use for the rollout
- `schedule` (String) schedule to use for the rollout
- `start_version` (String) start\_version is the version used for newly installed agents before their update window.
- `target_version` (String) target\_version is the version that all agents will update to during their update window.

### Nested Schema for `spec.tools`

Optional:

- `target_version` (String) TargetVersion specifies the semantic version required for tools to establish a connection with the cluster. Client tools after connection to the cluster going to be updated to this version automatically.

### Nested Schema for `metadata`

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.
- `name` (String) name is an object name.