YAML for AWS RDS for SQL Server

View as Markdown

AWS RDS for SQL Server target for executing queries on an RDS-managed MSSQL instance.

YAML parameters for AWS RDS for SQL Server

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 MSSQL instance. Default: 1433

databasestring

The default database name

ssl_modestring enum

SSL connection mode. Default: REQUIRE.

Allowed enum:

DISABLE,

REQUIRE,

VERIFY_FULL

ca_certificatestring

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

authMssqlAuthYaml

MSSQL authentication credentials

proxystring

SSH proxy target for tunneling to RDS instances in private VPCs

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_MSSQL

Last modified on Sep 17, 2026

Amazon Elastic Kubernetes Service Azure Kubernetes Service

YAML examples for AWS RDS for SQL Server

AWS RDS for SQL Server target with an AWS integration

yaml
- target: rds_mssql_prod
  type: RDS_MSSQL
  name: Production MSSQL on RDS
  integration: aws_prod
  region: us-east-1
  db_instance_identifier: my-prod-mssql
  host: my-prod-mssql.abc123.us-east-1.rds.amazonaws.com
  port: "1433"
  database: production
  ssl_mode: REQUIRE
  auth:
    username: admin
    password: $password
  proxy: my_ssh_bastion
  tags:
    - rds
    - mssql

Minimal

yaml
- target: rds_mssql_prod
  type: RDS_MSSQL
  integration: aws_prod
  region: us-east-1
  db_instance_identifier: my-prod-mssql
  host: my-prod-mssql.abc123.us-east-1.rds.amazonaws.com
  auth:
    username: admin
    password: $password