Skip to content

Commit d6ee2a7

Browse files
Documentation updates for AWS CloudFormation
1 parent d0f78eb commit d6ee2a7

12 files changed

+77
-63
lines changed

generator/ServiceModels/cloudformation/cloudformation-2010-05-15.docs.json

Lines changed: 12 additions & 12 deletions
Large diffs are not rendered by default.

generator/ServiceModels/cloudformation/cloudformation-2010-05-15.normal.json

Lines changed: 12 additions & 12 deletions
Large diffs are not rendered by default.

sdk/src/Services/CloudFormation/Generated/Model/CreateStackRequest.cs

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -377,11 +377,13 @@ internal bool IsSetResourceTypes()
377377
/// <summary>
378378
/// Gets and sets the property RetainExceptOnCreate.
379379
/// <para>
380-
/// This deletion policy deletes newly created resources, but retains existing resources,
381-
/// when a stack operation is rolled back. This ensures new, empty, and unused resources
382-
/// are deleted, while critical resources and their data are retained. <code>RetainExceptOnCreate</code>
383-
/// can be specified for any resource that supports the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html">
384-
/// DeletionPolicy</a> attribute.
380+
/// When set to <code>true</code>, newly created resources are deleted when the operation
381+
/// rolls back. This includes newly created resources marked with a deletion policy of
382+
/// <code>Retain</code>.
383+
/// </para>
384+
///
385+
/// <para>
386+
/// Default: <code>false</code>
385387
/// </para>
386388
/// </summary>
387389
public bool RetainExceptOnCreate

sdk/src/Services/CloudFormation/Generated/Model/CreateStackSetRequest.cs

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ public partial class CreateStackSetRequest : AmazonCloudFormationRequest
5959
/// <para>
6060
/// Specify an IAM role only if you are using customized administrator roles to control
6161
/// which users or groups can manage specific stack sets within the same administrator
62-
/// account. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/stacksets-prereqs.html">Prerequisites:
62+
/// account. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs.html">Prerequisites:
6363
/// Granting Permissions for Stack Set Operations</a> in the <i>CloudFormation User Guide</i>.
6464
/// </para>
6565
/// </summary>
@@ -220,7 +220,7 @@ internal bool IsSetCallAs()
220220
/// </para>
221221
/// </li> </ul>
222222
/// <para>
223-
/// For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/using-iam-template.html#capabilities">Acknowledging
223+
/// For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities">Acknowledging
224224
/// IAM Resources in CloudFormation Templates</a>.
225225
/// </para>
226226
/// </li> <li>
@@ -232,14 +232,14 @@ internal bool IsSetCallAs()
232232
/// Some templates reference macros. If your stack set template references one or more
233233
/// macros, you must create the stack set directly from the processed template, without
234234
/// first reviewing the resulting changes in a change set. To create the stack set directly,
235-
/// you must acknowledge this capability. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/template-macros.html">Using
235+
/// you must acknowledge this capability. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html">Using
236236
/// CloudFormation Macros to Perform Custom Processing on Templates</a>.
237237
/// </para>
238238
/// <important>
239239
/// <para>
240240
/// Stack sets with service-managed permissions don't currently support the use of macros
241-
/// in templates. (This includes the <a href="https://docs.aws.amazon.com/AWSCloudFormation/create-reusable-transform-function-snippets-and-add-to-your-template-with-aws-include-transform.html">AWS::Include</a>
242-
/// and <a href="https://docs.aws.amazon.com/AWSCloudFormation/transform-aws-serverless.html">AWS::Serverless</a>
241+
/// in templates. (This includes the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/create-reusable-transform-function-snippets-and-add-to-your-template-with-aws-include-transform.html">AWS::Include</a>
242+
/// and <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html">AWS::Serverless</a>
243243
/// transforms, which are macros hosted by CloudFormation.) Even if you specify this capability
244244
/// for a stack set with service-managed permissions, if you reference a macro in your
245245
/// template the stack set operation will fail.

sdk/src/Services/CloudFormation/Generated/Model/DescribeStacksRequest.cs

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,8 +67,12 @@ internal bool IsSetNextToken()
6767
/// Gets and sets the property StackName. <note>
6868
/// <para>
6969
/// If you don't pass a parameter to <code>StackName</code>, the API returns a response
70-
/// that describes all resources in the account. This requires <code>ListStacks</code>
71-
/// and <code>DescribeStacks</code> permissions.
70+
/// that describes all resources in the account, which can impact performance. This requires
71+
/// <code>ListStacks</code> and <code>DescribeStacks</code> permissions.
72+
/// </para>
73+
///
74+
/// <para>
75+
/// Consider using the <a>ListStacks</a> API if you're not passing a parameter to <code>StackName</code>.
7276
/// </para>
7377
///
7478
/// <para>

sdk/src/Services/CloudFormation/Generated/Model/ExecuteChangeSetRequest.cs

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -143,11 +143,13 @@ internal bool IsSetDisableRollback()
143143
/// <summary>
144144
/// Gets and sets the property RetainExceptOnCreate.
145145
/// <para>
146-
/// This deletion policy deletes newly created resources, but retains existing resources,
147-
/// when a stack operation is rolled back. This ensures new, empty, and unused resources
148-
/// are deleted, while critical resources and their data are retained. <code>RetainExceptOnCreate</code>
149-
/// can be specified for any resource that supports the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html">
150-
/// DeletionPolicy</a> attribute.
146+
/// When set to <code>true</code>, newly created resources are deleted when the operation
147+
/// rolls back. This includes newly created resources marked with a deletion policy of
148+
/// <code>Retain</code>.
149+
/// </para>
150+
///
151+
/// <para>
152+
/// Default: <code>false</code>
151153
/// </para>
152154
/// </summary>
153155
public bool RetainExceptOnCreate

sdk/src/Services/CloudFormation/Generated/Model/RollbackStackRequest.cs

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -96,11 +96,13 @@ internal bool IsSetClientRequestToken()
9696
/// <summary>
9797
/// Gets and sets the property RetainExceptOnCreate.
9898
/// <para>
99-
/// This deletion policy deletes newly created resources, but retains existing resources,
100-
/// when a stack operation is rolled back. This ensures new, empty, and unused resources
101-
/// are deleted, while critical resources and their data are retained. <code>RetainExceptOnCreate</code>
102-
/// can be specified for any resource that supports the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html">
103-
/// DeletionPolicy</a> attribute.
99+
/// When set to <code>true</code>, newly created resources are deleted when the operation
100+
/// rolls back. This includes newly created resources marked with a deletion policy of
101+
/// <code>Retain</code>.
102+
/// </para>
103+
///
104+
/// <para>
105+
/// Default: <code>false</code>
104106
/// </para>
105107
/// </summary>
106108
public bool RetainExceptOnCreate

sdk/src/Services/CloudFormation/Generated/Model/Stack.cs

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -325,11 +325,13 @@ internal bool IsSetParentId()
325325
/// <summary>
326326
/// Gets and sets the property RetainExceptOnCreate.
327327
/// <para>
328-
/// This deletion policy deletes newly created resources, but retains existing resources,
329-
/// when a stack operation is rolled back. This ensures new, empty, and unused resources
330-
/// are deleted, while critical resources and their data are retained. <code>RetainExceptOnCreate</code>
331-
/// can be specified for any resource that supports the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html">
332-
/// DeletionPolicy</a> attribute.
328+
/// When set to <code>true</code>, newly created resources are deleted when the operation
329+
/// rolls back. This includes newly created resources marked with a deletion policy of
330+
/// <code>Retain</code>.
331+
/// </para>
332+
///
333+
/// <para>
334+
/// Default: <code>false</code>
333335
/// </para>
334336
/// </summary>
335337
public bool RetainExceptOnCreate

sdk/src/Services/CloudFormation/Generated/Model/StackSet.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ public partial class StackSet
6363
///
6464
/// <para>
6565
/// Use customized administrator roles to control which users or groups can manage specific
66-
/// stack sets within the same administrator account. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/stacksets-prereqs.html">Prerequisites:
66+
/// stack sets within the same administrator account. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs.html">Prerequisites:
6767
/// Granting Permissions for Stack Set Operations</a> in the <i>CloudFormation User Guide</i>.
6868
/// </para>
6969
/// </summary>

sdk/src/Services/CloudFormation/Generated/Model/StackSetOperation.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ internal bool IsSetAction()
7777
///
7878
/// <para>
7979
/// Use customized administrator roles to control which users or groups can manage specific
80-
/// stack sets within the same administrator account. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/stacksets-prereqs.html">Define
80+
/// stack sets within the same administrator account. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs.html">Define
8181
/// Permissions for Multiple Administrators</a> in the <i>CloudFormation User Guide</i>.
8282
/// </para>
8383
/// </summary>

0 commit comments

Comments
 (0)