Resource field reference

Resource objects let you access resource configurations in custom tasks.
Resource attachments are passed to custom tasks as a map of aliases to the resource configuration via the environment variable AIRPLANE_RESOURCES. Resource object fields depend on the kind.

BigQuery

idstring

The ID of the resource.

slugstring

The slug of the resource as defined in the resource settings page.

namestring

The name of the resource.

kindstring(value: bigquery)

The kind of the resource.

The credentials string.

projectIDstring

The project ID.

locationstring

The geographic location of the stored data.

dataSetstring

The dataset for your tables and views.

dsnstring

The DSN of the BigQuery resource.

Mailgun

idstring

The ID of the resource.

slugstring

The slug of the resource as defined in the resource settings page.

namestring

The name of the resource.

kindstring(value: mailgun)

The kind of the resource.

apiKeystring

The Mailgun API key.

domainstring

The configured Mailgun domain.

MongoDB

idstring

The ID of the resource.

slugstring

The slug of the resource as defined in the resource settings page.

namestring

The name of the resource.

kindstring(value: mongodb)

The kind of the resource.

The MongoDB connection string.

MySQL

idstring

The ID of the resource.

slugstring

The slug of the resource as defined in the resource settings page.

namestring

The name of the resource.

kindstring(value: mysql)

The kind of the resource.

usernamestring

The login username.

hoststring

The host of the server.

portstring

The port of the server.

tlsstring

The TLS verification setting (false or skip-verify).

passwordstring

The login password.

dsnstring

The dsn of the server.

sshHoststring

Optional SSH host for tunneling.

sshPortstring

Optional SSH port for tunneling.

Optional SSH username for tunneling.

Optional SSH private key for tunneling.

PostgreSQL

idstring

The ID of the resource.

slugstring

The slug of the resource as defined in the resource settings page.

namestring

The name of the resource.

kindstring(value: postgres)

The kind of the resource.

usernamestring

The login username.

hoststring

The host of the server.

portstring

The port of the server.

sslModestring

The SSL mode setting (disable or require).

passwordstring

The login password.

dsnstring

The dsn of the server.

sshHoststring

Optional SSH host for tunneling.

sshPortstring

Optional SSH port for tunneling.

Optional SSH username for tunneling.

Optional SSH private key for tunneling.

Amazon Redshift

idstring

The ID of the resource.

slugstring

The slug of the resource as defined in the resource settings page.

namestring

The name of the resource.

kindstring(value: redshift)

The kind of the resource.

usernamestring

The login username.

hoststring

The host of the server.

portstring

The port of the server.

sslModestring

The SSL mode setting (disable or require).

passwordstring

The login password.

dsnstring

The dsn of the server.

sshHoststring

Optional SSH host for tunneling.

sshPortstring

Optional SSH port for tunneling.

Optional SSH username for tunneling.

Optional SSH private key for tunneling.

REST API

idstring

The ID of the resource.

slugstring

The slug of the resource as defined in the resource settings page.

namestring

The name of the resource.

kindstring(value: rest)

The kind of the resource.

baseURLstring

The base URL of the REST API.

headersobject

Mapping of header name to value.

List of header names that contain sensitive information.

SendGrid

idstring

The ID of the resource.

slugstring

The slug of the resource as defined in the resource settings page.

namestring

The name of the resource.

kindstring(value: sendgrid)

The kind of the resource.

apiKeystring

The SendGrid API key.

Slack

idstring

The ID of the resource.

slugstring

The slug of the resource as defined in the resource settings page.

namestring

The name of the resource.

kindstring(value: slack)

The kind of the resource.

The access token for the Slack API.

SMTP

idstring

The ID of the resource.

slugstring

The slug of the resource as defined in the resource settings page.

namestring

The name of the resource.

kindstring(value: smtp)

The kind of the resource.

hostNamestring

The hostname of the SMTP server.

portstring

The port of the SMTP server.

authobject

The SMTP auth configuration.

The kind of auth configured for the SMTP server.

Possible Values
plain
crammd5
login

The login username.

The login password.

The login identity. (Only set for plain auth.)

The login password digest. (Only set for crammd5 auth.)

Snowflake

idstring

The ID of the resource.

slugstring

The slug of the resource as defined in the resource settings page.

namestring

The name of the resource.

kindstring(value: snowflake)

The kind of the resource.

accountstring

The Snowflake account.

warehousestring

The virtual warehouse name.

schemastring

The name of the schema.

rolestring

The role configured for the Snowflake resource.

usernamestring

The login username.

passwordstring

The login password.

dsnstring

The dsn of the server.

Microsoft SQL Server

idstring

The ID of the resource.

slugstring

The slug of the resource as defined in the resource settings page.

namestring

The name of the resource.

kindstring(value: sqlserver)

The kind of the resource.

usernamestring

The login username.

hoststring

The host of the server.

portstring

The port of the server.

The encryption mode setting (disable or true).

passwordstring

The login password.

dsnstring

The dsn of the server.

sshHoststring

Optional SSH host for tunneling.

sshPortstring

Optional SSH port for tunneling.

Optional SSH username for tunneling.

Optional SSH private key for tunneling.