npm package: @guardian/cfn-cli
Description: Tools to help run common CloudFormation tasks from the command line
Author: Stephen Geller @stephengeller
Latest version: 1.6.0
Deprecated: No longer supported. Don't use this

# cfn-cli

Tools to help run common Cloudformation tasks from the command line

[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
[![Version](https://img.shields.io/npm/v/cfn-cli.svg)](https://npmjs.org/package/cfn-cli)
[![Downloads/week](https://img.shields.io/npm/dw/cfn-cli.svg)](https://npmjs.org/package/cfn-cli)
[![License](https://img.shields.io/npm/l/cfn-cli.svg)](https://github.com/guardian/cfn-cli/blob/master/package.json)

<!-- toc -->
* [cfn-cli](#cfn-cli)
* [Usage](#usage)
* [Commands](#commands)
<!-- tocstop -->

# Usage

<!-- usage -->
```sh-session
$ npm install -g @guardian/cfn-cli
$ cfn COMMAND
running command...
$ cfn (-v|--version|version)
@guardian/cfn-cli/1.6.0 darwin-x64 node-v14.16.1
$ cfn --help [COMMAND]
USAGE
  $ cfn COMMAND
...
```
<!-- usagestop -->

# Commands

<!-- commands -->
* [`cfn create-stack`](#cfn-create-stack)
* [`cfn help [COMMAND]`](#cfn-help-command)
* [`cfn rotate-instances`](#cfn-rotate-instances)
* [`cfn update-ami`](#cfn-update-ami)
* [`cfn update-parameters`](#cfn-update-parameters)
* [`cfn update-template`](#cfn-update-template)
* [`cfn validate-template`](#cfn-validate-template)

## `cfn create-stack`

Base command

```
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](https://github.com/guardian/cfn-cli/blob/v1.6.0/src/commands/create-stack.ts)_

## `cfn help [COMMAND]`

display help for cfn

```
display help for <%= config.bin %>

USAGE
  $ cfn help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI
```

_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v2.2.3/src/commands/help.ts)_

## `cfn rotate-instances`

Rotate all instances in an autoscaling group

```
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](https://github.com/guardian/cfn-cli/blob/v1.6.0/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

```
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](https://github.com/guardian/cfn-cli/blob/v1.6.0/src/commands/update-ami.ts)_

## `cfn update-parameters`

Updates a stack with a new template

```
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](https://github.com/guardian/cfn-cli/blob/v1.6.0/src/commands/update-parameters.ts)_

## `cfn update-template`

Updates a stack with a new 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](https://github.com/guardian/cfn-cli/blob/v1.6.0/src/commands/update-template.ts)_

## `cfn validate-template`

describe the command here

```
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](https://github.com/guardian/cfn-cli/blob/v1.6.0/src/commands/validate-template.ts)_
<!-- commandsstop -->