@aws-sdk/client-cloudformation 3.347.0 → 3.348.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -3
- package/dist-cjs/models/models_0.js +1 -0
- package/dist-es/models/models_0.js +1 -0
- package/dist-types/CloudFormation.d.ts +1 -3
- package/dist-types/CloudFormationClient.d.ts +1 -3
- package/dist-types/commands/ActivateTypeCommand.d.ts +6 -6
- package/dist-types/commands/BatchDescribeTypeConfigurationsCommand.d.ts +3 -4
- package/dist-types/commands/CancelUpdateStackCommand.d.ts +2 -2
- package/dist-types/commands/ContinueUpdateRollbackCommand.d.ts +9 -9
- package/dist-types/commands/CreateChangeSetCommand.d.ts +16 -19
- package/dist-types/commands/CreateStackCommand.d.ts +2 -2
- package/dist-types/commands/DeactivateTypeCommand.d.ts +5 -6
- package/dist-types/commands/DeleteChangeSetCommand.d.ts +5 -8
- package/dist-types/commands/DeleteStackCommand.d.ts +2 -3
- package/dist-types/commands/DeregisterTypeCommand.d.ts +9 -9
- package/dist-types/commands/DescribeAccountLimitsCommand.d.ts +3 -2
- package/dist-types/commands/DescribeChangeSetCommand.d.ts +3 -3
- package/dist-types/commands/DescribeChangeSetHooksCommand.d.ts +2 -1
- package/dist-types/commands/DescribeOrganizationsAccessCommand.d.ts +1 -1
- package/dist-types/commands/DescribePublisherCommand.d.ts +5 -6
- package/dist-types/commands/DescribeStackDriftDetectionStatusCommand.d.ts +9 -11
- package/dist-types/commands/DescribeStackEventsCommand.d.ts +4 -5
- package/dist-types/commands/DescribeStackInstanceCommand.d.ts +1 -1
- package/dist-types/commands/DescribeStackResourceCommand.d.ts +2 -2
- package/dist-types/commands/DescribeStackResourceDriftsCommand.d.ts +7 -11
- package/dist-types/commands/DescribeStackResourcesCommand.d.ts +12 -14
- package/dist-types/commands/DescribeStacksCommand.d.ts +2 -2
- package/dist-types/commands/DescribeTypeCommand.d.ts +2 -3
- package/dist-types/commands/DescribeTypeRegistrationCommand.d.ts +5 -11
- package/dist-types/commands/DetectStackDriftCommand.d.ts +16 -20
- package/dist-types/commands/DetectStackResourceDriftCommand.d.ts +9 -12
- package/dist-types/commands/DetectStackSetDriftCommand.d.ts +11 -21
- package/dist-types/commands/EstimateTemplateCostCommand.d.ts +2 -2
- package/dist-types/commands/ExecuteChangeSetCommand.d.ts +8 -11
- package/dist-types/commands/GetStackPolicyCommand.d.ts +2 -2
- package/dist-types/commands/GetTemplateCommand.d.ts +3 -4
- package/dist-types/commands/GetTemplateSummaryCommand.d.ts +7 -8
- package/dist-types/commands/ListChangeSetsCommand.d.ts +2 -2
- package/dist-types/commands/ListExportsCommand.d.ts +4 -6
- package/dist-types/commands/ListImportsCommand.d.ts +4 -6
- package/dist-types/commands/ListStackInstancesCommand.d.ts +1 -1
- package/dist-types/commands/ListStackResourcesCommand.d.ts +2 -2
- package/dist-types/commands/ListStacksCommand.d.ts +4 -4
- package/dist-types/commands/PublishTypeCommand.d.ts +6 -5
- package/dist-types/commands/RecordHandlerProgressCommand.d.ts +2 -1
- package/dist-types/commands/RegisterPublisherCommand.d.ts +4 -6
- package/dist-types/commands/RegisterTypeCommand.d.ts +10 -16
- package/dist-types/commands/RollbackStackCommand.d.ts +6 -8
- package/dist-types/commands/SetTypeConfigurationCommand.d.ts +9 -10
- package/dist-types/commands/SetTypeDefaultVersionCommand.d.ts +1 -2
- package/dist-types/commands/SignalResourceCommand.d.ts +4 -5
- package/dist-types/commands/TestTypeCommand.d.ts +16 -18
- package/dist-types/commands/UpdateStackCommand.d.ts +6 -6
- package/dist-types/commands/UpdateTerminationProtectionCommand.d.ts +6 -7
- package/dist-types/commands/ValidateTemplateCommand.d.ts +3 -3
- package/dist-types/index.d.ts +1 -3
- package/dist-types/models/models_0.d.ts +929 -1130
- package/dist-types/ts3.4/models/models_0.d.ts +1 -0
- package/package.json +5 -5
|
@@ -23,27 +23,23 @@ export interface DetectStackDriftCommandOutput extends DetectStackDriftOutput, _
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Detects whether a stack's actual configuration differs, or has
|
|
27
|
-
*
|
|
28
|
-
*
|
|
29
|
-
*
|
|
30
|
-
*
|
|
31
|
-
*
|
|
32
|
-
*
|
|
33
|
-
* <p>Use <code>DetectStackDrift</code> to detect drift on all supported resources for a given
|
|
34
|
-
*
|
|
35
|
-
*
|
|
36
|
-
* <p>For a list of stack resources that currently support drift detection, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift-resource-list.html">Resources
|
|
37
|
-
* that Support Drift Detection</a>.</p>
|
|
26
|
+
* <p>Detects whether a stack's actual configuration differs, or has <i>drifted</i>, from its expected
|
|
27
|
+
* configuration, as defined in the stack template and any values specified as template parameters. For each resource in
|
|
28
|
+
* the stack that supports drift detection, CloudFormation compares the actual configuration of the resource with its expected
|
|
29
|
+
* template configuration. Only resource properties explicitly defined in the stack template are checked for drift. A
|
|
30
|
+
* stack is considered to have drifted if one or more of its resources differ from their expected template
|
|
31
|
+
* configurations. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html">Detecting Unregulated Configuration Changes to
|
|
32
|
+
* Stacks and Resources</a>.</p>
|
|
33
|
+
* <p>Use <code>DetectStackDrift</code> to detect drift on all supported resources for a given stack, or <a>DetectStackResourceDrift</a> to detect drift on individual resources.</p>
|
|
34
|
+
* <p>For a list of stack resources that currently support drift detection, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift-resource-list.html">Resources that Support Drift
|
|
35
|
+
* Detection</a>.</p>
|
|
38
36
|
* <p>
|
|
39
|
-
* <code>DetectStackDrift</code> can take up to several minutes, depending on the number of
|
|
40
|
-
*
|
|
41
|
-
*
|
|
42
|
-
*
|
|
43
|
-
*
|
|
44
|
-
*
|
|
45
|
-
* to that stack. Perform <code>DetectStackDrift</code> directly on the nested stack
|
|
46
|
-
* itself.</p>
|
|
37
|
+
* <code>DetectStackDrift</code> can take up to several minutes, depending on the number of resources contained
|
|
38
|
+
* within the stack. Use <a>DescribeStackDriftDetectionStatus</a> to monitor the progress of a detect stack
|
|
39
|
+
* drift operation. Once the drift detection operation has completed, use <a>DescribeStackResourceDrifts</a>
|
|
40
|
+
* to return drift information about the stack and its resources.</p>
|
|
41
|
+
* <p>When detecting drift on a stack, CloudFormation doesn't detect drift on any nested stacks belonging to that stack.
|
|
42
|
+
* Perform <code>DetectStackDrift</code> directly on the nested stack itself.</p>
|
|
47
43
|
* @example
|
|
48
44
|
* Use a bare-bones client and the command you need to make an API call.
|
|
49
45
|
* ```javascript
|
|
@@ -24,18 +24,15 @@ export interface DetectStackResourceDriftCommandOutput extends DetectStackResour
|
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
26
|
* <p>Returns information about whether a resource's actual configuration differs, or has
|
|
27
|
-
*
|
|
28
|
-
*
|
|
29
|
-
*
|
|
30
|
-
*
|
|
31
|
-
*
|
|
32
|
-
*
|
|
33
|
-
* <p>
|
|
34
|
-
*
|
|
35
|
-
*
|
|
36
|
-
* <p>Resources that don't currently support drift detection can't be checked. For a list of
|
|
37
|
-
* resources that support drift detection, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift-resource-list.html">Resources
|
|
38
|
-
* that Support Drift Detection</a>.</p>
|
|
27
|
+
* <i>drifted</i>, from its expected configuration, as defined in the stack template and any values
|
|
28
|
+
* specified as template parameters. This information includes actual and expected property values for resources in
|
|
29
|
+
* which CloudFormation detects drift. Only resource properties explicitly defined in the stack template are checked for drift.
|
|
30
|
+
* For more information about stack and resource drift, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html">Detecting Unregulated Configuration Changes to
|
|
31
|
+
* Stacks and Resources</a>.</p>
|
|
32
|
+
* <p>Use <code>DetectStackResourceDrift</code> to detect drift on individual resources, or <a>DetectStackDrift</a> to detect drift on all resources in a given stack that support drift detection.</p>
|
|
33
|
+
* <p>Resources that don't currently support drift detection can't be checked. For a list of resources that support
|
|
34
|
+
* drift detection, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift-resource-list.html">Resources that Support Drift
|
|
35
|
+
* Detection</a>.</p>
|
|
39
36
|
* @example
|
|
40
37
|
* Use a bare-bones client and the command you need to make an API call.
|
|
41
38
|
* ```javascript
|
|
@@ -28,39 +28,29 @@ export interface DetectStackSetDriftCommandOutput extends DetectStackSetDriftOut
|
|
|
28
28
|
* performs drift detection on a stack set</a>.</p>
|
|
29
29
|
* <p>
|
|
30
30
|
* <code>DetectStackSetDrift</code> returns the <code>OperationId</code> of the stack set drift detection
|
|
31
|
-
* operation. Use this operation id with <
|
|
32
|
-
*
|
|
33
|
-
*
|
|
34
|
-
* progress of the drift detection operation. The drift detection operation may take some time, depending on the number
|
|
35
|
-
* of stack instances included in the stack set, in addition to the number of resources included in each stack.</p>
|
|
31
|
+
* operation. Use this operation id with <a>DescribeStackSetOperation</a> to monitor the progress of the
|
|
32
|
+
* drift detection operation. The drift detection operation may take some time, depending on the number of stack
|
|
33
|
+
* instances included in the stack set, in addition to the number of resources included in each stack.</p>
|
|
36
34
|
* <p>Once the operation has completed, use the following actions to return drift information:</p>
|
|
37
35
|
* <ul>
|
|
38
36
|
* <li>
|
|
39
|
-
* <p>Use <
|
|
40
|
-
*
|
|
41
|
-
*
|
|
42
|
-
* including detailed information about the last <i>completed</i> drift operation performed on the stack
|
|
43
|
-
* set. (Information about drift operations that are in progress isn't included.)</p>
|
|
37
|
+
* <p>Use <a>DescribeStackSet</a> to return detailed information about the stack set, including detailed
|
|
38
|
+
* information about the last <i>completed</i> drift operation performed on the stack set. (Information
|
|
39
|
+
* about drift operations that are in progress isn't included.)</p>
|
|
44
40
|
* </li>
|
|
45
41
|
* <li>
|
|
46
|
-
* <p>Use <
|
|
47
|
-
*
|
|
48
|
-
* </code> to return a list of stack instances belonging to the
|
|
49
|
-
* stack set, including the drift status and last drift time checked of each instance.</p>
|
|
42
|
+
* <p>Use <a>ListStackInstances</a> to return a list of stack instances belonging to the stack set,
|
|
43
|
+
* including the drift status and last drift time checked of each instance.</p>
|
|
50
44
|
* </li>
|
|
51
45
|
* <li>
|
|
52
|
-
* <p>Use <
|
|
53
|
-
*
|
|
54
|
-
* </code> to return detailed information about a specific stack
|
|
55
|
-
* instance, including its drift status and last drift time checked.</p>
|
|
46
|
+
* <p>Use <a>DescribeStackInstance</a> to return detailed information about a specific stack instance,
|
|
47
|
+
* including its drift status and last drift time checked.</p>
|
|
56
48
|
* </li>
|
|
57
49
|
* </ul>
|
|
58
50
|
* <p>For more information about performing a drift detection operation on a stack set, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-drift.html">Detecting unmanaged changes in
|
|
59
51
|
* stack sets</a>.</p>
|
|
60
52
|
* <p>You can only run a single drift detection operation on a given stack set at one time.</p>
|
|
61
|
-
* <p>To stop a drift detection stack set operation, use <
|
|
62
|
-
* <a>StopStackSetOperation</a>
|
|
63
|
-
* </code>.</p>
|
|
53
|
+
* <p>To stop a drift detection stack set operation, use <a>StopStackSetOperation</a>.</p>
|
|
64
54
|
* @example
|
|
65
55
|
* Use a bare-bones client and the command you need to make an API call.
|
|
66
56
|
* ```javascript
|
|
@@ -23,8 +23,8 @@ export interface EstimateTemplateCostCommandOutput extends EstimateTemplateCostO
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Returns the estimated monthly cost of a template. The return value is an Amazon Web Services Simple Monthly
|
|
27
|
-
*
|
|
26
|
+
* <p>Returns the estimated monthly cost of a template. The return value is an Amazon Web Services Simple Monthly
|
|
27
|
+
* Calculator URL with a query string that describes the resources required to run the template.</p>
|
|
28
28
|
* @example
|
|
29
29
|
* Use a bare-bones client and the command you need to make an API call.
|
|
30
30
|
* ```javascript
|
|
@@ -23,17 +23,14 @@ export interface ExecuteChangeSetCommandOutput extends ExecuteChangeSetOutput, _
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Updates a stack using the input information that was provided when the specified change
|
|
27
|
-
*
|
|
28
|
-
*
|
|
29
|
-
*
|
|
30
|
-
* <p>
|
|
31
|
-
*
|
|
32
|
-
* <p>
|
|
33
|
-
*
|
|
34
|
-
* policy.</p>
|
|
35
|
-
* <p>To create a change set for the entire stack hierarchy, <code>IncludeNestedStacks</code>
|
|
36
|
-
* must have been set to <code>True</code>.</p>
|
|
26
|
+
* <p>Updates a stack using the input information that was provided when the specified change set was created. After
|
|
27
|
+
* the call successfully completes, CloudFormation starts updating the stack. Use the <a>DescribeStacks</a> action to view the status of the update.</p>
|
|
28
|
+
* <p>When you execute a change set, CloudFormation deletes all other change sets associated with the stack
|
|
29
|
+
* because they aren't valid for the updated stack.</p>
|
|
30
|
+
* <p>If a stack policy is associated with the stack, CloudFormation enforces the policy during the update. You
|
|
31
|
+
* can't specify a temporary stack policy that overrides the current policy.</p>
|
|
32
|
+
* <p>To create a change set for the entire stack hierarchy, <code>IncludeNestedStacks</code> must have been set to
|
|
33
|
+
* <code>True</code>.</p>
|
|
37
34
|
* @example
|
|
38
35
|
* Use a bare-bones client and the command you need to make an API call.
|
|
39
36
|
* ```javascript
|
|
@@ -23,8 +23,8 @@ export interface GetStackPolicyCommandOutput extends GetStackPolicyOutput, __Met
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Returns the stack policy for a specified stack. If a stack doesn't have a policy, a null
|
|
27
|
-
*
|
|
26
|
+
* <p>Returns the stack policy for a specified stack. If a stack doesn't have a policy, a null value is
|
|
27
|
+
* returned.</p>
|
|
28
28
|
* @example
|
|
29
29
|
* Use a bare-bones client and the command you need to make an API call.
|
|
30
30
|
* ```javascript
|
|
@@ -23,10 +23,9 @@ export interface GetTemplateCommandOutput extends GetTemplateOutput, __MetadataB
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Returns the template body for a specified stack. You can get the template for running or
|
|
27
|
-
*
|
|
28
|
-
*
|
|
29
|
-
* the stack has been deleted.</p>
|
|
26
|
+
* <p>Returns the template body for a specified stack. You can get the template for running or deleted stacks.</p>
|
|
27
|
+
* <p>For deleted stacks, <code>GetTemplate</code> returns the template for up to 90 days after the stack has been
|
|
28
|
+
* deleted.</p>
|
|
30
29
|
* <note>
|
|
31
30
|
* <p>If the template doesn't exist, a <code>ValidationError</code> is returned.</p>
|
|
32
31
|
* </note>
|
|
@@ -23,14 +23,13 @@ export interface GetTemplateSummaryCommandOutput extends GetTemplateSummaryOutpu
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Returns information about a new or existing template. The <code>GetTemplateSummary</code>
|
|
27
|
-
*
|
|
28
|
-
*
|
|
29
|
-
* <p>You can use the <code>GetTemplateSummary</code> action when you submit a template, or you
|
|
30
|
-
*
|
|
31
|
-
* <p>For deleted stacks, <code>GetTemplateSummary</code> returns the template information for
|
|
32
|
-
*
|
|
33
|
-
* <code>ValidationError</code> is returned.</p>
|
|
26
|
+
* <p>Returns information about a new or existing template. The <code>GetTemplateSummary</code> action is useful for
|
|
27
|
+
* viewing parameter information, such as default parameter values and parameter types, before you create or update a
|
|
28
|
+
* stack or stack set.</p>
|
|
29
|
+
* <p>You can use the <code>GetTemplateSummary</code> action when you submit a template, or you can get template
|
|
30
|
+
* information for a stack set, or a running or deleted stack.</p>
|
|
31
|
+
* <p>For deleted stacks, <code>GetTemplateSummary</code> returns the template information for up to 90 days after the
|
|
32
|
+
* stack has been deleted. If the template doesn't exist, a <code>ValidationError</code> is returned.</p>
|
|
34
33
|
* @example
|
|
35
34
|
* Use a bare-bones client and the command you need to make an API call.
|
|
36
35
|
* ```javascript
|
|
@@ -23,8 +23,8 @@ export interface ListChangeSetsCommandOutput extends ListChangeSetsOutput, __Met
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Returns the ID and status of each active change set for a stack. For example, CloudFormation lists change
|
|
27
|
-
*
|
|
26
|
+
* <p>Returns the ID and status of each active change set for a stack. For example, CloudFormation lists change
|
|
27
|
+
* sets that are in the <code>CREATE_IN_PROGRESS</code> or <code>CREATE_PENDING</code> state.</p>
|
|
28
28
|
* @example
|
|
29
29
|
* Use a bare-bones client and the command you need to make an API call.
|
|
30
30
|
* ```javascript
|
|
@@ -23,13 +23,11 @@ export interface ListExportsCommandOutput extends ListExportsOutput, __MetadataB
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Lists all exported output values in the account and Region in which you call this action.
|
|
27
|
-
*
|
|
28
|
-
*
|
|
29
|
-
* <code>Fn::ImportValue</code>
|
|
30
|
-
* </a> function.</p>
|
|
26
|
+
* <p>Lists all exported output values in the account and Region in which you call this action. Use this action to see
|
|
27
|
+
* the exported output values that you can import into other stacks. To import values, use the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-importvalue.html">
|
|
28
|
+
* Fn::ImportValue</a> function.</p>
|
|
31
29
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-exports.html">
|
|
32
|
-
*
|
|
30
|
+
* CloudFormation export stack output values</a>.</p>
|
|
33
31
|
* @example
|
|
34
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
35
33
|
* ```javascript
|
|
@@ -23,12 +23,10 @@ export interface ListImportsCommandOutput extends ListImportsOutput, __MetadataB
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Lists all stacks that are importing an exported output value. To modify or remove an
|
|
27
|
-
*
|
|
28
|
-
*
|
|
29
|
-
*
|
|
30
|
-
* <code>Fn::ImportValue</code>
|
|
31
|
-
* </a> function.</p>
|
|
26
|
+
* <p>Lists all stacks that are importing an exported output value. To modify or remove an exported output value,
|
|
27
|
+
* first use this action to see which stacks are using it. To see the exported output values in your account, see <a>ListExports</a>.</p>
|
|
28
|
+
* <p>For more information about importing an exported output value, see the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-importvalue.html">Fn::ImportValue</a>
|
|
29
|
+
* function.</p>
|
|
32
30
|
* @example
|
|
33
31
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
32
|
* ```javascript
|
|
@@ -58,7 +58,7 @@ export interface ListStackInstancesCommandOutput extends ListStackInstancesOutpu
|
|
|
58
58
|
* // Status: "CURRENT" || "OUTDATED" || "INOPERABLE",
|
|
59
59
|
* // StatusReason: "STRING_VALUE",
|
|
60
60
|
* // StackInstanceStatus: { // StackInstanceComprehensiveStatus
|
|
61
|
-
* // DetailedStatus: "PENDING" || "RUNNING" || "SUCCEEDED" || "FAILED" || "CANCELLED" || "INOPERABLE",
|
|
61
|
+
* // DetailedStatus: "PENDING" || "RUNNING" || "SUCCEEDED" || "FAILED" || "CANCELLED" || "INOPERABLE" || "SKIPPED_SUSPENDED_ACCOUNT",
|
|
62
62
|
* // },
|
|
63
63
|
* // OrganizationalUnitId: "STRING_VALUE",
|
|
64
64
|
* // DriftStatus: "DRIFTED" || "IN_SYNC" || "UNKNOWN" || "NOT_CHECKED",
|
|
@@ -24,8 +24,8 @@ export interface ListStackResourcesCommandOutput extends ListStackResourcesOutpu
|
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
26
|
* <p>Returns descriptions of all resources of the specified stack.</p>
|
|
27
|
-
* <p>For deleted stacks, ListStackResources returns resource information for up to 90 days
|
|
28
|
-
*
|
|
27
|
+
* <p>For deleted stacks, ListStackResources returns resource information for up to 90 days after the stack has been
|
|
28
|
+
* deleted.</p>
|
|
29
29
|
* @example
|
|
30
30
|
* Use a bare-bones client and the command you need to make an API call.
|
|
31
31
|
* ```javascript
|
|
@@ -23,10 +23,10 @@ export interface ListStacksCommandOutput extends ListStacksOutput, __MetadataBea
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Returns the summary information for stacks whose status matches the specified
|
|
27
|
-
*
|
|
28
|
-
*
|
|
29
|
-
*
|
|
26
|
+
* <p>Returns the summary information for stacks whose status matches the specified StackStatusFilter. Summary
|
|
27
|
+
* information for stacks that have been deleted is kept for 90 days after the stack is deleted. If no StackStatusFilter
|
|
28
|
+
* is specified, summary information for all stacks is returned (including existing stacks and stacks that have been
|
|
29
|
+
* deleted).</p>
|
|
30
30
|
* @example
|
|
31
31
|
* Use a bare-bones client and the command you need to make an API call.
|
|
32
32
|
* ```javascript
|
|
@@ -23,11 +23,12 @@ export interface PublishTypeCommandOutput extends PublishTypeOutput, __MetadataB
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Publishes the specified extension to the CloudFormation registry as a public
|
|
27
|
-
*
|
|
28
|
-
*
|
|
29
|
-
*
|
|
30
|
-
* <p>To publish an extension, you must be registered as a publisher with CloudFormation. For more
|
|
26
|
+
* <p>Publishes the specified extension to the CloudFormation registry as a public extension in this Region.
|
|
27
|
+
* Public extensions are available for use by all CloudFormation users. For more information about publishing
|
|
28
|
+
* extensions, see <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.html">Publishing extensions to make them available for public use</a> in the <i>CloudFormation CLI
|
|
29
|
+
* User Guide</i>.</p>
|
|
30
|
+
* <p>To publish an extension, you must be registered as a publisher with CloudFormation. For more
|
|
31
|
+
* information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterPublisher.html">RegisterPublisher</a>.</p>
|
|
31
32
|
* @example
|
|
32
33
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
34
|
* ```javascript
|
|
@@ -24,7 +24,8 @@ export interface RecordHandlerProgressCommandOutput extends RecordHandlerProgres
|
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
26
|
* <p>Reports progress of a resource handler to CloudFormation.</p>
|
|
27
|
-
* <p>Reserved for use by the <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html">CloudFormation CLI</a>. Don't
|
|
27
|
+
* <p>Reserved for use by the <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/what-is-cloudformation-cli.html">CloudFormation CLI</a>. Don't
|
|
28
|
+
* use this API in your code.</p>
|
|
28
29
|
* @example
|
|
29
30
|
* Use a bare-bones client and the command you need to make an API call.
|
|
30
31
|
* ```javascript
|
|
@@ -23,12 +23,10 @@ export interface RegisterPublisherCommandOutput extends RegisterPublisherOutput,
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Registers your account as a publisher of public extensions in the CloudFormation
|
|
27
|
-
*
|
|
28
|
-
*
|
|
29
|
-
* <p>For information about requirements for registering as a public extension publisher, see
|
|
30
|
-
* <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.html#publish-extension-prereqs">Registering your account to publish CloudFormation extensions</a> in the
|
|
31
|
-
* <i>CloudFormation CLI User Guide</i>.</p>
|
|
26
|
+
* <p>Registers your account as a publisher of public extensions in the CloudFormation registry. Public
|
|
27
|
+
* extensions are available for use by all CloudFormation users. This publisher ID applies to your account in
|
|
28
|
+
* all Amazon Web Services Regions.</p>
|
|
29
|
+
* <p>For information about requirements for registering as a public extension publisher, see <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.html#publish-extension-prereqs">Registering your account to publish CloudFormation extensions</a> in the <i>CloudFormation CLI User Guide</i>.</p>
|
|
32
30
|
* <p></p>
|
|
33
31
|
* @example
|
|
34
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -23,8 +23,8 @@ export interface RegisterTypeCommandOutput extends RegisterTypeOutput, __Metadat
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Registers an extension with the CloudFormation service. Registering an extension
|
|
27
|
-
*
|
|
26
|
+
* <p>Registers an extension with the CloudFormation service. Registering an extension makes it available for
|
|
27
|
+
* use in CloudFormation templates in your Amazon Web Services account, and includes:</p>
|
|
28
28
|
* <ul>
|
|
29
29
|
* <li>
|
|
30
30
|
* <p>Validating the extension schema.</p>
|
|
@@ -36,20 +36,14 @@ export interface RegisterTypeCommandOutput extends RegisterTypeOutput, __Metadat
|
|
|
36
36
|
* <p>Making the extension available for use in your account.</p>
|
|
37
37
|
* </li>
|
|
38
38
|
* </ul>
|
|
39
|
-
* <p>For more information about how to develop extensions and ready them for registration, see
|
|
40
|
-
*
|
|
41
|
-
*
|
|
42
|
-
*
|
|
43
|
-
*
|
|
44
|
-
*
|
|
45
|
-
*
|
|
46
|
-
*
|
|
47
|
-
* </code>, you can use <code>
|
|
48
|
-
* <a>DescribeTypeRegistration</a>
|
|
49
|
-
* </code> to monitor
|
|
50
|
-
* the progress of the registration request.</p>
|
|
51
|
-
* <p>Once you have registered a private extension in your account and Region, use <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_SetTypeConfiguration.html">SetTypeConfiguration</a> to specify configuration properties for the extension. For
|
|
52
|
-
* more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-register.html#registry-set-configuration">Configuring extensions at the account level</a> in the <i>CloudFormation User Guide</i>.</p>
|
|
39
|
+
* <p>For more information about how to develop extensions and ready them for registration, see <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-types.html">Creating Resource
|
|
40
|
+
* Providers</a> in the <i>CloudFormation CLI User Guide</i>.</p>
|
|
41
|
+
* <p>You can have a maximum of 50 resource extension versions registered at a time. This maximum is per account and
|
|
42
|
+
* per Region. Use <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DeregisterType.html">DeregisterType</a> to deregister specific extension versions if necessary.</p>
|
|
43
|
+
* <p>Once you have initiated a registration request using <a>RegisterType</a>, you can use <a>DescribeTypeRegistration</a> to monitor the progress of the registration request.</p>
|
|
44
|
+
* <p>Once you have registered a private extension in your account and Region, use <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_SetTypeConfiguration.html">SetTypeConfiguration</a> to specify
|
|
45
|
+
* configuration properties for the extension. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-register.html#registry-set-configuration">Configuring extensions at
|
|
46
|
+
* the account level</a> in the <i>CloudFormation User Guide</i>.</p>
|
|
53
47
|
* @example
|
|
54
48
|
* Use a bare-bones client and the command you need to make an API call.
|
|
55
49
|
* ```javascript
|
|
@@ -23,14 +23,12 @@ export interface RollbackStackCommandOutput extends RollbackStackOutput, __Metad
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>When specifying <code>RollbackStack</code>, you preserve the state of previously
|
|
27
|
-
*
|
|
28
|
-
*
|
|
29
|
-
*
|
|
30
|
-
*
|
|
31
|
-
*
|
|
32
|
-
* known stable state includes any status in a <code>*_COMPLETE</code>. This includes the
|
|
33
|
-
* following stack statuses.</p>
|
|
26
|
+
* <p>When specifying <code>RollbackStack</code>, you preserve the state of previously provisioned resources when an
|
|
27
|
+
* operation fails. You can check the status of the stack through the <a>DescribeStacks</a> operation.</p>
|
|
28
|
+
* <p>Rolls back the specified stack to the last known stable state from <code>CREATE_FAILED</code> or
|
|
29
|
+
* <code>UPDATE_FAILED</code> stack statuses.</p>
|
|
30
|
+
* <p>This operation will delete a stack if it doesn't contain a last known stable state. A last known stable state
|
|
31
|
+
* includes any status in a <code>*_COMPLETE</code>. This includes the following stack statuses.</p>
|
|
34
32
|
* <ul>
|
|
35
33
|
* <li>
|
|
36
34
|
* <p>
|
|
@@ -23,17 +23,16 @@ export interface SetTypeConfigurationCommandOutput extends SetTypeConfigurationO
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Specifies the configuration data for a registered CloudFormation extension, in
|
|
27
|
-
*
|
|
28
|
-
* <p>To view the current configuration data for an extension, refer to the
|
|
29
|
-
*
|
|
30
|
-
*
|
|
31
|
-
* <i>CloudFormation User Guide</i>.</p>
|
|
26
|
+
* <p>Specifies the configuration data for a registered CloudFormation extension, in the given account and
|
|
27
|
+
* Region.</p>
|
|
28
|
+
* <p>To view the current configuration data for an extension, refer to the <code>ConfigurationSchema</code> element
|
|
29
|
+
* of <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DescribeType.html">DescribeType</a>. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-register.html#registry-set-configuration">Configuring extensions at
|
|
30
|
+
* the account level</a> in the <i>CloudFormation User Guide</i>.</p>
|
|
32
31
|
* <important>
|
|
33
|
-
* <p>It's strongly recommended that you use dynamic references to restrict sensitive
|
|
34
|
-
*
|
|
35
|
-
*
|
|
36
|
-
*
|
|
32
|
+
* <p>It's strongly recommended that you use dynamic references to restrict sensitive configuration definitions, such
|
|
33
|
+
* as third-party credentials. For more details on dynamic references, see <a href="https://docs.aws.amazon.com/">Using
|
|
34
|
+
* dynamic references to specify template values</a> in the <i>CloudFormation User
|
|
35
|
+
* Guide</i>.</p>
|
|
37
36
|
* </important>
|
|
38
37
|
* @example
|
|
39
38
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -23,8 +23,7 @@ export interface SetTypeDefaultVersionCommandOutput extends SetTypeDefaultVersio
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Specify the default version of an extension. The default version of an extension will be
|
|
27
|
-
* used in CloudFormation operations.</p>
|
|
26
|
+
* <p>Specify the default version of an extension. The default version of an extension will be used in CloudFormation operations.</p>
|
|
28
27
|
* @example
|
|
29
28
|
* Use a bare-bones client and the command you need to make an API call.
|
|
30
29
|
* ```javascript
|
|
@@ -24,11 +24,10 @@ export interface SignalResourceCommandOutput extends __MetadataBearer {
|
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
26
|
* <p>Sends a signal to the specified resource with a success or failure status. You can use the
|
|
27
|
-
*
|
|
28
|
-
*
|
|
29
|
-
*
|
|
30
|
-
*
|
|
31
|
-
* anywhere other than an Amazon EC2 instance.</p>
|
|
27
|
+
* <code>SignalResource</code> operation in conjunction with a creation policy or update policy. CloudFormation
|
|
28
|
+
* doesn't proceed with a stack creation or update until resources receive the required number of signals or the timeout
|
|
29
|
+
* period is exceeded. The <code>SignalResource</code> operation is useful in cases where you want to send signals from
|
|
30
|
+
* anywhere other than an Amazon EC2 instance.</p>
|
|
32
31
|
* @example
|
|
33
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
33
|
* ```javascript
|
|
@@ -23,30 +23,28 @@ export interface TestTypeCommandOutput extends TestTypeOutput, __MetadataBearer
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Tests a registered extension to make sure it meets all necessary requirements for being
|
|
27
|
-
* published in the CloudFormation registry.</p>
|
|
26
|
+
* <p>Tests a registered extension to make sure it meets all necessary requirements for being published in the CloudFormation registry.</p>
|
|
28
27
|
* <ul>
|
|
29
28
|
* <li>
|
|
30
|
-
* <p>For resource types, this includes passing all contracts tests defined for the
|
|
31
|
-
* type.</p>
|
|
29
|
+
* <p>For resource types, this includes passing all contracts tests defined for the type.</p>
|
|
32
30
|
* </li>
|
|
33
31
|
* <li>
|
|
34
|
-
* <p>For modules, this includes determining if the module's model meets all necessary
|
|
35
|
-
* requirements.</p>
|
|
32
|
+
* <p>For modules, this includes determining if the module's model meets all necessary requirements.</p>
|
|
36
33
|
* </li>
|
|
37
34
|
* </ul>
|
|
38
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.html#publish-extension-testing">Testing your public
|
|
39
|
-
*
|
|
40
|
-
*
|
|
41
|
-
*
|
|
42
|
-
*
|
|
43
|
-
*
|
|
44
|
-
*
|
|
45
|
-
*
|
|
46
|
-
*
|
|
47
|
-
*
|
|
48
|
-
*
|
|
49
|
-
*
|
|
35
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.html#publish-extension-testing">Testing your public
|
|
36
|
+
* extension prior to publishing</a> in the <i>CloudFormation CLI User Guide</i>.</p>
|
|
37
|
+
* <p>If you don't specify a version, CloudFormation uses the default version of the extension in your
|
|
38
|
+
* account and Region for testing.</p>
|
|
39
|
+
* <p>To perform testing, CloudFormation assumes the execution role specified when the type was registered.
|
|
40
|
+
* For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterType.html">RegisterType</a>.</p>
|
|
41
|
+
* <p>Once you've initiated testing on an extension using <code>TestType</code>, you can pass the returned
|
|
42
|
+
* <code>TypeVersionArn</code> into <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DescribeType.html">DescribeType</a> to monitor the current test
|
|
43
|
+
* status and test status description for the extension.</p>
|
|
44
|
+
* <p>An extension must have a test status of <code>PASSED</code> before it can be published. For more information,
|
|
45
|
+
* see <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-publish.html">Publishing
|
|
46
|
+
* extensions to make them available for public use</a> in the <i>CloudFormation CLI User
|
|
47
|
+
* Guide</i>.</p>
|
|
50
48
|
* @example
|
|
51
49
|
* Use a bare-bones client and the command you need to make an API call.
|
|
52
50
|
* ```javascript
|
|
@@ -23,12 +23,12 @@ export interface UpdateStackCommandOutput extends UpdateStackOutput, __MetadataB
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Updates a stack as specified in the template. After the call completes successfully, the
|
|
27
|
-
*
|
|
28
|
-
* <p>To get a copy of the template for an existing stack, you can use the <a>GetTemplate</a>
|
|
29
|
-
*
|
|
30
|
-
*
|
|
31
|
-
*
|
|
26
|
+
* <p>Updates a stack as specified in the template. After the call completes successfully, the stack update starts.
|
|
27
|
+
* You can check the status of the stack through the <a>DescribeStacks</a> action.</p>
|
|
28
|
+
* <p>To get a copy of the template for an existing stack, you can use the <a>GetTemplate</a>
|
|
29
|
+
* action.</p>
|
|
30
|
+
* <p>For more information about creating an update template, updating a stack, and monitoring the progress of the
|
|
31
|
+
* update, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks.html">Updating a Stack</a>.</p>
|
|
32
32
|
* @example
|
|
33
33
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
34
|
* ```javascript
|
|
@@ -23,13 +23,12 @@ export interface UpdateTerminationProtectionCommandOutput extends UpdateTerminat
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Updates termination protection for the specified stack. If a user attempts to delete a
|
|
27
|
-
*
|
|
28
|
-
*
|
|
29
|
-
*
|
|
30
|
-
*
|
|
31
|
-
*
|
|
32
|
-
* stack.</p>
|
|
26
|
+
* <p>Updates termination protection for the specified stack. If a user attempts to delete a stack with termination
|
|
27
|
+
* protection enabled, the operation fails and the stack remains unchanged. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-protect-stacks.html">Protecting a Stack From
|
|
28
|
+
* Being Deleted</a> in the <i>CloudFormation User Guide</i>.</p>
|
|
29
|
+
* <p>For <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html">nested
|
|
30
|
+
* stacks</a>, termination protection is set on the root stack and can't be changed directly on the nested
|
|
31
|
+
* stack.</p>
|
|
33
32
|
* @example
|
|
34
33
|
* Use a bare-bones client and the command you need to make an API call.
|
|
35
34
|
* ```javascript
|