Skip to content

Latest commit

 

History

History
109 lines (76 loc) · 2.75 KB

README.md

File metadata and controls

109 lines (76 loc) · 2.75 KB

@nitric/plugin-aws

An AWS plugin for Nitric

oclif Version Downloads/week License

Usage

$ npm install -g @nitric/plugin-aws
$ oclif-example COMMAND
running command...
$ oclif-example (-v|--version|version)
@nitric/plugin-aws/0.0.16 darwin-x64 node-v15.0.1
$ oclif-example --help [COMMAND]
USAGE
  $ oclif-example COMMAND
...

Commands

oclif-example deploy:aws [DIR]

Deploy a Nitric application to Amazon Web Services (AWS)

USAGE
  $ oclif-example deploy:aws [DIR]

OPTIONS
  -a, --account=account
      AWS Account ID to deploy to (default: locally configured account)

  -f, --file=file
      [default: nitric.yaml] Nitric descriptor file location

  -h, --help
      show CLI help

  -r,
  --region=(us-east-1|us-west-1|us-west-2|eu-west-1|eu-central-1|ap-southeast-1|ap-northeast-1|ap-southeast-2|ap-northea
  st-2|sa-east-1|cn-north-1|ap-south-1)
      AWS Region to deploy to

EXAMPLE
  $ nitric deploy:aws . -a 123123123123 -r us-east-1

See code: src/commands/deploy/aws.ts

oclif-example doctor:aws

Checks environment for configuration for deployment to AWS

USAGE
  $ oclif-example doctor:aws

OPTIONS
  -h, --help  show CLI help

EXAMPLE
  $ nitric doctor:aws

See code: src/commands/doctor/aws.ts

oclif-example down:aws [DIR]

Delete a CloudFormation Stack on AWS that was deployed by $ nitric deploy:aws

USAGE
  $ oclif-example down:aws [DIR]

OPTIONS
  -f, --file=file
  -h, --help                 show CLI help
  -r, --region=region        (required) AWS Region to tear down the stack in
  -s, --stackName=stackName  CloudFormation stack name, defaults to the name in the Nitric file if not provided.

EXAMPLE
  $ nitric down:aws . -s MyCloudFormationStack -r us-east-1

See code: src/commands/down/aws.ts