@aws-sdk/client-cloudformation 3.347.1 → 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 +4 -4
package/README.md
CHANGED
|
@@ -16,9 +16,7 @@ defines a collection of resources as a single unit called a stack. CloudFormatio
|
|
|
16
16
|
resources of the stack together and manages all dependencies between the resources for you.</p>
|
|
17
17
|
<p>For more information about CloudFormation, see the <a href="http://aws.amazon.com/cloudformation/">CloudFormation product page</a>.</p>
|
|
18
18
|
<p>CloudFormation makes use of other Amazon Web Services products. If you need additional technical information
|
|
19
|
-
about a specific Amazon Web Services product, you can find the product's technical documentation at <a href="https://docs.aws.amazon.com/">
|
|
20
|
-
<code>docs.aws.amazon.com</code>
|
|
21
|
-
</a>.</p>
|
|
19
|
+
about a specific Amazon Web Services product, you can find the product's technical documentation at <a href="https://docs.aws.amazon.com/">docs.aws.amazon.com</a>.</p>
|
|
22
20
|
|
|
23
21
|
## Installing
|
|
24
22
|
|
|
@@ -424,6 +424,7 @@ export const StackInstanceDetailedStatus = {
|
|
|
424
424
|
INOPERABLE: "INOPERABLE",
|
|
425
425
|
PENDING: "PENDING",
|
|
426
426
|
RUNNING: "RUNNING",
|
|
427
|
+
SKIPPED_SUSPENDED_ACCOUNT: "SKIPPED_SUSPENDED_ACCOUNT",
|
|
427
428
|
SUCCEEDED: "SUCCEEDED",
|
|
428
429
|
};
|
|
429
430
|
export const StackInstanceStatus = {
|
|
@@ -496,9 +496,7 @@ export interface CloudFormation {
|
|
|
496
496
|
* resources of the stack together and manages all dependencies between the resources for you.</p>
|
|
497
497
|
* <p>For more information about CloudFormation, see the <a href="http://aws.amazon.com/cloudformation/">CloudFormation product page</a>.</p>
|
|
498
498
|
* <p>CloudFormation makes use of other Amazon Web Services products. If you need additional technical information
|
|
499
|
-
* about a specific Amazon Web Services product, you can find the product's technical documentation at <a href="https://docs.aws.amazon.com/">
|
|
500
|
-
* <code>docs.aws.amazon.com</code>
|
|
501
|
-
* </a>.</p>
|
|
499
|
+
* about a specific Amazon Web Services product, you can find the product's technical documentation at <a href="https://docs.aws.amazon.com/">docs.aws.amazon.com</a>.</p>
|
|
502
500
|
*/
|
|
503
501
|
export declare class CloudFormation extends CloudFormationClient implements CloudFormation {
|
|
504
502
|
}
|
|
@@ -223,9 +223,7 @@ export interface CloudFormationClientResolvedConfig extends CloudFormationClient
|
|
|
223
223
|
* resources of the stack together and manages all dependencies between the resources for you.</p>
|
|
224
224
|
* <p>For more information about CloudFormation, see the <a href="http://aws.amazon.com/cloudformation/">CloudFormation product page</a>.</p>
|
|
225
225
|
* <p>CloudFormation makes use of other Amazon Web Services products. If you need additional technical information
|
|
226
|
-
* about a specific Amazon Web Services product, you can find the product's technical documentation at <a href="https://docs.aws.amazon.com/">
|
|
227
|
-
* <code>docs.aws.amazon.com</code>
|
|
228
|
-
* </a>.</p>
|
|
226
|
+
* about a specific Amazon Web Services product, you can find the product's technical documentation at <a href="https://docs.aws.amazon.com/">docs.aws.amazon.com</a>.</p>
|
|
229
227
|
*/
|
|
230
228
|
export declare class CloudFormationClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, CloudFormationClientResolvedConfig> {
|
|
231
229
|
/**
|
|
@@ -23,12 +23,12 @@ export interface ActivateTypeCommandOutput extends ActivateTypeOutput, __Metadat
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Activates a public third-party extension, making it available for use in stack templates.
|
|
27
|
-
*
|
|
28
|
-
*
|
|
29
|
-
* <p>Once you have activated a public third-party extension in your account and Region, use
|
|
30
|
-
*
|
|
31
|
-
*
|
|
26
|
+
* <p>Activates a public third-party extension, making it available for use in stack templates. For more information,
|
|
27
|
+
* see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html">Using public
|
|
28
|
+
* extensions</a> in the <i>CloudFormation User Guide</i>.</p>
|
|
29
|
+
* <p>Once you have activated a public third-party 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 more information, see
|
|
30
|
+
* <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-register.html#registry-set-configuration">Configuring extensions at
|
|
31
|
+
* the account level</a> in the <i>CloudFormation User Guide</i>.</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,10 +23,9 @@ export interface BatchDescribeTypeConfigurationsCommandOutput extends BatchDescr
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Returns configuration data for the specified CloudFormation extensions, from the
|
|
27
|
-
*
|
|
28
|
-
*
|
|
29
|
-
* <i>CloudFormation User Guide</i>.</p>
|
|
26
|
+
* <p>Returns configuration data for the specified CloudFormation extensions, from the CloudFormation registry for the account and Region.</p>
|
|
27
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-register.html#registry-set-configuration">Configuring extensions at
|
|
28
|
+
* the account level</a> in the <i>CloudFormation User Guide</i>.</p>
|
|
30
29
|
* @example
|
|
31
30
|
* Use a bare-bones client and the command you need to make an API call.
|
|
32
31
|
* ```javascript
|
|
@@ -23,8 +23,8 @@ export interface CancelUpdateStackCommandOutput extends __MetadataBearer {
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Cancels an update on the specified stack. If the call completes successfully, the stack
|
|
27
|
-
*
|
|
26
|
+
* <p>Cancels an update on the specified stack. If the call completes successfully, the stack rolls back the update
|
|
27
|
+
* and reverts to the previous stack configuration.</p>
|
|
28
28
|
* <note>
|
|
29
29
|
* <p>You can cancel only stacks that are in the <code>UPDATE_IN_PROGRESS</code> state.</p>
|
|
30
30
|
* </note>
|
|
@@ -23,15 +23,15 @@ export interface ContinueUpdateRollbackCommandOutput extends ContinueUpdateRollb
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>For a specified stack that's in the <code>UPDATE_ROLLBACK_FAILED</code> state, continues
|
|
27
|
-
*
|
|
28
|
-
*
|
|
29
|
-
*
|
|
30
|
-
*
|
|
31
|
-
*
|
|
32
|
-
*
|
|
33
|
-
*
|
|
34
|
-
*
|
|
26
|
+
* <p>For a specified stack that's in the <code>UPDATE_ROLLBACK_FAILED</code> state, continues rolling it back to the
|
|
27
|
+
* <code>UPDATE_ROLLBACK_COMPLETE</code> state. Depending on the cause of the failure, you can manually <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/troubleshooting.html#troubleshooting-errors-update-rollback-failed"> fix the
|
|
28
|
+
* error</a> and continue the rollback. By continuing the rollback, you can return your stack to a working state
|
|
29
|
+
* (the <code>UPDATE_ROLLBACK_COMPLETE</code> state), and then try to update the stack again.</p>
|
|
30
|
+
* <p>A stack goes into the <code>UPDATE_ROLLBACK_FAILED</code> state when CloudFormation can't roll back all
|
|
31
|
+
* changes after a failed stack update. For example, you might have a stack that's rolling back to an old database
|
|
32
|
+
* instance that was deleted outside of CloudFormation. Because CloudFormation doesn't know the database was
|
|
33
|
+
* deleted, it assumes that the database instance still exists and attempts to roll back to it, causing the update
|
|
34
|
+
* rollback to fail.</p>
|
|
35
35
|
* @example
|
|
36
36
|
* Use a bare-bones client and the command you need to make an API call.
|
|
37
37
|
* ```javascript
|
|
@@ -23,25 +23,22 @@ export interface CreateChangeSetCommandOutput extends CreateChangeSetOutput, __M
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Creates a list of changes that will be applied to a stack so that you can review the
|
|
27
|
-
*
|
|
28
|
-
*
|
|
29
|
-
*
|
|
30
|
-
*
|
|
31
|
-
*
|
|
32
|
-
*
|
|
33
|
-
*
|
|
34
|
-
*
|
|
35
|
-
*
|
|
36
|
-
*
|
|
37
|
-
*
|
|
38
|
-
*
|
|
39
|
-
*
|
|
40
|
-
* <p>
|
|
41
|
-
*
|
|
42
|
-
* changes until you execute the change set.</p>
|
|
43
|
-
* <p>To create a change set for the entire stack hierarchy, set
|
|
44
|
-
* <code>IncludeNestedStacks</code> to <code>True</code>.</p>
|
|
26
|
+
* <p>Creates a list of changes that will be applied to a stack so that you can review the changes before executing
|
|
27
|
+
* them. You can create a change set for a stack that doesn't exist or an existing stack. If you create a change set for
|
|
28
|
+
* a stack that doesn't exist, the change set shows all of the resources that CloudFormation will create. If you
|
|
29
|
+
* create a change set for an existing stack, CloudFormation compares the stack's information with the information
|
|
30
|
+
* that you submit in the change set and lists the differences. Use change sets to understand which resources CloudFormation will create or change, and how it will change resources in an existing stack, before you create or update
|
|
31
|
+
* a stack.</p>
|
|
32
|
+
* <p>To create a change set for a stack that doesn't exist, for the <code>ChangeSetType</code> parameter, specify
|
|
33
|
+
* <code>CREATE</code>. To create a change set for an existing stack, specify <code>UPDATE</code> for the
|
|
34
|
+
* <code>ChangeSetType</code> parameter. To create a change set for an import operation, specify <code>IMPORT</code>
|
|
35
|
+
* for the <code>ChangeSetType</code> parameter. After the <code>CreateChangeSet</code> call successfully completes,
|
|
36
|
+
* CloudFormation starts creating the change set. To check the status of the change set or to review it, use the
|
|
37
|
+
* <a>DescribeChangeSet</a> action.</p>
|
|
38
|
+
* <p>When you are satisfied with the changes the change set will make, execute the change set by using the <a>ExecuteChangeSet</a> action. CloudFormation doesn't make changes until you execute the change
|
|
39
|
+
* set.</p>
|
|
40
|
+
* <p>To create a change set for the entire stack hierarchy, set <code>IncludeNestedStacks</code> to
|
|
41
|
+
* <code>True</code>.</p>
|
|
45
42
|
* @example
|
|
46
43
|
* Use a bare-bones client and the command you need to make an API call.
|
|
47
44
|
* ```javascript
|
|
@@ -23,8 +23,8 @@ export interface CreateStackCommandOutput extends CreateStackOutput, __MetadataB
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Creates a stack as specified in the template. After the call completes successfully, the
|
|
27
|
-
*
|
|
26
|
+
* <p>Creates a stack as specified in the template. After the call completes successfully, the stack creation starts.
|
|
27
|
+
* You can check the status of the stack through the <a>DescribeStacks</a> operation.</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,12 +23,11 @@ export interface DeactivateTypeCommandOutput extends DeactivateTypeOutput, __Met
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Deactivates a public extension that was previously activated in this account and
|
|
27
|
-
*
|
|
28
|
-
*
|
|
29
|
-
*
|
|
30
|
-
*
|
|
31
|
-
* automatically updated if a new version of the extension is released.</p>
|
|
26
|
+
* <p>Deactivates a public extension that was previously activated in this account and Region.</p>
|
|
27
|
+
* <p>Once deactivated, an extension can't be used in any CloudFormation operation. This includes stack
|
|
28
|
+
* update operations where the stack template includes the extension, even if no updates are being made to the
|
|
29
|
+
* extension. In addition, deactivated extensions aren't automatically updated if a new version of the extension is
|
|
30
|
+
* released.</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,14 +23,11 @@ export interface DeleteChangeSetCommandOutput extends DeleteChangeSetOutput, __M
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Deletes the specified change set. Deleting change sets ensures that no one executes the
|
|
27
|
-
*
|
|
28
|
-
* <p>If
|
|
29
|
-
*
|
|
30
|
-
*
|
|
31
|
-
* nested change set, then <code>DeleteChangeSet</code> will delete all change sets that belong
|
|
32
|
-
* to the stacks hierarchy and will also delete all change sets for nested stacks with the status
|
|
33
|
-
* of <code>REVIEW_IN_PROGRESS</code>.</p>
|
|
26
|
+
* <p>Deletes the specified change set. Deleting change sets ensures that no one executes the wrong change set.</p>
|
|
27
|
+
* <p>If the call successfully completes, CloudFormation successfully deleted the change set.</p>
|
|
28
|
+
* <p>If <code>IncludeNestedStacks</code> specifies <code>True</code> during the creation of the nested change set,
|
|
29
|
+
* then <code>DeleteChangeSet</code> will delete all change sets that belong to the stacks hierarchy and will also
|
|
30
|
+
* delete all change sets for nested stacks with the status of <code>REVIEW_IN_PROGRESS</code>.</p>
|
|
34
31
|
* @example
|
|
35
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
36
33
|
* ```javascript
|
|
@@ -23,9 +23,8 @@ export interface DeleteStackCommandOutput extends __MetadataBearer {
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Deletes a specified stack. Once the call completes successfully, stack deletion starts.
|
|
27
|
-
*
|
|
28
|
-
* has been completed successfully.</p>
|
|
26
|
+
* <p>Deletes a specified stack. Once the call completes successfully, stack deletion starts. Deleted stacks don't
|
|
27
|
+
* show up in the <a>DescribeStacks</a> operation if the deletion has been completed successfully.</p>
|
|
29
28
|
* @example
|
|
30
29
|
* Use a bare-bones client and the command you need to make an API call.
|
|
31
30
|
* ```javascript
|
|
@@ -23,15 +23,15 @@ export interface DeregisterTypeCommandOutput extends DeregisterTypeOutput, __Met
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Marks an extension or extension version as <code>DEPRECATED</code> in the CloudFormation registry,
|
|
27
|
-
*
|
|
28
|
-
*
|
|
29
|
-
*
|
|
30
|
-
*
|
|
31
|
-
*
|
|
32
|
-
* <p>You can't deregister the default version of an extension if there are other active version
|
|
33
|
-
*
|
|
34
|
-
*
|
|
26
|
+
* <p>Marks an extension or extension version as <code>DEPRECATED</code> in the CloudFormation registry,
|
|
27
|
+
* removing it from active use. Deprecated extensions or extension versions cannot be used in CloudFormation
|
|
28
|
+
* operations.</p>
|
|
29
|
+
* <p>To deregister an entire extension, you must individually deregister all active versions of that extension. If an
|
|
30
|
+
* extension has only a single active version, deregistering that version results in the extension itself being
|
|
31
|
+
* deregistered and marked as deprecated in the registry.</p>
|
|
32
|
+
* <p>You can't deregister the default version of an extension if there are other active version of that extension. If
|
|
33
|
+
* you do deregister the default version of an extension, the extension type itself is deregistered as well and marked
|
|
34
|
+
* as deprecated.</p>
|
|
35
35
|
* <p>To view the deprecation status of an extension or extension version, use <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DescribeType.html">DescribeType</a>.</p>
|
|
36
36
|
* @example
|
|
37
37
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -23,8 +23,9 @@ export interface DescribeAccountLimitsCommandOutput extends DescribeAccountLimit
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Retrieves your account's CloudFormation limits, such as the maximum number of stacks
|
|
27
|
-
*
|
|
26
|
+
* <p>Retrieves your account's CloudFormation limits, such as the maximum number of stacks that you can create in
|
|
27
|
+
* your account. For more information about account limits, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cloudformation-limits.html">CloudFormation Quotas</a> in the
|
|
28
|
+
* <i>CloudFormation User Guide</i>.</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,9 +23,9 @@ export interface DescribeChangeSetCommandOutput extends DescribeChangeSetOutput,
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Returns the inputs for the change set and a list of changes that CloudFormation will
|
|
27
|
-
*
|
|
28
|
-
*
|
|
26
|
+
* <p>Returns the inputs for the change set and a list of changes that CloudFormation will make if you execute the
|
|
27
|
+
* change set. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-changesets.html">Updating Stacks Using Change
|
|
28
|
+
* Sets</a> in the CloudFormation User Guide.</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,7 +23,8 @@ export interface DescribeChangeSetHooksCommandOutput extends DescribeChangeSetHo
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Returns hook-related information for the change set and a list of changes that CloudFormation makes when you
|
|
26
|
+
* <p>Returns hook-related information for the change set and a list of changes that CloudFormation makes when you
|
|
27
|
+
* run the change set.</p>
|
|
27
28
|
* @example
|
|
28
29
|
* Use a bare-bones client and the command you need to make an API call.
|
|
29
30
|
* ```javascript
|
|
@@ -25,7 +25,7 @@ export interface DescribeOrganizationsAccessCommandOutput extends DescribeOrgani
|
|
|
25
25
|
* @public
|
|
26
26
|
* <p>Retrieves information about the account's <code>OrganizationAccess</code> status. This API
|
|
27
27
|
* can be called either by the management account or the delegated administrator by using the
|
|
28
|
-
*
|
|
28
|
+
* <code>CallAs</code> parameter. This API can also be called without the <code>CallAs</code>
|
|
29
29
|
* parameter by the management account.</p>
|
|
30
30
|
* @example
|
|
31
31
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -24,9 +24,8 @@ export interface DescribePublisherCommandOutput extends DescribePublisherOutput,
|
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
26
|
* <p>Returns information about a CloudFormation extension publisher.</p>
|
|
27
|
-
* <p>If you don't supply a <code>PublisherId</code>, and you have registered as an extension
|
|
28
|
-
*
|
|
29
|
-
* account.</p>
|
|
27
|
+
* <p>If you don't supply a <code>PublisherId</code>, and you have registered as an extension publisher,
|
|
28
|
+
* <code>DescribePublisher</code> returns information about your own publisher account.</p>
|
|
30
29
|
* <p>For more information about registering as a publisher, see:</p>
|
|
31
30
|
* <ul>
|
|
32
31
|
* <li>
|
|
@@ -36,9 +35,9 @@ export interface DescribePublisherCommandOutput extends DescribePublisherOutput,
|
|
|
36
35
|
* </li>
|
|
37
36
|
* <li>
|
|
38
37
|
* <p>
|
|
39
|
-
* <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.html">Publishing
|
|
40
|
-
*
|
|
41
|
-
*
|
|
38
|
+
* <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.html">Publishing
|
|
39
|
+
* extensions to make them available for public use</a> in the <i>CloudFormation CLI User
|
|
40
|
+
* Guide</i>
|
|
42
41
|
* </p>
|
|
43
42
|
* </li>
|
|
44
43
|
* </ul>
|
|
@@ -23,18 +23,16 @@ export interface DescribeStackDriftDetectionStatusCommandOutput extends Describe
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Returns information about a stack drift detection operation. A stack drift detection
|
|
27
|
-
*
|
|
28
|
-
*
|
|
29
|
-
*
|
|
30
|
-
*
|
|
31
|
-
* resource drift, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html">Detecting Unregulated
|
|
32
|
-
* Configuration Changes to Stacks and Resources</a>.</p>
|
|
26
|
+
* <p>Returns information about a stack drift detection operation. A stack drift detection operation detects whether a
|
|
27
|
+
* stack's actual configuration differs, or has <i>drifted</i>, from its expected configuration, as
|
|
28
|
+
* defined in the stack template and any values specified as template parameters. A stack is considered to have drifted
|
|
29
|
+
* if one or more of its resources have drifted. 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
|
|
30
|
+
* Configuration Changes to Stacks and Resources</a>.</p>
|
|
33
31
|
* <p>Use <a>DetectStackDrift</a> to initiate a stack drift detection operation.
|
|
34
|
-
*
|
|
35
|
-
*
|
|
36
|
-
*
|
|
37
|
-
*
|
|
32
|
+
* <code>DetectStackDrift</code> returns a <code>StackDriftDetectionId</code> you can use to monitor the progress of
|
|
33
|
+
* the operation using <code>DescribeStackDriftDetectionStatus</code>. Once the drift detection operation has completed,
|
|
34
|
+
* use <a>DescribeStackResourceDrifts</a> to return drift information about the stack and its
|
|
35
|
+
* resources.</p>
|
|
38
36
|
* @example
|
|
39
37
|
* Use a bare-bones client and the command you need to make an API call.
|
|
40
38
|
* ```javascript
|
|
@@ -23,12 +23,11 @@ export interface DescribeStackEventsCommandOutput extends DescribeStackEventsOut
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Returns all stack related events for a specified stack in reverse chronological order. For
|
|
27
|
-
*
|
|
28
|
-
* CloudFormation User Guide.</p>
|
|
26
|
+
* <p>Returns all stack related events for a specified stack in reverse chronological order. For more information
|
|
27
|
+
* 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 CloudFormation User Guide.</p>
|
|
29
28
|
* <note>
|
|
30
|
-
* <p>You can list events for stacks that have failed to create or have been deleted by
|
|
31
|
-
*
|
|
29
|
+
* <p>You can list events for stacks that have failed to create or have been deleted by specifying the unique stack
|
|
30
|
+
* identifier (stack ID).</p>
|
|
32
31
|
* </note>
|
|
33
32
|
* @example
|
|
34
33
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -56,7 +56,7 @@ export interface DescribeStackInstanceCommandOutput extends DescribeStackInstanc
|
|
|
56
56
|
* // ],
|
|
57
57
|
* // Status: "CURRENT" || "OUTDATED" || "INOPERABLE",
|
|
58
58
|
* // StackInstanceStatus: { // StackInstanceComprehensiveStatus
|
|
59
|
-
* // DetailedStatus: "PENDING" || "RUNNING" || "SUCCEEDED" || "FAILED" || "CANCELLED" || "INOPERABLE",
|
|
59
|
+
* // DetailedStatus: "PENDING" || "RUNNING" || "SUCCEEDED" || "FAILED" || "CANCELLED" || "INOPERABLE" || "SKIPPED_SUSPENDED_ACCOUNT",
|
|
60
60
|
* // },
|
|
61
61
|
* // StatusReason: "STRING_VALUE",
|
|
62
62
|
* // OrganizationalUnitId: "STRING_VALUE",
|
|
@@ -24,8 +24,8 @@ export interface DescribeStackResourceCommandOutput extends DescribeStackResourc
|
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
26
|
* <p>Returns a description of the specified resource in the specified stack.</p>
|
|
27
|
-
* <p>For deleted stacks, DescribeStackResource returns resource information for up to 90 days
|
|
28
|
-
*
|
|
27
|
+
* <p>For deleted stacks, DescribeStackResource returns resource information for up to 90 days after the stack has
|
|
28
|
+
* been 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,17 +23,13 @@ export interface DescribeStackResourceDriftsCommandOutput extends DescribeStackR
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Returns drift information for the resources that have been checked for drift in the
|
|
27
|
-
*
|
|
28
|
-
*
|
|
29
|
-
*
|
|
30
|
-
*
|
|
31
|
-
*
|
|
32
|
-
*
|
|
33
|
-
* that Support Drift Detection</a>.</p>
|
|
34
|
-
* <p>Use <a>DetectStackResourceDrift</a> to detect drift on individual resources, or
|
|
35
|
-
* <a>DetectStackDrift</a> to detect drift on all supported resources for a given
|
|
36
|
-
* stack.</p>
|
|
26
|
+
* <p>Returns drift information for the resources that have been checked for drift in the specified stack. This
|
|
27
|
+
* includes actual and expected configuration values for resources where CloudFormation detects configuration drift.</p>
|
|
28
|
+
* <p>For a given stack, there will be one <code>StackResourceDrift</code> for each stack resource that has been
|
|
29
|
+
* checked for drift. Resources that haven't yet been checked for drift aren't included. Resources that don't currently
|
|
30
|
+
* support drift detection aren't checked, and so not included. For a list of resources that support drift detection,
|
|
31
|
+
* see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift-resource-list.html">Resources that Support Drift Detection</a>.</p>
|
|
32
|
+
* <p>Use <a>DetectStackResourceDrift</a> to detect drift on individual resources, or <a>DetectStackDrift</a> to detect drift on all supported resources for a given stack.</p>
|
|
37
33
|
* @example
|
|
38
34
|
* Use a bare-bones client and the command you need to make an API call.
|
|
39
35
|
* ```javascript
|
|
@@ -23,23 +23,21 @@ export interface DescribeStackResourcesCommandOutput extends DescribeStackResour
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Returns Amazon Web Services resource descriptions for running and deleted stacks. If
|
|
27
|
-
*
|
|
28
|
-
*
|
|
29
|
-
* stack that the resource belongs to are returned.</p>
|
|
26
|
+
* <p>Returns Amazon Web Services resource descriptions for running and deleted stacks. If <code>StackName</code> is
|
|
27
|
+
* specified, all the associated resources that are part of the stack are returned. If <code>PhysicalResourceId</code>
|
|
28
|
+
* is specified, the associated resources of the stack that the resource belongs to are returned.</p>
|
|
30
29
|
* <note>
|
|
31
|
-
* <p>Only the first 100 resources will be returned. If your stack has more resources than
|
|
32
|
-
*
|
|
30
|
+
* <p>Only the first 100 resources will be returned. If your stack has more resources than this, you should use
|
|
31
|
+
* <code>ListStackResources</code> instead.</p>
|
|
33
32
|
* </note>
|
|
34
|
-
* <p>For deleted stacks, <code>DescribeStackResources</code> returns resource information for
|
|
35
|
-
*
|
|
36
|
-
* <p>You must specify either <code>StackName</code> or <code>PhysicalResourceId</code>, but not
|
|
37
|
-
*
|
|
38
|
-
*
|
|
39
|
-
* <code>PhysicalResourceId</code>, go to the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/">CloudFormation User Guide</a>.</p>
|
|
33
|
+
* <p>For deleted stacks, <code>DescribeStackResources</code> returns resource information for up to 90 days after the
|
|
34
|
+
* stack has been deleted.</p>
|
|
35
|
+
* <p>You must specify either <code>StackName</code> or <code>PhysicalResourceId</code>, but not both. In addition,
|
|
36
|
+
* you can specify <code>LogicalResourceId</code> to filter the returned result. For more information about resources,
|
|
37
|
+
* the <code>LogicalResourceId</code> and <code>PhysicalResourceId</code>, go to the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/">CloudFormation User Guide</a>.</p>
|
|
40
38
|
* <note>
|
|
41
|
-
* <p>A <code>ValidationError</code> is returned if you specify both <code>StackName</code>
|
|
42
|
-
*
|
|
39
|
+
* <p>A <code>ValidationError</code> is returned if you specify both <code>StackName</code> and
|
|
40
|
+
* <code>PhysicalResourceId</code> in the same request.</p>
|
|
43
41
|
* </note>
|
|
44
42
|
* @example
|
|
45
43
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -23,8 +23,8 @@ export interface DescribeStacksCommandOutput extends DescribeStacksOutput, __Met
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Returns the description for the specified stack; if no stack name was specified, then it
|
|
27
|
-
*
|
|
26
|
+
* <p>Returns the description for the specified stack; if no stack name was specified, then it returns the description
|
|
27
|
+
* for all the stacks created.</p>
|
|
28
28
|
* <note>
|
|
29
29
|
* <p>If the stack doesn't exist, an <code>ValidationError</code> is returned.</p>
|
|
30
30
|
* </note>
|
|
@@ -24,9 +24,8 @@ export interface DescribeTypeCommandOutput extends DescribeTypeOutput, __Metadat
|
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
26
|
* <p>Returns detailed information about an extension that has been registered.</p>
|
|
27
|
-
* <p>If you specify a <code>VersionId</code>, <code>DescribeType</code> returns information
|
|
28
|
-
*
|
|
29
|
-
* extension version.</p>
|
|
27
|
+
* <p>If you specify a <code>VersionId</code>, <code>DescribeType</code> returns information about that specific
|
|
28
|
+
* extension version. Otherwise, it returns information about the default extension version.</p>
|
|
30
29
|
* @example
|
|
31
30
|
* Use a bare-bones client and the command you need to make an API call.
|
|
32
31
|
* ```javascript
|
|
@@ -23,17 +23,11 @@ export interface DescribeTypeRegistrationCommandOutput extends DescribeTypeRegis
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Returns information about an extension's registration, including its current status and
|
|
27
|
-
*
|
|
28
|
-
* <p>When you initiate a registration request using <
|
|
29
|
-
*
|
|
30
|
-
*
|
|
31
|
-
* <a>DescribeTypeRegistration</a>
|
|
32
|
-
* </code> to monitor
|
|
33
|
-
* the progress of that registration request.</p>
|
|
34
|
-
* <p>Once the registration request has completed, use <code>
|
|
35
|
-
* <a>DescribeType</a>
|
|
36
|
-
* </code> to return detailed information about an extension.</p>
|
|
26
|
+
* <p>Returns information about an extension's registration, including its current status and type and version
|
|
27
|
+
* identifiers.</p>
|
|
28
|
+
* <p>When you initiate a registration request using <a>RegisterType</a>, you can then use <a>DescribeTypeRegistration</a> to monitor the progress of that registration request.</p>
|
|
29
|
+
* <p>Once the registration request has completed, use <a>DescribeType</a> to return detailed information
|
|
30
|
+
* about an extension.</p>
|
|
37
31
|
* @example
|
|
38
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
39
33
|
* ```javascript
|