sfn 2.2.0 → 3.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +20 -0
- data/bin/command-config-generator +44 -0
- data/bin/sfn +1 -5
- data/docs/README.md +2 -1
- data/docs/callbacks.md +18 -0
- data/docs/command-config.md +1276 -0
- data/docs/configuration.md +0 -105
- data/docs/overview.md +1 -0
- data/lib/sfn.rb +1 -0
- data/lib/sfn/api_provider.rb +9 -0
- data/lib/sfn/api_provider/google.rb +84 -0
- data/lib/sfn/command.rb +22 -0
- data/lib/sfn/command/create.rb +33 -45
- data/lib/sfn/command/describe.rb +1 -1
- data/lib/sfn/command/destroy.rb +7 -1
- data/lib/sfn/command/diff.rb +4 -5
- data/lib/sfn/command/graph.rb +1 -3
- data/lib/sfn/command/print.rb +3 -4
- data/lib/sfn/command/update.rb +89 -87
- data/lib/sfn/command/validate.rb +24 -11
- data/lib/sfn/command_module/base.rb +1 -12
- data/lib/sfn/command_module/stack.rb +45 -56
- data/lib/sfn/command_module/template.rb +74 -33
- data/lib/sfn/config/print.rb +5 -0
- data/lib/sfn/config/update.rb +4 -0
- data/lib/sfn/config/validate.rb +4 -0
- data/lib/sfn/monkey_patch/stack.rb +153 -83
- data/lib/sfn/monkey_patch/stack/azure.rb +23 -0
- data/lib/sfn/monkey_patch/stack/google.rb +129 -0
- data/lib/sfn/planner/aws.rb +111 -72
- data/lib/sfn/utils/json.rb +3 -0
- data/lib/sfn/utils/stack_parameter_scrubber.rb +20 -23
- data/lib/sfn/utils/stack_parameter_validator.rb +162 -157
- data/lib/sfn/version.rb +1 -1
- data/sfn.gemspec +3 -2
- metadata +34 -8
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA1:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 189a8f6f45b7c8e21e0736702c1b3491a575a19a
|
|
4
|
+
data.tar.gz: 2b45e84280906712c07a932087be8ef583b01afc
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: aee4b5d4a44cb4bdcd821522b1b302f9d480ad761a5e2de375a4699d758d9dabce84a488ab514cc65f0c9b83c1d0fd83f7418fcb0e9fccc553547e5f88070f21
|
|
7
|
+
data.tar.gz: e81546c3197913706bc5b15551fd63fd6a2ba058262fe04df59e27f6e52ec2e9674a599ca5960aab23f4184e0414ab1bbe7d9af64ddcc998b935674e0fa2ac20
|
data/CHANGELOG.md
CHANGED
|
@@ -1,3 +1,23 @@
|
|
|
1
|
+
# v3.0.0
|
|
2
|
+
_Major release includes breaking changes!_
|
|
3
|
+
* [feature] Add support for Google Cloud Deployment Manager (#181)
|
|
4
|
+
* [feature] Add `--sparkle-dump` option for template printing (#181)
|
|
5
|
+
* [enhancement] Minimum constraint on sparkle_formation set to 3.0
|
|
6
|
+
* [enhancement] Enable automatic provider restrictions using credentials provider
|
|
7
|
+
* [enhancement] Restrict Bundler automatic gem loading to `:sfn` group only (#171)
|
|
8
|
+
* [enhancement] Support uploading root template to storage bucket (#179)
|
|
9
|
+
* [enhancement] Provider specific extension support (#181)
|
|
10
|
+
* [enhancement] Support custom apply stack mappings (#185)
|
|
11
|
+
* [enhancement] Update planner to use new SparkleFormation::Resources::Resource instances (#186)
|
|
12
|
+
* Includes conditional logic support for property modification effects
|
|
13
|
+
* [fix] Mark AWS::EC2::Instance resources in planner on AWS::CloudFormation::Init modifications (#186)
|
|
14
|
+
* [fix] Set compile time stack parameters under logical name not stack name on update (#180)
|
|
15
|
+
* [task] Removal of `--translate` option for templates
|
|
16
|
+
* [task] Remove internal stack nesting implementation support
|
|
17
|
+
|
|
18
|
+
_NOTE: Breaking changes introduced via sparkle_formation 3.0 minimum constraint. Review
|
|
19
|
+
release sparkle_formation 3.0 release notes._
|
|
20
|
+
|
|
1
21
|
# v2.2.0
|
|
2
22
|
* [enhancement] Properly support list types when validating (#167)
|
|
3
23
|
* [enhancement] Restrict automatic gem loading when `:sfn` group is present (#175)
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
#!/usr/bin/env ruby
|
|
2
|
+
|
|
3
|
+
require 'sfn'
|
|
4
|
+
|
|
5
|
+
print 'Generating command and configuration page...'
|
|
6
|
+
|
|
7
|
+
klasses = Sfn::Config.constants.sort.map do |const|
|
|
8
|
+
klass = Sfn::Config.const_get(const)
|
|
9
|
+
klass if klass.is_a?(Class) && klass.respond_to?(:attributes)
|
|
10
|
+
end.compact
|
|
11
|
+
|
|
12
|
+
file = File.open(File.join(File.dirname(__FILE__), '..', 'docs', 'command-config.md'), 'w')
|
|
13
|
+
|
|
14
|
+
file.puts <<-EOS
|
|
15
|
+
---
|
|
16
|
+
title: "Commands and configuration"
|
|
17
|
+
weight: 3
|
|
18
|
+
anchors:
|
|
19
|
+
EOS
|
|
20
|
+
|
|
21
|
+
klasses.each do |klass|
|
|
22
|
+
file.puts " - title: \"#{klass.name.split('::').last} Command\""
|
|
23
|
+
file.puts " url: \"##{klass.name.split('::').last.downcase}-command\""
|
|
24
|
+
end
|
|
25
|
+
file.puts '---'
|
|
26
|
+
|
|
27
|
+
klasses.each do |klass|
|
|
28
|
+
file.puts "## #{klass.name.split('::').last} Command"
|
|
29
|
+
file.puts
|
|
30
|
+
file.puts '~~~'
|
|
31
|
+
file.puts "$ sfn #{klass.name.split('::').last.downcase}"
|
|
32
|
+
file.puts '~~~'
|
|
33
|
+
file.puts "\n"
|
|
34
|
+
file.puts "| Option | Attribute | Value"
|
|
35
|
+
file.puts "|--------|-----------|------"
|
|
36
|
+
klass.attributes.sort_by(&:first).map do |name, value|
|
|
37
|
+
file.puts "| `--#{name.to_s.tr('_', '-')}` | Description | #{value[:description]} |"
|
|
38
|
+
file.puts "| | Valid | `#{[value[:type]].flatten.compact.join('`, `')}` |"
|
|
39
|
+
file.puts "| | Default | #{value[:default].inspect unless value[:default].nil?}|\n"
|
|
40
|
+
end
|
|
41
|
+
file.puts
|
|
42
|
+
end
|
|
43
|
+
|
|
44
|
+
puts 'done'
|
data/bin/sfn
CHANGED
data/docs/README.md
CHANGED
|
@@ -7,7 +7,8 @@
|
|
|
7
7
|
- [sfn based](configuration.md#sfn-based)
|
|
8
8
|
- [knife based](configuration.md#knife-based)
|
|
9
9
|
- [Usage](usage.md)
|
|
10
|
-
- [Commands](usage.md#commands)
|
|
10
|
+
- [General Commands](usage.md#commands)
|
|
11
|
+
- [Commands List](command-config.md)
|
|
11
12
|
- [Callbacks](callbacks.md)
|
|
12
13
|
- [Enabling Callbacks](callbacks.md#enabling-callbacks)
|
|
13
14
|
- [Builtin Callbacks](callbacks.md#builtin-callbacks)
|
data/docs/callbacks.md
CHANGED
|
@@ -76,6 +76,24 @@ Configuration.new do
|
|
|
76
76
|
end
|
|
77
77
|
~~~
|
|
78
78
|
|
|
79
|
+
#### Important note
|
|
80
|
+
|
|
81
|
+
Some callbacks will require being enabled immediately upon startup
|
|
82
|
+
instead of during configuration. This can be done by using a special
|
|
83
|
+
`:sfn` group within your bundle. For example, to load the `sfn-serverspec`
|
|
84
|
+
callback immediately the Gemfile should look like:
|
|
85
|
+
|
|
86
|
+
```ruby
|
|
87
|
+
# Gemfile
|
|
88
|
+
source 'https://rubygems.org'
|
|
89
|
+
|
|
90
|
+
gem 'sfn'
|
|
91
|
+
|
|
92
|
+
group :sfn do
|
|
93
|
+
gem 'sfn-serverspec'
|
|
94
|
+
end
|
|
95
|
+
```
|
|
96
|
+
|
|
79
97
|
### Builtin Callbacks
|
|
80
98
|
|
|
81
99
|
Builtin callbacks distributed with `sfn`:
|
|
@@ -0,0 +1,1276 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "Commands and configuration"
|
|
3
|
+
weight: 3
|
|
4
|
+
anchors:
|
|
5
|
+
- title: "Conf Command"
|
|
6
|
+
url: "#conf-command"
|
|
7
|
+
- title: "Create Command"
|
|
8
|
+
url: "#create-command"
|
|
9
|
+
- title: "Describe Command"
|
|
10
|
+
url: "#describe-command"
|
|
11
|
+
- title: "Destroy Command"
|
|
12
|
+
url: "#destroy-command"
|
|
13
|
+
- title: "Diff Command"
|
|
14
|
+
url: "#diff-command"
|
|
15
|
+
- title: "Events Command"
|
|
16
|
+
url: "#events-command"
|
|
17
|
+
- title: "Export Command"
|
|
18
|
+
url: "#export-command"
|
|
19
|
+
- title: "Graph Command"
|
|
20
|
+
url: "#graph-command"
|
|
21
|
+
- title: "Import Command"
|
|
22
|
+
url: "#import-command"
|
|
23
|
+
- title: "Init Command"
|
|
24
|
+
url: "#init-command"
|
|
25
|
+
- title: "Inspect Command"
|
|
26
|
+
url: "#inspect-command"
|
|
27
|
+
- title: "List Command"
|
|
28
|
+
url: "#list-command"
|
|
29
|
+
- title: "Print Command"
|
|
30
|
+
url: "#print-command"
|
|
31
|
+
- title: "Promote Command"
|
|
32
|
+
url: "#promote-command"
|
|
33
|
+
- title: "Update Command"
|
|
34
|
+
url: "#update-command"
|
|
35
|
+
- title: "Validate Command"
|
|
36
|
+
url: "#validate-command"
|
|
37
|
+
---
|
|
38
|
+
## Conf Command
|
|
39
|
+
|
|
40
|
+
~~~
|
|
41
|
+
$ sfn conf
|
|
42
|
+
~~~
|
|
43
|
+
|
|
44
|
+
| Option | Attribute | Value
|
|
45
|
+
|--------|-----------|------
|
|
46
|
+
| `--apply-mapping` | Description | Customize apply stack mapping as [StackName__]OutputName:ParameterName (Key:Value[,Key:Value,...]) |
|
|
47
|
+
| | Valid | `Bogo::Smash` |
|
|
48
|
+
| | Default | |
|
|
49
|
+
| `--apply-nesting` | Description | Apply stack nesting |
|
|
50
|
+
| | Valid | `String`, `Symbol` |
|
|
51
|
+
| | Default | "deep"|
|
|
52
|
+
| `--apply-stack` | Description | Apply outputs from stack to input parameters |
|
|
53
|
+
| | Valid | `String` |
|
|
54
|
+
| | Default | |
|
|
55
|
+
| `--base-directory` | Description | Path to root of of templates directory |
|
|
56
|
+
| | Valid | `String` |
|
|
57
|
+
| | Default | |
|
|
58
|
+
| `--compile-parameters` | Description | Pass template compile time parameters directly |
|
|
59
|
+
| | Valid | `Bogo::Smash` |
|
|
60
|
+
| | Default | |
|
|
61
|
+
| `--config` | Description | Configuration file path |
|
|
62
|
+
| | Valid | `String` |
|
|
63
|
+
| | Default | |
|
|
64
|
+
| `--credentials` | Description | Provider credentials (Key:Value[,Key:Value,...]) |
|
|
65
|
+
| | Valid | `Bogo::Smash` |
|
|
66
|
+
| | Default | |
|
|
67
|
+
| `--debug` | Description | Enable debug output |
|
|
68
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
69
|
+
| | Default | |
|
|
70
|
+
| `--defaults` | Description | Automatically accept default values |
|
|
71
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
72
|
+
| | Default | |
|
|
73
|
+
| `--diffs` | Description | Show planner content diff |
|
|
74
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
75
|
+
| | Default | |
|
|
76
|
+
| `--file` | Description | Path to template file |
|
|
77
|
+
| | Valid | `String` |
|
|
78
|
+
| | Default | |
|
|
79
|
+
| `--file-path-prompt` | Description | Enable interactive prompt for template path discovery |
|
|
80
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
81
|
+
| | Default | true|
|
|
82
|
+
| `--generate` | Description | Generate a basic configuration file |
|
|
83
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
84
|
+
| | Default | |
|
|
85
|
+
| `--ignore-parameters` | Description | Parameters to ignore during modifications |
|
|
86
|
+
| | Valid | `String` |
|
|
87
|
+
| | Default | |
|
|
88
|
+
| `--interactive-parameters` | Description | Prompt for template parameters |
|
|
89
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
90
|
+
| | Default | true|
|
|
91
|
+
| `--merge-api-options` | Description | Merge API options defined within configuration on update |
|
|
92
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
93
|
+
| | Default | false|
|
|
94
|
+
| `--nesting-bucket` | Description | Bucket to use for storing nested stack templates |
|
|
95
|
+
| | Valid | `String` |
|
|
96
|
+
| | Default | |
|
|
97
|
+
| `--nesting-prefix` | Description | File name prefix for storing template in bucket |
|
|
98
|
+
| | Valid | `String` |
|
|
99
|
+
| | Default | |
|
|
100
|
+
| `--no-base-directory` | Description | Unset any value used for the template root directory path |
|
|
101
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
102
|
+
| | Default | |
|
|
103
|
+
| `--notification-topics` | Description | Notification endpoints for stack events |
|
|
104
|
+
| | Valid | `String` |
|
|
105
|
+
| | Default | |
|
|
106
|
+
| `--options` | Description | Extra options to apply to the API call (Key:Value[,Key:Value,...]) |
|
|
107
|
+
| | Valid | `Bogo::Smash` |
|
|
108
|
+
| | Default | |
|
|
109
|
+
| `--parameter` | Description | [DEPRECATED - use `parameters`] Pass template parameters directly (ParamName:ParamValue) |
|
|
110
|
+
| | Valid | `Bogo::Smash` |
|
|
111
|
+
| | Default | |
|
|
112
|
+
| `--parameters` | Description | Pass template parameters directly (Key:Value[,Key:Value,...]) |
|
|
113
|
+
| | Valid | `Bogo::Smash` |
|
|
114
|
+
| | Default | |
|
|
115
|
+
| `--plan` | Description | Provide planning information prior to update |
|
|
116
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
117
|
+
| | Default | true|
|
|
118
|
+
| `--plan-only` | Description | Exit after plan display |
|
|
119
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
120
|
+
| | Default | false|
|
|
121
|
+
| `--poll` | Description | Poll stack events on modification actions |
|
|
122
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
123
|
+
| | Default | true|
|
|
124
|
+
| `--print-only` | Description | Print the resulting stack template |
|
|
125
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
126
|
+
| | Default | |
|
|
127
|
+
| `--processing` | Description | Call the unicorns and explode the glitter bombs |
|
|
128
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
129
|
+
| | Default | true|
|
|
130
|
+
| `--rollback` | Description | Rollback stack on failure |
|
|
131
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
132
|
+
| | Default | |
|
|
133
|
+
| `--sparkle-pack` | Description | Load SparklePack gem |
|
|
134
|
+
| | Valid | `String` |
|
|
135
|
+
| | Default | |
|
|
136
|
+
| `--timeout` | Description | Seconds to wait for stack to complete |
|
|
137
|
+
| | Valid | `Integer` |
|
|
138
|
+
| | Default | |
|
|
139
|
+
| `--translate` | Description | Translate generated template to given provider |
|
|
140
|
+
| | Valid | `String` |
|
|
141
|
+
| | Default | |
|
|
142
|
+
| `--translate-chunk` | Description | Chunk length for serialization |
|
|
143
|
+
| | Valid | `Integer` |
|
|
144
|
+
| | Default | |
|
|
145
|
+
| `--upload-root-template` | Description | Upload root template to storage bucket |
|
|
146
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
147
|
+
| | Default | |
|
|
148
|
+
| `--yes` | Description | Automatically accept any requests for confirmation |
|
|
149
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
150
|
+
| | Default | |
|
|
151
|
+
|
|
152
|
+
## Create Command
|
|
153
|
+
|
|
154
|
+
~~~
|
|
155
|
+
$ sfn create
|
|
156
|
+
~~~
|
|
157
|
+
|
|
158
|
+
| Option | Attribute | Value
|
|
159
|
+
|--------|-----------|------
|
|
160
|
+
| `--apply-mapping` | Description | Customize apply stack mapping as [StackName__]OutputName:ParameterName (Key:Value[,Key:Value,...]) |
|
|
161
|
+
| | Valid | `Bogo::Smash` |
|
|
162
|
+
| | Default | |
|
|
163
|
+
| `--apply-nesting` | Description | Apply stack nesting |
|
|
164
|
+
| | Valid | `String`, `Symbol` |
|
|
165
|
+
| | Default | "deep"|
|
|
166
|
+
| `--apply-stack` | Description | Apply outputs from stack to input parameters |
|
|
167
|
+
| | Valid | `String` |
|
|
168
|
+
| | Default | |
|
|
169
|
+
| `--base-directory` | Description | Path to root of of templates directory |
|
|
170
|
+
| | Valid | `String` |
|
|
171
|
+
| | Default | |
|
|
172
|
+
| `--compile-parameters` | Description | Pass template compile time parameters directly |
|
|
173
|
+
| | Valid | `Bogo::Smash` |
|
|
174
|
+
| | Default | |
|
|
175
|
+
| `--config` | Description | Configuration file path |
|
|
176
|
+
| | Valid | `String` |
|
|
177
|
+
| | Default | |
|
|
178
|
+
| `--credentials` | Description | Provider credentials (Key:Value[,Key:Value,...]) |
|
|
179
|
+
| | Valid | `Bogo::Smash` |
|
|
180
|
+
| | Default | |
|
|
181
|
+
| `--debug` | Description | Enable debug output |
|
|
182
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
183
|
+
| | Default | |
|
|
184
|
+
| `--defaults` | Description | Automatically accept default values |
|
|
185
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
186
|
+
| | Default | |
|
|
187
|
+
| `--diffs` | Description | Show planner content diff |
|
|
188
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
189
|
+
| | Default | |
|
|
190
|
+
| `--file` | Description | Path to template file |
|
|
191
|
+
| | Valid | `String` |
|
|
192
|
+
| | Default | |
|
|
193
|
+
| `--file-path-prompt` | Description | Enable interactive prompt for template path discovery |
|
|
194
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
195
|
+
| | Default | true|
|
|
196
|
+
| `--ignore-parameters` | Description | Parameters to ignore during modifications |
|
|
197
|
+
| | Valid | `String` |
|
|
198
|
+
| | Default | |
|
|
199
|
+
| `--interactive-parameters` | Description | Prompt for template parameters |
|
|
200
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
201
|
+
| | Default | true|
|
|
202
|
+
| `--merge-api-options` | Description | Merge API options defined within configuration on update |
|
|
203
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
204
|
+
| | Default | false|
|
|
205
|
+
| `--nesting-bucket` | Description | Bucket to use for storing nested stack templates |
|
|
206
|
+
| | Valid | `String` |
|
|
207
|
+
| | Default | |
|
|
208
|
+
| `--nesting-prefix` | Description | File name prefix for storing template in bucket |
|
|
209
|
+
| | Valid | `String` |
|
|
210
|
+
| | Default | |
|
|
211
|
+
| `--no-base-directory` | Description | Unset any value used for the template root directory path |
|
|
212
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
213
|
+
| | Default | |
|
|
214
|
+
| `--notification-topics` | Description | Notification endpoints for stack events |
|
|
215
|
+
| | Valid | `String` |
|
|
216
|
+
| | Default | |
|
|
217
|
+
| `--options` | Description | Extra options to apply to the API call (Key:Value[,Key:Value,...]) |
|
|
218
|
+
| | Valid | `Bogo::Smash` |
|
|
219
|
+
| | Default | |
|
|
220
|
+
| `--parameter` | Description | [DEPRECATED - use `parameters`] Pass template parameters directly (ParamName:ParamValue) |
|
|
221
|
+
| | Valid | `Bogo::Smash` |
|
|
222
|
+
| | Default | |
|
|
223
|
+
| `--parameters` | Description | Pass template parameters directly (Key:Value[,Key:Value,...]) |
|
|
224
|
+
| | Valid | `Bogo::Smash` |
|
|
225
|
+
| | Default | |
|
|
226
|
+
| `--plan` | Description | Provide planning information prior to update |
|
|
227
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
228
|
+
| | Default | true|
|
|
229
|
+
| `--plan-only` | Description | Exit after plan display |
|
|
230
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
231
|
+
| | Default | false|
|
|
232
|
+
| `--poll` | Description | Poll stack events on modification actions |
|
|
233
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
234
|
+
| | Default | true|
|
|
235
|
+
| `--print-only` | Description | Print the resulting stack template |
|
|
236
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
237
|
+
| | Default | |
|
|
238
|
+
| `--processing` | Description | Call the unicorns and explode the glitter bombs |
|
|
239
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
240
|
+
| | Default | true|
|
|
241
|
+
| `--rollback` | Description | Rollback stack on failure |
|
|
242
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
243
|
+
| | Default | |
|
|
244
|
+
| `--sparkle-pack` | Description | Load SparklePack gem |
|
|
245
|
+
| | Valid | `String` |
|
|
246
|
+
| | Default | |
|
|
247
|
+
| `--timeout` | Description | Seconds to wait for stack to complete |
|
|
248
|
+
| | Valid | `Integer` |
|
|
249
|
+
| | Default | |
|
|
250
|
+
| `--translate` | Description | Translate generated template to given provider |
|
|
251
|
+
| | Valid | `String` |
|
|
252
|
+
| | Default | |
|
|
253
|
+
| `--translate-chunk` | Description | Chunk length for serialization |
|
|
254
|
+
| | Valid | `Integer` |
|
|
255
|
+
| | Default | |
|
|
256
|
+
| `--upload-root-template` | Description | Upload root template to storage bucket |
|
|
257
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
258
|
+
| | Default | |
|
|
259
|
+
| `--yes` | Description | Automatically accept any requests for confirmation |
|
|
260
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
261
|
+
| | Default | |
|
|
262
|
+
|
|
263
|
+
## Describe Command
|
|
264
|
+
|
|
265
|
+
~~~
|
|
266
|
+
$ sfn describe
|
|
267
|
+
~~~
|
|
268
|
+
|
|
269
|
+
| Option | Attribute | Value
|
|
270
|
+
|--------|-----------|------
|
|
271
|
+
| `--conf` | Description | |
|
|
272
|
+
| | Valid | `Sfn::Config::Conf` |
|
|
273
|
+
| | Default | |
|
|
274
|
+
| `--config` | Description | Configuration file path |
|
|
275
|
+
| | Valid | `String` |
|
|
276
|
+
| | Default | |
|
|
277
|
+
| `--create` | Description | |
|
|
278
|
+
| | Valid | `Sfn::Config::Create` |
|
|
279
|
+
| | Default | |
|
|
280
|
+
| `--credentials` | Description | Provider credentials (Key:Value[,Key:Value,...]) |
|
|
281
|
+
| | Valid | `Bogo::Smash` |
|
|
282
|
+
| | Default | |
|
|
283
|
+
| `--debug` | Description | Enable debug output |
|
|
284
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
285
|
+
| | Default | |
|
|
286
|
+
| `--defaults` | Description | Automatically accept default values |
|
|
287
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
288
|
+
| | Default | |
|
|
289
|
+
| `--destroy` | Description | |
|
|
290
|
+
| | Valid | `Sfn::Config::Destroy` |
|
|
291
|
+
| | Default | |
|
|
292
|
+
| `--events` | Description | |
|
|
293
|
+
| | Valid | `Sfn::Config::Events` |
|
|
294
|
+
| | Default | |
|
|
295
|
+
| `--export` | Description | |
|
|
296
|
+
| | Valid | `Sfn::Config::Export` |
|
|
297
|
+
| | Default | |
|
|
298
|
+
| `--ignore-parameters` | Description | Parameters to ignore during modifications |
|
|
299
|
+
| | Valid | `String` |
|
|
300
|
+
| | Default | |
|
|
301
|
+
| `--import` | Description | |
|
|
302
|
+
| | Valid | `Sfn::Config::Import` |
|
|
303
|
+
| | Default | |
|
|
304
|
+
| `--inspect` | Description | |
|
|
305
|
+
| | Valid | `Sfn::Config::Inspect` |
|
|
306
|
+
| | Default | |
|
|
307
|
+
| `--interactive-parameters` | Description | Prompt for template parameters |
|
|
308
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
309
|
+
| | Default | true|
|
|
310
|
+
| `--outputs` | Description | Display stack outputs |
|
|
311
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
312
|
+
| | Default | |
|
|
313
|
+
| `--poll` | Description | Poll stack events on modification actions |
|
|
314
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
315
|
+
| | Default | true|
|
|
316
|
+
| `--resources` | Description | Display stack resource list |
|
|
317
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
318
|
+
| | Default | |
|
|
319
|
+
| `--tags` | Description | Display stack tags |
|
|
320
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
321
|
+
| | Default | |
|
|
322
|
+
| `--update` | Description | |
|
|
323
|
+
| | Valid | `Sfn::Config::Update` |
|
|
324
|
+
| | Default | |
|
|
325
|
+
| `--yes` | Description | Automatically accept any requests for confirmation |
|
|
326
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
327
|
+
| | Default | |
|
|
328
|
+
|
|
329
|
+
## Destroy Command
|
|
330
|
+
|
|
331
|
+
~~~
|
|
332
|
+
$ sfn destroy
|
|
333
|
+
~~~
|
|
334
|
+
|
|
335
|
+
| Option | Attribute | Value
|
|
336
|
+
|--------|-----------|------
|
|
337
|
+
| `--conf` | Description | |
|
|
338
|
+
| | Valid | `Sfn::Config::Conf` |
|
|
339
|
+
| | Default | |
|
|
340
|
+
| `--config` | Description | Configuration file path |
|
|
341
|
+
| | Valid | `String` |
|
|
342
|
+
| | Default | |
|
|
343
|
+
| `--create` | Description | |
|
|
344
|
+
| | Valid | `Sfn::Config::Create` |
|
|
345
|
+
| | Default | |
|
|
346
|
+
| `--credentials` | Description | Provider credentials (Key:Value[,Key:Value,...]) |
|
|
347
|
+
| | Valid | `Bogo::Smash` |
|
|
348
|
+
| | Default | |
|
|
349
|
+
| `--debug` | Description | Enable debug output |
|
|
350
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
351
|
+
| | Default | |
|
|
352
|
+
| `--defaults` | Description | Automatically accept default values |
|
|
353
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
354
|
+
| | Default | |
|
|
355
|
+
| `--ignore-parameters` | Description | Parameters to ignore during modifications |
|
|
356
|
+
| | Valid | `String` |
|
|
357
|
+
| | Default | |
|
|
358
|
+
| `--interactive-parameters` | Description | Prompt for template parameters |
|
|
359
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
360
|
+
| | Default | true|
|
|
361
|
+
| `--poll` | Description | Poll stack events on modification actions |
|
|
362
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
363
|
+
| | Default | true|
|
|
364
|
+
| `--update` | Description | |
|
|
365
|
+
| | Valid | `Sfn::Config::Update` |
|
|
366
|
+
| | Default | |
|
|
367
|
+
| `--yes` | Description | Automatically accept any requests for confirmation |
|
|
368
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
369
|
+
| | Default | |
|
|
370
|
+
|
|
371
|
+
## Diff Command
|
|
372
|
+
|
|
373
|
+
~~~
|
|
374
|
+
$ sfn diff
|
|
375
|
+
~~~
|
|
376
|
+
|
|
377
|
+
| Option | Attribute | Value
|
|
378
|
+
|--------|-----------|------
|
|
379
|
+
| `--apply-mapping` | Description | Customize apply stack mapping as [StackName__]OutputName:ParameterName (Key:Value[,Key:Value,...]) |
|
|
380
|
+
| | Valid | `Bogo::Smash` |
|
|
381
|
+
| | Default | |
|
|
382
|
+
| `--apply-nesting` | Description | Apply stack nesting |
|
|
383
|
+
| | Valid | `String`, `Symbol` |
|
|
384
|
+
| | Default | "deep"|
|
|
385
|
+
| `--apply-stack` | Description | Apply outputs from stack to input parameters |
|
|
386
|
+
| | Valid | `String` |
|
|
387
|
+
| | Default | |
|
|
388
|
+
| `--base-directory` | Description | Path to root of of templates directory |
|
|
389
|
+
| | Valid | `String` |
|
|
390
|
+
| | Default | |
|
|
391
|
+
| `--compile-parameters` | Description | Pass template compile time parameters directly |
|
|
392
|
+
| | Valid | `Bogo::Smash` |
|
|
393
|
+
| | Default | |
|
|
394
|
+
| `--config` | Description | Configuration file path |
|
|
395
|
+
| | Valid | `String` |
|
|
396
|
+
| | Default | |
|
|
397
|
+
| `--credentials` | Description | Provider credentials (Key:Value[,Key:Value,...]) |
|
|
398
|
+
| | Valid | `Bogo::Smash` |
|
|
399
|
+
| | Default | |
|
|
400
|
+
| `--debug` | Description | Enable debug output |
|
|
401
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
402
|
+
| | Default | |
|
|
403
|
+
| `--defaults` | Description | Automatically accept default values |
|
|
404
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
405
|
+
| | Default | |
|
|
406
|
+
| `--diffs` | Description | Show planner content diff |
|
|
407
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
408
|
+
| | Default | |
|
|
409
|
+
| `--file` | Description | Path to template file |
|
|
410
|
+
| | Valid | `String` |
|
|
411
|
+
| | Default | |
|
|
412
|
+
| `--file-path-prompt` | Description | Enable interactive prompt for template path discovery |
|
|
413
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
414
|
+
| | Default | true|
|
|
415
|
+
| `--ignore-parameters` | Description | Parameters to ignore during modifications |
|
|
416
|
+
| | Valid | `String` |
|
|
417
|
+
| | Default | |
|
|
418
|
+
| `--interactive-parameters` | Description | Prompt for template parameters |
|
|
419
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
420
|
+
| | Default | true|
|
|
421
|
+
| `--merge-api-options` | Description | Merge API options defined within configuration on update |
|
|
422
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
423
|
+
| | Default | false|
|
|
424
|
+
| `--nesting-bucket` | Description | Bucket to use for storing nested stack templates |
|
|
425
|
+
| | Valid | `String` |
|
|
426
|
+
| | Default | |
|
|
427
|
+
| `--nesting-prefix` | Description | File name prefix for storing template in bucket |
|
|
428
|
+
| | Valid | `String` |
|
|
429
|
+
| | Default | |
|
|
430
|
+
| `--no-base-directory` | Description | Unset any value used for the template root directory path |
|
|
431
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
432
|
+
| | Default | |
|
|
433
|
+
| `--parameter` | Description | [DEPRECATED - use `parameters`] Pass template parameters directly (ParamName:ParamValue) |
|
|
434
|
+
| | Valid | `Bogo::Smash` |
|
|
435
|
+
| | Default | |
|
|
436
|
+
| `--parameters` | Description | Pass template parameters directly (Key:Value[,Key:Value,...]) |
|
|
437
|
+
| | Valid | `Bogo::Smash` |
|
|
438
|
+
| | Default | |
|
|
439
|
+
| `--plan` | Description | Provide planning information prior to update |
|
|
440
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
441
|
+
| | Default | true|
|
|
442
|
+
| `--plan-only` | Description | Exit after plan display |
|
|
443
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
444
|
+
| | Default | false|
|
|
445
|
+
| `--poll` | Description | Poll stack events on modification actions |
|
|
446
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
447
|
+
| | Default | true|
|
|
448
|
+
| `--print-only` | Description | Print the resulting stack template |
|
|
449
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
450
|
+
| | Default | |
|
|
451
|
+
| `--processing` | Description | Call the unicorns and explode the glitter bombs |
|
|
452
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
453
|
+
| | Default | true|
|
|
454
|
+
| `--raw-diff` | Description | Display raw diff information |
|
|
455
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
456
|
+
| | Default | false|
|
|
457
|
+
| `--sparkle-pack` | Description | Load SparklePack gem |
|
|
458
|
+
| | Valid | `String` |
|
|
459
|
+
| | Default | |
|
|
460
|
+
| `--translate` | Description | Translate generated template to given provider |
|
|
461
|
+
| | Valid | `String` |
|
|
462
|
+
| | Default | |
|
|
463
|
+
| `--translate-chunk` | Description | Chunk length for serialization |
|
|
464
|
+
| | Valid | `Integer` |
|
|
465
|
+
| | Default | |
|
|
466
|
+
| `--upload-root-template` | Description | Upload root template to storage bucket |
|
|
467
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
468
|
+
| | Default | |
|
|
469
|
+
| `--yes` | Description | Automatically accept any requests for confirmation |
|
|
470
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
471
|
+
| | Default | |
|
|
472
|
+
|
|
473
|
+
## Events Command
|
|
474
|
+
|
|
475
|
+
~~~
|
|
476
|
+
$ sfn events
|
|
477
|
+
~~~
|
|
478
|
+
|
|
479
|
+
| Option | Attribute | Value
|
|
480
|
+
|--------|-----------|------
|
|
481
|
+
| `--all-attributes` | Description | Display all event attributes |
|
|
482
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
483
|
+
| | Default | |
|
|
484
|
+
| `--all-events` | Description | Display all available events |
|
|
485
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
486
|
+
| | Default | |
|
|
487
|
+
| `--attribute` | Description | Event attribute to display |
|
|
488
|
+
| | Valid | `String` |
|
|
489
|
+
| | Default | |
|
|
490
|
+
| `--conf` | Description | |
|
|
491
|
+
| | Valid | `Sfn::Config::Conf` |
|
|
492
|
+
| | Default | |
|
|
493
|
+
| `--config` | Description | Configuration file path |
|
|
494
|
+
| | Valid | `String` |
|
|
495
|
+
| | Default | |
|
|
496
|
+
| `--create` | Description | |
|
|
497
|
+
| | Valid | `Sfn::Config::Create` |
|
|
498
|
+
| | Default | |
|
|
499
|
+
| `--credentials` | Description | Provider credentials (Key:Value[,Key:Value,...]) |
|
|
500
|
+
| | Valid | `Bogo::Smash` |
|
|
501
|
+
| | Default | |
|
|
502
|
+
| `--debug` | Description | Enable debug output |
|
|
503
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
504
|
+
| | Default | |
|
|
505
|
+
| `--defaults` | Description | Automatically accept default values |
|
|
506
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
507
|
+
| | Default | |
|
|
508
|
+
| `--destroy` | Description | |
|
|
509
|
+
| | Valid | `Sfn::Config::Destroy` |
|
|
510
|
+
| | Default | |
|
|
511
|
+
| `--ignore-parameters` | Description | Parameters to ignore during modifications |
|
|
512
|
+
| | Valid | `String` |
|
|
513
|
+
| | Default | |
|
|
514
|
+
| `--interactive-parameters` | Description | Prompt for template parameters |
|
|
515
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
516
|
+
| | Default | true|
|
|
517
|
+
| `--poll` | Description | Poll stack events on modification actions |
|
|
518
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
519
|
+
| | Default | true|
|
|
520
|
+
| `--poll-delay` | Description | Seconds to pause between each event poll |
|
|
521
|
+
| | Valid | `Integer` |
|
|
522
|
+
| | Default | 20|
|
|
523
|
+
| `--update` | Description | |
|
|
524
|
+
| | Valid | `Sfn::Config::Update` |
|
|
525
|
+
| | Default | |
|
|
526
|
+
| `--yes` | Description | Automatically accept any requests for confirmation |
|
|
527
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
528
|
+
| | Default | |
|
|
529
|
+
|
|
530
|
+
## Export Command
|
|
531
|
+
|
|
532
|
+
~~~
|
|
533
|
+
$ sfn export
|
|
534
|
+
~~~
|
|
535
|
+
|
|
536
|
+
| Option | Attribute | Value
|
|
537
|
+
|--------|-----------|------
|
|
538
|
+
| `--bucket` | Description | Remote storage bucket |
|
|
539
|
+
| | Valid | `String` |
|
|
540
|
+
| | Default | |
|
|
541
|
+
| `--bucket-prefix` | Description | Remote key prefix within bucket for dump file |
|
|
542
|
+
| | Valid | `String` |
|
|
543
|
+
| | Default | |
|
|
544
|
+
| `--conf` | Description | |
|
|
545
|
+
| | Valid | `Sfn::Config::Conf` |
|
|
546
|
+
| | Default | |
|
|
547
|
+
| `--config` | Description | Configuration file path |
|
|
548
|
+
| | Valid | `String` |
|
|
549
|
+
| | Default | |
|
|
550
|
+
| `--create` | Description | |
|
|
551
|
+
| | Valid | `Sfn::Config::Create` |
|
|
552
|
+
| | Default | |
|
|
553
|
+
| `--credentials` | Description | Provider credentials (Key:Value[,Key:Value,...]) |
|
|
554
|
+
| | Valid | `Bogo::Smash` |
|
|
555
|
+
| | Default | |
|
|
556
|
+
| `--debug` | Description | Enable debug output |
|
|
557
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
558
|
+
| | Default | |
|
|
559
|
+
| `--defaults` | Description | Automatically accept default values |
|
|
560
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
561
|
+
| | Default | |
|
|
562
|
+
| `--destroy` | Description | |
|
|
563
|
+
| | Valid | `Sfn::Config::Destroy` |
|
|
564
|
+
| | Default | |
|
|
565
|
+
| `--events` | Description | |
|
|
566
|
+
| | Valid | `Sfn::Config::Events` |
|
|
567
|
+
| | Default | |
|
|
568
|
+
| `--ignore-parameters` | Description | Parameters to ignore during modifications |
|
|
569
|
+
| | Valid | `String` |
|
|
570
|
+
| | Default | |
|
|
571
|
+
| `--interactive-parameters` | Description | Prompt for template parameters |
|
|
572
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
573
|
+
| | Default | true|
|
|
574
|
+
| `--name` | Description | Export file base name |
|
|
575
|
+
| | Valid | `String` |
|
|
576
|
+
| | Default | |
|
|
577
|
+
| `--path` | Description | Local path prefix for dump file |
|
|
578
|
+
| | Valid | `String` |
|
|
579
|
+
| | Default | |
|
|
580
|
+
| `--poll` | Description | Poll stack events on modification actions |
|
|
581
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
582
|
+
| | Default | true|
|
|
583
|
+
| `--update` | Description | |
|
|
584
|
+
| | Valid | `Sfn::Config::Update` |
|
|
585
|
+
| | Default | |
|
|
586
|
+
| `--yes` | Description | Automatically accept any requests for confirmation |
|
|
587
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
588
|
+
| | Default | |
|
|
589
|
+
|
|
590
|
+
## Graph Command
|
|
591
|
+
|
|
592
|
+
~~~
|
|
593
|
+
$ sfn graph
|
|
594
|
+
~~~
|
|
595
|
+
|
|
596
|
+
| Option | Attribute | Value
|
|
597
|
+
|--------|-----------|------
|
|
598
|
+
| `--apply-nesting` | Description | Apply stack nesting |
|
|
599
|
+
| | Valid | `String`, `Symbol` |
|
|
600
|
+
| | Default | "deep"|
|
|
601
|
+
| `--base-directory` | Description | Path to root of of templates directory |
|
|
602
|
+
| | Valid | `String` |
|
|
603
|
+
| | Default | |
|
|
604
|
+
| `--compile-parameters` | Description | Pass template compile time parameters directly |
|
|
605
|
+
| | Valid | `Bogo::Smash` |
|
|
606
|
+
| | Default | |
|
|
607
|
+
| `--config` | Description | Configuration file path |
|
|
608
|
+
| | Valid | `String` |
|
|
609
|
+
| | Default | |
|
|
610
|
+
| `--credentials` | Description | Provider credentials (Key:Value[,Key:Value,...]) |
|
|
611
|
+
| | Valid | `Bogo::Smash` |
|
|
612
|
+
| | Default | |
|
|
613
|
+
| `--debug` | Description | Enable debug output |
|
|
614
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
615
|
+
| | Default | |
|
|
616
|
+
| `--defaults` | Description | Automatically accept default values |
|
|
617
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
618
|
+
| | Default | |
|
|
619
|
+
| `--file` | Description | Path to template file |
|
|
620
|
+
| | Valid | `String` |
|
|
621
|
+
| | Default | |
|
|
622
|
+
| `--file-path-prompt` | Description | Enable interactive prompt for template path discovery |
|
|
623
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
624
|
+
| | Default | true|
|
|
625
|
+
| `--graph-style` | Description | Style of graph (`dependency`, `creation`) |
|
|
626
|
+
| | Valid | `String` |
|
|
627
|
+
| | Default | "creation"|
|
|
628
|
+
| `--ignore-parameters` | Description | Parameters to ignore during modifications |
|
|
629
|
+
| | Valid | `String` |
|
|
630
|
+
| | Default | |
|
|
631
|
+
| `--interactive-parameters` | Description | Prompt for template parameters |
|
|
632
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
633
|
+
| | Default | true|
|
|
634
|
+
| `--luckymike` | Description | Force `dependency` style graph |
|
|
635
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
636
|
+
| | Default | false|
|
|
637
|
+
| `--nesting-bucket` | Description | Bucket to use for storing nested stack templates |
|
|
638
|
+
| | Valid | `String` |
|
|
639
|
+
| | Default | |
|
|
640
|
+
| `--nesting-prefix` | Description | File name prefix for storing template in bucket |
|
|
641
|
+
| | Valid | `String` |
|
|
642
|
+
| | Default | |
|
|
643
|
+
| `--no-base-directory` | Description | Unset any value used for the template root directory path |
|
|
644
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
645
|
+
| | Default | |
|
|
646
|
+
| `--output-file` | Description | Directory to write graph files |
|
|
647
|
+
| | Valid | `String` |
|
|
648
|
+
| | Default | "/home/spox/Projects/sparkleformation/sfn/sfn-graph"|
|
|
649
|
+
| `--output-type` | Description | File output type (Requires graphviz package for non-dot types) |
|
|
650
|
+
| | Valid | `String` |
|
|
651
|
+
| | Default | "dot"|
|
|
652
|
+
| `--poll` | Description | Poll stack events on modification actions |
|
|
653
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
654
|
+
| | Default | true|
|
|
655
|
+
| `--print-only` | Description | Print the resulting stack template |
|
|
656
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
657
|
+
| | Default | |
|
|
658
|
+
| `--processing` | Description | Call the unicorns and explode the glitter bombs |
|
|
659
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
660
|
+
| | Default | true|
|
|
661
|
+
| `--sparkle-pack` | Description | Load SparklePack gem |
|
|
662
|
+
| | Valid | `String` |
|
|
663
|
+
| | Default | |
|
|
664
|
+
| `--translate` | Description | Translate generated template to given provider |
|
|
665
|
+
| | Valid | `String` |
|
|
666
|
+
| | Default | |
|
|
667
|
+
| `--translate-chunk` | Description | Chunk length for serialization |
|
|
668
|
+
| | Valid | `Integer` |
|
|
669
|
+
| | Default | |
|
|
670
|
+
| `--upload-root-template` | Description | Upload root template to storage bucket |
|
|
671
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
672
|
+
| | Default | |
|
|
673
|
+
| `--yes` | Description | Automatically accept any requests for confirmation |
|
|
674
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
675
|
+
| | Default | |
|
|
676
|
+
|
|
677
|
+
## Import Command
|
|
678
|
+
|
|
679
|
+
~~~
|
|
680
|
+
$ sfn import
|
|
681
|
+
~~~
|
|
682
|
+
|
|
683
|
+
| Option | Attribute | Value
|
|
684
|
+
|--------|-----------|------
|
|
685
|
+
| `--bucket` | Description | Remote storage bucket JSON export files are located |
|
|
686
|
+
| | Valid | `String` |
|
|
687
|
+
| | Default | |
|
|
688
|
+
| `--bucket-prefix` | Description | Remote key prefix within bucket for dump file |
|
|
689
|
+
| | Valid | `String` |
|
|
690
|
+
| | Default | |
|
|
691
|
+
| `--conf` | Description | |
|
|
692
|
+
| | Valid | `Sfn::Config::Conf` |
|
|
693
|
+
| | Default | |
|
|
694
|
+
| `--config` | Description | Configuration file path |
|
|
695
|
+
| | Valid | `String` |
|
|
696
|
+
| | Default | |
|
|
697
|
+
| `--create` | Description | |
|
|
698
|
+
| | Valid | `Sfn::Config::Create` |
|
|
699
|
+
| | Default | |
|
|
700
|
+
| `--credentials` | Description | Provider credentials (Key:Value[,Key:Value,...]) |
|
|
701
|
+
| | Valid | `Bogo::Smash` |
|
|
702
|
+
| | Default | |
|
|
703
|
+
| `--debug` | Description | Enable debug output |
|
|
704
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
705
|
+
| | Default | |
|
|
706
|
+
| `--defaults` | Description | Automatically accept default values |
|
|
707
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
708
|
+
| | Default | |
|
|
709
|
+
| `--destroy` | Description | |
|
|
710
|
+
| | Valid | `Sfn::Config::Destroy` |
|
|
711
|
+
| | Default | |
|
|
712
|
+
| `--events` | Description | |
|
|
713
|
+
| | Valid | `Sfn::Config::Events` |
|
|
714
|
+
| | Default | |
|
|
715
|
+
| `--export` | Description | |
|
|
716
|
+
| | Valid | `Sfn::Config::Export` |
|
|
717
|
+
| | Default | |
|
|
718
|
+
| `--ignore-parameters` | Description | Parameters to ignore during modifications |
|
|
719
|
+
| | Valid | `String` |
|
|
720
|
+
| | Default | |
|
|
721
|
+
| `--interactive-parameters` | Description | Prompt for template parameters |
|
|
722
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
723
|
+
| | Default | true|
|
|
724
|
+
| `--path` | Description | Directory path JSON export files are located |
|
|
725
|
+
| | Valid | `String` |
|
|
726
|
+
| | Default | |
|
|
727
|
+
| `--poll` | Description | Poll stack events on modification actions |
|
|
728
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
729
|
+
| | Default | true|
|
|
730
|
+
| `--update` | Description | |
|
|
731
|
+
| | Valid | `Sfn::Config::Update` |
|
|
732
|
+
| | Default | |
|
|
733
|
+
| `--yes` | Description | Automatically accept any requests for confirmation |
|
|
734
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
735
|
+
| | Default | |
|
|
736
|
+
|
|
737
|
+
## Init Command
|
|
738
|
+
|
|
739
|
+
~~~
|
|
740
|
+
$ sfn init
|
|
741
|
+
~~~
|
|
742
|
+
|
|
743
|
+
| Option | Attribute | Value
|
|
744
|
+
|--------|-----------|------
|
|
745
|
+
| `--conf` | Description | |
|
|
746
|
+
| | Valid | `Sfn::Config::Conf` |
|
|
747
|
+
| | Default | |
|
|
748
|
+
| `--config` | Description | Configuration file path |
|
|
749
|
+
| | Valid | `String` |
|
|
750
|
+
| | Default | |
|
|
751
|
+
| `--create` | Description | |
|
|
752
|
+
| | Valid | `Sfn::Config::Create` |
|
|
753
|
+
| | Default | |
|
|
754
|
+
| `--credentials` | Description | Provider credentials (Key:Value[,Key:Value,...]) |
|
|
755
|
+
| | Valid | `Bogo::Smash` |
|
|
756
|
+
| | Default | |
|
|
757
|
+
| `--debug` | Description | Enable debug output |
|
|
758
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
759
|
+
| | Default | |
|
|
760
|
+
| `--defaults` | Description | Automatically accept default values |
|
|
761
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
762
|
+
| | Default | |
|
|
763
|
+
| `--describe` | Description | |
|
|
764
|
+
| | Valid | `Sfn::Config::Describe` |
|
|
765
|
+
| | Default | |
|
|
766
|
+
| `--destroy` | Description | |
|
|
767
|
+
| | Valid | `Sfn::Config::Destroy` |
|
|
768
|
+
| | Default | |
|
|
769
|
+
| `--events` | Description | |
|
|
770
|
+
| | Valid | `Sfn::Config::Events` |
|
|
771
|
+
| | Default | |
|
|
772
|
+
| `--export` | Description | |
|
|
773
|
+
| | Valid | `Sfn::Config::Export` |
|
|
774
|
+
| | Default | |
|
|
775
|
+
| `--ignore-parameters` | Description | Parameters to ignore during modifications |
|
|
776
|
+
| | Valid | `String` |
|
|
777
|
+
| | Default | |
|
|
778
|
+
| `--import` | Description | |
|
|
779
|
+
| | Valid | `Sfn::Config::Import` |
|
|
780
|
+
| | Default | |
|
|
781
|
+
| `--inspect` | Description | |
|
|
782
|
+
| | Valid | `Sfn::Config::Inspect` |
|
|
783
|
+
| | Default | |
|
|
784
|
+
| `--interactive-parameters` | Description | Prompt for template parameters |
|
|
785
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
786
|
+
| | Default | true|
|
|
787
|
+
| `--list` | Description | |
|
|
788
|
+
| | Valid | `Sfn::Config::List` |
|
|
789
|
+
| | Default | |
|
|
790
|
+
| `--poll` | Description | Poll stack events on modification actions |
|
|
791
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
792
|
+
| | Default | true|
|
|
793
|
+
| `--promote` | Description | |
|
|
794
|
+
| | Valid | `Sfn::Config::Promote` |
|
|
795
|
+
| | Default | |
|
|
796
|
+
| `--update` | Description | |
|
|
797
|
+
| | Valid | `Sfn::Config::Update` |
|
|
798
|
+
| | Default | |
|
|
799
|
+
| `--validate` | Description | |
|
|
800
|
+
| | Valid | `Sfn::Config::Validate` |
|
|
801
|
+
| | Default | |
|
|
802
|
+
| `--yes` | Description | Automatically accept any requests for confirmation |
|
|
803
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
804
|
+
| | Default | |
|
|
805
|
+
|
|
806
|
+
## Inspect Command
|
|
807
|
+
|
|
808
|
+
~~~
|
|
809
|
+
$ sfn inspect
|
|
810
|
+
~~~
|
|
811
|
+
|
|
812
|
+
| Option | Attribute | Value
|
|
813
|
+
|--------|-----------|------
|
|
814
|
+
| `--attribute` | Description | Dot delimited attribute to view |
|
|
815
|
+
| | Valid | `String` |
|
|
816
|
+
| | Default | |
|
|
817
|
+
| `--conf` | Description | |
|
|
818
|
+
| | Valid | `Sfn::Config::Conf` |
|
|
819
|
+
| | Default | |
|
|
820
|
+
| `--config` | Description | Configuration file path |
|
|
821
|
+
| | Valid | `String` |
|
|
822
|
+
| | Default | |
|
|
823
|
+
| `--create` | Description | |
|
|
824
|
+
| | Valid | `Sfn::Config::Create` |
|
|
825
|
+
| | Default | |
|
|
826
|
+
| `--credentials` | Description | Provider credentials (Key:Value[,Key:Value,...]) |
|
|
827
|
+
| | Valid | `Bogo::Smash` |
|
|
828
|
+
| | Default | |
|
|
829
|
+
| `--debug` | Description | Enable debug output |
|
|
830
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
831
|
+
| | Default | |
|
|
832
|
+
| `--defaults` | Description | Automatically accept default values |
|
|
833
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
834
|
+
| | Default | |
|
|
835
|
+
| `--destroy` | Description | |
|
|
836
|
+
| | Valid | `Sfn::Config::Destroy` |
|
|
837
|
+
| | Default | |
|
|
838
|
+
| `--events` | Description | |
|
|
839
|
+
| | Valid | `Sfn::Config::Events` |
|
|
840
|
+
| | Default | |
|
|
841
|
+
| `--export` | Description | |
|
|
842
|
+
| | Valid | `Sfn::Config::Export` |
|
|
843
|
+
| | Default | |
|
|
844
|
+
| `--failure-log-path` | Description | Path to remote log file for display on failure |
|
|
845
|
+
| | Valid | `String` |
|
|
846
|
+
| | Default | "/var/log/chef/client.log"|
|
|
847
|
+
| `--identity-file` | Description | SSH identity file for authentication |
|
|
848
|
+
| | Valid | `String` |
|
|
849
|
+
| | Default | |
|
|
850
|
+
| `--ignore-parameters` | Description | Parameters to ignore during modifications |
|
|
851
|
+
| | Valid | `String` |
|
|
852
|
+
| | Default | |
|
|
853
|
+
| `--import` | Description | |
|
|
854
|
+
| | Valid | `Sfn::Config::Import` |
|
|
855
|
+
| | Default | |
|
|
856
|
+
| `--instance-failure` | Description | Display log file error from failed not if possible |
|
|
857
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
858
|
+
| | Default | |
|
|
859
|
+
| `--interactive-parameters` | Description | Prompt for template parameters |
|
|
860
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
861
|
+
| | Default | true|
|
|
862
|
+
| `--load-balancers` | Description | Locate all load balancers, display addresses and server states |
|
|
863
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
864
|
+
| | Default | |
|
|
865
|
+
| `--nodes` | Description | Locate all instances and display addresses |
|
|
866
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
867
|
+
| | Default | |
|
|
868
|
+
| `--poll` | Description | Poll stack events on modification actions |
|
|
869
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
870
|
+
| | Default | true|
|
|
871
|
+
| `--ssh-user` | Description | SSH username for inspection connect |
|
|
872
|
+
| | Valid | `String` |
|
|
873
|
+
| | Default | |
|
|
874
|
+
| `--update` | Description | |
|
|
875
|
+
| | Valid | `Sfn::Config::Update` |
|
|
876
|
+
| | Default | |
|
|
877
|
+
| `--yes` | Description | Automatically accept any requests for confirmation |
|
|
878
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
879
|
+
| | Default | |
|
|
880
|
+
|
|
881
|
+
## List Command
|
|
882
|
+
|
|
883
|
+
~~~
|
|
884
|
+
$ sfn list
|
|
885
|
+
~~~
|
|
886
|
+
|
|
887
|
+
| Option | Attribute | Value
|
|
888
|
+
|--------|-----------|------
|
|
889
|
+
| `--all-attributes` | Description | Print all available attributes |
|
|
890
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
891
|
+
| | Default | |
|
|
892
|
+
| `--attribute` | Description | Attribute of stack to print |
|
|
893
|
+
| | Valid | `String` |
|
|
894
|
+
| | Default | |
|
|
895
|
+
| `--conf` | Description | |
|
|
896
|
+
| | Valid | `Sfn::Config::Conf` |
|
|
897
|
+
| | Default | |
|
|
898
|
+
| `--config` | Description | Configuration file path |
|
|
899
|
+
| | Valid | `String` |
|
|
900
|
+
| | Default | |
|
|
901
|
+
| `--create` | Description | |
|
|
902
|
+
| | Valid | `Sfn::Config::Create` |
|
|
903
|
+
| | Default | |
|
|
904
|
+
| `--credentials` | Description | Provider credentials (Key:Value[,Key:Value,...]) |
|
|
905
|
+
| | Valid | `Bogo::Smash` |
|
|
906
|
+
| | Default | |
|
|
907
|
+
| `--debug` | Description | Enable debug output |
|
|
908
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
909
|
+
| | Default | |
|
|
910
|
+
| `--defaults` | Description | Automatically accept default values |
|
|
911
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
912
|
+
| | Default | |
|
|
913
|
+
| `--describe` | Description | |
|
|
914
|
+
| | Valid | `Sfn::Config::Describe` |
|
|
915
|
+
| | Default | |
|
|
916
|
+
| `--destroy` | Description | |
|
|
917
|
+
| | Valid | `Sfn::Config::Destroy` |
|
|
918
|
+
| | Default | |
|
|
919
|
+
| `--events` | Description | |
|
|
920
|
+
| | Valid | `Sfn::Config::Events` |
|
|
921
|
+
| | Default | |
|
|
922
|
+
| `--export` | Description | |
|
|
923
|
+
| | Valid | `Sfn::Config::Export` |
|
|
924
|
+
| | Default | |
|
|
925
|
+
| `--ignore-parameters` | Description | Parameters to ignore during modifications |
|
|
926
|
+
| | Valid | `String` |
|
|
927
|
+
| | Default | |
|
|
928
|
+
| `--import` | Description | |
|
|
929
|
+
| | Valid | `Sfn::Config::Import` |
|
|
930
|
+
| | Default | |
|
|
931
|
+
| `--inspect` | Description | |
|
|
932
|
+
| | Valid | `Sfn::Config::Inspect` |
|
|
933
|
+
| | Default | |
|
|
934
|
+
| `--interactive-parameters` | Description | Prompt for template parameters |
|
|
935
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
936
|
+
| | Default | true|
|
|
937
|
+
| `--poll` | Description | Poll stack events on modification actions |
|
|
938
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
939
|
+
| | Default | true|
|
|
940
|
+
| `--status` | Description | Match stacks with given status. Use "none" to disable. |
|
|
941
|
+
| | Valid | `String` |
|
|
942
|
+
| | Default | |
|
|
943
|
+
| `--update` | Description | |
|
|
944
|
+
| | Valid | `Sfn::Config::Update` |
|
|
945
|
+
| | Default | |
|
|
946
|
+
| `--yes` | Description | Automatically accept any requests for confirmation |
|
|
947
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
948
|
+
| | Default | |
|
|
949
|
+
|
|
950
|
+
## Print Command
|
|
951
|
+
|
|
952
|
+
~~~
|
|
953
|
+
$ sfn print
|
|
954
|
+
~~~
|
|
955
|
+
|
|
956
|
+
| Option | Attribute | Value
|
|
957
|
+
|--------|-----------|------
|
|
958
|
+
| `--apply-nesting` | Description | Apply stack nesting |
|
|
959
|
+
| | Valid | `String`, `Symbol` |
|
|
960
|
+
| | Default | "deep"|
|
|
961
|
+
| `--base-directory` | Description | Path to root of of templates directory |
|
|
962
|
+
| | Valid | `String` |
|
|
963
|
+
| | Default | |
|
|
964
|
+
| `--compile-parameters` | Description | Pass template compile time parameters directly |
|
|
965
|
+
| | Valid | `Bogo::Smash` |
|
|
966
|
+
| | Default | |
|
|
967
|
+
| `--config` | Description | Configuration file path |
|
|
968
|
+
| | Valid | `String` |
|
|
969
|
+
| | Default | |
|
|
970
|
+
| `--credentials` | Description | Provider credentials (Key:Value[,Key:Value,...]) |
|
|
971
|
+
| | Valid | `Bogo::Smash` |
|
|
972
|
+
| | Default | |
|
|
973
|
+
| `--debug` | Description | Enable debug output |
|
|
974
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
975
|
+
| | Default | |
|
|
976
|
+
| `--defaults` | Description | Automatically accept default values |
|
|
977
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
978
|
+
| | Default | |
|
|
979
|
+
| `--file` | Description | Path to template file |
|
|
980
|
+
| | Valid | `String` |
|
|
981
|
+
| | Default | |
|
|
982
|
+
| `--file-path-prompt` | Description | Enable interactive prompt for template path discovery |
|
|
983
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
984
|
+
| | Default | true|
|
|
985
|
+
| `--ignore-parameters` | Description | Parameters to ignore during modifications |
|
|
986
|
+
| | Valid | `String` |
|
|
987
|
+
| | Default | |
|
|
988
|
+
| `--interactive-parameters` | Description | Prompt for template parameters |
|
|
989
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
990
|
+
| | Default | true|
|
|
991
|
+
| `--nesting-bucket` | Description | Bucket to use for storing nested stack templates |
|
|
992
|
+
| | Valid | `String` |
|
|
993
|
+
| | Default | |
|
|
994
|
+
| `--nesting-prefix` | Description | File name prefix for storing template in bucket |
|
|
995
|
+
| | Valid | `String` |
|
|
996
|
+
| | Default | |
|
|
997
|
+
| `--no-base-directory` | Description | Unset any value used for the template root directory path |
|
|
998
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
999
|
+
| | Default | |
|
|
1000
|
+
| `--poll` | Description | Poll stack events on modification actions |
|
|
1001
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
1002
|
+
| | Default | true|
|
|
1003
|
+
| `--print-only` | Description | Print the resulting stack template |
|
|
1004
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
1005
|
+
| | Default | |
|
|
1006
|
+
| `--processing` | Description | Call the unicorns and explode the glitter bombs |
|
|
1007
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
1008
|
+
| | Default | true|
|
|
1009
|
+
| `--sparkle-dump` | Description | Do not use provider customized dump behavior |
|
|
1010
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
1011
|
+
| | Default | |
|
|
1012
|
+
| `--sparkle-pack` | Description | Load SparklePack gem |
|
|
1013
|
+
| | Valid | `String` |
|
|
1014
|
+
| | Default | |
|
|
1015
|
+
| `--translate` | Description | Translate generated template to given provider |
|
|
1016
|
+
| | Valid | `String` |
|
|
1017
|
+
| | Default | |
|
|
1018
|
+
| `--translate-chunk` | Description | Chunk length for serialization |
|
|
1019
|
+
| | Valid | `Integer` |
|
|
1020
|
+
| | Default | |
|
|
1021
|
+
| `--upload-root-template` | Description | Upload root template to storage bucket |
|
|
1022
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
1023
|
+
| | Default | |
|
|
1024
|
+
| `--write-to-file` | Description | Write compiled SparkleFormation template to path provided |
|
|
1025
|
+
| | Valid | `String` |
|
|
1026
|
+
| | Default | |
|
|
1027
|
+
| `--yes` | Description | Automatically accept any requests for confirmation |
|
|
1028
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
1029
|
+
| | Default | |
|
|
1030
|
+
|
|
1031
|
+
## Promote Command
|
|
1032
|
+
|
|
1033
|
+
~~~
|
|
1034
|
+
$ sfn promote
|
|
1035
|
+
~~~
|
|
1036
|
+
|
|
1037
|
+
| Option | Attribute | Value
|
|
1038
|
+
|--------|-----------|------
|
|
1039
|
+
| `--accounts` | Description | JSON accounts file path |
|
|
1040
|
+
| | Valid | `String` |
|
|
1041
|
+
| | Default | |
|
|
1042
|
+
| `--bucket` | Description | Bucket name containing the exports |
|
|
1043
|
+
| | Valid | `String` |
|
|
1044
|
+
| | Default | |
|
|
1045
|
+
| `--bucket-prefix` | Description | Key prefix within remote bucket |
|
|
1046
|
+
| | Valid | `String` |
|
|
1047
|
+
| | Default | |
|
|
1048
|
+
| `--conf` | Description | |
|
|
1049
|
+
| | Valid | `Sfn::Config::Conf` |
|
|
1050
|
+
| | Default | |
|
|
1051
|
+
| `--config` | Description | Configuration file path |
|
|
1052
|
+
| | Valid | `String` |
|
|
1053
|
+
| | Default | |
|
|
1054
|
+
| `--create` | Description | |
|
|
1055
|
+
| | Valid | `Sfn::Config::Create` |
|
|
1056
|
+
| | Default | |
|
|
1057
|
+
| `--credentials` | Description | Provider credentials (Key:Value[,Key:Value,...]) |
|
|
1058
|
+
| | Valid | `Bogo::Smash` |
|
|
1059
|
+
| | Default | |
|
|
1060
|
+
| `--debug` | Description | Enable debug output |
|
|
1061
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
1062
|
+
| | Default | |
|
|
1063
|
+
| `--defaults` | Description | Automatically accept default values |
|
|
1064
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
1065
|
+
| | Default | |
|
|
1066
|
+
| `--describe` | Description | |
|
|
1067
|
+
| | Valid | `Sfn::Config::Describe` |
|
|
1068
|
+
| | Default | |
|
|
1069
|
+
| `--destroy` | Description | |
|
|
1070
|
+
| | Valid | `Sfn::Config::Destroy` |
|
|
1071
|
+
| | Default | |
|
|
1072
|
+
| `--events` | Description | |
|
|
1073
|
+
| | Valid | `Sfn::Config::Events` |
|
|
1074
|
+
| | Default | |
|
|
1075
|
+
| `--export` | Description | |
|
|
1076
|
+
| | Valid | `Sfn::Config::Export` |
|
|
1077
|
+
| | Default | |
|
|
1078
|
+
| `--ignore-parameters` | Description | Parameters to ignore during modifications |
|
|
1079
|
+
| | Valid | `String` |
|
|
1080
|
+
| | Default | |
|
|
1081
|
+
| `--import` | Description | |
|
|
1082
|
+
| | Valid | `Sfn::Config::Import` |
|
|
1083
|
+
| | Default | |
|
|
1084
|
+
| `--inspect` | Description | |
|
|
1085
|
+
| | Valid | `Sfn::Config::Inspect` |
|
|
1086
|
+
| | Default | |
|
|
1087
|
+
| `--interactive-parameters` | Description | Prompt for template parameters |
|
|
1088
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
1089
|
+
| | Default | true|
|
|
1090
|
+
| `--list` | Description | |
|
|
1091
|
+
| | Valid | `Sfn::Config::List` |
|
|
1092
|
+
| | Default | |
|
|
1093
|
+
| `--poll` | Description | Poll stack events on modification actions |
|
|
1094
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
1095
|
+
| | Default | true|
|
|
1096
|
+
| `--update` | Description | |
|
|
1097
|
+
| | Valid | `Sfn::Config::Update` |
|
|
1098
|
+
| | Default | |
|
|
1099
|
+
| `--yes` | Description | Automatically accept any requests for confirmation |
|
|
1100
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
1101
|
+
| | Default | |
|
|
1102
|
+
|
|
1103
|
+
## Update Command
|
|
1104
|
+
|
|
1105
|
+
~~~
|
|
1106
|
+
$ sfn update
|
|
1107
|
+
~~~
|
|
1108
|
+
|
|
1109
|
+
| Option | Attribute | Value
|
|
1110
|
+
|--------|-----------|------
|
|
1111
|
+
| `--apply-mapping` | Description | Customize apply stack mapping as [StackName__]OutputName:ParameterName (Key:Value[,Key:Value,...]) |
|
|
1112
|
+
| | Valid | `Bogo::Smash` |
|
|
1113
|
+
| | Default | |
|
|
1114
|
+
| `--apply-nesting` | Description | Apply stack nesting |
|
|
1115
|
+
| | Valid | `String`, `Symbol` |
|
|
1116
|
+
| | Default | "deep"|
|
|
1117
|
+
| `--apply-stack` | Description | Apply outputs from stack to input parameters |
|
|
1118
|
+
| | Valid | `String` |
|
|
1119
|
+
| | Default | |
|
|
1120
|
+
| `--base-directory` | Description | Path to root of of templates directory |
|
|
1121
|
+
| | Valid | `String` |
|
|
1122
|
+
| | Default | |
|
|
1123
|
+
| `--compile-parameters` | Description | Pass template compile time parameters directly |
|
|
1124
|
+
| | Valid | `Bogo::Smash` |
|
|
1125
|
+
| | Default | |
|
|
1126
|
+
| `--config` | Description | Configuration file path |
|
|
1127
|
+
| | Valid | `String` |
|
|
1128
|
+
| | Default | |
|
|
1129
|
+
| `--credentials` | Description | Provider credentials (Key:Value[,Key:Value,...]) |
|
|
1130
|
+
| | Valid | `Bogo::Smash` |
|
|
1131
|
+
| | Default | |
|
|
1132
|
+
| `--debug` | Description | Enable debug output |
|
|
1133
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
1134
|
+
| | Default | |
|
|
1135
|
+
| `--defaults` | Description | Automatically accept default values |
|
|
1136
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
1137
|
+
| | Default | |
|
|
1138
|
+
| `--diffs` | Description | Show planner content diff |
|
|
1139
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
1140
|
+
| | Default | |
|
|
1141
|
+
| `--file` | Description | Path to template file |
|
|
1142
|
+
| | Valid | `String` |
|
|
1143
|
+
| | Default | |
|
|
1144
|
+
| `--file-path-prompt` | Description | Enable interactive prompt for template path discovery |
|
|
1145
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
1146
|
+
| | Default | true|
|
|
1147
|
+
| `--ignore-parameters` | Description | Parameters to ignore during modifications |
|
|
1148
|
+
| | Valid | `String` |
|
|
1149
|
+
| | Default | |
|
|
1150
|
+
| `--interactive-parameters` | Description | Prompt for template parameters |
|
|
1151
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
1152
|
+
| | Default | true|
|
|
1153
|
+
| `--merge-api-options` | Description | Merge API options defined within configuration on update |
|
|
1154
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
1155
|
+
| | Default | false|
|
|
1156
|
+
| `--nesting-bucket` | Description | Bucket to use for storing nested stack templates |
|
|
1157
|
+
| | Valid | `String` |
|
|
1158
|
+
| | Default | |
|
|
1159
|
+
| `--nesting-prefix` | Description | File name prefix for storing template in bucket |
|
|
1160
|
+
| | Valid | `String` |
|
|
1161
|
+
| | Default | |
|
|
1162
|
+
| `--no-base-directory` | Description | Unset any value used for the template root directory path |
|
|
1163
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
1164
|
+
| | Default | |
|
|
1165
|
+
| `--parameter` | Description | [DEPRECATED - use `parameters`] Pass template parameters directly (ParamName:ParamValue) |
|
|
1166
|
+
| | Valid | `Bogo::Smash` |
|
|
1167
|
+
| | Default | |
|
|
1168
|
+
| `--parameters` | Description | Pass template parameters directly (Key:Value[,Key:Value,...]) |
|
|
1169
|
+
| | Valid | `Bogo::Smash` |
|
|
1170
|
+
| | Default | |
|
|
1171
|
+
| `--plan` | Description | Provide planning information prior to update |
|
|
1172
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
1173
|
+
| | Default | true|
|
|
1174
|
+
| `--plan-only` | Description | Exit after plan display |
|
|
1175
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
1176
|
+
| | Default | false|
|
|
1177
|
+
| `--poll` | Description | Poll stack events on modification actions |
|
|
1178
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
1179
|
+
| | Default | true|
|
|
1180
|
+
| `--print-only` | Description | Print the resulting stack template |
|
|
1181
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
1182
|
+
| | Default | |
|
|
1183
|
+
| `--processing` | Description | Call the unicorns and explode the glitter bombs |
|
|
1184
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
1185
|
+
| | Default | true|
|
|
1186
|
+
| `--sparkle-pack` | Description | Load SparklePack gem |
|
|
1187
|
+
| | Valid | `String` |
|
|
1188
|
+
| | Default | |
|
|
1189
|
+
| `--translate` | Description | Translate generated template to given provider |
|
|
1190
|
+
| | Valid | `String` |
|
|
1191
|
+
| | Default | |
|
|
1192
|
+
| `--translate-chunk` | Description | Chunk length for serialization |
|
|
1193
|
+
| | Valid | `Integer` |
|
|
1194
|
+
| | Default | |
|
|
1195
|
+
| `--upload-root-template` | Description | Upload root template to storage bucket |
|
|
1196
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
1197
|
+
| | Default | |
|
|
1198
|
+
| `--yes` | Description | Automatically accept any requests for confirmation |
|
|
1199
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
1200
|
+
| | Default | |
|
|
1201
|
+
|
|
1202
|
+
## Validate Command
|
|
1203
|
+
|
|
1204
|
+
~~~
|
|
1205
|
+
$ sfn validate
|
|
1206
|
+
~~~
|
|
1207
|
+
|
|
1208
|
+
| Option | Attribute | Value
|
|
1209
|
+
|--------|-----------|------
|
|
1210
|
+
| `--apply-nesting` | Description | Apply stack nesting |
|
|
1211
|
+
| | Valid | `String`, `Symbol` |
|
|
1212
|
+
| | Default | "deep"|
|
|
1213
|
+
| `--base-directory` | Description | Path to root of of templates directory |
|
|
1214
|
+
| | Valid | `String` |
|
|
1215
|
+
| | Default | |
|
|
1216
|
+
| `--compile-parameters` | Description | Pass template compile time parameters directly |
|
|
1217
|
+
| | Valid | `Bogo::Smash` |
|
|
1218
|
+
| | Default | |
|
|
1219
|
+
| `--config` | Description | Configuration file path |
|
|
1220
|
+
| | Valid | `String` |
|
|
1221
|
+
| | Default | |
|
|
1222
|
+
| `--credentials` | Description | Provider credentials (Key:Value[,Key:Value,...]) |
|
|
1223
|
+
| | Valid | `Bogo::Smash` |
|
|
1224
|
+
| | Default | |
|
|
1225
|
+
| `--debug` | Description | Enable debug output |
|
|
1226
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
1227
|
+
| | Default | |
|
|
1228
|
+
| `--defaults` | Description | Automatically accept default values |
|
|
1229
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
1230
|
+
| | Default | |
|
|
1231
|
+
| `--file` | Description | Path to template file |
|
|
1232
|
+
| | Valid | `String` |
|
|
1233
|
+
| | Default | |
|
|
1234
|
+
| `--file-path-prompt` | Description | Enable interactive prompt for template path discovery |
|
|
1235
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
1236
|
+
| | Default | true|
|
|
1237
|
+
| `--ignore-parameters` | Description | Parameters to ignore during modifications |
|
|
1238
|
+
| | Valid | `String` |
|
|
1239
|
+
| | Default | |
|
|
1240
|
+
| `--interactive-parameters` | Description | Prompt for template parameters |
|
|
1241
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
1242
|
+
| | Default | true|
|
|
1243
|
+
| `--nesting-bucket` | Description | Bucket to use for storing nested stack templates |
|
|
1244
|
+
| | Valid | `String` |
|
|
1245
|
+
| | Default | |
|
|
1246
|
+
| `--nesting-prefix` | Description | File name prefix for storing template in bucket |
|
|
1247
|
+
| | Valid | `String` |
|
|
1248
|
+
| | Default | |
|
|
1249
|
+
| `--no-base-directory` | Description | Unset any value used for the template root directory path |
|
|
1250
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
1251
|
+
| | Default | |
|
|
1252
|
+
| `--poll` | Description | Poll stack events on modification actions |
|
|
1253
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
1254
|
+
| | Default | true|
|
|
1255
|
+
| `--print-only` | Description | Print the resulting stack template |
|
|
1256
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
1257
|
+
| | Default | |
|
|
1258
|
+
| `--processing` | Description | Call the unicorns and explode the glitter bombs |
|
|
1259
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
1260
|
+
| | Default | true|
|
|
1261
|
+
| `--sparkle-pack` | Description | Load SparklePack gem |
|
|
1262
|
+
| | Valid | `String` |
|
|
1263
|
+
| | Default | |
|
|
1264
|
+
| `--translate` | Description | Translate generated template to given provider |
|
|
1265
|
+
| | Valid | `String` |
|
|
1266
|
+
| | Default | |
|
|
1267
|
+
| `--translate-chunk` | Description | Chunk length for serialization |
|
|
1268
|
+
| | Valid | `Integer` |
|
|
1269
|
+
| | Default | |
|
|
1270
|
+
| `--upload-root-template` | Description | Upload root template to storage bucket |
|
|
1271
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
1272
|
+
| | Default | |
|
|
1273
|
+
| `--yes` | Description | Automatically accept any requests for confirmation |
|
|
1274
|
+
| | Valid | `TrueClass`, `FalseClass` |
|
|
1275
|
+
| | Default | |
|
|
1276
|
+
|