stsbroker CLI

CLI to configure and interact with your own AWS STS Broker.

• Usage
• Commands

Usage

$ npm install -g stsbroker
$ stsbroker COMMAND
running command...
$ stsbroker (-v|--version|version)
stsbroker/0.0.6 darwin-x64 node-v13.10.1
$ stsbroker --help [COMMAND]
USAGE
  $ stsbroker COMMAND
...

Commands

• stsbroker access
• stsbroker configure
• stsbroker help [COMMAND]
• stsbroker policies
• stsbroker request

stsbroker access

Assume the temporary session

USAGE
  $ stsbroker access

OPTIONS
  -c, --console      Open AWS Console
  -h, --help         show CLI help
  --profile=profile  (required) AWS Profile

See code: src/commands/access.ts

stsbroker configure

Configure your STS Broker

USAGE
  $ stsbroker configure

CONFIGURATION VARIABLES
       The following configuration variables are supported in the config file:

       o STS Broker region

       o STS Broker endpoint - STS Broker API endpoint. 
         Can be a API Gateway stage endpoint (""xxxxx.execute-api.us-east-2.amazonaws.com/Prod"")
         or a custom domain.

       o Cognito User Pool ID

       o Cognito User Pool App Client ID

       o Cognito domain

See code: src/commands/configure.ts

stsbroker help [COMMAND]

display help for stsbroker

USAGE
  $ stsbroker help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

stsbroker policies

Get STS Broker policies available

USAGE
  $ stsbroker policies

OPTIONS
  -x, --extended          show extra columns
  --columns=columns       only show provided columns (comma-separated)
  --csv                   output is csv format [alias: --output=csv]
  --filter=filter         filter property by partial string matching, ex: name=foo
  --no-header             hide table header from output
  --no-truncate           do not truncate output to fit screen
  --output=csv|json|yaml  output in a more machine friendly format
  --reset                 Reset Cognito credentials
  --sort=sort             property to sort by (prepend '-' for descending)

See code: src/commands/policies.ts

stsbroker request

Make a permission request to the STS Broker

USAGE
  $ stsbroker request

OPTIONS
  --reset  Reset Cognito credentials

See code: src/commands/request.ts