@guardian/cfn-cli

cfn-cli

Tools to help run common Cloudformation tasks from the command line

• cfn-cli
• Usage
• Commands

Usage

$ npm install -g @guardian/cfn-cli
$ cfn COMMAND
running command...
$ cfn (-v|--version|version)
@guardian/cfn-cli/1.5.5 darwin-x64 node-v12.18.1
$ cfn --help [COMMAND]
USAGE
  $ cfn COMMAND
...

Commands

• cfn create-stack
• cfn help [COMMAND]
• cfn rotate-instances
• cfn update-ami
• cfn update-parameters
• cfn update-template
• cfn validate-template

cfn create-stack

Base command

USAGE
  $ cfn create-stack

OPTIONS
  -h, --help               show CLI help
  -p, --profile=profile    (required) AWS profile
  -r, --region=region      AWS region
  -s, --stack=stack        (required) Stack to update
  -t, --template=template  (required) Template to upload

See code: src/commands/create-stack.ts

cfn help [COMMAND]

display help for cfn

USAGE
  $ cfn help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

cfn rotate-instances

Rotate all instances in an autoscaling group

USAGE
  $ cfn rotate-instances

OPTIONS
  -h, --help                   show CLI help
  -p, --profile=profile        (required) AWS profile
  -s, --stack-name=stack-name  (required) Stack to rotate instances in

See code: src/commands/rotate-instances.ts

cfn update-ami

Replace the AMI in a stack and rotate the ASG to spin up a new box with it

USAGE
  $ cfn update-ami

OPTIONS
  -a, --ami=ami                (required) AMI to replace with
  -h, --help                   show CLI help
  -p, --profile=profile        (required) AWS profile (value of --profile on the AWS CLI)
  -s, --stack-name=stack-name  (required) Stack to update with AMI

See code: src/commands/update-ami.ts

cfn update-parameters

Updates a stack with a new template

USAGE
  $ cfn update-parameters

OPTIONS
  -h, --help             show CLI help
  -p, --profile=profile  (required) AWS profile
  -r, --region=region    AWS region
  -s, --stack=stack      (required) Stack to update

See code: src/commands/update-parameters.ts

cfn update-template

Updates a stack with a new template

USAGE
  $ cfn update-template

OPTIONS
  -h, --help               show CLI help
  -p, --profile=profile    (required) AWS profile
  -r, --region=region      AWS region
  -s, --stack=stack        (required) Stack to update
  -t, --template=template  (required) Template to upload

See code: src/commands/update-template.ts

cfn validate-template

describe the command here

USAGE
  $ cfn validate-template

OPTIONS
  -h, --help                         show CLI help
  -p, --profile=profile              Profile
  -t, --template-path=template-path  (required) Path to template file to validate

See code: src/commands/validate-template.ts