docs/command-config.md in sfn-3.0.32 vs docs/command-config.md in sfn-3.1.0
- old
+ new
@@ -1,7 +1,7 @@
---
-title: "Commands and configuration"
+title: "Configuration"
weight: 6
anchors:
- title: "Conf Command"
url: "#conf-command"
- title: "Create Command"
@@ -26,19 +26,41 @@
url: "#inspect-command"
- title: "Lint Command"
url: "#lint-command"
- title: "List Command"
url: "#list-command"
+ - title: "Plan Command"
+ url: "#plan-command"
- title: "Print Command"
url: "#print-command"
- title: "Promote Command"
url: "#promote-command"
+ - title: "Realize Command"
+ url: "#realize-command"
- title: "Update Command"
url: "#update-command"
- title: "Validate Command"
url: "#validate-command"
---
+
+# Command configurations
+
+This lists commands and the options which the commands accept. It also
+includes the valid types which the options will accept. Options can be
+set with the `.sfn` configuration file to apply default values which
+can be overridden on the CLI. Options defined within the `.sfn` configuration
+file are the option name with `-` characters replaced with `_`.
+
+For example, the option `--apply-mapping` can be defined in the `.sfn`
+configuration file as:
+
+~~~ruby
+Configuration.new do
+ apply_mapping true
+end
+~~~
+
## Conf Command
~~~
$ sfn conf
~~~
@@ -55,10 +77,13 @@
| | Valid | `String` |
| | Default | |
| `--base-directory` | Description | Path to root of of templates directory |
| | Valid | `String` |
| | Default | |
+| `--colors` | Description | Enable colorized output |
+| | Valid | `TrueClass`, `FalseClass` |
+| | Default | true|
| `--compile-parameters` | Description | Pass template compile time parameters directly |
| | Valid | `Bogo::Smash` |
| | Default | |
| `--config` | Description | Configuration file path |
| | Valid | `String` |
@@ -88,10 +113,13 @@
| | Valid | `String` |
| | Default | |
| `--interactive-parameters` | Description | Prompt for template parameters |
| | Valid | `TrueClass`, `FalseClass` |
| | Default | true|
+| `--log` | Description | Enable logging with given level |
+| | Valid | `String` |
+| | Default | |
| `--merge-api-options` | Description | Merge API options defined within configuration on update |
| | Valid | `TrueClass`, `FalseClass` |
| | Default | false|
| `--nesting-bucket` | Description | Bucket to use for storing nested stack templates |
| | Valid | `String` |
@@ -172,10 +200,13 @@
| | Valid | `String` |
| | Default | |
| `--base-directory` | Description | Path to root of of templates directory |
| | Valid | `String` |
| | Default | |
+| `--colors` | Description | Enable colorized output |
+| | Valid | `TrueClass`, `FalseClass` |
+| | Default | true|
| `--compile-parameters` | Description | Pass template compile time parameters directly |
| | Valid | `Bogo::Smash` |
| | Default | |
| `--config` | Description | Configuration file path |
| | Valid | `String` |
@@ -202,10 +233,13 @@
| | Valid | `String` |
| | Default | |
| `--interactive-parameters` | Description | Prompt for template parameters |
| | Valid | `TrueClass`, `FalseClass` |
| | Default | true|
+| `--log` | Description | Enable logging with given level |
+| | Valid | `String` |
+| | Default | |
| `--merge-api-options` | Description | Merge API options defined within configuration on update |
| | Valid | `TrueClass`, `FalseClass` |
| | Default | false|
| `--nesting-bucket` | Description | Bucket to use for storing nested stack templates |
| | Valid | `String` |
@@ -274,10 +308,13 @@
$ sfn describe
~~~
| Option | Attribute | Value
|--------|-----------|------
+| `--colors` | Description | Enable colorized output |
+| | Valid | `TrueClass`, `FalseClass` |
+| | Default | true|
| `--conf` | Description | |
| | Valid | `Sfn::Config::Conf` |
| | Default | |
| `--config` | Description | Configuration file path |
| | Valid | `String` |
@@ -313,10 +350,13 @@
| | Valid | `Sfn::Config::Inspect` |
| | Default | |
| `--interactive-parameters` | Description | Prompt for template parameters |
| | Valid | `TrueClass`, `FalseClass` |
| | Default | true|
+| `--log` | Description | Enable logging with given level |
+| | Valid | `String` |
+| | Default | |
| `--outputs` | Description | Display stack outputs |
| | Valid | `TrueClass`, `FalseClass` |
| | Default | |
| `--poll` | Description | Poll stack events on modification actions |
| | Valid | `TrueClass`, `FalseClass` |
@@ -340,10 +380,13 @@
$ sfn destroy
~~~
| Option | Attribute | Value
|--------|-----------|------
+| `--colors` | Description | Enable colorized output |
+| | Valid | `TrueClass`, `FalseClass` |
+| | Default | true|
| `--conf` | Description | |
| | Valid | `Sfn::Config::Conf` |
| | Default | |
| `--config` | Description | Configuration file path |
| | Valid | `String` |
@@ -364,10 +407,13 @@
| | Valid | `String` |
| | Default | |
| `--interactive-parameters` | Description | Prompt for template parameters |
| | Valid | `TrueClass`, `FalseClass` |
| | Default | true|
+| `--log` | Description | Enable logging with given level |
+| | Valid | `String` |
+| | Default | |
| `--poll` | Description | Poll stack events on modification actions |
| | Valid | `TrueClass`, `FalseClass` |
| | Default | true|
| `--update` | Description | |
| | Valid | `Sfn::Config::Update` |
@@ -394,10 +440,13 @@
| | Valid | `String` |
| | Default | |
| `--base-directory` | Description | Path to root of of templates directory |
| | Valid | `String` |
| | Default | |
+| `--colors` | Description | Enable colorized output |
+| | Valid | `TrueClass`, `FalseClass` |
+| | Default | true|
| `--compile-parameters` | Description | Pass template compile time parameters directly |
| | Valid | `Bogo::Smash` |
| | Default | |
| `--config` | Description | Configuration file path |
| | Valid | `String` |
@@ -424,10 +473,13 @@
| | Valid | `String` |
| | Default | |
| `--interactive-parameters` | Description | Prompt for template parameters |
| | Valid | `TrueClass`, `FalseClass` |
| | Default | true|
+| `--log` | Description | Enable logging with given level |
+| | Valid | `String` |
+| | Default | |
| `--merge-api-options` | Description | Merge API options defined within configuration on update |
| | Valid | `TrueClass`, `FalseClass` |
| | Default | false|
| `--nesting-bucket` | Description | Bucket to use for storing nested stack templates |
| | Valid | `String` |
@@ -496,10 +548,13 @@
| | Valid | `TrueClass`, `FalseClass` |
| | Default | |
| `--attribute` | Description | Event attribute to display |
| | Valid | `String` |
| | Default | |
+| `--colors` | Description | Enable colorized output |
+| | Valid | `TrueClass`, `FalseClass` |
+| | Default | true|
| `--conf` | Description | |
| | Valid | `Sfn::Config::Conf` |
| | Default | |
| `--config` | Description | Configuration file path |
| | Valid | `String` |
@@ -523,10 +578,13 @@
| | Valid | `String` |
| | Default | |
| `--interactive-parameters` | Description | Prompt for template parameters |
| | Valid | `TrueClass`, `FalseClass` |
| | Default | true|
+| `--log` | Description | Enable logging with given level |
+| | Valid | `String` |
+| | Default | |
| `--poll` | Description | Poll stack events on modification actions |
| | Valid | `TrueClass`, `FalseClass` |
| | Default | true|
| `--poll-delay` | Description | Seconds to pause between each event poll |
| | Valid | `Integer` |
@@ -550,10 +608,13 @@
| | Valid | `String` |
| | Default | |
| `--bucket-prefix` | Description | Remote key prefix within bucket for dump file |
| | Valid | `String` |
| | Default | |
+| `--colors` | Description | Enable colorized output |
+| | Valid | `TrueClass`, `FalseClass` |
+| | Default | true|
| `--conf` | Description | |
| | Valid | `Sfn::Config::Conf` |
| | Default | |
| `--config` | Description | Configuration file path |
| | Valid | `String` |
@@ -580,10 +641,13 @@
| | Valid | `String` |
| | Default | |
| `--interactive-parameters` | Description | Prompt for template parameters |
| | Valid | `TrueClass`, `FalseClass` |
| | Default | true|
+| `--log` | Description | Enable logging with given level |
+| | Valid | `String` |
+| | Default | |
| `--name` | Description | Export file base name |
| | Valid | `String` |
| | Default | |
| `--path` | Description | Local path prefix for dump file |
| | Valid | `String` |
@@ -610,10 +674,13 @@
| | Valid | `String`, `Symbol` |
| | Default | "deep"|
| `--base-directory` | Description | Path to root of of templates directory |
| | Valid | `String` |
| | Default | |
+| `--colors` | Description | Enable colorized output |
+| | Valid | `TrueClass`, `FalseClass` |
+| | Default | true|
| `--compile-parameters` | Description | Pass template compile time parameters directly |
| | Valid | `Bogo::Smash` |
| | Default | |
| `--config` | Description | Configuration file path |
| | Valid | `String` |
@@ -640,10 +707,13 @@
| | Valid | `String` |
| | Default | |
| `--interactive-parameters` | Description | Prompt for template parameters |
| | Valid | `TrueClass`, `FalseClass` |
| | Default | true|
+| `--log` | Description | Enable logging with given level |
+| | Valid | `String` |
+| | Default | |
| `--luckymike` | Description | Force `dependency` style graph |
| | Valid | `TrueClass`, `FalseClass` |
| | Default | false|
| `--nesting-bucket` | Description | Bucket to use for storing nested stack templates |
| | Valid | `String` |
@@ -697,10 +767,13 @@
| | Valid | `String` |
| | Default | |
| `--bucket-prefix` | Description | Remote key prefix within bucket for dump file |
| | Valid | `String` |
| | Default | |
+| `--colors` | Description | Enable colorized output |
+| | Valid | `TrueClass`, `FalseClass` |
+| | Default | true|
| `--conf` | Description | |
| | Valid | `Sfn::Config::Conf` |
| | Default | |
| `--config` | Description | Configuration file path |
| | Valid | `String` |
@@ -730,10 +803,13 @@
| | Valid | `String` |
| | Default | |
| `--interactive-parameters` | Description | Prompt for template parameters |
| | Valid | `TrueClass`, `FalseClass` |
| | Default | true|
+| `--log` | Description | Enable logging with given level |
+| | Valid | `String` |
+| | Default | |
| `--path` | Description | Directory path JSON export files are located |
| | Valid | `String` |
| | Default | |
| `--poll` | Description | Poll stack events on modification actions |
| | Valid | `TrueClass`, `FalseClass` |
@@ -751,10 +827,13 @@
$ sfn init
~~~
| Option | Attribute | Value
|--------|-----------|------
+| `--colors` | Description | Enable colorized output |
+| | Valid | `TrueClass`, `FalseClass` |
+| | Default | true|
| `--conf` | Description | |
| | Valid | `Sfn::Config::Conf` |
| | Default | |
| `--config` | Description | Configuration file path |
| | Valid | `String` |
@@ -796,10 +875,13 @@
| | Valid | `TrueClass`, `FalseClass` |
| | Default | true|
| `--list` | Description | |
| | Valid | `Sfn::Config::List` |
| | Default | |
+| `--log` | Description | Enable logging with given level |
+| | Valid | `String` |
+| | Default | |
| `--poll` | Description | Poll stack events on modification actions |
| | Valid | `TrueClass`, `FalseClass` |
| | Default | true|
| `--promote` | Description | |
| | Valid | `Sfn::Config::Promote` |
@@ -823,10 +905,13 @@
| Option | Attribute | Value
|--------|-----------|------
| `--attribute` | Description | Dot delimited attribute to view |
| | Valid | `String` |
| | Default | |
+| `--colors` | Description | Enable colorized output |
+| | Valid | `TrueClass`, `FalseClass` |
+| | Default | true|
| `--conf` | Description | |
| | Valid | `Sfn::Config::Conf` |
| | Default | |
| `--config` | Description | Configuration file path |
| | Valid | `String` |
@@ -871,10 +956,13 @@
| | Valid | `TrueClass`, `FalseClass` |
| | Default | true|
| `--load-balancers` | Description | Locate all load balancers, display addresses and server states |
| | Valid | `TrueClass`, `FalseClass` |
| | Default | |
+| `--log` | Description | Enable logging with given level |
+| | Valid | `String` |
+| | Default | |
| `--nodes` | Description | Locate all instances and display addresses |
| | Valid | `TrueClass`, `FalseClass` |
| | Default | |
| `--poll` | Description | Poll stack events on modification actions |
| | Valid | `TrueClass`, `FalseClass` |
@@ -901,10 +989,13 @@
| | Valid | `String`, `Symbol` |
| | Default | "deep"|
| `--base-directory` | Description | Path to root of of templates directory |
| | Valid | `String` |
| | Default | |
+| `--colors` | Description | Enable colorized output |
+| | Valid | `TrueClass`, `FalseClass` |
+| | Default | true|
| `--compile-parameters` | Description | Pass template compile time parameters directly |
| | Valid | `Bogo::Smash` |
| | Default | |
| `--config` | Description | Configuration file path |
| | Valid | `String` |
@@ -940,10 +1031,13 @@
| | Valid | `String` |
| | Default | |
| `--local-rule-sets-only` | Description | Only apply rule sets provided by lint directory |
| | Valid | `TrueClass`, `FalseClass` |
| | Default | false|
+| `--log` | Description | Enable logging with given level |
+| | Valid | `String` |
+| | Default | |
| `--nesting-bucket` | Description | Bucket to use for storing nested stack templates |
| | Valid | `String` |
| | Default | |
| `--nesting-prefix` | Description | File name prefix for storing template in bucket |
| | Valid | `String` |
@@ -988,10 +1082,13 @@
| | Valid | `TrueClass`, `FalseClass` |
| | Default | |
| `--attribute` | Description | Attribute of stack to print |
| | Valid | `String` |
| | Default | |
+| `--colors` | Description | Enable colorized output |
+| | Valid | `TrueClass`, `FalseClass` |
+| | Default | true|
| `--conf` | Description | |
| | Valid | `Sfn::Config::Conf` |
| | Default | |
| `--config` | Description | Configuration file path |
| | Valid | `String` |
@@ -1030,10 +1127,13 @@
| | Valid | `Sfn::Config::Inspect` |
| | Default | |
| `--interactive-parameters` | Description | Prompt for template parameters |
| | Valid | `TrueClass`, `FalseClass` |
| | Default | true|
+| `--log` | Description | Enable logging with given level |
+| | Valid | `String` |
+| | Default | |
| `--poll` | Description | Poll stack events on modification actions |
| | Valid | `TrueClass`, `FalseClass` |
| | Default | true|
| `--status` | Description | Match stacks with given status. Use "none" to disable. |
| | Valid | `String` |
@@ -1043,10 +1143,142 @@
| | Default | |
| `--yes` | Description | Automatically accept any requests for confirmation |
| | Valid | `TrueClass`, `FalseClass` |
| | Default | |
+## Plan Command
+
+~~~
+$ sfn plan
+~~~
+
+| Option | Attribute | Value
+|--------|-----------|------
+| `--apply-mapping` | Description | Customize apply stack mapping as [StackName__]OutputName:ParameterName (Key:Value[,Key:Value,...]) |
+| | Valid | `Bogo::Smash` |
+| | Default | |
+| `--apply-nesting` | Description | Apply stack nesting |
+| | Valid | `String`, `Symbol` |
+| | Default | "deep"|
+| `--apply-stack` | Description | Apply outputs from stack to input parameters |
+| | Valid | `String` |
+| | Default | |
+| `--auto-destroy-plan` | Description | Automatically destroy generated plan |
+| | Valid | `TrueClass`, `FalseClass`, `NilClass` |
+| | Default | |
+| `--auto-destroy-stack` | Description | Automatically destroy empty stack |
+| | Valid | `TrueClass`, `FalseClass`, `NilClass` |
+| | Default | |
+| `--base-directory` | Description | Path to root of of templates directory |
+| | Valid | `String` |
+| | Default | |
+| `--colors` | Description | Enable colorized output |
+| | Valid | `TrueClass`, `FalseClass` |
+| | Default | true|
+| `--compile-parameters` | Description | Pass template compile time parameters directly |
+| | Valid | `Bogo::Smash` |
+| | Default | |
+| `--config` | Description | Configuration file path |
+| | Valid | `String` |
+| | Default | |
+| `--credentials` | Description | Provider credentials (Key:Value[,Key:Value,...]) |
+| | Valid | `Bogo::Smash` |
+| | Default | |
+| `--debug` | Description | Enable debug output |
+| | Valid | `TrueClass`, `FalseClass` |
+| | Default | |
+| `--defaults` | Description | Automatically accept default values |
+| | Valid | `TrueClass`, `FalseClass` |
+| | Default | |
+| `--diffs` | Description | Show planner content diff |
+| | Valid | `TrueClass`, `FalseClass` |
+| | Default | true|
+| `--file` | Description | Path to template file |
+| | Valid | `String` |
+| | Default | |
+| `--file-path-prompt` | Description | Enable interactive prompt for template path discovery |
+| | Valid | `TrueClass`, `FalseClass` |
+| | Default | true|
+| `--ignore-parameters` | Description | Parameters to ignore during modifications |
+| | Valid | `String` |
+| | Default | |
+| `--interactive-parameters` | Description | Prompt for template parameters |
+| | Valid | `TrueClass`, `FalseClass` |
+| | Default | true|
+| `--list` | Description | List all available plans for stack |
+| | Valid | `TrueClass`, `FalseClass` |
+| | Default | false|
+| `--load-existing` | Description | Load existing plan if exists |
+| | Valid | `TrueClass`, `FalseClass`, `NilClass` |
+| | Default | |
+| `--log` | Description | Enable logging with given level |
+| | Valid | `String` |
+| | Default | |
+| `--merge-api-options` | Description | Merge API options defined within configuration on update |
+| | Valid | `TrueClass`, `FalseClass` |
+| | Default | false|
+| `--nesting-bucket` | Description | Bucket to use for storing nested stack templates |
+| | Valid | `String` |
+| | Default | |
+| `--nesting-prefix` | Description | File name prefix for storing template in bucket |
+| | Valid | `String` |
+| | Default | |
+| `--no-base-directory` | Description | Unset any value used for the template root directory path |
+| | Valid | `TrueClass`, `FalseClass` |
+| | Default | |
+| `--notification-topics` | Description | Notification endpoints for stack events |
+| | Valid | `String` |
+| | Default | |
+| `--options` | Description | Extra options to apply to the API call (Key:Value[,Key:Value,...]) |
+| | Valid | `Bogo::Smash` |
+| | Default | |
+| `--parameter` | Description | [DEPRECATED - use `parameters`] Pass template parameters directly (ParamName:ParamValue) |
+| | Valid | `Bogo::Smash` |
+| | Default | |
+| `--parameter-validation` | Description | Stack parameter validation behavior |
+| | Valid | `String` |
+| | Default | "default"|
+| `--parameters` | Description | Pass template parameters directly (Key:Value[,Key:Value,...]) |
+| | Valid | `Bogo::Smash` |
+| | Default | |
+| `--plan-name` | Description | Custom plan name or ID (not applicable to all providers) |
+| | Valid | `String` |
+| | Default | |
+| `--plan-only` | Description | Exit after plan display |
+| | Valid | `TrueClass`, `FalseClass` |
+| | Default | false|
+| `--poll` | Description | Poll stack events on modification actions |
+| | Valid | `TrueClass`, `FalseClass` |
+| | Default | true|
+| `--print-only` | Description | Print the resulting stack template |
+| | Valid | `TrueClass`, `FalseClass` |
+| | Default | |
+| `--processing` | Description | Call the unicorns and explode the glitter bombs |
+| | Valid | `TrueClass`, `FalseClass` |
+| | Default | true|
+| `--rollback` | Description | Rollback stack on failure |
+| | Valid | `TrueClass`, `FalseClass` |
+| | Default | |
+| `--sparkle-pack` | Description | Load SparklePack gem |
+| | Valid | `String` |
+| | Default | |
+| `--timeout` | Description | Seconds to wait for stack to complete |
+| | Valid | `Integer` |
+| | Default | |
+| `--translate` | Description | Translate generated template to given provider |
+| | Valid | `String` |
+| | Default | |
+| `--translate-chunk` | Description | Chunk length for serialization |
+| | Valid | `Integer` |
+| | Default | |
+| `--upload-root-template` | Description | Upload root template to storage bucket |
+| | Valid | `TrueClass`, `FalseClass` |
+| | Default | |
+| `--yes` | Description | Automatically accept any requests for confirmation |
+| | Valid | `TrueClass`, `FalseClass` |
+| | Default | |
+
## Print Command
~~~
$ sfn print
~~~
@@ -1057,10 +1289,13 @@
| | Valid | `String`, `Symbol` |
| | Default | "deep"|
| `--base-directory` | Description | Path to root of of templates directory |
| | Valid | `String` |
| | Default | |
+| `--colors` | Description | Enable colorized output |
+| | Valid | `TrueClass`, `FalseClass` |
+| | Default | true|
| `--compile-parameters` | Description | Pass template compile time parameters directly |
| | Valid | `Bogo::Smash` |
| | Default | |
| `--config` | Description | Configuration file path |
| | Valid | `String` |
@@ -1084,10 +1319,13 @@
| | Valid | `String` |
| | Default | |
| `--interactive-parameters` | Description | Prompt for template parameters |
| | Valid | `TrueClass`, `FalseClass` |
| | Default | true|
+| `--log` | Description | Enable logging with given level |
+| | Valid | `String` |
+| | Default | |
| `--nesting-bucket` | Description | Bucket to use for storing nested stack templates |
| | Valid | `String` |
| | Default | |
| `--nesting-prefix` | Description | File name prefix for storing template in bucket |
| | Valid | `String` |
@@ -1120,10 +1358,13 @@
| | Valid | `TrueClass`, `FalseClass` |
| | Default | |
| `--write-to-file` | Description | Write compiled SparkleFormation template to path provided |
| | Valid | `String` |
| | Default | |
+| `--yaml` | Description | Output template content in YAML format |
+| | Valid | `TrueClass`, `FalseClass` |
+| | Default | |
| `--yes` | Description | Automatically accept any requests for confirmation |
| | Valid | `TrueClass`, `FalseClass` |
| | Default | |
## Promote Command
@@ -1141,10 +1382,13 @@
| | Valid | `String` |
| | Default | |
| `--bucket-prefix` | Description | Key prefix within remote bucket |
| | Valid | `String` |
| | Default | |
+| `--colors` | Description | Enable colorized output |
+| | Valid | `TrueClass`, `FalseClass` |
+| | Default | true|
| `--conf` | Description | |
| | Valid | `Sfn::Config::Conf` |
| | Default | |
| `--config` | Description | Configuration file path |
| | Valid | `String` |
@@ -1186,20 +1430,101 @@
| | Valid | `TrueClass`, `FalseClass` |
| | Default | true|
| `--list` | Description | |
| | Valid | `Sfn::Config::List` |
| | Default | |
+| `--log` | Description | Enable logging with given level |
+| | Valid | `String` |
+| | Default | |
| `--poll` | Description | Poll stack events on modification actions |
| | Valid | `TrueClass`, `FalseClass` |
| | Default | true|
| `--update` | Description | |
| | Valid | `Sfn::Config::Update` |
| | Default | |
| `--yes` | Description | Automatically accept any requests for confirmation |
| | Valid | `TrueClass`, `FalseClass` |
| | Default | |
+## Realize Command
+
+~~~
+$ sfn realize
+~~~
+
+| Option | Attribute | Value
+|--------|-----------|------
+| `--colors` | Description | Enable colorized output |
+| | Valid | `TrueClass`, `FalseClass` |
+| | Default | true|
+| `--conf` | Description | |
+| | Valid | `Sfn::Config::Conf` |
+| | Default | |
+| `--config` | Description | Configuration file path |
+| | Valid | `String` |
+| | Default | |
+| `--create` | Description | |
+| | Valid | `Sfn::Config::Create` |
+| | Default | |
+| `--credentials` | Description | Provider credentials (Key:Value[,Key:Value,...]) |
+| | Valid | `Bogo::Smash` |
+| | Default | |
+| `--debug` | Description | Enable debug output |
+| | Valid | `TrueClass`, `FalseClass` |
+| | Default | |
+| `--defaults` | Description | Automatically accept default values |
+| | Valid | `TrueClass`, `FalseClass` |
+| | Default | |
+| `--describe` | Description | |
+| | Valid | `Sfn::Config::Describe` |
+| | Default | |
+| `--destroy` | Description | |
+| | Valid | `Sfn::Config::Destroy` |
+| | Default | |
+| `--events` | Description | |
+| | Valid | `Sfn::Config::Events` |
+| | Default | |
+| `--export` | Description | |
+| | Valid | `Sfn::Config::Export` |
+| | Default | |
+| `--ignore-parameters` | Description | Parameters to ignore during modifications |
+| | Valid | `String` |
+| | Default | |
+| `--import` | Description | |
+| | Valid | `Sfn::Config::Import` |
+| | Default | |
+| `--inspect` | Description | |
+| | Valid | `Sfn::Config::Inspect` |
+| | Default | |
+| `--interactive-parameters` | Description | Prompt for template parameters |
+| | Valid | `TrueClass`, `FalseClass` |
+| | Default | true|
+| `--list` | Description | |
+| | Valid | `Sfn::Config::List` |
+| | Default | |
+| `--log` | Description | Enable logging with given level |
+| | Valid | `String` |
+| | Default | |
+| `--plan-name` | Description | Custom plan name or ID |
+| | Valid | `String` |
+| | Default | |
+| `--poll` | Description | Poll stack events on modification actions |
+| | Valid | `TrueClass`, `FalseClass` |
+| | Default | true|
+| `--promote` | Description | |
+| | Valid | `Sfn::Config::Promote` |
+| | Default | |
+| `--update` | Description | |
+| | Valid | `Sfn::Config::Update` |
+| | Default | |
+| `--validate` | Description | |
+| | Valid | `Sfn::Config::Validate` |
+| | Default | |
+| `--yes` | Description | Automatically accept any requests for confirmation |
+| | Valid | `TrueClass`, `FalseClass` |
+| | Default | |
+
## Update Command
~~~
$ sfn update
~~~
@@ -1216,10 +1541,13 @@
| | Valid | `String` |
| | Default | |
| `--base-directory` | Description | Path to root of of templates directory |
| | Valid | `String` |
| | Default | |
+| `--colors` | Description | Enable colorized output |
+| | Valid | `TrueClass`, `FalseClass` |
+| | Default | true|
| `--compile-parameters` | Description | Pass template compile time parameters directly |
| | Valid | `Bogo::Smash` |
| | Default | |
| `--config` | Description | Configuration file path |
| | Valid | `String` |
@@ -1246,10 +1574,13 @@
| | Valid | `String` |
| | Default | |
| `--interactive-parameters` | Description | Prompt for template parameters |
| | Valid | `TrueClass`, `FalseClass` |
| | Default | true|
+| `--log` | Description | Enable logging with given level |
+| | Valid | `String` |
+| | Default | |
| `--merge-api-options` | Description | Merge API options defined within configuration on update |
| | Valid | `TrueClass`, `FalseClass` |
| | Default | false|
| `--nesting-bucket` | Description | Bucket to use for storing nested stack templates |
| | Valid | `String` |
@@ -1312,10 +1643,13 @@
| | Valid | `String`, `Symbol` |
| | Default | "deep"|
| `--base-directory` | Description | Path to root of of templates directory |
| | Valid | `String` |
| | Default | |
+| `--colors` | Description | Enable colorized output |
+| | Valid | `TrueClass`, `FalseClass` |
+| | Default | true|
| `--compile-parameters` | Description | Pass template compile time parameters directly |
| | Valid | `Bogo::Smash` |
| | Default | |
| `--config` | Description | Configuration file path |
| | Valid | `String` |
@@ -1339,9 +1673,12 @@
| | Valid | `String` |
| | Default | |
| `--interactive-parameters` | Description | Prompt for template parameters |
| | Valid | `TrueClass`, `FalseClass` |
| | Default | true|
+| `--log` | Description | Enable logging with given level |
+| | Valid | `String` |
+| | Default | |
| `--nesting-bucket` | Description | Bucket to use for storing nested stack templates |
| | Valid | `String` |
| | Default | |
| `--nesting-prefix` | Description | File name prefix for storing template in bucket |
| | Valid | `String` |