README
Heroku Postgres via PrivateLink CLI
Usage
$ npm install -g @heroku-cli/plugin-pg-privatelink
$ heroku COMMAND
running command...
$ heroku (-v|--version|version)
@heroku-cli/plugin-pg-privatelink/0.8.0 darwin-x64 node-v10.15.1
$ heroku --help [COMMAND]
USAGE
$ heroku COMMAND
...
Commands
heroku pg:privatelink [DATABASE]
heroku pg:privatelink:access [DATABASE]
heroku pg:privatelink:access:add [DATABASE]
heroku pg:privatelink:access:remove [DATABASE]
heroku pg:privatelink:create [DATABASE]
heroku pg:privatelink:destroy [DATABASE]
heroku pg:privatelink:wait [DATABASE]
heroku pg:privatelink [DATABASE]
list all your privatelink endpoints!
USAGE
$ heroku pg:privatelink [DATABASE]
OPTIONS
-a, --app=app (required) app to run command against
EXAMPLE
$ heroku pg:privatelink postgresql-sushi-12345
See code: src/commands/pg/privatelink/index.ts
heroku pg:privatelink:access [DATABASE]
list all accounts for your privatelink endpoint's whitelist
USAGE
$ heroku pg:privatelink:access [DATABASE]
OPTIONS
-a, --app=app (required) app to run command against
EXAMPLE
$ heroku pg:privatelink:access postgresql-sushi-12345
See code: src/commands/pg/privatelink/access/index.ts
heroku pg:privatelink:access:add [DATABASE]
add an account to your privatelink endpoint's whitelist
USAGE
$ heroku pg:privatelink:access:add [DATABASE]
OPTIONS
-a, --app=app (required) app to run command against
-i, --aws-account-id=aws-account-id AWS account id to use
EXAMPLES
$ heroku pg:privatelink:access:add postgresql-sushi-12345 --aws-account-id 123456789012:user/abc
$ heroku pg:privatelink:access:add postgresql-sushi-12345 --aws-account-id 123456789012:user/abc --aws-account-id
123456789012:user/xyz
See code: src/commands/pg/privatelink/access/add.ts
heroku pg:privatelink:access:remove [DATABASE]
remove an account from your privatelink endpoint's whitelist
USAGE
$ heroku pg:privatelink:access:remove [DATABASE]
OPTIONS
-a, --app=app (required) app to run command against
-i, --aws-account-id=aws-account-id AWS account id to use
EXAMPLES
$ heroku pg:privatelink:access:remove postgresql-sushi-12345 --aws-account-id 123456789012:user/xyz
$ heroku pg:privatelink:access:remove postgresql-sushi-12345 --aws-account-id 123456789012:user/abc --aws-account-id
123456789012:user/xyz
See code: src/commands/pg/privatelink/access/remove.ts
heroku pg:privatelink:create [DATABASE]
create a new privatelink endpoint for your database
USAGE
$ heroku pg:privatelink:create [DATABASE]
OPTIONS
-a, --app=app (required) app to run command against
-i, --aws-account-id=aws-account-id AWS account id to use
EXAMPLES
$ heroku pg:privatelink:create postgresql-sushi-12345 --aws-account-id 123456789012:user/abc
$ heroku pg:privatelink:create postgresql-sushi-12345 --aws-account-id 123456789012:user/abc --account-id
123456789012:user/xyz
See code: src/commands/pg/privatelink/create.ts
heroku pg:privatelink:destroy [DATABASE]
destroy a privatelink endpoint for your database
USAGE
$ heroku pg:privatelink:destroy [DATABASE]
OPTIONS
-a, --app=app (required) app to run command against
EXAMPLE
$ heroku pg:privatelink:destroy postgresql-sushi-12345
See code: src/commands/pg/privatelink/destroy.ts
heroku pg:privatelink:wait [DATABASE]
wait for your privatelink endpoint to be provisioned
USAGE
$ heroku pg:privatelink:wait [DATABASE]
OPTIONS
-a, --app=app (required) app to run command against
EXAMPLE
$ heroku pg:privatelink:wait postgresql-sushi-12345
See code: src/commands/pg/privatelink/wait.ts