Merge pull request #411 from ericzbeard/v-1-9-1

Schemas and docs for v1.10.0
aws-cloudformation · May 31, 2024 · b18b179 · b18b179
2 parents 2bfa38a + 0fd0d2f
commit b18b179
Show file tree

Hide file tree

Showing 121 changed files with 6,179 additions and 2,596 deletions.
diff --git a/README.md b/README.md
@@ -419,12 +419,14 @@ Output a chart to an HTML file that you can view with a browser to look at how l
 ### Pkl
 
 You can now write CloudFormation templates in Apple's new configuration
-language, pkl. Rain commands that accept input as JSON or YAML now also accept
-files with the `.pkl` extension. As a part of each rain release, a Pkl package
-called `cloudformation` is created. This package has classes that can be
-imported for each registry resource type, in addition to higher level patterns.
-This allows you to write a type-safe template and create your own client-side
-modules, in a way that is similar to CDK, but with declarative code.
+language, Pkl. Rain commands that accept input as JSON or YAML now also accept
+files with the `.pkl` extension. We host a Pkl package in a [separate
+repo](https://github.com/aws-cloudformation/cloudformation-pkl) that is
+generated based on the CloudFormation registry. This package has classes that
+can be imported for each registry resource type, in addition to higher level
+patterns. This allows you to write a type-safe template and create your own
+client-side modules, in a way that is similar to CDK, but with declarative
+code.
 
 Example Pkl template:
 

diff --git a/docs/README.tmpl b/docs/README.tmpl
@@ -392,13 +392,38 @@ Output a chart to an HTML file that you can view with a browser to look at how l
 ### Pkl
 
 You can now write CloudFormation templates in Apple's new configuration
-language, pkl. Rain commands that accept input as JSON or YAML now also accept
-files with the `.pkl` extension. We host a Pkl package called `cloudformation`
-is created at https://github.com/aws-cloudformation/cloudformation-pkl. This
-package has classes that can be imported for each registry resource type, in
-addition to higher level patterns. This allows you to write a type-safe
-template and create your own client-side modules, in a way that is similar to
-CDK, but with declarative code.
+language, Pkl. Rain commands that accept input as JSON or YAML now also accept
+files with the `.pkl` extension. We host a Pkl package in a [separate
+repo](https://github.com/aws-cloudformation/cloudformation-pkl) that is
+generated based on the CloudFormation registry. This package has classes that
+can be imported for each registry resource type, in addition to higher level
+patterns. This allows you to write a type-safe template and create your own
+client-side modules, in a way that is similar to CDK, but with declarative
+code.
+
+Example Pkl template:
+
+```pkl
+amends "package://github.com/aws-cloudformation/cloudformation-pkl/releases/download/[email protected]/[email protected]#/template.pkl"
+import "package://github.com/aws-cloudformation/cloudformation-pkl/releases/download/[email protected]/[email protected]#/cloudformation.pkl" as cfn
+import "package://github.com/aws-cloudformation/cloudformation-pkl/releases/download/[email protected]/[email protected]#/aws/s3/bucket.pkl" as bucket
+
+Description = "Create a bucket"
+
+Parameters {
+    ["Name"] {
+        Type = "String"
+        Default = "baz"
+    }
+}
+
+Resources {
+    ["MyBucket"] = new bucket.Bucket {
+        BucketName = cfn.Ref("Name")
+    }
+}
+
+```
 
 ## Other CloudFormation tools
 

diff --git a/docs/bash_completion.sh b/docs/bash_completion.sh
@@ -931,6 +931,8 @@ _rain_deploy()
     flags+=("-d")
     local_nonpersistent_flags+=("--detach")
     local_nonpersistent_flags+=("-d")
+    flags+=("--experimental")
+    local_nonpersistent_flags+=("--experimental")
     flags+=("--help")
     flags+=("-h")
     local_nonpersistent_flags+=("--help")
@@ -1100,6 +1102,10 @@ _rain_forecast()
     flags_with_completion=()
     flags_completion=()
 
+    flags+=("--action=")
+    two_word_flags+=("--action")
+    local_nonpersistent_flags+=("--action")
+    local_nonpersistent_flags+=("--action=")
     flags+=("--all")
     flags+=("-a")
     local_nonpersistent_flags+=("--all")
@@ -1120,6 +1126,12 @@ _rain_forecast()
     flags+=("-h")
     local_nonpersistent_flags+=("--help")
     local_nonpersistent_flags+=("-h")
+    flags+=("--ignore=")
+    two_word_flags+=("--ignore")
+    local_nonpersistent_flags+=("--ignore")
+    local_nonpersistent_flags+=("--ignore=")
+    flags+=("--include-iam")
+    local_nonpersistent_flags+=("--include-iam")
     flags+=("--params=")
     two_word_flags+=("--params")
     local_nonpersistent_flags+=("--params")
@@ -1140,8 +1152,6 @@ _rain_forecast()
     two_word_flags+=("--role-arn")
     local_nonpersistent_flags+=("--role-arn")
     local_nonpersistent_flags+=("--role-arn=")
-    flags+=("--skip-iam")
-    local_nonpersistent_flags+=("--skip-iam")
     flags+=("--tags=")
     two_word_flags+=("--tags")
     local_nonpersistent_flags+=("--tags")
@@ -1274,6 +1284,10 @@ _rain_logs()
     local_nonpersistent_flags+=("--region")
     local_nonpersistent_flags+=("--region=")
     local_nonpersistent_flags+=("-r")
+    flags+=("--since-user-initiated")
+    flags+=("-s")
+    local_nonpersistent_flags+=("--since-user-initiated")
+    local_nonpersistent_flags+=("-s")
     flags+=("--no-colour")
 
     must_have_one_flag=()
@@ -1498,6 +1512,8 @@ _rain_stackset_deploy()
     two_word_flags+=("--accounts")
     local_nonpersistent_flags+=("--accounts")
     local_nonpersistent_flags+=("--accounts=")
+    flags+=("--admin")
+    local_nonpersistent_flags+=("--admin")
     flags+=("--config=")
     two_word_flags+=("--config")
     two_word_flags+=("-c")
@@ -1589,6 +1605,8 @@ _rain_stackset_ls()
     flags_with_completion=()
     flags_completion=()
 
+    flags+=("--admin")
+    local_nonpersistent_flags+=("--admin")
     flags+=("--all")
     flags+=("-a")
     local_nonpersistent_flags+=("--all")
@@ -1631,6 +1649,8 @@ _rain_stackset_rm()
     flags_with_completion=()
     flags_completion=()
 
+    flags+=("--admin")
+    local_nonpersistent_flags+=("--admin")
     flags+=("--detach")
     flags+=("-d")
     local_nonpersistent_flags+=("--detach")

diff --git a/docs/index.md b/docs/index.md
@@ -35,4 +35,4 @@ Rain is a command line tool for working with AWS CloudFormation templates and st
 * [rain tree](rain_tree.md)	 - Find dependencies of Resources and Outputs in a local template
 * [rain watch](rain_watch.md)	 - Display an updating view of a CloudFormation stack
 
-###### Auto generated by spf13/cobra on 2-May-2024
+###### Auto generated by spf13/cobra on 31-May-2024
diff --git a/docs/rain_bootstrap.md b/docs/rain_bootstrap.md
@@ -30,4 +30,4 @@ rain bootstrap
 
 * [rain](index.md)	 - 
 
-###### Auto generated by spf13/cobra on 2-May-2024
+###### Auto generated by spf13/cobra on 31-May-2024
diff --git a/docs/rain_build.md b/docs/rain_build.md
@@ -41,4 +41,4 @@ rain build [<resource type>] or <prompt>
 
 * [rain](index.md)	 - 
 
-###### Auto generated by spf13/cobra on 2-May-2024
+###### Auto generated by spf13/cobra on 31-May-2024
diff --git a/docs/rain_cat.md b/docs/rain_cat.md
@@ -35,4 +35,4 @@ rain cat <stack>
 
 * [rain](index.md)	 - 
 
-###### Auto generated by spf13/cobra on 2-May-2024
+###### Auto generated by spf13/cobra on 31-May-2024
diff --git a/docs/rain_cc.md b/docs/rain_cc.md
@@ -32,4 +32,4 @@ You must pass the --experimental (-x) flag to use this command, to acknowledge t
 * [rain cc rm](rain_cc_rm.md)	 - Delete a deployment created by cc deploy (Experimental!)
 * [rain cc state](rain_cc_state.md)	 - Download the state file for a template deployed with cc deploy
 
-###### Auto generated by spf13/cobra on 2-May-2024
+###### Auto generated by spf13/cobra on 31-May-2024
diff --git a/docs/rain_cc_deploy.md b/docs/rain_cc_deploy.md
@@ -40,4 +40,4 @@ rain cc deploy <template> <name>
 
 * [rain cc](rain_cc.md)	 - Interact with templates using Cloud Control API instead of CloudFormation
 
-###### Auto generated by spf13/cobra on 2-May-2024
+###### Auto generated by spf13/cobra on 31-May-2024
diff --git a/docs/rain_cc_drift.md b/docs/rain_cc_drift.md
@@ -33,4 +33,4 @@ rain cc drift <name>
 
 * [rain cc](rain_cc.md)	 - Interact with templates using Cloud Control API instead of CloudFormation
 
-###### Auto generated by spf13/cobra on 2-May-2024
+###### Auto generated by spf13/cobra on 31-May-2024
diff --git a/docs/rain_cc_rm.md b/docs/rain_cc_rm.md
@@ -33,4 +33,4 @@ rain cc rm <name>
 
 * [rain cc](rain_cc.md)	 - Interact with templates using Cloud Control API instead of CloudFormation
 
-###### Auto generated by spf13/cobra on 2-May-2024
+###### Auto generated by spf13/cobra on 31-May-2024
diff --git a/docs/rain_cc_state.md b/docs/rain_cc_state.md
@@ -33,4 +33,4 @@ rain cc state <name>
 
 * [rain cc](rain_cc.md)	 - Interact with templates using Cloud Control API instead of CloudFormation
 
-###### Auto generated by spf13/cobra on 2-May-2024
+###### Auto generated by spf13/cobra on 31-May-2024
diff --git a/docs/rain_console.md b/docs/rain_console.md
@@ -39,4 +39,4 @@ rain console [stack]
 
 * [rain](index.md)	 - 
 
-###### Auto generated by spf13/cobra on 2-May-2024
+###### Auto generated by spf13/cobra on 31-May-2024
diff --git a/docs/rain_deploy.md b/docs/rain_deploy.md
@@ -57,6 +57,7 @@ rain deploy <template> [stack]
       --changeset                execute the changeset, rain deploy --changeset <stackName> <changeSetName>
   -c, --config string            YAML or JSON file to set tags and parameters
   -d, --detach                   once deployment has started, don't wait around for it to finish
+      --experimental             Acknowledge that you want to deploy with an experimental feature
   -h, --help                     help for deploy
       --ignore-unknown-params    Ignore unknown parameters
   -k, --keep                     keep deployed resources after a failure by disabling rollbacks
@@ -84,4 +85,4 @@ rain deploy <template> [stack]
 
 * [rain](index.md)	 - 
 
-###### Auto generated by spf13/cobra on 2-May-2024
+###### Auto generated by spf13/cobra on 31-May-2024
diff --git a/docs/rain_diff.md b/docs/rain_diff.md
@@ -28,4 +28,4 @@ rain diff <from> <to>
 
 * [rain](index.md)	 - 
 
-###### Auto generated by spf13/cobra on 2-May-2024
+###### Auto generated by spf13/cobra on 31-May-2024
diff --git a/docs/rain_fmt.md b/docs/rain_fmt.md
@@ -37,4 +37,4 @@ rain fmt <filename>...
 
 * [rain](index.md)	 - 
 
-###### Auto generated by spf13/cobra on 2-May-2024
+###### Auto generated by spf13/cobra on 31-May-2024
diff --git a/docs/rain_forecast.md b/docs/rain_forecast.md
@@ -16,17 +16,8 @@ This command is not a linter! Use cfn-lint for that. The forecast command
 is concerned with things that could go wrong during deployment, after the 
 template has been checked to make sure it has a valid syntax.
 
-This command checks for some common issues across all resources:
-
-- The resource already exists
-- You do not have permissions to create/update/delete the resource
-- (More to come.. service quotas, drift issues)
-
-Resource-specific checks:
-
-- S3 bucket is not empty
-- S3 bucket policy has an invalid principal
-- (Many more to come...)
+This command checks for some common issues across all resources, and 
+resource-specific checks. See the README for more details.
 
 
 ```
@@ -36,16 +27,18 @@ rain forecast --experimental <template> [stackName]
 ### Options
 
 ```
+      --action string     The stack action to check: create, update, delete, all (default is all) (default "all")
   -a, --all               Show all checks, not just failed ones
   -c, --config string     YAML or JSON file to set tags and parameters
       --debug             Output debugging information
   -x, --experimental      Acknowledge that this is an experimental feature
   -h, --help              help for forecast
+      --ignore strings    Resource types and specific codes to ignore, separated by commas, for example, AWS::S3::Bucket,F0002
+      --include-iam       Include permissions checks, which can take a long time
       --params strings    set parameter values; use the format key1=value1,key2=value2
   -p, --profile string    AWS profile name; read from the AWS CLI configuration file
   -r, --region string     AWS region to use
       --role-arn string   An optional execution role arn to use for predicting IAM failures
-      --skip-iam          Skip permissions checks, which can take a long time
       --tags strings      add tags to the stack; use the format key1=value1,key2=value2
       --type string       Optional resource type to limit checks to only that type
 ```
@@ -60,4 +53,4 @@ rain forecast --experimental <template> [stackName]
 
 * [rain](index.md)	 - 
 
-###### Auto generated by spf13/cobra on 2-May-2024
+###### Auto generated by spf13/cobra on 31-May-2024
diff --git a/docs/rain_info.md b/docs/rain_info.md
@@ -30,4 +30,4 @@ rain info
 
 * [rain](index.md)	 - 
 
-###### Auto generated by spf13/cobra on 2-May-2024
+###### Auto generated by spf13/cobra on 31-May-2024
diff --git a/docs/rain_logs.md b/docs/rain_logs.md
@@ -16,14 +16,15 @@ rain logs <stack> (<resource>)
 ### Options
 
 ```
-  -a, --all              include uninteresting logs
-  -c, --chart            Output a gantt chart of the most recent action as an html file
-  -d, --days uint        Age of the logs to display in days
-      --debug            Output debugging information
-  -h, --help             help for logs
-  -l, --length uint      Number of logs to display
-  -p, --profile string   AWS profile name; read from the AWS CLI configuration file
-  -r, --region string    AWS region to use
+  -a, --all                    include uninteresting logs
+  -c, --chart                  Output a gantt chart of the most recent action as an html file
+  -d, --days uint              Age of the logs to display in days
+      --debug                  Output debugging information
+  -h, --help                   help for logs
+  -l, --length uint            Number of logs to display
+  -p, --profile string         AWS profile name; read from the AWS CLI configuration file
+  -r, --region string          AWS region to use
+  -s, --since-user-initiated   Only show logs since the last 'User Initiated' event
 ```
 
 ### Options inherited from parent commands
@@ -36,4 +37,4 @@ rain logs <stack> (<resource>)
 
 * [rain](index.md)	 - 
 
-###### Auto generated by spf13/cobra on 2-May-2024
+###### Auto generated by spf13/cobra on 31-May-2024
diff --git a/docs/rain_ls.md b/docs/rain_ls.md
@@ -31,4 +31,4 @@ rain ls <stack> [changeset]
 
 * [rain](index.md)	 - 
 
-###### Auto generated by spf13/cobra on 2-May-2024
+###### Auto generated by spf13/cobra on 31-May-2024
diff --git a/docs/rain_merge.md b/docs/rain_merge.md
@@ -29,4 +29,4 @@ rain merge <template> <template> ...
 
 * [rain](index.md)	 - 
 
-###### Auto generated by spf13/cobra on 2-May-2024
+###### Auto generated by spf13/cobra on 31-May-2024
diff --git a/docs/rain_pkg.md b/docs/rain_pkg.md
@@ -68,4 +68,4 @@ rain pkg <template>
 
 * [rain](index.md)	 - 
 
-###### Auto generated by spf13/cobra on 2-May-2024
+###### Auto generated by spf13/cobra on 31-May-2024
diff --git a/docs/rain_rm.md b/docs/rain_rm.md
@@ -33,4 +33,4 @@ rain rm <stack> [changeset]
 
 * [rain](index.md)	 - 
 
-###### Auto generated by spf13/cobra on 2-May-2024
+###### Auto generated by spf13/cobra on 31-May-2024
diff --git a/docs/rain_stackset.md b/docs/rain_stackset.md
@@ -28,4 +28,4 @@ This command manipulates stack sets. It has no action if specific stack set comm
 * [rain stackset ls](rain_stackset_ls.md)	 - List a CloudFormation stack sets in a given region
 * [rain stackset rm](rain_stackset_rm.md)	 - Delete a CloudFormation stack set and/or its instances.
 
-###### Auto generated by spf13/cobra on 2-May-2024
+###### Auto generated by spf13/cobra on 31-May-2024
diff --git a/docs/rain_stackset_deploy.md b/docs/rain_stackset_deploy.md
@@ -22,15 +22,15 @@ Tags:
 StackSet:
 	description: "test description"
 	...
-StackSetInstanses:
+StackSetInstances:
 	accounts:
 		- "123456789123"
 	regions:
 		- us-east-1
 		- us-east-2
 ...
 
-Account(s) and region(s) provideed as flags OVERRIDE values from configuration files. Tags and parameters from the configuration file are MERGED with CLI flag values. 
+Account(s) and region(s) provided as flags OVERRIDE values from configuration files. Tags and parameters from the configuration file are MERGED with CLI flag values. 
 
 
 ```
@@ -41,6 +41,7 @@ rain stackset deploy <template> [stackset] [flags]
 
 ```
       --accounts strings         accounts for which to create stack set instances
+      --admin                    Use delegated admin permissions
   -c, --config string            YAML or JSON file to set additional configuration parameters
   -d, --detach                   once deployment has started, don't wait around for it to finish
   -h, --help                     help for deploy
@@ -64,4 +65,4 @@ rain stackset deploy <template> [stackset] [flags]
 
 * [rain stackset](rain_stackset.md)	 - This command manipulates stack sets.
 
-###### Auto generated by spf13/cobra on 2-May-2024
+###### Auto generated by spf13/cobra on 31-May-2024
diff --git a/docs/rain_stackset_ls.md b/docs/rain_stackset_ls.md
@@ -13,6 +13,7 @@ rain stackset ls <stack set>
 ### Options
 
 ```
+      --admin            Use delegated admin permissions
   -a, --all              list stacks in all regions; if you specify a stack set name, show more details
   -h, --help             help for ls
   -p, --profile string   AWS profile name; read from the AWS CLI configuration file
@@ -30,4 +31,4 @@ rain stackset ls <stack set>
 
 * [rain stackset](rain_stackset.md)	 - This command manipulates stack sets.
 
-###### Auto generated by spf13/cobra on 2-May-2024
+###### Auto generated by spf13/cobra on 31-May-2024