README.md in cloudformation-ruby-dsl-0.5.3 vs README.md in cloudformation-ruby-dsl-0.5.4

- old
+ new

@@ -18,10 +18,18 @@ Run `gem install cloudformation-ruby-dsl` to install system-wide. To use in a specific project, add `gem 'cloudformation-ruby-dsl'` to your Gemfile, and then run `bundle`. +## Releasing + +See [Releasing](docs/Releasing.md). + +## Contributing + +See [Contributing](docs/Contributing.md). + ## Usage To convert existing JSON templates to use the DSL, run cfntemplate-to-ruby [EXISTING_CFN] > [NEW_NAME.rb] @@ -40,11 +48,11 @@ ### DSL Statements Add the named object to the appropriate collection. - `parameter(name, options)` (may be marked :Immutable, which will raise error on a later change) - `mapping(name, options)` -- `condition(name, options)` +- `condition(name, conditions)` - `resource(name, options)` - `output(name, options)` ### CloudFormation Function Calls @@ -55,10 +63,18 @@ - `get_azs(region)` - `join(delim, *list)` - `select(index, list)` - `ref(name)` +Intrinsic conditionals are also supported, with some syntactic sugar. +- `fn_not(condition)` +- `fn_or(*condition_list)` +- `fn_and(*condition_list)` +- `fn_if(condition, value_if_true, value_if_false)` +- `equal(lhsOperand, rhsOperand)` +- `not_equal(lhsOperand, rhsOperand)` + Reference a CloudFormation pseudo parameter. - `aws_account_id()` - `aws_notification_arns()` - `aws_no_value()` - `aws_region()` @@ -74,6 +90,6 @@ - `interpolate(string)`: embed CFN references into a string (`{{ref('Service')}}`) for later interpretation by the CFN engine - `Table.load(filename)`: load a table from the listed file, which can then be turned into mappings (via `get_map`) ### Default Region -The tool defaults to region 'us-east-1'. To change this set either 'EC2_REGION' or 'AWS_DEFAULT_REGION' environment variables. +The tool defaults to region `us-east-1`. To change this set either `EC2_REGION` or `AWS_DEFAULT_REGION` in your environment.