@aws-sdk/client-cloudformation 3.51.0 → 3.52.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/CHANGELOG.md +11 -0
- package/README.md +10 -10
- package/dist-cjs/CloudFormation.js +15 -0
- package/dist-cjs/commands/DescribeChangeSetHooksCommand.js +36 -0
- package/dist-cjs/commands/index.js +1 -0
- package/dist-cjs/models/models_0.js +65 -5
- package/dist-cjs/protocols/Aws_query.js +208 -3
- package/dist-es/CloudFormation.js +15 -0
- package/dist-es/commands/DescribeChangeSetHooksCommand.js +39 -0
- package/dist-es/commands/index.js +1 -0
- package/dist-es/models/models_0.js +50 -0
- package/dist-es/protocols/Aws_query.js +211 -0
- package/dist-types/CloudFormation.d.ts +134 -130
- package/dist-types/CloudFormationClient.d.ts +13 -12
- package/dist-types/commands/ActivateTypeCommand.d.ts +1 -2
- package/dist-types/commands/BatchDescribeTypeConfigurationsCommand.d.ts +2 -2
- package/dist-types/commands/CancelUpdateStackCommand.d.ts +2 -1
- package/dist-types/commands/ContinueUpdateRollbackCommand.d.ts +8 -8
- package/dist-types/commands/CreateChangeSetCommand.d.ts +6 -7
- package/dist-types/commands/CreateStackCommand.d.ts +1 -1
- package/dist-types/commands/CreateStackInstancesCommand.d.ts +4 -4
- package/dist-types/commands/DeactivateTypeCommand.d.ts +3 -3
- package/dist-types/commands/DeleteChangeSetCommand.d.ts +2 -2
- package/dist-types/commands/DeleteStackCommand.d.ts +2 -2
- package/dist-types/commands/DeleteStackInstancesCommand.d.ts +1 -1
- package/dist-types/commands/DeregisterTypeCommand.d.ts +3 -3
- package/dist-types/commands/DescribeAccountLimitsCommand.d.ts +3 -3
- package/dist-types/commands/DescribeChangeSetCommand.d.ts +2 -3
- package/dist-types/commands/DescribeChangeSetHooksCommand.d.ts +35 -0
- package/dist-types/commands/DescribePublisherCommand.d.ts +3 -4
- package/dist-types/commands/DescribeStackEventsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeStackResourceDriftsCommand.d.ts +2 -2
- package/dist-types/commands/DescribeStackSetCommand.d.ts +1 -1
- package/dist-types/commands/DescribeStackSetOperationCommand.d.ts +1 -1
- package/dist-types/commands/DescribeStacksCommand.d.ts +1 -1
- package/dist-types/commands/DetectStackDriftCommand.d.ts +1 -1
- package/dist-types/commands/DetectStackResourceDriftCommand.d.ts +1 -1
- package/dist-types/commands/DetectStackSetDriftCommand.d.ts +7 -6
- package/dist-types/commands/ExecuteChangeSetCommand.d.ts +7 -7
- package/dist-types/commands/GetTemplateCommand.d.ts +3 -3
- package/dist-types/commands/GetTemplateSummaryCommand.d.ts +1 -1
- package/dist-types/commands/ImportStacksToStackSetCommand.d.ts +9 -6
- package/dist-types/commands/ListExportsCommand.d.ts +1 -1
- package/dist-types/commands/ListStackSetOperationResultsCommand.d.ts +1 -1
- package/dist-types/commands/ListStackSetOperationsCommand.d.ts +1 -1
- package/dist-types/commands/ListStackSetsCommand.d.ts +2 -3
- package/dist-types/commands/PublishTypeCommand.d.ts +4 -6
- package/dist-types/commands/RecordHandlerProgressCommand.d.ts +1 -1
- package/dist-types/commands/RegisterPublisherCommand.d.ts +4 -4
- package/dist-types/commands/RegisterTypeCommand.d.ts +5 -6
- package/dist-types/commands/RollbackStackCommand.d.ts +1 -1
- package/dist-types/commands/SetTypeConfigurationCommand.d.ts +3 -3
- package/dist-types/commands/SignalResourceCommand.d.ts +2 -2
- package/dist-types/commands/StopStackSetOperationCommand.d.ts +1 -1
- package/dist-types/commands/TestTypeCommand.d.ts +4 -5
- package/dist-types/commands/UpdateStackCommand.d.ts +1 -1
- package/dist-types/commands/UpdateStackInstancesCommand.d.ts +6 -5
- package/dist-types/commands/UpdateStackSetCommand.d.ts +1 -1
- package/dist-types/commands/UpdateTerminationProtectionCommand.d.ts +1 -1
- package/dist-types/commands/index.d.ts +1 -0
- package/dist-types/models/models_0.d.ts +1009 -733
- package/dist-types/protocols/Aws_query.d.ts +3 -0
- package/dist-types/ts3.4/CloudFormation.d.ts +5 -0
- package/dist-types/ts3.4/CloudFormationClient.d.ts +3 -2
- package/dist-types/ts3.4/commands/DescribeChangeSetHooksCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/index.d.ts +1 -0
- package/dist-types/ts3.4/models/models_0.d.ts +116 -2
- package/dist-types/ts3.4/protocols/Aws_query.d.ts +3 -0
- package/package.json +34 -34
|
@@ -7,12 +7,10 @@ export interface PublishTypeCommandInput extends PublishTypeInput {
|
|
|
7
7
|
export interface PublishTypeCommandOutput extends PublishTypeOutput, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Publishes the specified extension to the CloudFormation registry as a public
|
|
11
|
-
* in this region. Public extensions are available for use by all CloudFormation users. For
|
|
12
|
-
*
|
|
13
|
-
*
|
|
14
|
-
* <p>To publish an extension, you must be registered as a publisher with CloudFormation. For
|
|
15
|
-
* more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_RegisterPublisher.html">RegisterPublisher</a>.</p>
|
|
10
|
+
* <p>Publishes the specified extension to the CloudFormation registry as a public
|
|
11
|
+
* extension in this region. Public extensions are available for use by all CloudFormation users. For more information on 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
|
|
12
|
+
* <i>CloudFormation CLI User Guide</i>.</p>
|
|
13
|
+
* <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>
|
|
16
14
|
* @example
|
|
17
15
|
* Use a bare-bones client and the command you need to make an API call.
|
|
18
16
|
* ```javascript
|
|
@@ -8,7 +8,7 @@ export interface RecordHandlerProgressCommandOutput extends RecordHandlerProgres
|
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
10
|
* <p>Reports progress of a resource handler to CloudFormation.</p>
|
|
11
|
-
* <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>.
|
|
11
|
+
* <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>
|
|
12
12
|
* @example
|
|
13
13
|
* Use a bare-bones client and the command you need to make an API call.
|
|
14
14
|
* ```javascript
|
|
@@ -7,12 +7,12 @@ export interface RegisterPublisherCommandInput extends RegisterPublisherInput {
|
|
|
7
7
|
export interface RegisterPublisherCommandOutput extends RegisterPublisherOutput, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Registers your account as a publisher of public extensions in the CloudFormation
|
|
11
|
-
*
|
|
12
|
-
* publisher ID applies to your account in all Amazon Web Services Regions.</p>
|
|
10
|
+
* <p>Registers your account as a publisher of public extensions in the CloudFormation registry. Public extensions are available for use by all CloudFormation users.
|
|
11
|
+
* This publisher ID applies to your account in all Amazon Web Services Regions.</p>
|
|
13
12
|
* <p>For information on requirements for registering as a public extension publisher, see
|
|
14
13
|
* <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/publish-extension.html#publish-extension-prereqs">Registering your account to publish CloudFormation
|
|
15
|
-
* extensions</a> in the <i>CloudFormation CLI User
|
|
14
|
+
* extensions</a> in the <i>CloudFormation CLI User
|
|
15
|
+
* Guide</i>.</p>
|
|
16
16
|
* <p></p>
|
|
17
17
|
* @example
|
|
18
18
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -11,16 +11,16 @@ export interface RegisterTypeCommandOutput extends RegisterTypeOutput, __Metadat
|
|
|
11
11
|
* extension makes it available for use in CloudFormation templates in your Amazon Web Services account, and includes:</p>
|
|
12
12
|
* <ul>
|
|
13
13
|
* <li>
|
|
14
|
-
* <p>Validating the extension schema
|
|
14
|
+
* <p>Validating the extension schema.</p>
|
|
15
15
|
* </li>
|
|
16
16
|
* <li>
|
|
17
|
-
* <p>Determining which handlers, if any, have been specified for the extension
|
|
17
|
+
* <p>Determining which handlers, if any, have been specified for the extension.</p>
|
|
18
18
|
* </li>
|
|
19
19
|
* <li>
|
|
20
|
-
* <p>Making the extension available for use in your account
|
|
20
|
+
* <p>Making the extension available for use in your account.</p>
|
|
21
21
|
* </li>
|
|
22
22
|
* </ul>
|
|
23
|
-
* <p>For more information on how to develop extensions and ready them for
|
|
23
|
+
* <p>For more information on how to develop extensions and ready them for registration, see
|
|
24
24
|
* <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-types.html">Creating Resource
|
|
25
25
|
* Providers</a> in the <i>CloudFormation CLI User
|
|
26
26
|
* Guide</i>.</p>
|
|
@@ -33,8 +33,7 @@ export interface RegisterTypeCommandOutput extends RegisterTypeOutput, __Metadat
|
|
|
33
33
|
* </code> to
|
|
34
34
|
* monitor the progress of the registration request.</p>
|
|
35
35
|
* <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
|
|
36
|
-
* 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
|
|
37
|
-
* User Guide</i>.</p>
|
|
36
|
+
* 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>
|
|
38
37
|
* @example
|
|
39
38
|
* Use a bare-bones client and the command you need to make an API call.
|
|
40
39
|
* ```javascript
|
|
@@ -9,7 +9,7 @@ export interface RollbackStackCommandOutput extends RollbackStackOutput, __Metad
|
|
|
9
9
|
/**
|
|
10
10
|
* <p>When specifying <code>RollbackStack</code>, you preserve the state of previously
|
|
11
11
|
* provisioned resources when an operation fails. You can check the status of the stack
|
|
12
|
-
* through the <a>DescribeStacks</a>
|
|
12
|
+
* through the <a>DescribeStacks</a> operation.</p>
|
|
13
13
|
* <p>Rolls back the specified stack to the last known stable state from
|
|
14
14
|
* <code>CREATE_FAILED</code> or <code>UPDATE_FAILED</code> stack statuses.</p>
|
|
15
15
|
* <p>This operation will delete a stack if it doesn't contain a last known stable state. A
|
|
@@ -7,14 +7,14 @@ export interface SetTypeConfigurationCommandInput extends SetTypeConfigurationIn
|
|
|
7
7
|
export interface SetTypeConfigurationCommandOutput extends SetTypeConfigurationOutput, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Specifies the configuration data for a registered CloudFormation extension, in
|
|
11
|
-
* account and region.</p>
|
|
10
|
+
* <p>Specifies the configuration data for a registered CloudFormation extension, in
|
|
11
|
+
* the given account and region.</p>
|
|
12
12
|
* <p>To view the current configuration data for an extension, refer to the
|
|
13
13
|
* <code>ConfigurationSchema</code> element of <a href="AWSCloudFormation/latest/APIReference/API_DescribeType.html">DescribeType</a>.
|
|
14
14
|
* 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
|
|
15
15
|
* <i>CloudFormation User Guide</i>.</p>
|
|
16
16
|
* <important>
|
|
17
|
-
* <p>It
|
|
17
|
+
* <p>It's strongly recommended that you use dynamic references to restrict sensitive
|
|
18
18
|
* configuration definitions, such as third-party credentials. For more details on dynamic
|
|
19
19
|
* references, see <a href="https://docs.aws.amazon.com/">Using dynamic references to specify
|
|
20
20
|
* template values</a> in the <i>CloudFormation User
|
|
@@ -8,8 +8,8 @@ export interface SignalResourceCommandOutput extends __MetadataBearer {
|
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
10
|
* <p>Sends a signal to the specified resource with a success or failure status. You can use
|
|
11
|
-
* the SignalResource
|
|
12
|
-
* the required number of signals or the timeout period is exceeded. The SignalResource
|
|
11
|
+
* the <code>SignalResource</code> operation in conjunction with a creation policy or update policy. CloudFormation doesn't proceed with a stack creation or update until resources receive
|
|
12
|
+
* the required number of signals or the timeout period is exceeded. The <code>SignalResource</code> operation is
|
|
13
13
|
* useful in cases where you want to send signals from anywhere other than an Amazon EC2
|
|
14
14
|
* instance.</p>
|
|
15
15
|
* @example
|
|
@@ -7,7 +7,7 @@ export interface StopStackSetOperationCommandInput extends StopStackSetOperation
|
|
|
7
7
|
export interface StopStackSetOperationCommandOutput extends StopStackSetOperationOutput, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Stops an in-progress operation on a stack set and its associated stack instances.
|
|
10
|
+
* <p>Stops an in-progress operation on a stack set and its associated stack instances. StackSets will cancel all the unstarted stack instance deployments and wait for those are in-progress to complete.</p>
|
|
11
11
|
* @example
|
|
12
12
|
* Use a bare-bones client and the command you need to make an API call.
|
|
13
13
|
* ```javascript
|
|
@@ -19,12 +19,11 @@ export interface TestTypeCommandOutput extends TestTypeOutput, __MetadataBearer
|
|
|
19
19
|
* requirements.</p>
|
|
20
20
|
* </li>
|
|
21
21
|
* </ul>
|
|
22
|
-
* <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
|
|
23
|
-
*
|
|
24
|
-
* <p>If you do not specify a version, CloudFormation uses the default version of the
|
|
22
|
+
* <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>
|
|
23
|
+
* <p>If you don't specify a version, CloudFormation uses the default version of the
|
|
25
24
|
* extension in your account and region for testing.</p>
|
|
26
|
-
* <p>To perform testing, CloudFormation assumes the execution role specified when
|
|
27
|
-
* was registered. For more information, see <a href="AWSCloudFormation/latest/APIReference/API_RegisterType.html">RegisterType</a>.</p>
|
|
25
|
+
* <p>To perform testing, CloudFormation assumes the execution role specified when
|
|
26
|
+
* the type was registered. For more information, see <a href="AWSCloudFormation/latest/APIReference/API_RegisterType.html">RegisterType</a>.</p>
|
|
28
27
|
* <p>Once you've initiated testing on an extension using <code>TestType</code>, you can use
|
|
29
28
|
* <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DescribeType.html">DescribeType</a> to monitor the current test status and test
|
|
30
29
|
* status description for the extension.</p>
|
|
@@ -8,7 +8,7 @@ export interface UpdateStackCommandOutput extends UpdateStackOutput, __MetadataB
|
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
10
|
* <p>Updates a stack as specified in the template. After the call completes successfully, the
|
|
11
|
-
* stack update starts. You can check the status of the stack
|
|
11
|
+
* stack update starts. You can check the status of the stack through the <a>DescribeStacks</a> action.</p>
|
|
12
12
|
* <p>To get a copy of the template for an existing stack, you can use the <a>GetTemplate</a> action.</p>
|
|
13
13
|
* <p>For more information about creating an update template, updating a stack, and monitoring
|
|
14
14
|
* the progress of the update, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks.html">Updating a
|
|
@@ -8,11 +8,12 @@ export interface UpdateStackInstancesCommandOutput extends UpdateStackInstancesO
|
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
10
|
* <p>Updates the parameter values for stack instances for the specified accounts, within the
|
|
11
|
-
* specified Regions. A stack instance refers to a stack in a specific
|
|
12
|
-
*
|
|
13
|
-
*
|
|
14
|
-
*
|
|
15
|
-
*
|
|
11
|
+
* specified Amazon Web Services Regions. A stack instance refers to a stack in a specific
|
|
12
|
+
* account and Region.</p>
|
|
13
|
+
* <p>You can only update stack instances in Amazon Web Services Regions and accounts where
|
|
14
|
+
* 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>
|
|
15
|
+
* <p>During stack set updates, any parameters overridden for a stack instance aren't updated,
|
|
16
|
+
* but retain their overridden value.</p>
|
|
16
17
|
* <p>You can only update the parameter <i>values</i> that are specified in the
|
|
17
18
|
* 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
|
|
18
19
|
* template, before you can override the parameter value specified in the stack set you must
|
|
@@ -8,7 +8,7 @@ export interface UpdateStackSetCommandOutput extends UpdateStackSetOutput, __Met
|
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
10
|
* <p>Updates the stack set, and associated stack instances in the specified accounts and
|
|
11
|
-
*
|
|
11
|
+
* Amazon Web Services Regions.</p>
|
|
12
12
|
* <p>Even if the stack set operation created by updating the stack set fails (completely or
|
|
13
13
|
* partially, below or above a specified failure tolerance), the stack set is updated with
|
|
14
14
|
* your changes. Subsequent <a>CreateStackInstances</a> calls on the specified
|
|
@@ -12,7 +12,7 @@ export interface UpdateTerminationProtectionCommandOutput extends UpdateTerminat
|
|
|
12
12
|
* unchanged. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-protect-stacks.html">Protecting a
|
|
13
13
|
* Stack From Being Deleted</a> in the <i>CloudFormation User Guide</i>.</p>
|
|
14
14
|
* <p>For <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html">nested
|
|
15
|
-
* stacks</a>, termination protection is set on the root stack and
|
|
15
|
+
* stacks</a>, termination protection is set on the root stack and can't be changed
|
|
16
16
|
* directly on the nested stack.</p>
|
|
17
17
|
* @example
|
|
18
18
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -14,6 +14,7 @@ export * from "./DeleteStackSetCommand";
|
|
|
14
14
|
export * from "./DeregisterTypeCommand";
|
|
15
15
|
export * from "./DescribeAccountLimitsCommand";
|
|
16
16
|
export * from "./DescribeChangeSetCommand";
|
|
17
|
+
export * from "./DescribeChangeSetHooksCommand";
|
|
17
18
|
export * from "./DescribePublisherCommand";
|
|
18
19
|
export * from "./DescribeStackDriftDetectionStatusCommand";
|
|
19
20
|
export * from "./DescribeStackEventsCommand";
|