@heroku-cli/plugin-data-privatelink

Heroku Postgres via PrivateLink CLI

• Usage
• Commands

Usage

$ npm install -g @heroku-cli/plugin-data-privatelink
$ heroku COMMAND
running command...
$ heroku (-v|--version|version)
@heroku-cli/plugin-data-privatelink/1.3.1 darwin-arm64 node-v16.18.0
$ heroku --help [COMMAND]
USAGE
  $ heroku COMMAND
...

Commands

• heroku data:privatelink [DATABASE]
• heroku data:privatelink:access [DATABASE]
• heroku data:privatelink:access:add [DATABASE]
• heroku data:privatelink:access:remove [DATABASE]
• heroku data:privatelink:create [DATABASE]
• heroku data:privatelink:destroy [DATABASE]
• heroku data:privatelink:wait [DATABASE]

heroku data:privatelink [DATABASE]

list all your privatelink endpoints!

USAGE
  $ heroku data:privatelink [DATABASE]

OPTIONS
  -a, --app=app  (required) app to run command against

ALIASES
  $ heroku pg:privatelink
  $ heroku kafka:privatelink
  $ heroku redis:privatelink

EXAMPLE
  $ heroku data:privatelink postgresql-sushi-12345

See code: src/commands/data/privatelink/index.ts

heroku data:privatelink:access [DATABASE]

list all allowed accounts for your privatelink endpoint

USAGE
  $ heroku data:privatelink:access [DATABASE]

OPTIONS
  -a, --app=app  (required) app to run command against

ALIASES
  $ heroku pg:privatelink:access
  $ heroku kafka:privatelink:access
  $ heroku redis:privatelink:access

EXAMPLE
  $ heroku data:privatelink:access postgresql-sushi-12345

See code: src/commands/data/privatelink/access/index.ts

heroku data:privatelink:access:add [DATABASE]

add an allowed account to your privatelink endpoint

USAGE
  $ heroku data: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

ALIASES
  $ heroku pg:privatelink:access:add
  $ heroku kafka:privatelink:access:add
  $ heroku redis:privatelink:access:add

EXAMPLES
  $ heroku data:privatelink:access:add postgresql-sushi-12345 --aws-account-id 123456789012:user/abc
  $ heroku data:privatelink:access:add postgresql-sushi-12345 --aws-account-id 123456789012:user/abc --aws-account-id 
  123456789012:user/xyz

See code: src/commands/data/privatelink/access/add.ts

heroku data:privatelink:access:remove [DATABASE]

remove an allowed account from your privatelink endpoint

USAGE
  $ heroku data: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

ALIASES
  $ heroku pg:privatelink:access:remove
  $ heroku kafka:privatelink:access:remove
  $ heroku redis:privatelink:access:remove

EXAMPLES
  $ heroku data:privatelink:access:remove postgresql-sushi-12345 --aws-account-id 123456789012:user/xyz
  $ heroku data:privatelink:access:remove postgresql-sushi-12345 --aws-account-id 123456789012:user/abc --aws-account-id 
  123456789012:user/xyz

See code: src/commands/data/privatelink/access/remove.ts

heroku data:privatelink:create [DATABASE]

create a new privatelink endpoint for your database

USAGE
  $ heroku data: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

ALIASES
  $ heroku pg:privatelink:create
  $ heroku kafka:privatelink:create
  $ heroku redis:privatelink:create

EXAMPLES
  $ heroku data:privatelink:create postgresql-sushi-12345 --aws-account-id 123456789012:user/abc
  $ heroku data:privatelink:create postgresql-sushi-12345 --aws-account-id 123456789012:user/abc --account-id 
  123456789012:user/xyz

See code: src/commands/data/privatelink/create.ts

heroku data:privatelink:destroy [DATABASE]

destroy a privatelink endpoint for your database

USAGE
  $ heroku data:privatelink:destroy [DATABASE]

OPTIONS
  -a, --app=app  (required) app to run command against

ALIASES
  $ heroku pg:privatelink:destroy
  $ heroku kafka:privatelink:destroy
  $ heroku redis:privatelink:destroy

EXAMPLE
  $ heroku data:privatelink:destroy postgresql-sushi-12345

See code: src/commands/data/privatelink/destroy.ts

heroku data:privatelink:wait [DATABASE]

wait for your privatelink endpoint to be provisioned

USAGE
  $ heroku data:privatelink:wait [DATABASE]

OPTIONS
  -a, --app=app  (required) app to run command against

ALIASES
  $ heroku pg:privatelink:wait
  $ heroku kafka:privatelink:wait
  $ heroku redis:privatelink:wait

EXAMPLE
  $ heroku data:privatelink:wait postgresql-sushi-12345

See code: src/commands/data/privatelink/wait.ts