@aws-sdk/client-cloudformation 3.36.0 → 3.36.1

package/dist-types/ts3.4/commands/TestTypeCommand.d.ts

@@ -6,52 +6,11 @@ export interface TestTypeCommandInput extends TestTypeInput {
 }
 export interface TestTypeCommandOutput extends TestTypeOutput, __MetadataBearer {
 }
-/**
- * <p>Tests a registered extension to make sure it meets all necessary requirements for being
- *          published in the CloudFormation registry.</p>
- *          <ul>
- *             <li>
- *                <p>For resource types, this includes passing all contracts tests defined for the
- *                type.</p>
- *             </li>
- *             <li>
- *                <p>For modules, this includes determining if the module's model meets all necessary
- *                requirements.</p>
- *             </li>
- *          </ul>
- *          <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>
- *          <p>If you do not specify a version, CloudFormation uses the default version of the
- *          extension in your account and region for testing.</p>
- *          <p>To perform testing, CloudFormation assumes the execution role specified when the type
- *          was registered. For more information, see <a href="AWSCloudFormation/latest/APIReference/API_RegisterType.html">RegisterType</a>.</p>
- *          <p>Once you've initiated testing on an extension using <code>TestType</code>, you can use
- *             <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 the extension.</p>
- *          <p>An extension must have a test status of <code>PASSED</code> before it can be published.
- *          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>
- *          in the <i>CloudFormation CLI User Guide</i>.</p>
- * @example
- * Use a bare-bones client and the command you need to make an API call.
- * ```javascript
- * import { CloudFormationClient, TestTypeCommand } from "@aws-sdk/client-cloudformation"; // ES Modules import
- * // const { CloudFormationClient, TestTypeCommand } = require("@aws-sdk/client-cloudformation"); // CommonJS import
- * const client = new CloudFormationClient(config);
- * const command = new TestTypeCommand(input);
- * const response = await client.send(command);
- * ```
- *
- * @see {@link TestTypeCommandInput} for command's `input` shape.
- * @see {@link TestTypeCommandOutput} for command's `response` shape.
- * @see {@link CloudFormationClientResolvedConfig | config} for command's `input` shape.
- *
- */
+
 export declare class TestTypeCommand extends $Command<TestTypeCommandInput, TestTypeCommandOutput, CloudFormationClientResolvedConfig> {
     readonly input: TestTypeCommandInput;
     constructor(input: TestTypeCommandInput);
-    /**
-     * @internal
-     */
+    
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CloudFormationClientResolvedConfig, options?: __HttpHandlerOptions): Handler<TestTypeCommandInput, TestTypeCommandOutput>;
     private serialize;
     private deserialize;

package/dist-types/ts3.4/commands/UpdateStackCommand.d.ts

@@ -6,34 +6,11 @@ export interface UpdateStackCommandInput extends UpdateStackInput {
 }
 export interface UpdateStackCommandOutput extends UpdateStackOutput, __MetadataBearer {
 }
-/**
- * <p>Updates a stack as specified in the template. After the call completes successfully,
- *          the stack update starts. You can check the status of the stack via the <a>DescribeStacks</a> action.</p>
- *          <p>To get a copy of the template for an existing stack, you can use the <a>GetTemplate</a> action.</p>
- *          <p>For more information about creating an update template, updating a stack, and
- *          monitoring the progress of the update, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks.html">Updating a
- *             Stack</a>.</p>
- * @example
- * Use a bare-bones client and the command you need to make an API call.
- * ```javascript
- * import { CloudFormationClient, UpdateStackCommand } from "@aws-sdk/client-cloudformation"; // ES Modules import
- * // const { CloudFormationClient, UpdateStackCommand } = require("@aws-sdk/client-cloudformation"); // CommonJS import
- * const client = new CloudFormationClient(config);
- * const command = new UpdateStackCommand(input);
- * const response = await client.send(command);
- * ```
- *
- * @see {@link UpdateStackCommandInput} for command's `input` shape.
- * @see {@link UpdateStackCommandOutput} for command's `response` shape.
- * @see {@link CloudFormationClientResolvedConfig | config} for command's `input` shape.
- *
- */
+
 export declare class UpdateStackCommand extends $Command<UpdateStackCommandInput, UpdateStackCommandOutput, CloudFormationClientResolvedConfig> {
     readonly input: UpdateStackCommandInput;
     constructor(input: UpdateStackCommandInput);
-    /**
-     * @internal
-     */
+    
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CloudFormationClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateStackCommandInput, UpdateStackCommandOutput>;
     private serialize;
     private deserialize;

package/dist-types/ts3.4/commands/UpdateStackInstancesCommand.d.ts

@@ -6,41 +6,11 @@ export interface UpdateStackInstancesCommandInput extends UpdateStackInstancesIn
 }
 export interface UpdateStackInstancesCommandOutput extends UpdateStackInstancesOutput, __MetadataBearer {
 }
-/**
- * <p>Updates the parameter values for stack instances for the specified accounts, within
- *          the specified Regions. A stack instance refers to a stack in a specific account and Region. </p>
- *          <p>You can only update stack instances in Regions and accounts where 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>
- *          <p>During stack set updates, any parameters overridden for a stack instance are not
- *          updated, but retain their overridden value.</p>
- *          <p>You can only update the parameter <i>values</i> that are specified in
- *          the 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
- *          template, before you can override the parameter value specified in the stack set you must
- *          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
- *          parameter value specified in the stack set. Once a stack instance has been updated with the
- *          new parameter, you can then override the parameter value using
- *             <code>UpdateStackInstances</code>.</p>
- * @example
- * Use a bare-bones client and the command you need to make an API call.
- * ```javascript
- * import { CloudFormationClient, UpdateStackInstancesCommand } from "@aws-sdk/client-cloudformation"; // ES Modules import
- * // const { CloudFormationClient, UpdateStackInstancesCommand } = require("@aws-sdk/client-cloudformation"); // CommonJS import
- * const client = new CloudFormationClient(config);
- * const command = new UpdateStackInstancesCommand(input);
- * const response = await client.send(command);
- * ```
- *
- * @see {@link UpdateStackInstancesCommandInput} for command's `input` shape.
- * @see {@link UpdateStackInstancesCommandOutput} for command's `response` shape.
- * @see {@link CloudFormationClientResolvedConfig | config} for command's `input` shape.
- *
- */
+
 export declare class UpdateStackInstancesCommand extends $Command<UpdateStackInstancesCommandInput, UpdateStackInstancesCommandOutput, CloudFormationClientResolvedConfig> {
     readonly input: UpdateStackInstancesCommandInput;
     constructor(input: UpdateStackInstancesCommandInput);
-    /**
-     * @internal
-     */
+    
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CloudFormationClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateStackInstancesCommandInput, UpdateStackInstancesCommandOutput>;
     private serialize;
     private deserialize;

package/dist-types/ts3.4/commands/UpdateStackSetCommand.d.ts

@@ -6,34 +6,11 @@ export interface UpdateStackSetCommandInput extends UpdateStackSetInput {
 }
 export interface UpdateStackSetCommandOutput extends UpdateStackSetOutput, __MetadataBearer {
 }
-/**
- * <p>Updates the stack set, and associated stack instances in the specified accounts and
- *          Regions.</p>
- *          <p>Even if the stack set operation created by updating the stack set fails (completely
- *          or partially, below or above a specified failure tolerance), the stack set is updated with
- *          your changes. Subsequent <a>CreateStackInstances</a> calls on the specified
- *          stack set use the updated stack set.</p>
- * @example
- * Use a bare-bones client and the command you need to make an API call.
- * ```javascript
- * import { CloudFormationClient, UpdateStackSetCommand } from "@aws-sdk/client-cloudformation"; // ES Modules import
- * // const { CloudFormationClient, UpdateStackSetCommand } = require("@aws-sdk/client-cloudformation"); // CommonJS import
- * const client = new CloudFormationClient(config);
- * const command = new UpdateStackSetCommand(input);
- * const response = await client.send(command);
- * ```
- *
- * @see {@link UpdateStackSetCommandInput} for command's `input` shape.
- * @see {@link UpdateStackSetCommandOutput} for command's `response` shape.
- * @see {@link CloudFormationClientResolvedConfig | config} for command's `input` shape.
- *
- */
+
 export declare class UpdateStackSetCommand extends $Command<UpdateStackSetCommandInput, UpdateStackSetCommandOutput, CloudFormationClientResolvedConfig> {
     readonly input: UpdateStackSetCommandInput;
     constructor(input: UpdateStackSetCommandInput);
-    /**
-     * @internal
-     */
+    
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CloudFormationClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateStackSetCommandInput, UpdateStackSetCommandOutput>;
     private serialize;
     private deserialize;

package/dist-types/ts3.4/commands/UpdateTerminationProtectionCommand.d.ts

@@ -6,35 +6,11 @@ export interface UpdateTerminationProtectionCommandInput extends UpdateTerminati
 }
 export interface UpdateTerminationProtectionCommandOutput extends UpdateTerminationProtectionOutput, __MetadataBearer {
 }
-/**
- * <p>Updates termination protection for the specified stack. If a user attempts to delete
- *          a stack with termination protection enabled, the operation fails and the stack remains
- *          unchanged. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-protect-stacks.html">Protecting a
- *             Stack From Being Deleted</a> in the <i>CloudFormation User Guide</i>.</p>
- *          <p>For <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html">nested
- *             stacks</a>, termination protection is set on the root stack and cannot be changed
- *          directly on the nested stack.</p>
- * @example
- * Use a bare-bones client and the command you need to make an API call.
- * ```javascript
- * import { CloudFormationClient, UpdateTerminationProtectionCommand } from "@aws-sdk/client-cloudformation"; // ES Modules import
- * // const { CloudFormationClient, UpdateTerminationProtectionCommand } = require("@aws-sdk/client-cloudformation"); // CommonJS import
- * const client = new CloudFormationClient(config);
- * const command = new UpdateTerminationProtectionCommand(input);
- * const response = await client.send(command);
- * ```
- *
- * @see {@link UpdateTerminationProtectionCommandInput} for command's `input` shape.
- * @see {@link UpdateTerminationProtectionCommandOutput} for command's `response` shape.
- * @see {@link CloudFormationClientResolvedConfig | config} for command's `input` shape.
- *
- */
+
 export declare class UpdateTerminationProtectionCommand extends $Command<UpdateTerminationProtectionCommandInput, UpdateTerminationProtectionCommandOutput, CloudFormationClientResolvedConfig> {
     readonly input: UpdateTerminationProtectionCommandInput;
     constructor(input: UpdateTerminationProtectionCommandInput);
-    /**
-     * @internal
-     */
+    
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CloudFormationClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateTerminationProtectionCommandInput, UpdateTerminationProtectionCommandOutput>;
     private serialize;
     private deserialize;

package/dist-types/ts3.4/commands/ValidateTemplateCommand.d.ts

@@ -6,31 +6,11 @@ export interface ValidateTemplateCommandInput extends ValidateTemplateInput {
 }
 export interface ValidateTemplateCommandOutput extends ValidateTemplateOutput, __MetadataBearer {
 }
-/**
- * <p>Validates a specified template. CloudFormation first checks if the template is
- *          valid JSON. If it isn't, CloudFormation checks if the template is valid YAML. If both
- *          these checks fail, CloudFormation returns a template validation error.</p>
- * @example
- * Use a bare-bones client and the command you need to make an API call.
- * ```javascript
- * import { CloudFormationClient, ValidateTemplateCommand } from "@aws-sdk/client-cloudformation"; // ES Modules import
- * // const { CloudFormationClient, ValidateTemplateCommand } = require("@aws-sdk/client-cloudformation"); // CommonJS import
- * const client = new CloudFormationClient(config);
- * const command = new ValidateTemplateCommand(input);
- * const response = await client.send(command);
- * ```
- *
- * @see {@link ValidateTemplateCommandInput} for command's `input` shape.
- * @see {@link ValidateTemplateCommandOutput} for command's `response` shape.
- * @see {@link CloudFormationClientResolvedConfig | config} for command's `input` shape.
- *
- */
+
 export declare class ValidateTemplateCommand extends $Command<ValidateTemplateCommandInput, ValidateTemplateCommandOutput, CloudFormationClientResolvedConfig> {
     readonly input: ValidateTemplateCommandInput;
     constructor(input: ValidateTemplateCommandInput);
-    /**
-     * @internal
-     */
+    
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: CloudFormationClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ValidateTemplateCommandInput, ValidateTemplateCommandOutput>;
     private serialize;
     private deserialize;