Overview
Resources
Data Types

DatabaseEndpoint Object

Description

Endpoint parameters to connect to a database server.

Properties

endpoint

Connection endpoint for the database server.

Type: string

Required: Yes

password

Password to use when authenticating with the database server.

Type: string

Required: Conditional

port

Connection port for the database server.

Type: integer

Required: Yes

username

Username with which to authenticate with the database server

Type: string

Required: Yes

Sample JSON

{
"endpoint": "my-instance.example.com",
"port": 3306,
"username": "user1",
"password": "123456789012"
}