generate_docs() for conditionalCreateOnlyProperties

#367 (comment) aws-cloudformation/cloudformation-resource-schema#121 https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt
aws-cloudformation · Apr 28, 2021 · 57104b1 · 57104b1
1 parent 5435570
commit 57104b1
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 1 deletion.
diff --git a/src/rpdk/core/project.py b/src/rpdk/core/project.py
@@ -650,7 +650,11 @@ def _set_docs_properties(  # noqa: C901
             and proppath_ptr in self.schema["createOnlyProperties"]
         ):
             prop["createonly"] = True
-
+        if (
+            "conditionalCreateOnlyProperties" in self.schema
+            and proppath_ptr in self.schema["conditionalCreateOnlyProperties"]
+        ):
+            prop["conditionalCreateOnly"] = True
         if (
             "readOnlyProperties" in self.schema
             and proppath_ptr in self.schema["readOnlyProperties"]

diff --git a/src/rpdk/core/templates/docs-readme.md b/src/rpdk/core/templates/docs-readme.md
@@ -76,6 +76,9 @@ _Pattern_: <code>{{ prop.pattern }}</code>
 {% if prop.createonly %}
 
 _Update requires_: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)
+{% elif prop.conditionalCreateOnly %}
+
+_Update requires_: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)
 {% else %}
 
 _Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

diff --git a/src/rpdk/core/templates/docs-subproperty.md b/src/rpdk/core/templates/docs-subproperty.md
@@ -71,6 +71,9 @@ _Pattern_: <code>{{ prop.pattern }}</code>
 {% if prop.createonly %}
 
 _Update requires_: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)
+{% elif prop.conditionalCreateOnly %}
+
+_Update requires_: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)
 {% else %}
 
 _Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)