cloudformation-ruby-dsl 1.4.0 → 1.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1fc27537e778d1d9bf9b8886047e87f578e93f3a
-  data.tar.gz: ba288ca3b0e250854b5f7c45485d963a4cd27a37
+  metadata.gz: 689a6e23672cf1be2ca2acaad415484f9c79fab5
+  data.tar.gz: 280c4250cb0a541faaac7c7ced39a67fcdac6474
 SHA512:
-  metadata.gz: 7179312a3f4a3462c7de36b9e0ec77f42d1c2bca68e8d52e0cfe9cb3a19d9c97abcf3d04aaa92a3e844aa0a5dc27d67757e0777d5d6e9ac6cd55d6c597ff09ab
-  data.tar.gz: b6f097b17b653d267a0f07a946fbeab1996b82604bf9386b749c3bc88337f82de741adc3fe02bc697c0f260f1f2ffef975c1e7d26319351e55268218ed331e5e
+  metadata.gz: 85e1e94afbaf7fdcd320c748fc91de02b8cbaedf974dd66ee4f8d0d30d255c749892d1af1c188c3e73f8c9f54cc2c32ee3811d4f46590c4c8224f4dd74ce5fed
+  data.tar.gz: 92ed9f50c46fbc82cd01aef262dc330fa6914bcd93df806bdfe5b927db4a3ea76cd09ae4c9b57d165ef8b0e359e9ea69dcd2845e499e7f8ab3b39ce9bd30e530

data/README.md

@@ -57,6 +57,20 @@ Make the resulting file executable (`chmod +x [NEW_NAME.rb]`). It can respond to
 - `describe-resource`: given two arguments: stack-name and logical-resource-id, get output from a stack concerning the specific resource (takes optional `--nopretty` to minimize output)
 - `get-template`: get entire template output of an existing stack
 
+Command line options similar to cloudformation commands, but parsed by the dsl.
+- `--profile`
+- `--stack-name`
+- `--region`
+- `--parameters`
+- `--tag  `
+
+Any other parameters are passed directly onto cloudformation. (--disable-rollback for instance)
+
+Using the ruby scripts:
+```
+template.rb create --stack-name my_stack --parameters "BucketName=bucket-s3-static;SnsQueue=mysnsqueue"
+```
+
 Below are the various functions currently available in the DSL. See [the example script](examples/cloudformation-ruby-script.rb) for more usage information.
 
 ### DSL Statements

data/lib/cloudformation-ruby-dsl/cfntemplate.rb

@@ -109,6 +109,7 @@ end
 
 def validate_action(action)
   valid = %w[
+    help
     expand
     diff
     validate
@@ -188,6 +189,52 @@ def cfn(template)
   end
 
   case action
+  when 'help' 
+  begin
+    # Give some basic usage.
+    help_string=%q(
+## Usage
+
+To convert existing JSON templates to use the DSL, run
+
+    cfntemplate-to-ruby [EXISTING_CFN] > [NEW_NAME.rb]
+
+You may need to preface this with `bundle exec` if you installed via Bundler.
+
+Make the resulting file executable (`chmod +x [NEW_NAME.rb]`). It can respond to the following subcommands (which are listed if you run without parameters):
+- `expand`: output the JSON template to the command line (takes optional `--nopretty` to minimize the output)
+- `diff`: compare an existing stack with your template. Produces following exit codes:
+```
+    0 - no differences, nothing to update
+    1 - stack does not exist, template Validation error
+    2 - there are differences between an existing stack and your template
+```
+- `validate`: run validation against the stack definition
+- `create`: create a new stack from the output
+- `update`: update an existing stack from the output. Produces following exit codes:
+```
+    0 - update finished successfully
+    1 - no updates to perform, stack doesn't exist, unable to update immutable parameter or tag, AWS ServiceError exception
+```
+- `cancel-update`: cancel updating a stack
+- `delete`: delete a stack (with prompt)
+- `describe`: get output of an existing stack and output it (takes optional `--nopretty` to minimize output)
+- `describe-resource`: given two arguments: stack-name and logical-resource-id, get output from a stack concerning the specific resource (takes optional `--nopretty` to minimize output)
+- `get-template`: get entire template output of an existing stack
+
+Command line options similar to cloudformation commands, but parsed by the dsl.
+ --profile --stack-name --region --parameters --tag
+
+Any other parameters are passed directly onto cloudformation. (--disable-rollback for instance)
+
+Using the ruby scripts:
+template.rb create --stack-name my_stack --parameters "BucketName=bucket-s3-static;SnsQueue=mysnsqueue"
+
+)
+    puts help_string
+    exit(true)
+  end
+
   when 'expand'
     # Write the pretty-printed JSON template to stdout and exit.  [--nopretty] option writes output with minimal whitespace
     # example: <template.rb> expand --parameters "Env=prod" --region eu-west-1 --nopretty

data/lib/cloudformation-ruby-dsl/version.rb

@@ -15,7 +15,7 @@
 module Cfn
   module Ruby
     module Dsl
-      VERSION = "1.4.0"
+      VERSION = "1.4.1"
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cloudformation-ruby-dsl
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.4.1
 platform: ruby
 authors:
 - Shawn Smith