forked from cloudfoundry/docs-bosh
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathlinks-common-types.html.md.erb
27 lines (20 loc) · 1008 Bytes
/
links-common-types.html.md.erb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
---
title: Links - Common types
---
Common suggested link types that release authors should conform to if type is used.
---
## <a id="database"></a> `database` type
`link('...').address` returns database address.
* **adapter** [String]: Name of the adapter.
* **port** [Integer]: Port to connect on.
* **tls** [Hash]: See [TLS properties](props-common.html#tls)
* **username** [String]: Database username to use. Example: `u387455`.
* **password** [String]: Database password to use.
* **database** [String]: Database name. Example: `app-server`
* **options** [Hash, optional]: Opaque set of options for the adapter. Example: `{max_connections: 32, pool_timeout: 10}`.
---
## <a id="blobstore"></a> `blobstore` type
`link('...').address` returns blobstore address.
* **adapter** [String]: Name of the adapter (s3, gcp, etc.).
* **tls** [Hash]: See [TLS properties](props-common.html#tls)
* **options** [Hash, optional]: Opaque set of options. Example: `{aws_access_key: ..., secret_access_key: ...}`.