@aws-sdk/client-cloudformation 3.312.0 → 3.316.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/dist-cjs/CloudFormation.js +70 -924
- package/dist-cjs/protocols/Aws_query.js +133 -198
- package/dist-es/CloudFormation.js +70 -924
- package/dist-es/protocols/Aws_query.js +134 -199
- package/dist-types/CloudFormation.d.ts +89 -597
- package/dist-types/ts3.4/CloudFormation.d.ts +4 -1
- package/package.json +6 -6
|
@@ -66,931 +66,423 @@ import { UpdateStackInstancesCommandInput, UpdateStackInstancesCommandOutput } f
|
|
|
66
66
|
import { UpdateStackSetCommandInput, UpdateStackSetCommandOutput } from "./commands/UpdateStackSetCommand";
|
|
67
67
|
import { UpdateTerminationProtectionCommandInput, UpdateTerminationProtectionCommandOutput } from "./commands/UpdateTerminationProtectionCommand";
|
|
68
68
|
import { ValidateTemplateCommandInput, ValidateTemplateCommandOutput } from "./commands/ValidateTemplateCommand";
|
|
69
|
-
|
|
70
|
-
* @public
|
|
71
|
-
* <fullname>CloudFormation</fullname>
|
|
72
|
-
* <p>CloudFormation allows you to create and manage Amazon Web Services infrastructure
|
|
73
|
-
* deployments predictably and repeatedly. You can use CloudFormation to leverage
|
|
74
|
-
* Amazon Web Services products, such as Amazon Elastic Compute Cloud, Amazon Elastic Block Store,
|
|
75
|
-
* Amazon Simple Notification Service, Elastic Load Balancing, and Auto Scaling to build highly
|
|
76
|
-
* reliable, highly scalable, cost-effective applications without creating or configuring the
|
|
77
|
-
* underlying Amazon Web Services infrastructure.</p>
|
|
78
|
-
* <p>With CloudFormation, you declare all your resources and dependencies in a template
|
|
79
|
-
* file. The template defines a collection of resources as a single unit called a stack.
|
|
80
|
-
* CloudFormation creates and deletes all member resources of the stack together and
|
|
81
|
-
* manages all dependencies between the resources for you.</p>
|
|
82
|
-
* <p>For more information about CloudFormation, see the <a href="http://aws.amazon.com/cloudformation/">CloudFormation product page</a>.</p>
|
|
83
|
-
* <p>CloudFormation makes use of other Amazon Web Services products. If you need
|
|
84
|
-
* additional technical information about a specific Amazon Web Services product, you can find
|
|
85
|
-
* the product's technical documentation at <a href="https://docs.aws.amazon.com/">
|
|
86
|
-
* <code>docs.aws.amazon.com</code>
|
|
87
|
-
* </a>.</p>
|
|
88
|
-
*/
|
|
89
|
-
export declare class CloudFormation extends CloudFormationClient {
|
|
69
|
+
export interface CloudFormation {
|
|
90
70
|
/**
|
|
91
|
-
* @
|
|
92
|
-
* <p>Activates a public third-party extension, making it available for use in stack
|
|
93
|
-
* templates. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-public.html">Using
|
|
94
|
-
* public extensions</a> in the <i>CloudFormation User Guide</i>.</p>
|
|
95
|
-
* <p>Once you have activated a public third-party extension in your account and region, use
|
|
96
|
-
* <a href="AWSCloudFormation/latest/APIReference/API_SetTypeConfiguration.html">SetTypeConfiguration</a> to specify configuration properties for the extension. For
|
|
97
|
-
* 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>
|
|
71
|
+
* @see {@link ActivateTypeCommand}
|
|
98
72
|
*/
|
|
99
73
|
activateType(args: ActivateTypeCommandInput, options?: __HttpHandlerOptions): Promise<ActivateTypeCommandOutput>;
|
|
100
74
|
activateType(args: ActivateTypeCommandInput, cb: (err: any, data?: ActivateTypeCommandOutput) => void): void;
|
|
101
75
|
activateType(args: ActivateTypeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ActivateTypeCommandOutput) => void): void;
|
|
102
76
|
/**
|
|
103
|
-
* @
|
|
104
|
-
* <p>Returns configuration data for the specified CloudFormation extensions, from
|
|
105
|
-
* the CloudFormation registry for the account and region.</p>
|
|
106
|
-
* <p>For 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
|
|
107
|
-
* <i>CloudFormation User Guide</i>.</p>
|
|
77
|
+
* @see {@link BatchDescribeTypeConfigurationsCommand}
|
|
108
78
|
*/
|
|
109
79
|
batchDescribeTypeConfigurations(args: BatchDescribeTypeConfigurationsCommandInput, options?: __HttpHandlerOptions): Promise<BatchDescribeTypeConfigurationsCommandOutput>;
|
|
110
80
|
batchDescribeTypeConfigurations(args: BatchDescribeTypeConfigurationsCommandInput, cb: (err: any, data?: BatchDescribeTypeConfigurationsCommandOutput) => void): void;
|
|
111
81
|
batchDescribeTypeConfigurations(args: BatchDescribeTypeConfigurationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchDescribeTypeConfigurationsCommandOutput) => void): void;
|
|
112
82
|
/**
|
|
113
|
-
* @
|
|
114
|
-
* <p>Cancels an update on the specified stack. If the call completes successfully, the stack
|
|
115
|
-
* rolls back the update and reverts to the previous stack configuration.</p>
|
|
116
|
-
* <note>
|
|
117
|
-
* <p>You can cancel only stacks that are in the <code>UPDATE_IN_PROGRESS</code>
|
|
118
|
-
* state.</p>
|
|
119
|
-
* </note>
|
|
83
|
+
* @see {@link CancelUpdateStackCommand}
|
|
120
84
|
*/
|
|
121
85
|
cancelUpdateStack(args: CancelUpdateStackCommandInput, options?: __HttpHandlerOptions): Promise<CancelUpdateStackCommandOutput>;
|
|
122
86
|
cancelUpdateStack(args: CancelUpdateStackCommandInput, cb: (err: any, data?: CancelUpdateStackCommandOutput) => void): void;
|
|
123
87
|
cancelUpdateStack(args: CancelUpdateStackCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelUpdateStackCommandOutput) => void): void;
|
|
124
88
|
/**
|
|
125
|
-
* @
|
|
126
|
-
* <p>For a specified stack that's in the <code>UPDATE_ROLLBACK_FAILED</code> state, continues
|
|
127
|
-
* rolling it back to the <code>UPDATE_ROLLBACK_COMPLETE</code> state. Depending on the cause
|
|
128
|
-
* 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 error</a> and continue the rollback. By continuing the rollback, you can
|
|
129
|
-
* return your stack to a working state (the <code>UPDATE_ROLLBACK_COMPLETE</code> state), and
|
|
130
|
-
* then try to update the stack again.</p>
|
|
131
|
-
* <p>A stack goes into the <code>UPDATE_ROLLBACK_FAILED</code> state when CloudFormation can't roll back all changes after a failed stack update. For example, you
|
|
132
|
-
* might have a stack that's rolling back to an old database instance that was deleted outside
|
|
133
|
-
* of CloudFormation. Because CloudFormation doesn't know the database was deleted, it
|
|
134
|
-
* assumes that the database instance still exists and attempts to roll back to it, causing
|
|
135
|
-
* the update rollback to fail.</p>
|
|
89
|
+
* @see {@link ContinueUpdateRollbackCommand}
|
|
136
90
|
*/
|
|
137
91
|
continueUpdateRollback(args: ContinueUpdateRollbackCommandInput, options?: __HttpHandlerOptions): Promise<ContinueUpdateRollbackCommandOutput>;
|
|
138
92
|
continueUpdateRollback(args: ContinueUpdateRollbackCommandInput, cb: (err: any, data?: ContinueUpdateRollbackCommandOutput) => void): void;
|
|
139
93
|
continueUpdateRollback(args: ContinueUpdateRollbackCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ContinueUpdateRollbackCommandOutput) => void): void;
|
|
140
94
|
/**
|
|
141
|
-
* @
|
|
142
|
-
* <p>Creates a list of changes that will be applied to a stack so that you can review the
|
|
143
|
-
* changes before executing them. You can create a change set for a stack that doesn't exist
|
|
144
|
-
* or an existing stack. If you create a change set for a stack that doesn't exist, the change
|
|
145
|
-
* set shows all of the resources that CloudFormation will create. If you create a change
|
|
146
|
-
* set for an existing stack, CloudFormation compares the stack's information with the
|
|
147
|
-
* information that you submit in the change set and lists the differences. Use change sets to
|
|
148
|
-
* understand which resources CloudFormation will create or change, and how it will change
|
|
149
|
-
* resources in an existing stack, before you create or update a stack.</p>
|
|
150
|
-
* <p>To create a change set for a stack that doesn't exist, for the
|
|
151
|
-
* <code>ChangeSetType</code> parameter, specify <code>CREATE</code>. To create a change
|
|
152
|
-
* set for an existing stack, specify <code>UPDATE</code> for the <code>ChangeSetType</code>
|
|
153
|
-
* parameter. To create a change set for an import operation, specify <code>IMPORT</code> for
|
|
154
|
-
* the <code>ChangeSetType</code> parameter. After the <code>CreateChangeSet</code> call
|
|
155
|
-
* successfully completes, CloudFormation starts creating the change set. To check the
|
|
156
|
-
* status of the change set or to review it, use the <a>DescribeChangeSet</a>
|
|
157
|
-
* action.</p>
|
|
158
|
-
* <p>When you are satisfied with the changes the change set will make, execute the change set
|
|
159
|
-
* by using the <a>ExecuteChangeSet</a> action. CloudFormation doesn't make
|
|
160
|
-
* changes until you execute the change set.</p>
|
|
161
|
-
* <p>To create a change set for the entire stack hierarchy, set
|
|
162
|
-
* <code>IncludeNestedStacks</code> to <code>True</code>.</p>
|
|
95
|
+
* @see {@link CreateChangeSetCommand}
|
|
163
96
|
*/
|
|
164
97
|
createChangeSet(args: CreateChangeSetCommandInput, options?: __HttpHandlerOptions): Promise<CreateChangeSetCommandOutput>;
|
|
165
98
|
createChangeSet(args: CreateChangeSetCommandInput, cb: (err: any, data?: CreateChangeSetCommandOutput) => void): void;
|
|
166
99
|
createChangeSet(args: CreateChangeSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateChangeSetCommandOutput) => void): void;
|
|
167
100
|
/**
|
|
168
|
-
* @
|
|
169
|
-
* <p>Creates a stack as specified in the template. After the call completes successfully, the
|
|
170
|
-
* stack creation starts. You can check the status of the stack through the <a>DescribeStacks</a>operation.</p>
|
|
101
|
+
* @see {@link CreateStackCommand}
|
|
171
102
|
*/
|
|
172
103
|
createStack(args: CreateStackCommandInput, options?: __HttpHandlerOptions): Promise<CreateStackCommandOutput>;
|
|
173
104
|
createStack(args: CreateStackCommandInput, cb: (err: any, data?: CreateStackCommandOutput) => void): void;
|
|
174
105
|
createStack(args: CreateStackCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateStackCommandOutput) => void): void;
|
|
175
106
|
/**
|
|
176
|
-
* @
|
|
177
|
-
* <p>Creates stack instances for the specified accounts, within the specified Amazon Web Services Regions. A stack instance refers to a stack in a specific account and Region.
|
|
178
|
-
* You must specify at least one value for either <code>Accounts</code> or
|
|
179
|
-
* <code>DeploymentTargets</code>, and you must specify at least one value for
|
|
180
|
-
* <code>Regions</code>.</p>
|
|
107
|
+
* @see {@link CreateStackInstancesCommand}
|
|
181
108
|
*/
|
|
182
109
|
createStackInstances(args: CreateStackInstancesCommandInput, options?: __HttpHandlerOptions): Promise<CreateStackInstancesCommandOutput>;
|
|
183
110
|
createStackInstances(args: CreateStackInstancesCommandInput, cb: (err: any, data?: CreateStackInstancesCommandOutput) => void): void;
|
|
184
111
|
createStackInstances(args: CreateStackInstancesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateStackInstancesCommandOutput) => void): void;
|
|
185
112
|
/**
|
|
186
|
-
* @
|
|
187
|
-
* <p>Creates a stack set.</p>
|
|
113
|
+
* @see {@link CreateStackSetCommand}
|
|
188
114
|
*/
|
|
189
115
|
createStackSet(args: CreateStackSetCommandInput, options?: __HttpHandlerOptions): Promise<CreateStackSetCommandOutput>;
|
|
190
116
|
createStackSet(args: CreateStackSetCommandInput, cb: (err: any, data?: CreateStackSetCommandOutput) => void): void;
|
|
191
117
|
createStackSet(args: CreateStackSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateStackSetCommandOutput) => void): void;
|
|
192
118
|
/**
|
|
193
|
-
* @
|
|
194
|
-
* <p>Deactivates a public extension that was previously activated in this account and
|
|
195
|
-
* region.</p>
|
|
196
|
-
* <p>Once deactivated, an extension can't be used in any CloudFormation operation.
|
|
197
|
-
* This includes stack update operations where the stack template includes the extension, even
|
|
198
|
-
* if no updates are being made to the extension. In addition, deactivated extensions aren't
|
|
199
|
-
* automatically updated if a new version of the extension is released.</p>
|
|
119
|
+
* @see {@link DeactivateTypeCommand}
|
|
200
120
|
*/
|
|
201
121
|
deactivateType(args: DeactivateTypeCommandInput, options?: __HttpHandlerOptions): Promise<DeactivateTypeCommandOutput>;
|
|
202
122
|
deactivateType(args: DeactivateTypeCommandInput, cb: (err: any, data?: DeactivateTypeCommandOutput) => void): void;
|
|
203
123
|
deactivateType(args: DeactivateTypeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeactivateTypeCommandOutput) => void): void;
|
|
204
124
|
/**
|
|
205
|
-
* @
|
|
206
|
-
* <p>Deletes the specified change set. Deleting change sets ensures that no one executes the
|
|
207
|
-
* wrong change set.</p>
|
|
208
|
-
* <p>If the call successfully completes, CloudFormation successfully deleted the change
|
|
209
|
-
* set.</p>
|
|
210
|
-
* <p>If <code>IncludeNestedStacks</code> specifies <code>True</code> during the creation of
|
|
211
|
-
* the nested change set, then <code>DeleteChangeSet</code> will delete all change sets that
|
|
212
|
-
* belong to the stacks hierarchy and will also delete all change sets for nested stacks with
|
|
213
|
-
* the status of <code>REVIEW_IN_PROGRESS</code>.</p>
|
|
125
|
+
* @see {@link DeleteChangeSetCommand}
|
|
214
126
|
*/
|
|
215
127
|
deleteChangeSet(args: DeleteChangeSetCommandInput, options?: __HttpHandlerOptions): Promise<DeleteChangeSetCommandOutput>;
|
|
216
128
|
deleteChangeSet(args: DeleteChangeSetCommandInput, cb: (err: any, data?: DeleteChangeSetCommandOutput) => void): void;
|
|
217
129
|
deleteChangeSet(args: DeleteChangeSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteChangeSetCommandOutput) => void): void;
|
|
218
130
|
/**
|
|
219
|
-
* @
|
|
220
|
-
* <p>Deletes a specified stack. Once the call completes successfully, stack deletion starts.
|
|
221
|
-
* Deleted stacks don't show up in the <a>DescribeStacks</a> operation if the
|
|
222
|
-
* deletion has been completed successfully.</p>
|
|
131
|
+
* @see {@link DeleteStackCommand}
|
|
223
132
|
*/
|
|
224
133
|
deleteStack(args: DeleteStackCommandInput, options?: __HttpHandlerOptions): Promise<DeleteStackCommandOutput>;
|
|
225
134
|
deleteStack(args: DeleteStackCommandInput, cb: (err: any, data?: DeleteStackCommandOutput) => void): void;
|
|
226
135
|
deleteStack(args: DeleteStackCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteStackCommandOutput) => void): void;
|
|
227
136
|
/**
|
|
228
|
-
* @
|
|
229
|
-
* <p>Deletes stack instances for the specified accounts, in the specified Amazon Web Services Regions.</p>
|
|
137
|
+
* @see {@link DeleteStackInstancesCommand}
|
|
230
138
|
*/
|
|
231
139
|
deleteStackInstances(args: DeleteStackInstancesCommandInput, options?: __HttpHandlerOptions): Promise<DeleteStackInstancesCommandOutput>;
|
|
232
140
|
deleteStackInstances(args: DeleteStackInstancesCommandInput, cb: (err: any, data?: DeleteStackInstancesCommandOutput) => void): void;
|
|
233
141
|
deleteStackInstances(args: DeleteStackInstancesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteStackInstancesCommandOutput) => void): void;
|
|
234
142
|
/**
|
|
235
|
-
* @
|
|
236
|
-
* <p>Deletes a stack set. Before you can delete a stack set, all its member stack instances
|
|
237
|
-
* must be deleted. For more information about how to complete this, see <a>DeleteStackInstances</a>.</p>
|
|
143
|
+
* @see {@link DeleteStackSetCommand}
|
|
238
144
|
*/
|
|
239
145
|
deleteStackSet(args: DeleteStackSetCommandInput, options?: __HttpHandlerOptions): Promise<DeleteStackSetCommandOutput>;
|
|
240
146
|
deleteStackSet(args: DeleteStackSetCommandInput, cb: (err: any, data?: DeleteStackSetCommandOutput) => void): void;
|
|
241
147
|
deleteStackSet(args: DeleteStackSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteStackSetCommandOutput) => void): void;
|
|
242
148
|
/**
|
|
243
|
-
* @
|
|
244
|
-
* <p>Marks an extension or extension version as <code>DEPRECATED</code> in the CloudFormation registry, removing it from active use. Deprecated extensions or
|
|
245
|
-
* extension versions cannot be used in CloudFormation operations.</p>
|
|
246
|
-
* <p>To deregister an entire extension, you must individually deregister all active versions
|
|
247
|
-
* of that extension. If an extension has only a single active version, deregistering that
|
|
248
|
-
* version results in the extension itself being deregistered and marked as deprecated in the
|
|
249
|
-
* registry.</p>
|
|
250
|
-
* <p>You can't deregister the default version of an extension if there are other active
|
|
251
|
-
* version of that extension. If you do deregister the default version of an extension, the
|
|
252
|
-
* extension type itself is deregistered as well and marked as deprecated.</p>
|
|
253
|
-
* <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>
|
|
149
|
+
* @see {@link DeregisterTypeCommand}
|
|
254
150
|
*/
|
|
255
151
|
deregisterType(args: DeregisterTypeCommandInput, options?: __HttpHandlerOptions): Promise<DeregisterTypeCommandOutput>;
|
|
256
152
|
deregisterType(args: DeregisterTypeCommandInput, cb: (err: any, data?: DeregisterTypeCommandOutput) => void): void;
|
|
257
153
|
deregisterType(args: DeregisterTypeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeregisterTypeCommandOutput) => void): void;
|
|
258
154
|
/**
|
|
259
|
-
* @
|
|
260
|
-
* <p>Retrieves your account's CloudFormation limits, such as the maximum number of stacks
|
|
261
|
-
* that you can create in 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
|
|
262
|
-
* <i>CloudFormation User Guide</i>.</p>
|
|
155
|
+
* @see {@link DescribeAccountLimitsCommand}
|
|
263
156
|
*/
|
|
264
157
|
describeAccountLimits(args: DescribeAccountLimitsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeAccountLimitsCommandOutput>;
|
|
265
158
|
describeAccountLimits(args: DescribeAccountLimitsCommandInput, cb: (err: any, data?: DescribeAccountLimitsCommandOutput) => void): void;
|
|
266
159
|
describeAccountLimits(args: DescribeAccountLimitsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAccountLimitsCommandOutput) => void): void;
|
|
267
160
|
/**
|
|
268
|
-
* @
|
|
269
|
-
* <p>Returns the inputs for the change set and a list of changes that CloudFormation will
|
|
270
|
-
* make if you execute the 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 Sets</a> in the CloudFormation User Guide.</p>
|
|
161
|
+
* @see {@link DescribeChangeSetCommand}
|
|
271
162
|
*/
|
|
272
163
|
describeChangeSet(args: DescribeChangeSetCommandInput, options?: __HttpHandlerOptions): Promise<DescribeChangeSetCommandOutput>;
|
|
273
164
|
describeChangeSet(args: DescribeChangeSetCommandInput, cb: (err: any, data?: DescribeChangeSetCommandOutput) => void): void;
|
|
274
165
|
describeChangeSet(args: DescribeChangeSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeChangeSetCommandOutput) => void): void;
|
|
275
166
|
/**
|
|
276
|
-
* @
|
|
277
|
-
* <p>Returns hook-related information for the change set and a list of changes that CloudFormation makes when you run the change set.</p>
|
|
167
|
+
* @see {@link DescribeChangeSetHooksCommand}
|
|
278
168
|
*/
|
|
279
169
|
describeChangeSetHooks(args: DescribeChangeSetHooksCommandInput, options?: __HttpHandlerOptions): Promise<DescribeChangeSetHooksCommandOutput>;
|
|
280
170
|
describeChangeSetHooks(args: DescribeChangeSetHooksCommandInput, cb: (err: any, data?: DescribeChangeSetHooksCommandOutput) => void): void;
|
|
281
171
|
describeChangeSetHooks(args: DescribeChangeSetHooksCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeChangeSetHooksCommandOutput) => void): void;
|
|
282
172
|
/**
|
|
283
|
-
* @
|
|
284
|
-
* <p>Returns information about a CloudFormation extension publisher.</p>
|
|
285
|
-
* <p>If you don't supply a <code>PublisherId</code>, and you have registered as an extension
|
|
286
|
-
* publisher, <code>DescribePublisher</code> returns information about your own publisher
|
|
287
|
-
* account.</p>
|
|
288
|
-
* <p>For more information about registering as a publisher, see:</p>
|
|
289
|
-
* <ul>
|
|
290
|
-
* <li>
|
|
291
|
-
* <p>
|
|
292
|
-
* <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterPublisher.html">RegisterPublisher</a>
|
|
293
|
-
* </p>
|
|
294
|
-
* </li>
|
|
295
|
-
* <li>
|
|
296
|
-
* <p>
|
|
297
|
-
* <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.html">Publishing
|
|
298
|
-
* extensions to make them available for public use</a> in the <i>CloudFormation CLI User Guide</i>
|
|
299
|
-
* </p>
|
|
300
|
-
* </li>
|
|
301
|
-
* </ul>
|
|
173
|
+
* @see {@link DescribePublisherCommand}
|
|
302
174
|
*/
|
|
303
175
|
describePublisher(args: DescribePublisherCommandInput, options?: __HttpHandlerOptions): Promise<DescribePublisherCommandOutput>;
|
|
304
176
|
describePublisher(args: DescribePublisherCommandInput, cb: (err: any, data?: DescribePublisherCommandOutput) => void): void;
|
|
305
177
|
describePublisher(args: DescribePublisherCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribePublisherCommandOutput) => void): void;
|
|
306
178
|
/**
|
|
307
|
-
* @
|
|
308
|
-
* <p>Returns information about a stack drift detection operation. A stack drift detection
|
|
309
|
-
* operation detects whether a stack's actual configuration differs, or has
|
|
310
|
-
* <i>drifted</i>, from it's expected configuration, as defined in the stack
|
|
311
|
-
* template and any values specified as template parameters. A stack is considered to have
|
|
312
|
-
* drifted if one or more of its resources have drifted. For more information about stack and
|
|
313
|
-
* resource drift, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html">Detecting
|
|
314
|
-
* Unregulated Configuration Changes to Stacks and Resources</a>.</p>
|
|
315
|
-
* <p>Use <a>DetectStackDrift</a> to initiate a stack drift detection operation.
|
|
316
|
-
* <code>DetectStackDrift</code> returns a <code>StackDriftDetectionId</code> you can use
|
|
317
|
-
* to monitor the progress of the operation using
|
|
318
|
-
* <code>DescribeStackDriftDetectionStatus</code>. Once the drift detection operation has
|
|
319
|
-
* completed, use <a>DescribeStackResourceDrifts</a> to return drift information
|
|
320
|
-
* about the stack and its resources.</p>
|
|
179
|
+
* @see {@link DescribeStackDriftDetectionStatusCommand}
|
|
321
180
|
*/
|
|
322
181
|
describeStackDriftDetectionStatus(args: DescribeStackDriftDetectionStatusCommandInput, options?: __HttpHandlerOptions): Promise<DescribeStackDriftDetectionStatusCommandOutput>;
|
|
323
182
|
describeStackDriftDetectionStatus(args: DescribeStackDriftDetectionStatusCommandInput, cb: (err: any, data?: DescribeStackDriftDetectionStatusCommandOutput) => void): void;
|
|
324
183
|
describeStackDriftDetectionStatus(args: DescribeStackDriftDetectionStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeStackDriftDetectionStatusCommandOutput) => void): void;
|
|
325
184
|
/**
|
|
326
|
-
* @
|
|
327
|
-
* <p>Returns all stack related events for a specified stack in reverse chronological order.
|
|
328
|
-
* For more information 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
|
|
329
|
-
* CloudFormation User Guide.</p>
|
|
330
|
-
* <note>
|
|
331
|
-
* <p>You can list events for stacks that have failed to create or have been deleted by
|
|
332
|
-
* specifying the unique stack identifier (stack ID).</p>
|
|
333
|
-
* </note>
|
|
185
|
+
* @see {@link DescribeStackEventsCommand}
|
|
334
186
|
*/
|
|
335
187
|
describeStackEvents(args: DescribeStackEventsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeStackEventsCommandOutput>;
|
|
336
188
|
describeStackEvents(args: DescribeStackEventsCommandInput, cb: (err: any, data?: DescribeStackEventsCommandOutput) => void): void;
|
|
337
189
|
describeStackEvents(args: DescribeStackEventsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeStackEventsCommandOutput) => void): void;
|
|
338
190
|
/**
|
|
339
|
-
* @
|
|
340
|
-
* <p>Returns the stack instance that's associated with the specified stack set, Amazon Web Services account, and Region.</p>
|
|
341
|
-
* <p>For a list of stack instances that are associated with a specific stack set, use <a>ListStackInstances</a>.</p>
|
|
191
|
+
* @see {@link DescribeStackInstanceCommand}
|
|
342
192
|
*/
|
|
343
193
|
describeStackInstance(args: DescribeStackInstanceCommandInput, options?: __HttpHandlerOptions): Promise<DescribeStackInstanceCommandOutput>;
|
|
344
194
|
describeStackInstance(args: DescribeStackInstanceCommandInput, cb: (err: any, data?: DescribeStackInstanceCommandOutput) => void): void;
|
|
345
195
|
describeStackInstance(args: DescribeStackInstanceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeStackInstanceCommandOutput) => void): void;
|
|
346
196
|
/**
|
|
347
|
-
* @
|
|
348
|
-
* <p>Returns a description of the specified resource in the specified stack.</p>
|
|
349
|
-
* <p>For deleted stacks, DescribeStackResource returns resource information for up to 90 days
|
|
350
|
-
* after the stack has been deleted.</p>
|
|
197
|
+
* @see {@link DescribeStackResourceCommand}
|
|
351
198
|
*/
|
|
352
199
|
describeStackResource(args: DescribeStackResourceCommandInput, options?: __HttpHandlerOptions): Promise<DescribeStackResourceCommandOutput>;
|
|
353
200
|
describeStackResource(args: DescribeStackResourceCommandInput, cb: (err: any, data?: DescribeStackResourceCommandOutput) => void): void;
|
|
354
201
|
describeStackResource(args: DescribeStackResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeStackResourceCommandOutput) => void): void;
|
|
355
202
|
/**
|
|
356
|
-
* @
|
|
357
|
-
* <p>Returns drift information for the resources that have been checked for drift in the
|
|
358
|
-
* specified stack. This includes actual and expected configuration values for resources where
|
|
359
|
-
* CloudFormation detects configuration drift.</p>
|
|
360
|
-
* <p>For a given stack, there will be one <code>StackResourceDrift</code> for each stack
|
|
361
|
-
* resource that has been checked for drift. Resources that haven't yet been checked for drift
|
|
362
|
-
* aren't included. Resources that don't currently support drift detection aren't checked, and
|
|
363
|
-
* so not included. For a list of resources that 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 Detection</a>.</p>
|
|
364
|
-
* <p>Use <a>DetectStackResourceDrift</a> to detect drift on individual resources,
|
|
365
|
-
* or <a>DetectStackDrift</a> to detect drift on all supported resources for a
|
|
366
|
-
* given stack.</p>
|
|
203
|
+
* @see {@link DescribeStackResourceDriftsCommand}
|
|
367
204
|
*/
|
|
368
205
|
describeStackResourceDrifts(args: DescribeStackResourceDriftsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeStackResourceDriftsCommandOutput>;
|
|
369
206
|
describeStackResourceDrifts(args: DescribeStackResourceDriftsCommandInput, cb: (err: any, data?: DescribeStackResourceDriftsCommandOutput) => void): void;
|
|
370
207
|
describeStackResourceDrifts(args: DescribeStackResourceDriftsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeStackResourceDriftsCommandOutput) => void): void;
|
|
371
208
|
/**
|
|
372
|
-
* @
|
|
373
|
-
* <p>Returns Amazon Web Services resource descriptions for running and deleted stacks. If
|
|
374
|
-
* <code>StackName</code> is specified, all the associated resources that are part of the
|
|
375
|
-
* stack are returned. If <code>PhysicalResourceId</code> is specified, the associated
|
|
376
|
-
* resources of the stack that the resource belongs to are returned.</p>
|
|
377
|
-
* <note>
|
|
378
|
-
* <p>Only the first 100 resources will be returned. If your stack has more resources than
|
|
379
|
-
* this, you should use <code>ListStackResources</code> instead.</p>
|
|
380
|
-
* </note>
|
|
381
|
-
* <p>For deleted stacks, <code>DescribeStackResources</code> returns resource information for
|
|
382
|
-
* up to 90 days after the stack has been deleted.</p>
|
|
383
|
-
* <p>You must specify either <code>StackName</code> or <code>PhysicalResourceId</code>, but
|
|
384
|
-
* not both. In addition, you can specify <code>LogicalResourceId</code> to filter the
|
|
385
|
-
* returned result. For more information about resources, the <code>LogicalResourceId</code>
|
|
386
|
-
* and <code>PhysicalResourceId</code>, go to the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/">CloudFormation User
|
|
387
|
-
* Guide</a>.</p>
|
|
388
|
-
* <note>
|
|
389
|
-
* <p>A <code>ValidationError</code> is returned if you specify both <code>StackName</code>
|
|
390
|
-
* and <code>PhysicalResourceId</code> in the same request.</p>
|
|
391
|
-
* </note>
|
|
209
|
+
* @see {@link DescribeStackResourcesCommand}
|
|
392
210
|
*/
|
|
393
211
|
describeStackResources(args: DescribeStackResourcesCommandInput, options?: __HttpHandlerOptions): Promise<DescribeStackResourcesCommandOutput>;
|
|
394
212
|
describeStackResources(args: DescribeStackResourcesCommandInput, cb: (err: any, data?: DescribeStackResourcesCommandOutput) => void): void;
|
|
395
213
|
describeStackResources(args: DescribeStackResourcesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeStackResourcesCommandOutput) => void): void;
|
|
396
214
|
/**
|
|
397
|
-
* @
|
|
398
|
-
* <p>Returns the description for the specified stack; if no stack name was specified, then it
|
|
399
|
-
* returns the description for all the stacks created.</p>
|
|
400
|
-
* <note>
|
|
401
|
-
* <p>If the stack doesn't exist, an <code>ValidationError</code> is returned.</p>
|
|
402
|
-
* </note>
|
|
215
|
+
* @see {@link DescribeStacksCommand}
|
|
403
216
|
*/
|
|
404
217
|
describeStacks(args: DescribeStacksCommandInput, options?: __HttpHandlerOptions): Promise<DescribeStacksCommandOutput>;
|
|
405
218
|
describeStacks(args: DescribeStacksCommandInput, cb: (err: any, data?: DescribeStacksCommandOutput) => void): void;
|
|
406
219
|
describeStacks(args: DescribeStacksCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeStacksCommandOutput) => void): void;
|
|
407
220
|
/**
|
|
408
|
-
* @
|
|
409
|
-
* <p>Returns the description of the specified stack set.</p>
|
|
221
|
+
* @see {@link DescribeStackSetCommand}
|
|
410
222
|
*/
|
|
411
223
|
describeStackSet(args: DescribeStackSetCommandInput, options?: __HttpHandlerOptions): Promise<DescribeStackSetCommandOutput>;
|
|
412
224
|
describeStackSet(args: DescribeStackSetCommandInput, cb: (err: any, data?: DescribeStackSetCommandOutput) => void): void;
|
|
413
225
|
describeStackSet(args: DescribeStackSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeStackSetCommandOutput) => void): void;
|
|
414
226
|
/**
|
|
415
|
-
* @
|
|
416
|
-
* <p>Returns the description of the specified stack set operation.</p>
|
|
227
|
+
* @see {@link DescribeStackSetOperationCommand}
|
|
417
228
|
*/
|
|
418
229
|
describeStackSetOperation(args: DescribeStackSetOperationCommandInput, options?: __HttpHandlerOptions): Promise<DescribeStackSetOperationCommandOutput>;
|
|
419
230
|
describeStackSetOperation(args: DescribeStackSetOperationCommandInput, cb: (err: any, data?: DescribeStackSetOperationCommandOutput) => void): void;
|
|
420
231
|
describeStackSetOperation(args: DescribeStackSetOperationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeStackSetOperationCommandOutput) => void): void;
|
|
421
232
|
/**
|
|
422
|
-
* @
|
|
423
|
-
* <p>Returns detailed information about an extension that has been registered.</p>
|
|
424
|
-
* <p>If you specify a <code>VersionId</code>, <code>DescribeType</code> returns information
|
|
425
|
-
* about that specific extension version. Otherwise, it returns information about the default
|
|
426
|
-
* extension version.</p>
|
|
233
|
+
* @see {@link DescribeTypeCommand}
|
|
427
234
|
*/
|
|
428
235
|
describeType(args: DescribeTypeCommandInput, options?: __HttpHandlerOptions): Promise<DescribeTypeCommandOutput>;
|
|
429
236
|
describeType(args: DescribeTypeCommandInput, cb: (err: any, data?: DescribeTypeCommandOutput) => void): void;
|
|
430
237
|
describeType(args: DescribeTypeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTypeCommandOutput) => void): void;
|
|
431
238
|
/**
|
|
432
|
-
* @
|
|
433
|
-
* <p>Returns information about an extension's registration, including its current status and
|
|
434
|
-
* type and version identifiers.</p>
|
|
435
|
-
* <p>When you initiate a registration request using <code>
|
|
436
|
-
* <a>RegisterType</a>
|
|
437
|
-
* </code>, you can then use <code>
|
|
438
|
-
* <a>DescribeTypeRegistration</a>
|
|
439
|
-
* </code> to
|
|
440
|
-
* monitor the progress of that registration request.</p>
|
|
441
|
-
* <p>Once the registration request has completed, use <code>
|
|
442
|
-
* <a>DescribeType</a>
|
|
443
|
-
* </code> to return detailed information about an extension.</p>
|
|
239
|
+
* @see {@link DescribeTypeRegistrationCommand}
|
|
444
240
|
*/
|
|
445
241
|
describeTypeRegistration(args: DescribeTypeRegistrationCommandInput, options?: __HttpHandlerOptions): Promise<DescribeTypeRegistrationCommandOutput>;
|
|
446
242
|
describeTypeRegistration(args: DescribeTypeRegistrationCommandInput, cb: (err: any, data?: DescribeTypeRegistrationCommandOutput) => void): void;
|
|
447
243
|
describeTypeRegistration(args: DescribeTypeRegistrationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeTypeRegistrationCommandOutput) => void): void;
|
|
448
244
|
/**
|
|
449
|
-
* @
|
|
450
|
-
* <p>Detects whether a stack's actual configuration differs, or has
|
|
451
|
-
* <i>drifted</i>, from it's expected configuration, as defined in the stack
|
|
452
|
-
* template and any values specified as template parameters. For each resource in the stack
|
|
453
|
-
* that supports drift detection, CloudFormation compares the actual configuration of the resource with
|
|
454
|
-
* its expected template configuration. Only resource properties explicitly defined in the
|
|
455
|
-
* stack template are checked for drift. A stack is considered to have drifted if one or more
|
|
456
|
-
* of its resources differ from their expected template configurations. For more information,
|
|
457
|
-
* see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html">Detecting
|
|
458
|
-
* Unregulated Configuration Changes to Stacks and Resources</a>.</p>
|
|
459
|
-
* <p>Use <code>DetectStackDrift</code> to detect drift on all supported resources for a given
|
|
460
|
-
* stack, or <a>DetectStackResourceDrift</a> to detect drift on individual
|
|
461
|
-
* resources.</p>
|
|
462
|
-
* <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 Detection</a>.</p>
|
|
463
|
-
* <p>
|
|
464
|
-
* <code>DetectStackDrift</code> can take up to several minutes, depending on the number of
|
|
465
|
-
* resources contained within the stack. Use <a>DescribeStackDriftDetectionStatus</a> to monitor the progress of a detect stack drift operation. Once the drift detection
|
|
466
|
-
* operation has completed, use <a>DescribeStackResourceDrifts</a> to return drift
|
|
467
|
-
* information about the stack and its resources.</p>
|
|
468
|
-
* <p>When detecting drift on a stack, CloudFormation doesn't detect drift on any nested stacks
|
|
469
|
-
* belonging to that stack. Perform <code>DetectStackDrift</code> directly on the nested stack
|
|
470
|
-
* itself.</p>
|
|
245
|
+
* @see {@link DetectStackDriftCommand}
|
|
471
246
|
*/
|
|
472
247
|
detectStackDrift(args: DetectStackDriftCommandInput, options?: __HttpHandlerOptions): Promise<DetectStackDriftCommandOutput>;
|
|
473
248
|
detectStackDrift(args: DetectStackDriftCommandInput, cb: (err: any, data?: DetectStackDriftCommandOutput) => void): void;
|
|
474
249
|
detectStackDrift(args: DetectStackDriftCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DetectStackDriftCommandOutput) => void): void;
|
|
475
250
|
/**
|
|
476
|
-
* @
|
|
477
|
-
* <p>Returns information about whether a resource's actual configuration differs, or has
|
|
478
|
-
* <i>drifted</i>, from it's expected configuration, as defined in the stack
|
|
479
|
-
* template and any values specified as template parameters. This information includes actual
|
|
480
|
-
* and expected property values for resources in which CloudFormation detects drift. Only resource
|
|
481
|
-
* properties explicitly defined in the stack template are checked for drift. For more
|
|
482
|
-
* information about stack and resource drift, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html">Detecting
|
|
483
|
-
* Unregulated Configuration Changes to Stacks and Resources</a>.</p>
|
|
484
|
-
* <p>Use <code>DetectStackResourceDrift</code> to detect drift on individual resources, or
|
|
485
|
-
* <a>DetectStackDrift</a> to detect drift on all resources in a given stack
|
|
486
|
-
* that support drift detection.</p>
|
|
487
|
-
* <p>Resources that don't currently support drift detection can't be checked. For a list of
|
|
488
|
-
* resources that 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 Detection</a>.</p>
|
|
251
|
+
* @see {@link DetectStackResourceDriftCommand}
|
|
489
252
|
*/
|
|
490
253
|
detectStackResourceDrift(args: DetectStackResourceDriftCommandInput, options?: __HttpHandlerOptions): Promise<DetectStackResourceDriftCommandOutput>;
|
|
491
254
|
detectStackResourceDrift(args: DetectStackResourceDriftCommandInput, cb: (err: any, data?: DetectStackResourceDriftCommandOutput) => void): void;
|
|
492
255
|
detectStackResourceDrift(args: DetectStackResourceDriftCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DetectStackResourceDriftCommandOutput) => void): void;
|
|
493
256
|
/**
|
|
494
|
-
* @
|
|
495
|
-
* <p>Detect drift on a stack set. When CloudFormation performs drift detection on a
|
|
496
|
-
* stack set, it performs drift detection on the stack associated with each stack instance in
|
|
497
|
-
* the stack set. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-drift.html">How CloudFormation performs drift detection on a stack set</a>.</p>
|
|
498
|
-
* <p>
|
|
499
|
-
* <code>DetectStackSetDrift</code> returns the <code>OperationId</code> of the stack set
|
|
500
|
-
* drift detection operation. Use this operation id with <code>
|
|
501
|
-
* <a>DescribeStackSetOperation</a>
|
|
502
|
-
* </code> to monitor the progress of the drift
|
|
503
|
-
* detection operation. The drift detection operation may take some time, depending on the
|
|
504
|
-
* number of stack instances included in the stack set, in addition to the number of resources
|
|
505
|
-
* included in each stack.</p>
|
|
506
|
-
* <p>Once the operation has completed, use the following actions to return drift
|
|
507
|
-
* information:</p>
|
|
508
|
-
* <ul>
|
|
509
|
-
* <li>
|
|
510
|
-
* <p>Use <code>
|
|
511
|
-
* <a>DescribeStackSet</a>
|
|
512
|
-
* </code> to return detailed information
|
|
513
|
-
* about the stack set, including detailed information about the last
|
|
514
|
-
* <i>completed</i> drift operation performed on the stack set.
|
|
515
|
-
* (Information about drift operations that are in progress isn't included.)</p>
|
|
516
|
-
* </li>
|
|
517
|
-
* <li>
|
|
518
|
-
* <p>Use <code>
|
|
519
|
-
* <a>ListStackInstances</a>
|
|
520
|
-
* </code> to return a list of stack
|
|
521
|
-
* instances belonging to the stack set, including the drift status and last drift time
|
|
522
|
-
* checked of each instance.</p>
|
|
523
|
-
* </li>
|
|
524
|
-
* <li>
|
|
525
|
-
* <p>Use <code>
|
|
526
|
-
* <a>DescribeStackInstance</a>
|
|
527
|
-
* </code> to return detailed
|
|
528
|
-
* information about a specific stack instance, including its drift status and last
|
|
529
|
-
* drift time checked.</p>
|
|
530
|
-
* </li>
|
|
531
|
-
* </ul>
|
|
532
|
-
* <p>For more information about performing a drift detection operation on a stack set, see
|
|
533
|
-
* <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-drift.html">Detecting unmanaged
|
|
534
|
-
* changes in stack sets</a>.</p>
|
|
535
|
-
* <p>You can only run a single drift detection operation on a given stack set at one
|
|
536
|
-
* time.</p>
|
|
537
|
-
* <p>To stop a drift detection stack set operation, use <code>
|
|
538
|
-
* <a>StopStackSetOperation</a>
|
|
539
|
-
* </code>.</p>
|
|
257
|
+
* @see {@link DetectStackSetDriftCommand}
|
|
540
258
|
*/
|
|
541
259
|
detectStackSetDrift(args: DetectStackSetDriftCommandInput, options?: __HttpHandlerOptions): Promise<DetectStackSetDriftCommandOutput>;
|
|
542
260
|
detectStackSetDrift(args: DetectStackSetDriftCommandInput, cb: (err: any, data?: DetectStackSetDriftCommandOutput) => void): void;
|
|
543
261
|
detectStackSetDrift(args: DetectStackSetDriftCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DetectStackSetDriftCommandOutput) => void): void;
|
|
544
262
|
/**
|
|
545
|
-
* @
|
|
546
|
-
* <p>Returns the estimated monthly cost of a template. The return value is an Amazon Web Services Simple Monthly Calculator URL with a query string that describes the
|
|
547
|
-
* resources required to run the template.</p>
|
|
263
|
+
* @see {@link EstimateTemplateCostCommand}
|
|
548
264
|
*/
|
|
549
265
|
estimateTemplateCost(args: EstimateTemplateCostCommandInput, options?: __HttpHandlerOptions): Promise<EstimateTemplateCostCommandOutput>;
|
|
550
266
|
estimateTemplateCost(args: EstimateTemplateCostCommandInput, cb: (err: any, data?: EstimateTemplateCostCommandOutput) => void): void;
|
|
551
267
|
estimateTemplateCost(args: EstimateTemplateCostCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: EstimateTemplateCostCommandOutput) => void): void;
|
|
552
268
|
/**
|
|
553
|
-
* @
|
|
554
|
-
* <p>Updates a stack using the input information that was provided when the specified change
|
|
555
|
-
* set was created. After the call successfully completes, CloudFormation starts updating
|
|
556
|
-
* the stack. Use the <a>DescribeStacks</a> action to view the status of the
|
|
557
|
-
* update.</p>
|
|
558
|
-
* <p>When you execute a change set, CloudFormation deletes all other change sets
|
|
559
|
-
* associated with the stack because they aren't valid for the updated stack.</p>
|
|
560
|
-
* <p>If a stack policy is associated with the stack, CloudFormation enforces the policy
|
|
561
|
-
* during the update. You can't specify a temporary stack policy that overrides the current
|
|
562
|
-
* policy.</p>
|
|
563
|
-
* <p>To create a change set for the entire stack hierarchy, <code>IncludeNestedStacks</code>
|
|
564
|
-
* must have been set to <code>True</code>.</p>
|
|
269
|
+
* @see {@link ExecuteChangeSetCommand}
|
|
565
270
|
*/
|
|
566
271
|
executeChangeSet(args: ExecuteChangeSetCommandInput, options?: __HttpHandlerOptions): Promise<ExecuteChangeSetCommandOutput>;
|
|
567
272
|
executeChangeSet(args: ExecuteChangeSetCommandInput, cb: (err: any, data?: ExecuteChangeSetCommandOutput) => void): void;
|
|
568
273
|
executeChangeSet(args: ExecuteChangeSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ExecuteChangeSetCommandOutput) => void): void;
|
|
569
274
|
/**
|
|
570
|
-
* @
|
|
571
|
-
* <p>Returns the stack policy for a specified stack. If a stack doesn't have a policy, a null
|
|
572
|
-
* value is returned.</p>
|
|
275
|
+
* @see {@link GetStackPolicyCommand}
|
|
573
276
|
*/
|
|
574
277
|
getStackPolicy(args: GetStackPolicyCommandInput, options?: __HttpHandlerOptions): Promise<GetStackPolicyCommandOutput>;
|
|
575
278
|
getStackPolicy(args: GetStackPolicyCommandInput, cb: (err: any, data?: GetStackPolicyCommandOutput) => void): void;
|
|
576
279
|
getStackPolicy(args: GetStackPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetStackPolicyCommandOutput) => void): void;
|
|
577
280
|
/**
|
|
578
|
-
* @
|
|
579
|
-
* <p>Returns the template body for a specified stack. You can get the template for running or
|
|
580
|
-
* deleted stacks.</p>
|
|
581
|
-
* <p>For deleted stacks, <code>GetTemplate</code> returns the template for up to 90 days
|
|
582
|
-
* after the stack has been deleted.</p>
|
|
583
|
-
* <note>
|
|
584
|
-
* <p>If the template doesn't exist, a <code>ValidationError</code> is returned.</p>
|
|
585
|
-
* </note>
|
|
281
|
+
* @see {@link GetTemplateCommand}
|
|
586
282
|
*/
|
|
587
283
|
getTemplate(args: GetTemplateCommandInput, options?: __HttpHandlerOptions): Promise<GetTemplateCommandOutput>;
|
|
588
284
|
getTemplate(args: GetTemplateCommandInput, cb: (err: any, data?: GetTemplateCommandOutput) => void): void;
|
|
589
285
|
getTemplate(args: GetTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetTemplateCommandOutput) => void): void;
|
|
590
286
|
/**
|
|
591
|
-
* @
|
|
592
|
-
* <p>Returns information about a new or existing template. The
|
|
593
|
-
* <code>GetTemplateSummary</code> action is useful for viewing parameter information, such
|
|
594
|
-
* as default parameter values and parameter types, before you create or update a stack or
|
|
595
|
-
* stack set.</p>
|
|
596
|
-
* <p>You can use the <code>GetTemplateSummary</code> action when you submit a template, or
|
|
597
|
-
* you can get template information for a stack set, or a running or deleted stack.</p>
|
|
598
|
-
* <p>For deleted stacks, <code>GetTemplateSummary</code> returns the template information for
|
|
599
|
-
* up to 90 days after the stack has been deleted. If the template doesn't exist, a
|
|
600
|
-
* <code>ValidationError</code> is returned.</p>
|
|
287
|
+
* @see {@link GetTemplateSummaryCommand}
|
|
601
288
|
*/
|
|
602
289
|
getTemplateSummary(args: GetTemplateSummaryCommandInput, options?: __HttpHandlerOptions): Promise<GetTemplateSummaryCommandOutput>;
|
|
603
290
|
getTemplateSummary(args: GetTemplateSummaryCommandInput, cb: (err: any, data?: GetTemplateSummaryCommandOutput) => void): void;
|
|
604
291
|
getTemplateSummary(args: GetTemplateSummaryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetTemplateSummaryCommandOutput) => void): void;
|
|
605
292
|
/**
|
|
606
|
-
* @
|
|
607
|
-
* <p>Import existing stacks into a new stack sets. Use the stack import operation to import
|
|
608
|
-
* up to 10 stacks into a new stack set in the same account as the source stack or in a
|
|
609
|
-
* different administrator account and Region, by specifying the stack ID of the stack you
|
|
610
|
-
* intend to import.</p>
|
|
611
|
-
* <note>
|
|
612
|
-
* <p>
|
|
613
|
-
* <code>ImportStacksToStackSet</code> is only supported by self-managed
|
|
614
|
-
* permissions.</p>
|
|
615
|
-
* </note>
|
|
293
|
+
* @see {@link ImportStacksToStackSetCommand}
|
|
616
294
|
*/
|
|
617
295
|
importStacksToStackSet(args: ImportStacksToStackSetCommandInput, options?: __HttpHandlerOptions): Promise<ImportStacksToStackSetCommandOutput>;
|
|
618
296
|
importStacksToStackSet(args: ImportStacksToStackSetCommandInput, cb: (err: any, data?: ImportStacksToStackSetCommandOutput) => void): void;
|
|
619
297
|
importStacksToStackSet(args: ImportStacksToStackSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ImportStacksToStackSetCommandOutput) => void): void;
|
|
620
298
|
/**
|
|
621
|
-
* @
|
|
622
|
-
* <p>Returns the ID and status of each active change set for a stack. For example, CloudFormation lists change sets that are in the <code>CREATE_IN_PROGRESS</code> or
|
|
623
|
-
* <code>CREATE_PENDING</code> state.</p>
|
|
299
|
+
* @see {@link ListChangeSetsCommand}
|
|
624
300
|
*/
|
|
625
301
|
listChangeSets(args: ListChangeSetsCommandInput, options?: __HttpHandlerOptions): Promise<ListChangeSetsCommandOutput>;
|
|
626
302
|
listChangeSets(args: ListChangeSetsCommandInput, cb: (err: any, data?: ListChangeSetsCommandOutput) => void): void;
|
|
627
303
|
listChangeSets(args: ListChangeSetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListChangeSetsCommandOutput) => void): void;
|
|
628
304
|
/**
|
|
629
|
-
* @
|
|
630
|
-
* <p>Lists all exported output values in the account and Region in which you call this
|
|
631
|
-
* action. Use this action to see the exported output values that you can import into other
|
|
632
|
-
* stacks. To import values, use the <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-importvalue.html">
|
|
633
|
-
* <code>Fn::ImportValue</code>
|
|
634
|
-
* </a> function.</p>
|
|
635
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-exports.html">
|
|
636
|
-
* CloudFormation export stack output values</a>.</p>
|
|
305
|
+
* @see {@link ListExportsCommand}
|
|
637
306
|
*/
|
|
638
307
|
listExports(args: ListExportsCommandInput, options?: __HttpHandlerOptions): Promise<ListExportsCommandOutput>;
|
|
639
308
|
listExports(args: ListExportsCommandInput, cb: (err: any, data?: ListExportsCommandOutput) => void): void;
|
|
640
309
|
listExports(args: ListExportsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListExportsCommandOutput) => void): void;
|
|
641
310
|
/**
|
|
642
|
-
* @
|
|
643
|
-
* <p>Lists all stacks that are importing an exported output value. To modify or remove an
|
|
644
|
-
* exported output value, first use this action to see which stacks are using it. To see the
|
|
645
|
-
* exported output values in your account, see <a>ListExports</a>.</p>
|
|
646
|
-
* <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">
|
|
647
|
-
* <code>Fn::ImportValue</code>
|
|
648
|
-
* </a> function.</p>
|
|
311
|
+
* @see {@link ListImportsCommand}
|
|
649
312
|
*/
|
|
650
313
|
listImports(args: ListImportsCommandInput, options?: __HttpHandlerOptions): Promise<ListImportsCommandOutput>;
|
|
651
314
|
listImports(args: ListImportsCommandInput, cb: (err: any, data?: ListImportsCommandOutput) => void): void;
|
|
652
315
|
listImports(args: ListImportsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListImportsCommandOutput) => void): void;
|
|
653
316
|
/**
|
|
654
|
-
* @
|
|
655
|
-
* <p>Returns summary information about stack instances that are associated with the specified
|
|
656
|
-
* stack set. You can filter for stack instances that are associated with a specific Amazon Web Services account name or Region, or that have a specific status.</p>
|
|
317
|
+
* @see {@link ListStackInstancesCommand}
|
|
657
318
|
*/
|
|
658
319
|
listStackInstances(args: ListStackInstancesCommandInput, options?: __HttpHandlerOptions): Promise<ListStackInstancesCommandOutput>;
|
|
659
320
|
listStackInstances(args: ListStackInstancesCommandInput, cb: (err: any, data?: ListStackInstancesCommandOutput) => void): void;
|
|
660
321
|
listStackInstances(args: ListStackInstancesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListStackInstancesCommandOutput) => void): void;
|
|
661
322
|
/**
|
|
662
|
-
* @
|
|
663
|
-
* <p>Returns descriptions of all resources of the specified stack.</p>
|
|
664
|
-
* <p>For deleted stacks, ListStackResources returns resource information for up to 90 days
|
|
665
|
-
* after the stack has been deleted.</p>
|
|
323
|
+
* @see {@link ListStackResourcesCommand}
|
|
666
324
|
*/
|
|
667
325
|
listStackResources(args: ListStackResourcesCommandInput, options?: __HttpHandlerOptions): Promise<ListStackResourcesCommandOutput>;
|
|
668
326
|
listStackResources(args: ListStackResourcesCommandInput, cb: (err: any, data?: ListStackResourcesCommandOutput) => void): void;
|
|
669
327
|
listStackResources(args: ListStackResourcesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListStackResourcesCommandOutput) => void): void;
|
|
670
328
|
/**
|
|
671
|
-
* @
|
|
672
|
-
* <p>Returns the summary information for stacks whose status matches the specified
|
|
673
|
-
* StackStatusFilter. Summary information for stacks that have been deleted is kept for 90
|
|
674
|
-
* days after the stack is deleted. If no StackStatusFilter is specified, summary information
|
|
675
|
-
* for all stacks is returned (including existing stacks and stacks that have been
|
|
676
|
-
* deleted).</p>
|
|
329
|
+
* @see {@link ListStacksCommand}
|
|
677
330
|
*/
|
|
678
331
|
listStacks(args: ListStacksCommandInput, options?: __HttpHandlerOptions): Promise<ListStacksCommandOutput>;
|
|
679
332
|
listStacks(args: ListStacksCommandInput, cb: (err: any, data?: ListStacksCommandOutput) => void): void;
|
|
680
333
|
listStacks(args: ListStacksCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListStacksCommandOutput) => void): void;
|
|
681
334
|
/**
|
|
682
|
-
* @
|
|
683
|
-
* <p>Returns summary information about the results of a stack set operation.</p>
|
|
335
|
+
* @see {@link ListStackSetOperationResultsCommand}
|
|
684
336
|
*/
|
|
685
337
|
listStackSetOperationResults(args: ListStackSetOperationResultsCommandInput, options?: __HttpHandlerOptions): Promise<ListStackSetOperationResultsCommandOutput>;
|
|
686
338
|
listStackSetOperationResults(args: ListStackSetOperationResultsCommandInput, cb: (err: any, data?: ListStackSetOperationResultsCommandOutput) => void): void;
|
|
687
339
|
listStackSetOperationResults(args: ListStackSetOperationResultsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListStackSetOperationResultsCommandOutput) => void): void;
|
|
688
340
|
/**
|
|
689
|
-
* @
|
|
690
|
-
* <p>Returns summary information about operations performed on a stack set.</p>
|
|
341
|
+
* @see {@link ListStackSetOperationsCommand}
|
|
691
342
|
*/
|
|
692
343
|
listStackSetOperations(args: ListStackSetOperationsCommandInput, options?: __HttpHandlerOptions): Promise<ListStackSetOperationsCommandOutput>;
|
|
693
344
|
listStackSetOperations(args: ListStackSetOperationsCommandInput, cb: (err: any, data?: ListStackSetOperationsCommandOutput) => void): void;
|
|
694
345
|
listStackSetOperations(args: ListStackSetOperationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListStackSetOperationsCommandOutput) => void): void;
|
|
695
346
|
/**
|
|
696
|
-
* @
|
|
697
|
-
* <p>Returns summary information about stack sets that are associated with the user.</p>
|
|
698
|
-
* <ul>
|
|
699
|
-
* <li>
|
|
700
|
-
* <p>[Self-managed permissions] If you set the <code>CallAs</code> parameter to
|
|
701
|
-
* <code>SELF</code> while signed in to your Amazon Web Services account,
|
|
702
|
-
* <code>ListStackSets</code> returns all self-managed stack sets in your Amazon Web Services account.</p>
|
|
703
|
-
* </li>
|
|
704
|
-
* <li>
|
|
705
|
-
* <p>[Service-managed permissions] If you set the <code>CallAs</code> parameter to
|
|
706
|
-
* <code>SELF</code> while signed in to the organization's management account, <code>ListStackSets</code> returns all stack sets in the
|
|
707
|
-
* management account.</p>
|
|
708
|
-
* </li>
|
|
709
|
-
* <li>
|
|
710
|
-
* <p>[Service-managed permissions] If you set the <code>CallAs</code> parameter to
|
|
711
|
-
* <code>DELEGATED_ADMIN</code> while signed in to your member account,
|
|
712
|
-
* <code>ListStackSets</code> returns all stack sets with service-managed permissions
|
|
713
|
-
* in the management account.</p>
|
|
714
|
-
* </li>
|
|
715
|
-
* </ul>
|
|
347
|
+
* @see {@link ListStackSetsCommand}
|
|
716
348
|
*/
|
|
717
349
|
listStackSets(args: ListStackSetsCommandInput, options?: __HttpHandlerOptions): Promise<ListStackSetsCommandOutput>;
|
|
718
350
|
listStackSets(args: ListStackSetsCommandInput, cb: (err: any, data?: ListStackSetsCommandOutput) => void): void;
|
|
719
351
|
listStackSets(args: ListStackSetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListStackSetsCommandOutput) => void): void;
|
|
720
352
|
/**
|
|
721
|
-
* @
|
|
722
|
-
* <p>Returns a list of registration tokens for the specified extension(s).</p>
|
|
353
|
+
* @see {@link ListTypeRegistrationsCommand}
|
|
723
354
|
*/
|
|
724
355
|
listTypeRegistrations(args: ListTypeRegistrationsCommandInput, options?: __HttpHandlerOptions): Promise<ListTypeRegistrationsCommandOutput>;
|
|
725
356
|
listTypeRegistrations(args: ListTypeRegistrationsCommandInput, cb: (err: any, data?: ListTypeRegistrationsCommandOutput) => void): void;
|
|
726
357
|
listTypeRegistrations(args: ListTypeRegistrationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTypeRegistrationsCommandOutput) => void): void;
|
|
727
358
|
/**
|
|
728
|
-
* @
|
|
729
|
-
* <p>Returns summary information about extension that have been registered with CloudFormation.</p>
|
|
359
|
+
* @see {@link ListTypesCommand}
|
|
730
360
|
*/
|
|
731
361
|
listTypes(args: ListTypesCommandInput, options?: __HttpHandlerOptions): Promise<ListTypesCommandOutput>;
|
|
732
362
|
listTypes(args: ListTypesCommandInput, cb: (err: any, data?: ListTypesCommandOutput) => void): void;
|
|
733
363
|
listTypes(args: ListTypesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTypesCommandOutput) => void): void;
|
|
734
364
|
/**
|
|
735
|
-
* @
|
|
736
|
-
* <p>Returns summary information about the versions of an extension.</p>
|
|
365
|
+
* @see {@link ListTypeVersionsCommand}
|
|
737
366
|
*/
|
|
738
367
|
listTypeVersions(args: ListTypeVersionsCommandInput, options?: __HttpHandlerOptions): Promise<ListTypeVersionsCommandOutput>;
|
|
739
368
|
listTypeVersions(args: ListTypeVersionsCommandInput, cb: (err: any, data?: ListTypeVersionsCommandOutput) => void): void;
|
|
740
369
|
listTypeVersions(args: ListTypeVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTypeVersionsCommandOutput) => void): void;
|
|
741
370
|
/**
|
|
742
|
-
* @
|
|
743
|
-
* <p>Publishes the specified extension to the CloudFormation registry as a public
|
|
744
|
-
* extension in this region. Public extensions are available for use by all CloudFormation users. For more information about publishing 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
|
|
745
|
-
* <i>CloudFormation CLI User Guide</i>.</p>
|
|
746
|
-
* <p>To publish an extension, you must be registered as a publisher with CloudFormation. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterPublisher.html">RegisterPublisher</a>.</p>
|
|
371
|
+
* @see {@link PublishTypeCommand}
|
|
747
372
|
*/
|
|
748
373
|
publishType(args: PublishTypeCommandInput, options?: __HttpHandlerOptions): Promise<PublishTypeCommandOutput>;
|
|
749
374
|
publishType(args: PublishTypeCommandInput, cb: (err: any, data?: PublishTypeCommandOutput) => void): void;
|
|
750
375
|
publishType(args: PublishTypeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PublishTypeCommandOutput) => void): void;
|
|
751
376
|
/**
|
|
752
|
-
* @
|
|
753
|
-
* <p>Reports progress of a resource handler to CloudFormation.</p>
|
|
754
|
-
* <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 use this API in your code.</p>
|
|
377
|
+
* @see {@link RecordHandlerProgressCommand}
|
|
755
378
|
*/
|
|
756
379
|
recordHandlerProgress(args: RecordHandlerProgressCommandInput, options?: __HttpHandlerOptions): Promise<RecordHandlerProgressCommandOutput>;
|
|
757
380
|
recordHandlerProgress(args: RecordHandlerProgressCommandInput, cb: (err: any, data?: RecordHandlerProgressCommandOutput) => void): void;
|
|
758
381
|
recordHandlerProgress(args: RecordHandlerProgressCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RecordHandlerProgressCommandOutput) => void): void;
|
|
759
382
|
/**
|
|
760
|
-
* @
|
|
761
|
-
* <p>Registers your account as a publisher of public extensions in the CloudFormation registry. Public extensions are available for use by all CloudFormation users.
|
|
762
|
-
* This publisher ID applies to your account in all Amazon Web Services Regions.</p>
|
|
763
|
-
* <p>For information about requirements for registering as a public extension publisher, see
|
|
764
|
-
* <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.html#publish-extension-prereqs">Registering your account to publish CloudFormation
|
|
765
|
-
* extensions</a> in the <i>CloudFormation CLI User
|
|
766
|
-
* Guide</i>.</p>
|
|
767
|
-
* <p></p>
|
|
383
|
+
* @see {@link RegisterPublisherCommand}
|
|
768
384
|
*/
|
|
769
385
|
registerPublisher(args: RegisterPublisherCommandInput, options?: __HttpHandlerOptions): Promise<RegisterPublisherCommandOutput>;
|
|
770
386
|
registerPublisher(args: RegisterPublisherCommandInput, cb: (err: any, data?: RegisterPublisherCommandOutput) => void): void;
|
|
771
387
|
registerPublisher(args: RegisterPublisherCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RegisterPublisherCommandOutput) => void): void;
|
|
772
388
|
/**
|
|
773
|
-
* @
|
|
774
|
-
* <p>Registers an extension with the CloudFormation service. Registering an
|
|
775
|
-
* extension makes it available for use in CloudFormation templates in your Amazon Web Services account, and includes:</p>
|
|
776
|
-
* <ul>
|
|
777
|
-
* <li>
|
|
778
|
-
* <p>Validating the extension schema.</p>
|
|
779
|
-
* </li>
|
|
780
|
-
* <li>
|
|
781
|
-
* <p>Determining which handlers, if any, have been specified for the extension.</p>
|
|
782
|
-
* </li>
|
|
783
|
-
* <li>
|
|
784
|
-
* <p>Making the extension available for use in your account.</p>
|
|
785
|
-
* </li>
|
|
786
|
-
* </ul>
|
|
787
|
-
* <p>For more information about how to develop extensions and ready them for registration,
|
|
788
|
-
* see <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-types.html">Creating Resource
|
|
789
|
-
* Providers</a> in the <i>CloudFormation CLI User
|
|
790
|
-
* Guide</i>.</p>
|
|
791
|
-
* <p>You can have a maximum of 50 resource extension versions registered at a time. This
|
|
792
|
-
* maximum is per account and per region. Use <a href="AWSCloudFormation/latest/APIReference/API_DeregisterType.html">DeregisterType</a> to deregister specific extension versions if necessary.</p>
|
|
793
|
-
* <p>Once you have initiated a registration request using <code>
|
|
794
|
-
* <a>RegisterType</a>
|
|
795
|
-
* </code>, you can use <code>
|
|
796
|
-
* <a>DescribeTypeRegistration</a>
|
|
797
|
-
* </code> to
|
|
798
|
-
* monitor the progress of the registration request.</p>
|
|
799
|
-
* <p>Once you have registered a private extension in your account and region, use <a href="AWSCloudFormation/latest/APIReference/API_SetTypeConfiguration.html">SetTypeConfiguration</a> to specify configuration properties for the extension. For
|
|
800
|
-
* 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>
|
|
389
|
+
* @see {@link RegisterTypeCommand}
|
|
801
390
|
*/
|
|
802
391
|
registerType(args: RegisterTypeCommandInput, options?: __HttpHandlerOptions): Promise<RegisterTypeCommandOutput>;
|
|
803
392
|
registerType(args: RegisterTypeCommandInput, cb: (err: any, data?: RegisterTypeCommandOutput) => void): void;
|
|
804
393
|
registerType(args: RegisterTypeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RegisterTypeCommandOutput) => void): void;
|
|
805
394
|
/**
|
|
806
|
-
* @
|
|
807
|
-
* <p>When specifying <code>RollbackStack</code>, you preserve the state of previously
|
|
808
|
-
* provisioned resources when an operation fails. You can check the status of the stack
|
|
809
|
-
* through the <a>DescribeStacks</a> operation.</p>
|
|
810
|
-
* <p>Rolls back the specified stack to the last known stable state from
|
|
811
|
-
* <code>CREATE_FAILED</code> or <code>UPDATE_FAILED</code> stack statuses.</p>
|
|
812
|
-
* <p>This operation will delete a stack if it doesn't contain a last known stable state. A
|
|
813
|
-
* last known stable state includes any status in a <code>*_COMPLETE</code>. This includes the
|
|
814
|
-
* following stack statuses.</p>
|
|
815
|
-
* <ul>
|
|
816
|
-
* <li>
|
|
817
|
-
* <p>
|
|
818
|
-
* <code>CREATE_COMPLETE</code>
|
|
819
|
-
* </p>
|
|
820
|
-
* </li>
|
|
821
|
-
* <li>
|
|
822
|
-
* <p>
|
|
823
|
-
* <code>UPDATE_COMPLETE</code>
|
|
824
|
-
* </p>
|
|
825
|
-
* </li>
|
|
826
|
-
* <li>
|
|
827
|
-
* <p>
|
|
828
|
-
* <code>UPDATE_ROLLBACK_COMPLETE</code>
|
|
829
|
-
* </p>
|
|
830
|
-
* </li>
|
|
831
|
-
* <li>
|
|
832
|
-
* <p>
|
|
833
|
-
* <code>IMPORT_COMPLETE</code>
|
|
834
|
-
* </p>
|
|
835
|
-
* </li>
|
|
836
|
-
* <li>
|
|
837
|
-
* <p>
|
|
838
|
-
* <code>IMPORT_ROLLBACK_COMPLETE</code>
|
|
839
|
-
* </p>
|
|
840
|
-
* </li>
|
|
841
|
-
* </ul>
|
|
395
|
+
* @see {@link RollbackStackCommand}
|
|
842
396
|
*/
|
|
843
397
|
rollbackStack(args: RollbackStackCommandInput, options?: __HttpHandlerOptions): Promise<RollbackStackCommandOutput>;
|
|
844
398
|
rollbackStack(args: RollbackStackCommandInput, cb: (err: any, data?: RollbackStackCommandOutput) => void): void;
|
|
845
399
|
rollbackStack(args: RollbackStackCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RollbackStackCommandOutput) => void): void;
|
|
846
400
|
/**
|
|
847
|
-
* @
|
|
848
|
-
* <p>Sets a stack policy for a specified stack.</p>
|
|
401
|
+
* @see {@link SetStackPolicyCommand}
|
|
849
402
|
*/
|
|
850
403
|
setStackPolicy(args: SetStackPolicyCommandInput, options?: __HttpHandlerOptions): Promise<SetStackPolicyCommandOutput>;
|
|
851
404
|
setStackPolicy(args: SetStackPolicyCommandInput, cb: (err: any, data?: SetStackPolicyCommandOutput) => void): void;
|
|
852
405
|
setStackPolicy(args: SetStackPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetStackPolicyCommandOutput) => void): void;
|
|
853
406
|
/**
|
|
854
|
-
* @
|
|
855
|
-
* <p>Specifies the configuration data for a registered CloudFormation extension, in
|
|
856
|
-
* the given account and region.</p>
|
|
857
|
-
* <p>To view the current configuration data for an extension, refer to the
|
|
858
|
-
* <code>ConfigurationSchema</code> element of <a href="AWSCloudFormation/latest/APIReference/API_DescribeType.html">DescribeType</a>.
|
|
859
|
-
* For 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
|
|
860
|
-
* <i>CloudFormation User Guide</i>.</p>
|
|
861
|
-
* <important>
|
|
862
|
-
* <p>It's strongly recommended that you use dynamic references to restrict sensitive
|
|
863
|
-
* configuration definitions, such as third-party credentials. For more details on dynamic
|
|
864
|
-
* references, see <a href="https://docs.aws.amazon.com/">Using dynamic references to specify
|
|
865
|
-
* template values</a> in the <i>CloudFormation User
|
|
866
|
-
* Guide</i>.</p>
|
|
867
|
-
* </important>
|
|
407
|
+
* @see {@link SetTypeConfigurationCommand}
|
|
868
408
|
*/
|
|
869
409
|
setTypeConfiguration(args: SetTypeConfigurationCommandInput, options?: __HttpHandlerOptions): Promise<SetTypeConfigurationCommandOutput>;
|
|
870
410
|
setTypeConfiguration(args: SetTypeConfigurationCommandInput, cb: (err: any, data?: SetTypeConfigurationCommandOutput) => void): void;
|
|
871
411
|
setTypeConfiguration(args: SetTypeConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetTypeConfigurationCommandOutput) => void): void;
|
|
872
412
|
/**
|
|
873
|
-
* @
|
|
874
|
-
* <p>Specify the default version of an extension. The default version of an extension will be
|
|
875
|
-
* used in CloudFormation operations.</p>
|
|
413
|
+
* @see {@link SetTypeDefaultVersionCommand}
|
|
876
414
|
*/
|
|
877
415
|
setTypeDefaultVersion(args: SetTypeDefaultVersionCommandInput, options?: __HttpHandlerOptions): Promise<SetTypeDefaultVersionCommandOutput>;
|
|
878
416
|
setTypeDefaultVersion(args: SetTypeDefaultVersionCommandInput, cb: (err: any, data?: SetTypeDefaultVersionCommandOutput) => void): void;
|
|
879
417
|
setTypeDefaultVersion(args: SetTypeDefaultVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetTypeDefaultVersionCommandOutput) => void): void;
|
|
880
418
|
/**
|
|
881
|
-
* @
|
|
882
|
-
* <p>Sends a signal to the specified resource with a success or failure status. You can use
|
|
883
|
-
* the <code>SignalResource</code> operation in conjunction with a creation policy or update
|
|
884
|
-
* policy. CloudFormation doesn't proceed with a stack creation or update until
|
|
885
|
-
* resources receive the required number of signals or the timeout period is exceeded. The
|
|
886
|
-
* <code>SignalResource</code> operation is useful in cases where you want to send signals
|
|
887
|
-
* from anywhere other than an Amazon EC2 instance.</p>
|
|
419
|
+
* @see {@link SignalResourceCommand}
|
|
888
420
|
*/
|
|
889
421
|
signalResource(args: SignalResourceCommandInput, options?: __HttpHandlerOptions): Promise<SignalResourceCommandOutput>;
|
|
890
422
|
signalResource(args: SignalResourceCommandInput, cb: (err: any, data?: SignalResourceCommandOutput) => void): void;
|
|
891
423
|
signalResource(args: SignalResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SignalResourceCommandOutput) => void): void;
|
|
892
424
|
/**
|
|
893
|
-
* @
|
|
894
|
-
* <p>Stops an in-progress operation on a stack set and its associated stack instances.
|
|
895
|
-
* StackSets will cancel all the unstarted stack instance deployments and wait for those are
|
|
896
|
-
* in-progress to complete.</p>
|
|
425
|
+
* @see {@link StopStackSetOperationCommand}
|
|
897
426
|
*/
|
|
898
427
|
stopStackSetOperation(args: StopStackSetOperationCommandInput, options?: __HttpHandlerOptions): Promise<StopStackSetOperationCommandOutput>;
|
|
899
428
|
stopStackSetOperation(args: StopStackSetOperationCommandInput, cb: (err: any, data?: StopStackSetOperationCommandOutput) => void): void;
|
|
900
429
|
stopStackSetOperation(args: StopStackSetOperationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopStackSetOperationCommandOutput) => void): void;
|
|
901
430
|
/**
|
|
902
|
-
* @
|
|
903
|
-
* <p>Tests a registered extension to make sure it meets all necessary requirements for being
|
|
904
|
-
* published in the CloudFormation registry.</p>
|
|
905
|
-
* <ul>
|
|
906
|
-
* <li>
|
|
907
|
-
* <p>For resource types, this includes passing all contracts tests defined for the
|
|
908
|
-
* type.</p>
|
|
909
|
-
* </li>
|
|
910
|
-
* <li>
|
|
911
|
-
* <p>For modules, this includes determining if the module's model meets all necessary
|
|
912
|
-
* requirements.</p>
|
|
913
|
-
* </li>
|
|
914
|
-
* </ul>
|
|
915
|
-
* <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 extension prior to publishing</a> in the <i>CloudFormation CLI User Guide</i>.</p>
|
|
916
|
-
* <p>If you don't specify a version, CloudFormation uses the default version of the
|
|
917
|
-
* extension in your account and region for testing.</p>
|
|
918
|
-
* <p>To perform testing, CloudFormation assumes the execution role specified when
|
|
919
|
-
* the type was registered. For more information, see <a href="AWSCloudFormation/latest/APIReference/API_RegisterType.html">RegisterType</a>.</p>
|
|
920
|
-
* <p>Once you've initiated testing on an extension using <code>TestType</code>, you can pass
|
|
921
|
-
* the returned <code>TypeVersionArn</code> into <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DescribeType.html">DescribeType</a> to monitor the current test status and test status description for
|
|
922
|
-
* the extension.</p>
|
|
923
|
-
* <p>An extension must have a test status of <code>PASSED</code> before it can be published.
|
|
924
|
-
* For more information, see <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-publish.html">Publishing extensions to make them available for public use</a>
|
|
925
|
-
* in the <i>CloudFormation CLI User Guide</i>.</p>
|
|
431
|
+
* @see {@link TestTypeCommand}
|
|
926
432
|
*/
|
|
927
433
|
testType(args: TestTypeCommandInput, options?: __HttpHandlerOptions): Promise<TestTypeCommandOutput>;
|
|
928
434
|
testType(args: TestTypeCommandInput, cb: (err: any, data?: TestTypeCommandOutput) => void): void;
|
|
929
435
|
testType(args: TestTypeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TestTypeCommandOutput) => void): void;
|
|
930
436
|
/**
|
|
931
|
-
* @
|
|
932
|
-
* <p>Updates a stack as specified in the template. After the call completes successfully, the
|
|
933
|
-
* stack update starts. You can check the status of the stack through the <a>DescribeStacks</a> action.</p>
|
|
934
|
-
* <p>To get a copy of the template for an existing stack, you can use the <a>GetTemplate</a> action.</p>
|
|
935
|
-
* <p>For more information about creating an update template, updating a stack, and monitoring
|
|
936
|
-
* the progress of the update, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks.html">Updating a
|
|
937
|
-
* Stack</a>.</p>
|
|
437
|
+
* @see {@link UpdateStackCommand}
|
|
938
438
|
*/
|
|
939
439
|
updateStack(args: UpdateStackCommandInput, options?: __HttpHandlerOptions): Promise<UpdateStackCommandOutput>;
|
|
940
440
|
updateStack(args: UpdateStackCommandInput, cb: (err: any, data?: UpdateStackCommandOutput) => void): void;
|
|
941
441
|
updateStack(args: UpdateStackCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateStackCommandOutput) => void): void;
|
|
942
442
|
/**
|
|
943
|
-
* @
|
|
944
|
-
* <p>Updates the parameter values for stack instances for the specified accounts, within the
|
|
945
|
-
* specified Amazon Web Services Regions. A stack instance refers to a stack in a specific
|
|
946
|
-
* account and Region.</p>
|
|
947
|
-
* <p>You can only update stack instances in Amazon Web Services Regions and accounts where
|
|
948
|
-
* they already exist; to create additional stack instances, use <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_CreateStackInstances.html">CreateStackInstances</a>.</p>
|
|
949
|
-
* <p>During stack set updates, any parameters overridden for a stack instance aren't updated,
|
|
950
|
-
* but retain their overridden value.</p>
|
|
951
|
-
* <p>You can only update the parameter <i>values</i> that are specified in the
|
|
952
|
-
* stack set; to add or delete a parameter itself, use <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_UpdateStackSet.html">UpdateStackSet</a> to update the stack set template. If you add a parameter to a
|
|
953
|
-
* template, before you can override the parameter value specified in the stack set you must
|
|
954
|
-
* first use <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_UpdateStackSet.html">UpdateStackSet</a> to update all stack instances with the updated template and
|
|
955
|
-
* parameter value specified in the stack set. Once a stack instance has been updated with the
|
|
956
|
-
* new parameter, you can then override the parameter value using
|
|
957
|
-
* <code>UpdateStackInstances</code>.</p>
|
|
443
|
+
* @see {@link UpdateStackInstancesCommand}
|
|
958
444
|
*/
|
|
959
445
|
updateStackInstances(args: UpdateStackInstancesCommandInput, options?: __HttpHandlerOptions): Promise<UpdateStackInstancesCommandOutput>;
|
|
960
446
|
updateStackInstances(args: UpdateStackInstancesCommandInput, cb: (err: any, data?: UpdateStackInstancesCommandOutput) => void): void;
|
|
961
447
|
updateStackInstances(args: UpdateStackInstancesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateStackInstancesCommandOutput) => void): void;
|
|
962
448
|
/**
|
|
963
|
-
* @
|
|
964
|
-
* <p>Updates the stack set, and associated stack instances in the specified accounts and
|
|
965
|
-
* Amazon Web Services Regions.</p>
|
|
966
|
-
* <p>Even if the stack set operation created by updating the stack set fails (completely or
|
|
967
|
-
* partially, below or above a specified failure tolerance), the stack set is updated with
|
|
968
|
-
* your changes. Subsequent <a>CreateStackInstances</a> calls on the specified
|
|
969
|
-
* stack set use the updated stack set.</p>
|
|
449
|
+
* @see {@link UpdateStackSetCommand}
|
|
970
450
|
*/
|
|
971
451
|
updateStackSet(args: UpdateStackSetCommandInput, options?: __HttpHandlerOptions): Promise<UpdateStackSetCommandOutput>;
|
|
972
452
|
updateStackSet(args: UpdateStackSetCommandInput, cb: (err: any, data?: UpdateStackSetCommandOutput) => void): void;
|
|
973
453
|
updateStackSet(args: UpdateStackSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateStackSetCommandOutput) => void): void;
|
|
974
454
|
/**
|
|
975
|
-
* @
|
|
976
|
-
* <p>Updates termination protection for the specified stack. If a user attempts to delete a
|
|
977
|
-
* stack with termination protection enabled, the operation fails and the stack remains
|
|
978
|
-
* unchanged. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-protect-stacks.html">Protecting a
|
|
979
|
-
* Stack From Being Deleted</a> in the <i>CloudFormation User Guide</i>.</p>
|
|
980
|
-
* <p>For <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html">nested
|
|
981
|
-
* stacks</a>, termination protection is set on the root stack and can't be changed
|
|
982
|
-
* directly on the nested stack.</p>
|
|
455
|
+
* @see {@link UpdateTerminationProtectionCommand}
|
|
983
456
|
*/
|
|
984
457
|
updateTerminationProtection(args: UpdateTerminationProtectionCommandInput, options?: __HttpHandlerOptions): Promise<UpdateTerminationProtectionCommandOutput>;
|
|
985
458
|
updateTerminationProtection(args: UpdateTerminationProtectionCommandInput, cb: (err: any, data?: UpdateTerminationProtectionCommandOutput) => void): void;
|
|
986
459
|
updateTerminationProtection(args: UpdateTerminationProtectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateTerminationProtectionCommandOutput) => void): void;
|
|
987
460
|
/**
|
|
988
|
-
* @
|
|
989
|
-
* <p>Validates a specified template. CloudFormation first checks if the template is
|
|
990
|
-
* valid JSON. If it isn't, CloudFormation checks if the template is valid YAML. If
|
|
991
|
-
* both these checks fail, CloudFormation returns a template validation error.</p>
|
|
461
|
+
* @see {@link ValidateTemplateCommand}
|
|
992
462
|
*/
|
|
993
463
|
validateTemplate(args: ValidateTemplateCommandInput, options?: __HttpHandlerOptions): Promise<ValidateTemplateCommandOutput>;
|
|
994
464
|
validateTemplate(args: ValidateTemplateCommandInput, cb: (err: any, data?: ValidateTemplateCommandOutput) => void): void;
|
|
995
465
|
validateTemplate(args: ValidateTemplateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ValidateTemplateCommandOutput) => void): void;
|
|
996
466
|
}
|
|
467
|
+
/**
|
|
468
|
+
* @public
|
|
469
|
+
* <fullname>CloudFormation</fullname>
|
|
470
|
+
* <p>CloudFormation allows you to create and manage Amazon Web Services infrastructure
|
|
471
|
+
* deployments predictably and repeatedly. You can use CloudFormation to leverage
|
|
472
|
+
* Amazon Web Services products, such as Amazon Elastic Compute Cloud, Amazon Elastic Block Store,
|
|
473
|
+
* Amazon Simple Notification Service, Elastic Load Balancing, and Auto Scaling to build highly
|
|
474
|
+
* reliable, highly scalable, cost-effective applications without creating or configuring the
|
|
475
|
+
* underlying Amazon Web Services infrastructure.</p>
|
|
476
|
+
* <p>With CloudFormation, you declare all your resources and dependencies in a template
|
|
477
|
+
* file. The template defines a collection of resources as a single unit called a stack.
|
|
478
|
+
* CloudFormation creates and deletes all member resources of the stack together and
|
|
479
|
+
* manages all dependencies between the resources for you.</p>
|
|
480
|
+
* <p>For more information about CloudFormation, see the <a href="http://aws.amazon.com/cloudformation/">CloudFormation product page</a>.</p>
|
|
481
|
+
* <p>CloudFormation makes use of other Amazon Web Services products. If you need
|
|
482
|
+
* additional technical information about a specific Amazon Web Services product, you can find
|
|
483
|
+
* the product's technical documentation at <a href="https://docs.aws.amazon.com/">
|
|
484
|
+
* <code>docs.aws.amazon.com</code>
|
|
485
|
+
* </a>.</p>
|
|
486
|
+
*/
|
|
487
|
+
export declare class CloudFormation extends CloudFormationClient implements CloudFormation {
|
|
488
|
+
}
|