Skip to content

Commit

Permalink
v1.0.1
Browse files Browse the repository at this point in the history
  • Loading branch information
brettgoulder committed Aug 7, 2019
1 parent 1b485e4 commit 57fe547
Show file tree
Hide file tree
Showing 2 changed files with 58 additions and 30 deletions.
86 changes: 57 additions & 29 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ $ npm install -g @heroku-cli/plugin-data-privatelink
$ heroku COMMAND
running command...
$ heroku (-v|--version|version)
@heroku-cli/plugin-data-privatelink/0.8.0 darwin-x64 node-v10.15.1
@heroku-cli/plugin-data-privatelink/1.0.1 darwin-x64 node-v10.16.0
$ heroku --help [COMMAND]
USAGE
$ heroku COMMAND
Expand All @@ -26,139 +26,167 @@ USAGE
<!-- usagestop -->
# Commands
<!-- commands -->
* [`heroku data:privatelink [ADDON]`](#heroku-dataprivatelink-addon)
* [`heroku data:privatelink:access [ADDON]`](#heroku-dataprivatelinkaccess-addon)
* [`heroku data:privatelink:access:add [ADDON]`](#heroku-dataprivatelinkaccessadd-addon)
* [`heroku data:privatelink:access:remove [ADDON]`](#heroku-dataprivatelinkaccessremove-addon)
* [`heroku data:privatelink:create [ADDON]`](#heroku-dataprivatelinkcreate-addon)
* [`heroku data:privatelink:destroy [ADDON]`](#heroku-dataprivatelinkdestroy-addon)
* [`heroku data:privatelink:wait [ADDON]`](#heroku-dataprivatelinkwait-addon)
* [`heroku data:privatelink [DATABASE]`](#heroku-dataprivatelink-database)
* [`heroku data:privatelink:access [DATABASE]`](#heroku-dataprivatelinkaccess-database)
* [`heroku data:privatelink:access:add [DATABASE]`](#heroku-dataprivatelinkaccessadd-database)
* [`heroku data:privatelink:access:remove [DATABASE]`](#heroku-dataprivatelinkaccessremove-database)
* [`heroku data:privatelink:create [DATABASE]`](#heroku-dataprivatelinkcreate-database)
* [`heroku data:privatelink:destroy [DATABASE]`](#heroku-dataprivatelinkdestroy-database)
* [`heroku data:privatelink:wait [DATABASE]`](#heroku-dataprivatelinkwait-database)

## `heroku data:privatelink [ADDON]`
## `heroku data:privatelink [DATABASE]`

list all your privatelink endpoints!

```
USAGE
$ heroku data:privatelink [ADDON]
$ heroku data:privatelink [DATABASE]
OPTIONS
-a, --app=app (required) app to run command against
ALIASES
$ heroku pg:privatelink
$ heroku kafka:privatelink
EXAMPLE
$ heroku data:privatelink postgresql-sushi-12345
```

_See code: [src/commands/data/privatelink/index.ts](https://github.com/heroku/heroku-data-privatelink-cli/blob/v0.8.0/src/commands/data/privatelink/index.ts)_
_See code: [src/commands/data/privatelink/index.ts](https://github.com/heroku/heroku-data-privatelink-cli/blob/v1.0.1/src/commands/data/privatelink/index.ts)_

## `heroku data:privatelink:access [ADDON]`
## `heroku data:privatelink:access [DATABASE]`

list all accounts for your privatelink endpoint's whitelist

```
USAGE
$ heroku data:privatelink:access [ADDON]
$ heroku data:privatelink:access [DATABASE]
OPTIONS
-a, --app=app (required) app to run command against
ALIASES
$ heroku pg:privatelink:access
$ heroku kafka:privatelink:access
EXAMPLE
$ heroku data:privatelink:access postgresql-sushi-12345
```

_See code: [src/commands/data/privatelink/access/index.ts](https://github.com/heroku/heroku-data-privatelink-cli/blob/v0.8.0/src/commands/data/privatelink/access/index.ts)_
_See code: [src/commands/data/privatelink/access/index.ts](https://github.com/heroku/heroku-data-privatelink-cli/blob/v1.0.1/src/commands/data/privatelink/access/index.ts)_

## `heroku data:privatelink:access:add [ADDON]`
## `heroku data:privatelink:access:add [DATABASE]`

add an account to your privatelink endpoint's whitelist

```
USAGE
$ heroku data:privatelink:access:add [ADDON]
$ 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
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](https://github.com/heroku/heroku-data-privatelink-cli/blob/v0.8.0/src/commands/data/privatelink/access/add.ts)_
_See code: [src/commands/data/privatelink/access/add.ts](https://github.com/heroku/heroku-data-privatelink-cli/blob/v1.0.1/src/commands/data/privatelink/access/add.ts)_

## `heroku data:privatelink:access:remove [ADDON]`
## `heroku data:privatelink:access:remove [DATABASE]`

remove an account from your privatelink endpoint's whitelist

```
USAGE
$ heroku data:privatelink:access:remove [ADDON]
$ 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
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](https://github.com/heroku/heroku-data-privatelink-cli/blob/v0.8.0/src/commands/data/privatelink/access/remove.ts)_
_See code: [src/commands/data/privatelink/access/remove.ts](https://github.com/heroku/heroku-data-privatelink-cli/blob/v1.0.1/src/commands/data/privatelink/access/remove.ts)_

## `heroku data:privatelink:create [ADDON]`
## `heroku data:privatelink:create [DATABASE]`

create a new privatelink endpoint for your database

```
USAGE
$ heroku data:privatelink:create [ADDON]
$ 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
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](https://github.com/heroku/heroku-data-privatelink-cli/blob/v0.8.0/src/commands/data/privatelink/create.ts)_
_See code: [src/commands/data/privatelink/create.ts](https://github.com/heroku/heroku-data-privatelink-cli/blob/v1.0.1/src/commands/data/privatelink/create.ts)_

## `heroku data:privatelink:destroy [ADDON]`
## `heroku data:privatelink:destroy [DATABASE]`

destroy a privatelink endpoint for your database

```
USAGE
$ heroku data:privatelink:destroy [ADDON]
$ heroku data:privatelink:destroy [DATABASE]
OPTIONS
-a, --app=app (required) app to run command against
ALIASES
$ heroku pg:privatelink:destroy
$ heroku kafka:privatelink:destroy
EXAMPLE
$ heroku data:privatelink:destroy postgresql-sushi-12345
```

_See code: [src/commands/data/privatelink/destroy.ts](https://github.com/heroku/heroku-data-privatelink-cli/blob/v0.8.0/src/commands/data/privatelink/destroy.ts)_
_See code: [src/commands/data/privatelink/destroy.ts](https://github.com/heroku/heroku-data-privatelink-cli/blob/v1.0.1/src/commands/data/privatelink/destroy.ts)_

## `heroku data:privatelink:wait [ADDON]`
## `heroku data:privatelink:wait [DATABASE]`

wait for your privatelink endpoint to be provisioned

```
USAGE
$ heroku data:privatelink:wait [ADDON]
$ heroku data:privatelink:wait [DATABASE]
OPTIONS
-a, --app=app (required) app to run command against
ALIASES
$ heroku pg:privatelink:wait
$ heroku kafka:privatelink:wait
EXAMPLE
$ heroku data:privatelink:wait postgresql-sushi-12345
```

_See code: [src/commands/data/privatelink/wait.ts](https://github.com/heroku/heroku-data-privatelink-cli/blob/v0.8.0/src/commands/data/privatelink/wait.ts)_
_See code: [src/commands/data/privatelink/wait.ts](https://github.com/heroku/heroku-data-privatelink-cli/blob/v1.0.1/src/commands/data/privatelink/wait.ts)_
<!-- commandsstop -->
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@heroku-cli/plugin-data-privatelink",
"description": "Heroku Data via PrivateLink CLI",
"version": "0.8.0",
"version": "1.0.1",
"author": "Heroku Data UX",
"bugs": "https://github.com/heroku/heroku-data-privatelink-cli/issues",
"dependencies": {
Expand Down

0 comments on commit 57fe547

Please sign in to comment.