Skip to content

Commit

Permalink
feat(cli): pass cloudformation parameters to "cdk deploy"
Browse files Browse the repository at this point in the history
Adding an example of using parameters to the README.md
  • Loading branch information
Viphor committed Mar 3, 2020
1 parent 2024a54 commit 98b655a
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion packages/aws-cdk/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -136,9 +136,15 @@ and always deploy the stack.
In order to pass parameters to your template during deployment, you can use `--parameters
(STACK:KEY=VALUE)`. This will apply the value `VALUE` to the key `KEY` for stack `STACK`. The stack
name can either be `*` or omitted in order to apply to all stacks.
Note: The parameters will not propagate to NestedStacks. These has to be sent with the constructor
Note: The parameters will not propagate to NestedStacks. These must be sent with the constructor
of these.

An example of this could be:

```console
$ cdk deploy --app='node bin/main.js' --parameters 'MyStackName:MyKey=HelloWorld'
```

#### `cdk destroy`
Deletes a stack from it's environment. This will cause the resources in the stack to be destroyed (unless they were
configured with a `DeletionPolicy` of `Retain`). During the stack destruction, the command will output progress
Expand Down

0 comments on commit 98b655a

Please sign in to comment.