Skip to content

Commit 16debc9

Browse files
author
awstools
committed
docs(client-cloudformation): CloudFormation documentation update for March, 2024
1 parent 069e57e commit 16debc9

File tree

5 files changed

+37
-43
lines changed

5 files changed

+37
-43
lines changed

‎clients/client-cloudformation/src/commands/DescribeStackEventsCommand.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@ export interface DescribeStackEventsCommandOutput extends DescribeStackEventsOut
2929
/**
3030
* @public
3131
* <p>Returns all stack related events for a specified stack in reverse chronological order. For more information
32-
* about a stack's event history, go to <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/concept-stack.html">Stacks</a> in the
33-
* <i>CloudFormation User Guide</i>.</p>
32+
* about a stack's event history, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stack-resource-configuration-complete.html">CloudFormation stack creation
33+
* events</a> in the <i>CloudFormation User Guide</i>.</p>
3434
* <note>
3535
* <p>You can list events for stacks that have failed to create or have been deleted by specifying the unique stack
3636
* identifier (stack ID).</p>

‎clients/client-cloudformation/src/commands/DescribeStacksCommand.ts

+2-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,8 @@ export interface DescribeStacksCommandOutput extends DescribeStacksOutput, __Met
2929
/**
3030
* @public
3131
* <p>Returns the description for the specified stack; if no stack name was specified, then it returns the description
32-
* for all the stacks created.</p>
32+
* for all the stacks created. For more information about a stack's event history, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stack-resource-configuration-complete.html">CloudFormation stack creation
33+
* events</a> in the <i>CloudFormation User Guide</i>.</p>
3334
* <note>
3435
* <p>If the stack doesn't exist, a <code>ValidationError</code> is returned.</p>
3536
* </note>

‎clients/client-cloudformation/src/models/models_0.ts

+13-20
Original file line numberDiff line numberDiff line change
@@ -823,7 +823,7 @@ export interface ResourceTargetDefinition {
823823
* causes the resource to be recreated. The value can be <code>Never</code>, <code>Always</code>, or
824824
* <code>Conditionally</code>. To determine the conditions for a <code>Conditionally</code> recreation, see the update
825825
* behavior for that <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">property</a> in the
826-
* CloudFormation User Guide.</p>
826+
* <i>CloudFormation User Guide</i>.</p>
827827
*/
828828
RequiresRecreation?: RequiresRecreation;
829829
}
@@ -1555,7 +1555,7 @@ export interface ResourceToImport {
15551555
* @public
15561556
* <p>The type of resource to import into your stack, such as <code>AWS::S3::Bucket</code>. For a list of supported
15571557
* resource types, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resource-import-supported-resources.html">Resources that support import
1558-
* operations</a> in the CloudFormation User Guide.</p>
1558+
* operations</a> in the <i>CloudFormation User Guide</i>.</p>
15591559
*/
15601560
ResourceType: string | undefined;
15611561

@@ -3011,7 +3011,7 @@ export interface CreateStackSetInput {
30113011
* @public
30123012
* <p>The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200
30133013
* bytes. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html">Template Anatomy</a> in the
3014-
* CloudFormation User Guide.</p>
3014+
* <i>CloudFormation User Guide</i>.</p>
30153015
* <p>Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.</p>
30163016
*/
30173017
TemplateBody?: string;
@@ -3021,7 +3021,7 @@ export interface CreateStackSetInput {
30213021
* <p>The location of the file that contains the template body. The URL must point to a template (maximum size:
30223022
* 460,800 bytes) that's located in an Amazon S3 bucket or a Systems Manager document. For more information, see
30233023
* <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html">Template Anatomy</a>
3024-
* in the CloudFormation User Guide.</p>
3024+
* in the <i>CloudFormation User Guide</i>.</p>
30253025
* <p>Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.</p>
30263026
*/
30273027
TemplateURL?: string;
@@ -4814,7 +4814,7 @@ export interface StackEvent {
48144814
/**
48154815
* @public
48164816
* <p>Type of resource. (For more information, go to <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Amazon Web Services Resource Types
4817-
* Reference</a> in the CloudFormation User Guide.)</p>
4817+
* Reference</a> in the <i>CloudFormation User Guide</i>.)</p>
48184818
*/
48194819
ResourceType?: string;
48204820

@@ -5023,13 +5023,6 @@ export interface StackInstanceComprehensiveStatus {
50235023
* </li>
50245024
* <li>
50255025
* <p>
5026-
* <code>FAILED_IMPORT</code>: The import of the stack instance in the specified account and Region failed and
5027-
* left the stack in an unstable state. Once the issues causing the failure are fixed, the import operation can be
5028-
* retried. If enough stack set operations fail in enough accounts within a Region, the failure tolerance for the
5029-
* stack set operation as a whole might be exceeded.</p>
5030-
* </li>
5031-
* <li>
5032-
* <p>
50335026
* <code>INOPERABLE</code>: A <code>DeleteStackInstances</code> operation has failed and left the stack in an
50345027
* unstable state. Stacks in this state are excluded from further <code>UpdateStackSet</code> operations. You might
50355028
* need to perform a <code>DeleteStackInstances</code> operation, with <code>RetainStacks</code> set to
@@ -5364,7 +5357,7 @@ export interface StackResourceDetail {
53645357
/**
53655358
* @public
53665359
* <p>Type of resource. For more information, go to <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Amazon Web Services Resource Types
5367-
* Reference</a> in the CloudFormation User Guide.</p>
5360+
* Reference</a> in the <i>CloudFormation User Guide</i>.</p>
53685361
*/
53695362
ResourceType: string | undefined;
53705363

@@ -5395,7 +5388,7 @@ export interface StackResourceDetail {
53955388
/**
53965389
* @public
53975390
* <p>The content of the <code>Metadata</code> attribute declared for the resource. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-metadata.html">Metadata Attribute</a>
5398-
* in the CloudFormation User Guide.</p>
5391+
* in the <i>CloudFormation User Guide</i>.</p>
53995392
*/
54005393
Metadata?: string;
54015394

@@ -5771,7 +5764,7 @@ export interface StackResource {
57715764
/**
57725765
* @public
57735766
* <p>Type of resource. For more information, go to <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Amazon Web Services Resource Types
5774-
* Reference</a> in the CloudFormation User Guide.</p>
5767+
* Reference</a> in the <i>CloudFormation User Guide</i>.</p>
57755768
*/
57765769
ResourceType: string | undefined;
57775770

@@ -6643,7 +6636,7 @@ export interface StackSetOperation {
66436636
* <p>
66446637
* <code>QUEUED</code>: [Service-managed permissions] For automatic deployments that require a sequence of
66456638
* operations, the operation is queued to be performed. For more information, see the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-status-codes">stack set operation status
6646-
* codes</a> in the CloudFormation User Guide.</p>
6639+
* codes</a> in the <i>CloudFormation User Guide</i>.</p>
66476640
* </li>
66486641
* <li>
66496642
* <p>
@@ -6727,7 +6720,7 @@ export interface StackSetOperation {
67276720
* <p>This information will only be present for stack set operations whose <code>Action</code> type is
67286721
* <code>DETECT_DRIFT</code>.</p>
67296722
* <p>For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-drift.html">Detecting Unmanaged Changes in Stack Sets</a> in
6730-
* the CloudFormation User Guide.</p>
6723+
* the <i>CloudFormation User Guide</i>.</p>
67316724
*/
67326725
StackSetDriftDetectionDetails?: StackSetDriftDetectionDetails;
67336726

@@ -8738,7 +8731,7 @@ export interface StackInstanceResourceDriftsSummary {
87388731
/**
87398732
* @public
87408733
* <p>Type of resource. For more information, go to <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Amazon Web Services Resource Types
8741-
* Reference</a> in the CloudFormation User Guide.</p>
8734+
* Reference</a> in the <i>CloudFormation User Guide</i>.</p>
87428735
*/
87438736
ResourceType: string | undefined;
87448737

@@ -9142,7 +9135,7 @@ export interface StackResourceSummary {
91429135
/**
91439136
* @public
91449137
* <p>Type of resource. (For more information, go to <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Amazon Web Services Resource Types
9145-
* Reference</a> in the CloudFormation User Guide.)</p>
9138+
* Reference</a> in the <i>CloudFormation User Guide</i>.)</p>
91469139
*/
91479140
ResourceType: string | undefined;
91489141

@@ -9646,7 +9639,7 @@ export interface StackSetOperationSummary {
96469639
* <p>
96479640
* <code>QUEUED</code>: [Service-managed permissions] For automatic deployments that require a sequence of
96489641
* operations, the operation is queued to be performed. For more information, see the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-status-codes">stack set operation status
9649-
* codes</a> in the CloudFormation User Guide.</p>
9642+
* codes</a> in the <i>CloudFormation User Guide</i>.</p>
96509643
* </li>
96519644
* <li>
96529645
* <p>

‎clients/client-cloudformation/src/models/models_1.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -690,7 +690,7 @@ export interface UpdateStackSetInput {
690690
* @public
691691
* <p>The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200
692692
* bytes. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html">Template Anatomy</a> in the
693-
* CloudFormation User Guide.</p>
693+
* <i>CloudFormation User Guide</i>.</p>
694694
* <p>Conditional: You must specify only one of the following parameters: <code>TemplateBody</code> or
695695
* <code>TemplateURL</code>—or set <code>UsePreviousTemplate</code> to true.</p>
696696
*/
@@ -701,7 +701,7 @@ export interface UpdateStackSetInput {
701701
* <p>The location of the file that contains the template body. The URL must point to a template (maximum size:
702702
* 460,800 bytes) that is located in an Amazon S3 bucket or a Systems Manager document. For more information,
703703
* see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html">Template
704-
* Anatomy</a> in the CloudFormation User Guide.</p>
704+
* Anatomy</a> in the <i>CloudFormation User Guide</i>.</p>
705705
* <p>Conditional: You must specify only one of the following parameters: <code>TemplateBody</code> or
706706
* <code>TemplateURL</code>—or set <code>UsePreviousTemplate</code> to true.</p>
707707
*/

0 commit comments

Comments
 (0)