Skip to content

heroku/heroku-data-privatelink-cli

Repository files navigation

Heroku Data via PrivateLink CLI

oclif Version Downloads/week License

Usage

$ npm install -g @heroku-cli/plugin-data-privatelink
$ heroku COMMAND
running command...
$ heroku (--version)
@heroku-cli/plugin-data-privatelink/1.3.2 darwin-x64 node-v16.20.2
$ heroku --help [COMMAND]
USAGE
  $ heroku COMMAND
...

Commands

heroku data:privatelink DATABASE

list all your privatelink endpoints

USAGE
  $ heroku data:privatelink DATABASE -a <value> [-r <value>]

FLAGS
  -a, --app=<value>     (required) app to run command against
  -r, --remote=<value>  git remote of app to use

DESCRIPTION
  list all your privatelink endpoints

EXAMPLES
  $ heroku data:privatelink postgresql-sushi-12345 --app my-app

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 -a <value> [-r <value>]

FLAGS
  -a, --app=<value>     (required) app to run command against
  -r, --remote=<value>  git remote of app to use

DESCRIPTION
  list all allowed accounts for your privatelink endpoint

EXAMPLES
  $ heroku data:privatelink:access postgresql-sushi-12345 --app my-app

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

heroku data:privatelink:access:add DATABASE

add one or more allowed AWS accounts to your privatelink endpoint

USAGE
  $ heroku data:privatelink:access:add DATABASE -i <value> -a <value> [-r <value>]

FLAGS
  -a, --app=<value>                (required) app to run command against
  -i, --aws-account-id=<value>...  (required) AWS account id to use
  -r, --remote=<value>             git remote of app to use

DESCRIPTION
  add one or more allowed AWS accounts to your privatelink endpoint

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

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

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 -i <value> -a <value> [-r <value>]

FLAGS
  -a, --app=<value>                (required) app to run command against
  -i, --aws-account-id=<value>...  (required) AWS account id to use
  -r, --remote=<value>             git remote of app to use

DESCRIPTION
  remove an allowed account from your privatelink endpoint

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

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

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 -i <value> -a <value> [-r <value>]

FLAGS
  -a, --app=<value>                (required) app to run command against
  -i, --aws-account-id=<value>...  (required) AWS account id to use
  -r, --remote=<value>             git remote of app to use

DESCRIPTION
  create a new privatelink endpoint for your database

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

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

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 -a <value> [-r <value>]

FLAGS
  -a, --app=<value>     (required) app to run command against
  -r, --remote=<value>  git remote of app to use

DESCRIPTION
  destroy a privatelink endpoint for your database

EXAMPLES
  $ heroku data:privatelink:destroy postgresql-sushi-12345 --app my-app

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 -a <value> [-r <value>]

FLAGS
  -a, --app=<value>     (required) app to run command against
  -r, --remote=<value>  git remote of app to use

DESCRIPTION
  wait for your privatelink endpoint to be provisioned

EXAMPLES
  $ heroku data:privatelink:wait postgresql-sushi-12345 postgresql-sushi-12345 --app my-app

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

heroku help [COMMANDS]

Display help for heroku.

USAGE
  $ heroku help [COMMANDS] [-n]

ARGUMENTS
  COMMANDS  Command to show help for.

FLAGS
  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION
  Display help for heroku.

See code: @oclif/plugin-help

heroku kafka:privatelink DATABASE

list all your privatelink endpoints

USAGE
  $ heroku kafka:privatelink DATABASE -a <value> [-r <value>]

FLAGS
  -a, --app=<value>     (required) app to run command against
  -r, --remote=<value>  git remote of app to use

DESCRIPTION
  list all your privatelink endpoints

EXAMPLES
  $ heroku data:privatelink postgresql-sushi-12345 --app my-app

heroku kafka:privatelink:access DATABASE

list all allowed accounts for your privatelink endpoint

USAGE
  $ heroku kafka:privatelink:access DATABASE -a <value> [-r <value>]

FLAGS
  -a, --app=<value>     (required) app to run command against
  -r, --remote=<value>  git remote of app to use

DESCRIPTION
  list all allowed accounts for your privatelink endpoint

EXAMPLES
  $ heroku data:privatelink:access postgresql-sushi-12345 --app my-app

heroku kafka:privatelink:access:add DATABASE

add one or more allowed AWS accounts to your privatelink endpoint

USAGE
  $ heroku kafka:privatelink:access:add DATABASE -i <value> -a <value> [-r <value>]

FLAGS
  -a, --app=<value>                (required) app to run command against
  -i, --aws-account-id=<value>...  (required) AWS account id to use
  -r, --remote=<value>             git remote of app to use

DESCRIPTION
  add one or more allowed AWS accounts to your privatelink endpoint

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

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

heroku kafka:privatelink:access:remove DATABASE

remove an allowed account from your privatelink endpoint

USAGE
  $ heroku kafka:privatelink:access:remove DATABASE -i <value> -a <value> [-r <value>]

FLAGS
  -a, --app=<value>                (required) app to run command against
  -i, --aws-account-id=<value>...  (required) AWS account id to use
  -r, --remote=<value>             git remote of app to use

DESCRIPTION
  remove an allowed account from your privatelink endpoint

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

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

heroku kafka:privatelink:create DATABASE

create a new privatelink endpoint for your database

USAGE
  $ heroku kafka:privatelink:create DATABASE -i <value> -a <value> [-r <value>]

FLAGS
  -a, --app=<value>                (required) app to run command against
  -i, --aws-account-id=<value>...  (required) AWS account id to use
  -r, --remote=<value>             git remote of app to use

DESCRIPTION
  create a new privatelink endpoint for your database

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

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

heroku kafka:privatelink:destroy DATABASE

destroy a privatelink endpoint for your database

USAGE
  $ heroku kafka:privatelink:destroy DATABASE -a <value> [-r <value>]

FLAGS
  -a, --app=<value>     (required) app to run command against
  -r, --remote=<value>  git remote of app to use

DESCRIPTION
  destroy a privatelink endpoint for your database

EXAMPLES
  $ heroku data:privatelink:destroy postgresql-sushi-12345 --app my-app

heroku kafka:privatelink:wait DATABASE

wait for your privatelink endpoint to be provisioned

USAGE
  $ heroku kafka:privatelink:wait DATABASE -a <value> [-r <value>]

FLAGS
  -a, --app=<value>     (required) app to run command against
  -r, --remote=<value>  git remote of app to use

DESCRIPTION
  wait for your privatelink endpoint to be provisioned

EXAMPLES
  $ heroku data:privatelink:wait postgresql-sushi-12345 postgresql-sushi-12345 --app my-app

heroku pg:privatelink DATABASE

list all your privatelink endpoints

USAGE
  $ heroku pg:privatelink DATABASE -a <value> [-r <value>]

FLAGS
  -a, --app=<value>     (required) app to run command against
  -r, --remote=<value>  git remote of app to use

DESCRIPTION
  list all your privatelink endpoints

EXAMPLES
  $ heroku data:privatelink postgresql-sushi-12345 --app my-app

heroku pg:privatelink:access DATABASE

list all allowed accounts for your privatelink endpoint

USAGE
  $ heroku pg:privatelink:access DATABASE -a <value> [-r <value>]

FLAGS
  -a, --app=<value>     (required) app to run command against
  -r, --remote=<value>  git remote of app to use

DESCRIPTION
  list all allowed accounts for your privatelink endpoint

EXAMPLES
  $ heroku data:privatelink:access postgresql-sushi-12345 --app my-app

heroku pg:privatelink:access:add DATABASE

add one or more allowed AWS accounts to your privatelink endpoint

USAGE
  $ heroku pg:privatelink:access:add DATABASE -i <value> -a <value> [-r <value>]

FLAGS
  -a, --app=<value>                (required) app to run command against
  -i, --aws-account-id=<value>...  (required) AWS account id to use
  -r, --remote=<value>             git remote of app to use

DESCRIPTION
  add one or more allowed AWS accounts to your privatelink endpoint

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

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

heroku pg:privatelink:access:remove DATABASE

remove an allowed account from your privatelink endpoint

USAGE
  $ heroku pg:privatelink:access:remove DATABASE -i <value> -a <value> [-r <value>]

FLAGS
  -a, --app=<value>                (required) app to run command against
  -i, --aws-account-id=<value>...  (required) AWS account id to use
  -r, --remote=<value>             git remote of app to use

DESCRIPTION
  remove an allowed account from your privatelink endpoint

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

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

heroku pg:privatelink:create DATABASE

create a new privatelink endpoint for your database

USAGE
  $ heroku pg:privatelink:create DATABASE -i <value> -a <value> [-r <value>]

FLAGS
  -a, --app=<value>                (required) app to run command against
  -i, --aws-account-id=<value>...  (required) AWS account id to use
  -r, --remote=<value>             git remote of app to use

DESCRIPTION
  create a new privatelink endpoint for your database

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

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

heroku pg:privatelink:destroy DATABASE

destroy a privatelink endpoint for your database

USAGE
  $ heroku pg:privatelink:destroy DATABASE -a <value> [-r <value>]

FLAGS
  -a, --app=<value>     (required) app to run command against
  -r, --remote=<value>  git remote of app to use

DESCRIPTION
  destroy a privatelink endpoint for your database

EXAMPLES
  $ heroku data:privatelink:destroy postgresql-sushi-12345 --app my-app

heroku pg:privatelink:wait DATABASE

wait for your privatelink endpoint to be provisioned

USAGE
  $ heroku pg:privatelink:wait DATABASE -a <value> [-r <value>]

FLAGS
  -a, --app=<value>     (required) app to run command against
  -r, --remote=<value>  git remote of app to use

DESCRIPTION
  wait for your privatelink endpoint to be provisioned

EXAMPLES
  $ heroku data:privatelink:wait postgresql-sushi-12345 postgresql-sushi-12345 --app my-app

heroku redis:privatelink DATABASE

list all your privatelink endpoints

USAGE
  $ heroku redis:privatelink DATABASE -a <value> [-r <value>]

FLAGS
  -a, --app=<value>     (required) app to run command against
  -r, --remote=<value>  git remote of app to use

DESCRIPTION
  list all your privatelink endpoints

EXAMPLES
  $ heroku data:privatelink postgresql-sushi-12345 --app my-app

heroku redis:privatelink:access DATABASE

list all allowed accounts for your privatelink endpoint

USAGE
  $ heroku redis:privatelink:access DATABASE -a <value> [-r <value>]

FLAGS
  -a, --app=<value>     (required) app to run command against
  -r, --remote=<value>  git remote of app to use

DESCRIPTION
  list all allowed accounts for your privatelink endpoint

EXAMPLES
  $ heroku data:privatelink:access postgresql-sushi-12345 --app my-app

heroku redis:privatelink:access:add DATABASE

add one or more allowed AWS accounts to your privatelink endpoint

USAGE
  $ heroku redis:privatelink:access:add DATABASE -i <value> -a <value> [-r <value>]

FLAGS
  -a, --app=<value>                (required) app to run command against
  -i, --aws-account-id=<value>...  (required) AWS account id to use
  -r, --remote=<value>             git remote of app to use

DESCRIPTION
  add one or more allowed AWS accounts to your privatelink endpoint

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

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

heroku redis:privatelink:access:remove DATABASE

remove an allowed account from your privatelink endpoint

USAGE
  $ heroku redis:privatelink:access:remove DATABASE -i <value> -a <value> [-r <value>]

FLAGS
  -a, --app=<value>                (required) app to run command against
  -i, --aws-account-id=<value>...  (required) AWS account id to use
  -r, --remote=<value>             git remote of app to use

DESCRIPTION
  remove an allowed account from your privatelink endpoint

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

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

heroku redis:privatelink:create DATABASE

create a new privatelink endpoint for your database

USAGE
  $ heroku redis:privatelink:create DATABASE -i <value> -a <value> [-r <value>]

FLAGS
  -a, --app=<value>                (required) app to run command against
  -i, --aws-account-id=<value>...  (required) AWS account id to use
  -r, --remote=<value>             git remote of app to use

DESCRIPTION
  create a new privatelink endpoint for your database

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

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

heroku redis:privatelink:destroy DATABASE

destroy a privatelink endpoint for your database

USAGE
  $ heroku redis:privatelink:destroy DATABASE -a <value> [-r <value>]

FLAGS
  -a, --app=<value>     (required) app to run command against
  -r, --remote=<value>  git remote of app to use

DESCRIPTION
  destroy a privatelink endpoint for your database

EXAMPLES
  $ heroku data:privatelink:destroy postgresql-sushi-12345 --app my-app

heroku redis:privatelink:wait DATABASE

wait for your privatelink endpoint to be provisioned

USAGE
  $ heroku redis:privatelink:wait DATABASE -a <value> [-r <value>]

FLAGS
  -a, --app=<value>     (required) app to run command against
  -r, --remote=<value>  git remote of app to use

DESCRIPTION
  wait for your privatelink endpoint to be provisioned

EXAMPLES
  $ heroku data:privatelink:wait postgresql-sushi-12345 postgresql-sushi-12345 --app my-app