YAML for MySQL

View as Markdown

MySQL target for executing queries on a MySQL database.

YAML parameters for MySQL

PARAMETERS

hostrequiredstring

The hostname or IP address of the MySQL server

targetrequiredstring

The human-readable ID of the target

namestring

The name of the target

portstring

The port of the MySQL server. Default: 3306

databasestring

The default database name

authMysqlAuthYaml

MySQL authentication credentials

proxystring

SSH proxy target for tunneling to private MySQL servers

permissionsPermissionsYaml

Access permissions for the target

disabledboolean

Indicates if this target is disabled (default: false)

tagsstring[]

The list of tags associated with the target

use_asUseAsYaml

Defines how the target can be used (as deployment target, proxy, or both)

notestring

Note for this resource

agent_notestring

YAML note for AI agents operating on this resource

typestring

Value: MYSQL

Last modified on Sep 17, 2026

MongoDB PostgreSQL

YAML examples for MySQL

MySQL target with password authentication

yaml
- target: production_mysql
  type: MYSQL
  name: Production MySQL
  host: mysql.example.com
  port: "3306"
  database: myapp
  auth:
    username: deploy_user
    password: $password
  proxy: my_ssh_bastion
  tags:
    - mysql
    - production

Minimal

yaml
- target: production_mysql
  type: MYSQL
  host: mysql.example.com
  auth:
    username: deploy_user
    password: $password