YAML for RDS_POSTGRESQL

View as Markdown

AWS RDS for PostgreSQL target for executing queries on an RDS-managed PostgreSQL instance.

YAML parameters for RDS_POSTGRESQL

PARAMETERS

integrationrequiredstring

Hash ID or identifier of an AWS integration.

regionrequiredstring

AWS region of the RDS instance, e.g. us-east-1

db_instance_identifierrequiredstring

RDS DB instance identifier

hostrequiredstring

The endpoint hostname of the RDS instance

targetrequiredstring

The human-readable ID of the target

namestring

The name of the target

portstring

The port of the RDS PostgreSQL instance. Default: 5432

databasestring

The default database name

ssl_modestring enum

SSL connection mode. Default: REQUIRE. VERIFY_FULL cannot be combined with proxy — through an SSH tunnel the client connects to 127.0.0.1, so the server certificate fails hostname validation.

Allowed enum:

DISABLE,

REQUIRE,

VERIFY_FULL

ca_certificatestring

PEM-encoded CA certificate (required when ssl_mode is VERIFY_FULL)

authPostgresqlAuthYaml

PostgreSQL authentication credentials

proxystring

SSH proxy target for tunneling to RDS instances in private VPCs. Keep ssl_mode at REQUIRE (the default) — TLS still terminates on the RDS instance, so the bastion never sees the wire protocol. VERIFY_FULL is not usable together with a proxy.

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: RDS_POSTGRESQL

Last modified on Nov 2, 2026

RDS_MYSQL SSH Server

YAML examples for RDS_POSTGRESQL

RDS PostgreSQL target with SSL verification

yaml

- target: rds-postgresql-prod
  type: RDS_POSTGRESQL
  name: Production PostgreSQL on RDS
  integration: aws-prod
  region: us-east-1
  db_instance_identifier: my-prod-postgresql
  host: my-prod-postgresql.abc123.us-east-1.rds.amazonaws.com
  port: '5432'
  database: production
  ssl_mode: VERIFY_FULL
  ca_certificate: |
    -----BEGIN CERTIFICATE-----
    <paste the AWS RDS regional CA bundle for us-east-1 here>
    -----END CERTIFICATE-----
  auth:
    username: admin
    password: secured

Minimal

yaml

- target: rds-postgresql
  type: RDS_POSTGRESQL
  integration: aws-prod
  region: us-east-1
  db_instance_identifier: my-postgresql
  host: my-postgresql.abc123.us-east-1.rds.amazonaws.com
  auth:
    username: admin
    password: secured