Skip to content

Commit

Permalink
feat(client-cloudformation): This release supports for a new API List…
Browse files Browse the repository at this point in the history
…StackSetAutoDeploymentTargets, which provider auto-deployment configuration as a describable resource. Customers can now view the specific combinations of regions and OUs that are being auto-deployed.
  • Loading branch information
awstools committed Mar 18, 2024
1 parent 8a73474 commit 29679ab
Show file tree
Hide file tree
Showing 15 changed files with 583 additions and 128 deletions.
8 changes: 8 additions & 0 deletions clients/client-cloudformation/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -670,6 +670,14 @@ ListStacks

[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/cloudformation/command/ListStacksCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-cloudformation/Interface/ListStacksCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-cloudformation/Interface/ListStacksCommandOutput/)

</details>
<details>
<summary>
ListStackSetAutoDeploymentTargets
</summary>

[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/cloudformation/command/ListStackSetAutoDeploymentTargetsCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-cloudformation/Interface/ListStackSetAutoDeploymentTargetsCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-cloudformation/Interface/ListStackSetAutoDeploymentTargetsCommandOutput/)

</details>
<details>
<summary>
Expand Down
23 changes: 23 additions & 0 deletions clients/client-cloudformation/src/CloudFormation.ts
Original file line number Diff line number Diff line change
Expand Up @@ -264,6 +264,11 @@ import {
ListStackResourcesCommandOutput,
} from "./commands/ListStackResourcesCommand";
import { ListStacksCommand, ListStacksCommandInput, ListStacksCommandOutput } from "./commands/ListStacksCommand";
import {
ListStackSetAutoDeploymentTargetsCommand,
ListStackSetAutoDeploymentTargetsCommandInput,
ListStackSetAutoDeploymentTargetsCommandOutput,
} from "./commands/ListStackSetAutoDeploymentTargetsCommand";
import {
ListStackSetOperationResultsCommand,
ListStackSetOperationResultsCommandInput,
Expand Down Expand Up @@ -427,6 +432,7 @@ const commands = {
ListStackInstancesCommand,
ListStackResourcesCommand,
ListStacksCommand,
ListStackSetAutoDeploymentTargetsCommand,
ListStackSetOperationResultsCommand,
ListStackSetOperationsCommand,
ListStackSetsCommand,
Expand Down Expand Up @@ -1367,6 +1373,23 @@ export interface CloudFormation {
cb: (err: any, data?: ListStacksCommandOutput) => void
): void;

/**
* @see {@link ListStackSetAutoDeploymentTargetsCommand}
*/
listStackSetAutoDeploymentTargets(
args: ListStackSetAutoDeploymentTargetsCommandInput,
options?: __HttpHandlerOptions
): Promise<ListStackSetAutoDeploymentTargetsCommandOutput>;
listStackSetAutoDeploymentTargets(
args: ListStackSetAutoDeploymentTargetsCommandInput,
cb: (err: any, data?: ListStackSetAutoDeploymentTargetsCommandOutput) => void
): void;
listStackSetAutoDeploymentTargets(
args: ListStackSetAutoDeploymentTargetsCommandInput,
options: __HttpHandlerOptions,
cb: (err: any, data?: ListStackSetAutoDeploymentTargetsCommandOutput) => void
): void;

/**
* @see {@link ListStackSetOperationResultsCommand}
*/
Expand Down
6 changes: 6 additions & 0 deletions clients/client-cloudformation/src/CloudFormationClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -200,6 +200,10 @@ import {
import { ListStackInstancesCommandInput, ListStackInstancesCommandOutput } from "./commands/ListStackInstancesCommand";
import { ListStackResourcesCommandInput, ListStackResourcesCommandOutput } from "./commands/ListStackResourcesCommand";
import { ListStacksCommandInput, ListStacksCommandOutput } from "./commands/ListStacksCommand";
import {
ListStackSetAutoDeploymentTargetsCommandInput,
ListStackSetAutoDeploymentTargetsCommandOutput,
} from "./commands/ListStackSetAutoDeploymentTargetsCommand";
import {
ListStackSetOperationResultsCommandInput,
ListStackSetOperationResultsCommandOutput,
Expand Down Expand Up @@ -325,6 +329,7 @@ export type ServiceInputTypes =
| ListStackInstanceResourceDriftsCommandInput
| ListStackInstancesCommandInput
| ListStackResourcesCommandInput
| ListStackSetAutoDeploymentTargetsCommandInput
| ListStackSetOperationResultsCommandInput
| ListStackSetOperationsCommandInput
| ListStackSetsCommandInput
Expand Down Expand Up @@ -411,6 +416,7 @@ export type ServiceOutputTypes =
| ListStackInstanceResourceDriftsCommandOutput
| ListStackInstancesCommandOutput
| ListStackResourcesCommandOutput
| ListStackSetAutoDeploymentTargetsCommandOutput
| ListStackSetOperationResultsCommandOutput
| ListStackSetOperationsCommandOutput
| ListStackSetsCommandOutput
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,9 @@ export interface ActivateTypeCommandOutput extends ActivateTypeOutput, __Metadat
* extensions</a> in the <i>CloudFormation User Guide</i>.</p>
* <p>Once you have activated a public third-party extension in your account and Region, use <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_SetTypeConfiguration.html">
* <code>SetTypeConfiguration</code>
* </a> to specify configuration properties for the extension. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-register.html#registry-set-configuration">Configuring extensions at the account level</a> in the <i>CloudFormation User Guide</i>.</p>
* </a> to specify configuration properties for the extension. For more
* information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-register.html#registry-set-configuration">Configuring extensions at
* the account level</a> in the <i>CloudFormation User Guide</i>.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,100 @@
// smithy-typescript generated code
import { getEndpointPlugin } from "@smithy/middleware-endpoint";
import { getSerdePlugin } from "@smithy/middleware-serde";
import { Command as $Command } from "@smithy/smithy-client";
import { MetadataBearer as __MetadataBearer } from "@smithy/types";

import { CloudFormationClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudFormationClient";
import { commonParams } from "../endpoint/EndpointParameters";
import { ListStackSetAutoDeploymentTargetsInput, ListStackSetAutoDeploymentTargetsOutput } from "../models/models_0";
import {
de_ListStackSetAutoDeploymentTargetsCommand,
se_ListStackSetAutoDeploymentTargetsCommand,
} from "../protocols/Aws_query";

/**
* @public
*/
export { __MetadataBearer, $Command };
/**
* @public
*
* The input for {@link ListStackSetAutoDeploymentTargetsCommand}.
*/
export interface ListStackSetAutoDeploymentTargetsCommandInput extends ListStackSetAutoDeploymentTargetsInput {}
/**
* @public
*
* The output of {@link ListStackSetAutoDeploymentTargetsCommand}.
*/
export interface ListStackSetAutoDeploymentTargetsCommandOutput
extends ListStackSetAutoDeploymentTargetsOutput,
__MetadataBearer {}

/**
* <p>Returns summary information about deployment targets for a stack set.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
* import { CloudFormationClient, ListStackSetAutoDeploymentTargetsCommand } from "@aws-sdk/client-cloudformation"; // ES Modules import
* // const { CloudFormationClient, ListStackSetAutoDeploymentTargetsCommand } = require("@aws-sdk/client-cloudformation"); // CommonJS import
* const client = new CloudFormationClient(config);
* const input = { // ListStackSetAutoDeploymentTargetsInput
* StackSetName: "STRING_VALUE", // required
* NextToken: "STRING_VALUE",
* MaxResults: Number("int"),
* CallAs: "SELF" || "DELEGATED_ADMIN",
* };
* const command = new ListStackSetAutoDeploymentTargetsCommand(input);
* const response = await client.send(command);
* // { // ListStackSetAutoDeploymentTargetsOutput
* // Summaries: [ // StackSetAutoDeploymentTargetSummaries
* // { // StackSetAutoDeploymentTargetSummary
* // OrganizationalUnitId: "STRING_VALUE",
* // Regions: [ // RegionList
* // "STRING_VALUE",
* // ],
* // },
* // ],
* // NextToken: "STRING_VALUE",
* // };
*
* ```
*
* @param ListStackSetAutoDeploymentTargetsCommandInput - {@link ListStackSetAutoDeploymentTargetsCommandInput}
* @returns {@link ListStackSetAutoDeploymentTargetsCommandOutput}
* @see {@link ListStackSetAutoDeploymentTargetsCommandInput} for command's `input` shape.
* @see {@link ListStackSetAutoDeploymentTargetsCommandOutput} for command's `response` shape.
* @see {@link CloudFormationClientResolvedConfig | config} for CloudFormationClient's `config` shape.
*
* @throws {@link StackSetNotFoundException} (client fault)
* <p>The specified stack set doesn't exist.</p>
*
* @throws {@link CloudFormationServiceException}
* <p>Base exception class for all service exceptions from CloudFormation service.</p>
*
* @public
*/
export class ListStackSetAutoDeploymentTargetsCommand extends $Command
.classBuilder<
ListStackSetAutoDeploymentTargetsCommandInput,
ListStackSetAutoDeploymentTargetsCommandOutput,
CloudFormationClientResolvedConfig,
ServiceInputTypes,
ServiceOutputTypes
>()
.ep({
...commonParams,
})
.m(function (this: any, Command: any, cs: any, config: CloudFormationClientResolvedConfig, o: any) {
return [
getSerdePlugin(config, this.serialize, this.deserialize),
getEndpointPlugin(config, Command.getEndpointParameterInstructions()),
];
})
.s("CloudFormation", "ListStackSetAutoDeploymentTargets", {})
.n("CloudFormationClient", "ListStackSetAutoDeploymentTargetsCommand")
.f(void 0, void 0)
.ser(se_ListStackSetAutoDeploymentTargetsCommand)
.de(de_ListStackSetAutoDeploymentTargetsCommand)
.build() {}
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,8 @@ export interface RegisterTypeCommandOutput extends RegisterTypeOutput, __Metadat
* <p>Once you have initiated a registration request using <a>RegisterType</a>, you can use <a>DescribeTypeRegistration</a> to monitor the progress of the registration request.</p>
* <p>Once you have registered a private extension in your account and Region, use <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_SetTypeConfiguration.html">
* <code>SetTypeConfiguration</code>
* </a> to specify
* configuration properties for the extension. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-register.html#registry-set-configuration">Configuring extensions at
* </a>
* to specify configuration properties for the extension. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry-register.html#registry-set-configuration">Configuring extensions at
* the account level</a> in the <i>CloudFormation User Guide</i>.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types";

import { CloudFormationClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudFormationClient";
import { commonParams } from "../endpoint/EndpointParameters";
import { SetTypeDefaultVersionInput, SetTypeDefaultVersionOutput } from "../models/models_0";
import { SetTypeDefaultVersionInput } from "../models/models_0";
import { SetTypeDefaultVersionOutput } from "../models/models_1";
import { de_SetTypeDefaultVersionCommand, se_SetTypeDefaultVersionCommand } from "../protocols/Aws_query";

/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types";

import { CloudFormationClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CloudFormationClient";
import { commonParams } from "../endpoint/EndpointParameters";
import { SignalResourceInput } from "../models/models_0";
import { SignalResourceInput } from "../models/models_1";
import { de_SignalResourceCommand, se_SignalResourceCommand } from "../protocols/Aws_query";

/**
Expand Down
4 changes: 2 additions & 2 deletions clients/client-cloudformation/src/commands/TestTypeCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,8 @@ export interface TestTypeCommandOutput extends TestTypeOutput, __MetadataBearer
* <p>Once you've initiated testing on an extension using <code>TestType</code>, you can pass the returned
* <code>TypeVersionArn</code> into <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DescribeType.html">
* <code>DescribeType</code>
* </a> to monitor the current test
* status and test status description for the extension.</p>
* </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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,13 +37,13 @@ export interface UpdateStackInstancesCommandOutput extends UpdateStackInstancesO
* <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">
* <code>UpdateStackSet</code>
* </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">
* </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">
* <code>UpdateStackSet</code>
* </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
* </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.
Expand Down
1 change: 1 addition & 0 deletions clients/client-cloudformation/src/commands/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@ export * from "./ListResourceScansCommand";
export * from "./ListStackInstanceResourceDriftsCommand";
export * from "./ListStackInstancesCommand";
export * from "./ListStackResourcesCommand";
export * from "./ListStackSetAutoDeploymentTargetsCommand";
export * from "./ListStackSetOperationResultsCommand";
export * from "./ListStackSetOperationsCommand";
export * from "./ListStackSetsCommand";
Expand Down

0 comments on commit 29679ab

Please sign in to comment.