Skip to content

Commit c2d6378

Browse files
author
awstools
committed
feat(client-appconfig): Adding Create, Get, Update, Delete, and List APIs for new two new resources: Extensions and ExtensionAssociations.
1 parent 2255877 commit c2d6378

27 files changed

+4980
-333
lines changed

clients/client-appconfig/README.md

Lines changed: 24 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -9,51 +9,52 @@
99

1010
AWS SDK for JavaScript AppConfig Client for Node.js, Browser and React Native.
1111

12-
<p>Use AppConfig, a capability of Amazon Web Services Systems Manager, to create, manage, and quickly deploy
13-
application configurations. AppConfig supports controlled deployments to applications of
14-
any size and includes built-in validation checks and monitoring. You can use AppConfig with
15-
applications hosted on Amazon EC2 instances, Lambda, containers, mobile applications, or IoT
16-
devices.</p>
12+
<p>Use AppConfig, a capability of Amazon Web Services Systems Manager, to create, manage, and quickly
13+
deploy application configurations. AppConfig supports controlled deployments to
14+
applications of any size and includes built-in validation checks and monitoring. You can
15+
use AppConfig with applications hosted on Amazon EC2 instances, Lambda, containers,
16+
mobile applications, or IoT devices.</p>
1717
<p>To prevent errors when deploying application configurations, especially for production
1818
systems where a simple typo could cause an unexpected outage, AppConfig includes
1919
validators. A validator provides a syntactic or semantic check to ensure that the
2020
configuration you want to deploy works as intended. To validate your application
2121
configuration data, you provide a schema or an Amazon Web Services Lambda function that runs against
2222
the configuration. The configuration deployment or update can only proceed when the
2323
configuration data is valid.</p>
24-
<p>During a configuration deployment, AppConfig monitors the application to ensure that the
25-
deployment is successful. If the system encounters an error, AppConfig rolls back the
26-
change to minimize impact for your application users. You can configure a deployment
27-
strategy for each application or environment that includes deployment criteria, including
28-
velocity, bake time, and alarms to monitor. Similar to error monitoring, if a deployment
29-
triggers an alarm, AppConfig automatically rolls back to the previous version. </p>
24+
<p>During a configuration deployment, AppConfig monitors the application to
25+
ensure that the deployment is successful. If the system encounters an error, AppConfig rolls back the change to minimize impact for your application users. You can
26+
configure a deployment strategy for each application or environment that includes
27+
deployment criteria, including velocity, bake time, and alarms to monitor. Similar to error
28+
monitoring, if a deployment triggers an alarm, AppConfig automatically rolls back
29+
to the previous version. </p>
3030
<p>AppConfig supports multiple use cases. Here are some examples:</p>
3131
<ul>
3232
<li>
3333
<p>
34-
<b>Feature flags</b>: Use AppConfig to turn on new
35-
features that require a timely deployment, such as a product launch or announcement.
36-
</p>
34+
<b>Feature flags</b>: Use AppConfig to turn on
35+
new features that require a timely deployment, such as a product launch or
36+
announcement. </p>
3737
</li>
3838
<li>
3939
<p>
40-
<b>Application tuning</b>: Use AppConfig to carefully
41-
introduce changes to your application that can only be tested with production
42-
traffic.</p>
40+
<b>Application tuning</b>: Use AppConfig to
41+
carefully introduce changes to your application that can only be tested with
42+
production traffic.</p>
4343
</li>
4444
<li>
4545
<p>
46-
<b>Allow list</b>: Use AppConfig to allow premium
47-
subscribers to access paid content. </p>
46+
<b>Allow list</b>: Use AppConfig to allow
47+
premium subscribers to access paid content. </p>
4848
</li>
4949
<li>
5050
<p>
51-
<b>Operational issues</b>: Use AppConfig to reduce
52-
stress on your application when a dependency or other external factor impacts the
53-
system.</p>
51+
<b>Operational issues</b>: Use AppConfig to
52+
reduce stress on your application when a dependency or other external factor impacts
53+
the system.</p>
5454
</li>
5555
</ul>
56-
<p>This reference is intended to be used with the <a href="http://docs.aws.amazon.com/appconfig/latest/userguide/what-is-appconfig.html">AppConfig User Guide</a>.</p>
56+
<p>This reference is intended to be used with the <a href="http://docs.aws.amazon.com/appconfig/latest/userguide/what-is-appconfig.html">AppConfig User
57+
Guide</a>.</p>
5758

5859
## Installing
5960

clients/client-appconfig/src/AppConfig.ts

Lines changed: 456 additions & 51 deletions
Large diffs are not rendered by default.

clients/client-appconfig/src/AppConfigClient.ts

Lines changed: 69 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,11 @@ import {
6363
CreateDeploymentStrategyCommandOutput,
6464
} from "./commands/CreateDeploymentStrategyCommand";
6565
import { CreateEnvironmentCommandInput, CreateEnvironmentCommandOutput } from "./commands/CreateEnvironmentCommand";
66+
import {
67+
CreateExtensionAssociationCommandInput,
68+
CreateExtensionAssociationCommandOutput,
69+
} from "./commands/CreateExtensionAssociationCommand";
70+
import { CreateExtensionCommandInput, CreateExtensionCommandOutput } from "./commands/CreateExtensionCommand";
6671
import {
6772
CreateHostedConfigurationVersionCommandInput,
6873
CreateHostedConfigurationVersionCommandOutput,
@@ -77,6 +82,11 @@ import {
7782
DeleteDeploymentStrategyCommandOutput,
7883
} from "./commands/DeleteDeploymentStrategyCommand";
7984
import { DeleteEnvironmentCommandInput, DeleteEnvironmentCommandOutput } from "./commands/DeleteEnvironmentCommand";
85+
import {
86+
DeleteExtensionAssociationCommandInput,
87+
DeleteExtensionAssociationCommandOutput,
88+
} from "./commands/DeleteExtensionAssociationCommand";
89+
import { DeleteExtensionCommandInput, DeleteExtensionCommandOutput } from "./commands/DeleteExtensionCommand";
8090
import {
8191
DeleteHostedConfigurationVersionCommandInput,
8292
DeleteHostedConfigurationVersionCommandOutput,
@@ -93,6 +103,11 @@ import {
93103
GetDeploymentStrategyCommandOutput,
94104
} from "./commands/GetDeploymentStrategyCommand";
95105
import { GetEnvironmentCommandInput, GetEnvironmentCommandOutput } from "./commands/GetEnvironmentCommand";
106+
import {
107+
GetExtensionAssociationCommandInput,
108+
GetExtensionAssociationCommandOutput,
109+
} from "./commands/GetExtensionAssociationCommand";
110+
import { GetExtensionCommandInput, GetExtensionCommandOutput } from "./commands/GetExtensionCommand";
96111
import {
97112
GetHostedConfigurationVersionCommandInput,
98113
GetHostedConfigurationVersionCommandOutput,
@@ -108,6 +123,11 @@ import {
108123
ListDeploymentStrategiesCommandOutput,
109124
} from "./commands/ListDeploymentStrategiesCommand";
110125
import { ListEnvironmentsCommandInput, ListEnvironmentsCommandOutput } from "./commands/ListEnvironmentsCommand";
126+
import {
127+
ListExtensionAssociationsCommandInput,
128+
ListExtensionAssociationsCommandOutput,
129+
} from "./commands/ListExtensionAssociationsCommand";
130+
import { ListExtensionsCommandInput, ListExtensionsCommandOutput } from "./commands/ListExtensionsCommand";
111131
import {
112132
ListHostedConfigurationVersionsCommandInput,
113133
ListHostedConfigurationVersionsCommandOutput,
@@ -130,6 +150,11 @@ import {
130150
UpdateDeploymentStrategyCommandOutput,
131151
} from "./commands/UpdateDeploymentStrategyCommand";
132152
import { UpdateEnvironmentCommandInput, UpdateEnvironmentCommandOutput } from "./commands/UpdateEnvironmentCommand";
153+
import {
154+
UpdateExtensionAssociationCommandInput,
155+
UpdateExtensionAssociationCommandOutput,
156+
} from "./commands/UpdateExtensionAssociationCommand";
157+
import { UpdateExtensionCommandInput, UpdateExtensionCommandOutput } from "./commands/UpdateExtensionCommand";
133158
import {
134159
ValidateConfigurationCommandInput,
135160
ValidateConfigurationCommandOutput,
@@ -141,24 +166,32 @@ export type ServiceInputTypes =
141166
| CreateConfigurationProfileCommandInput
142167
| CreateDeploymentStrategyCommandInput
143168
| CreateEnvironmentCommandInput
169+
| CreateExtensionAssociationCommandInput
170+
| CreateExtensionCommandInput
144171
| CreateHostedConfigurationVersionCommandInput
145172
| DeleteApplicationCommandInput
146173
| DeleteConfigurationProfileCommandInput
147174
| DeleteDeploymentStrategyCommandInput
148175
| DeleteEnvironmentCommandInput
176+
| DeleteExtensionAssociationCommandInput
177+
| DeleteExtensionCommandInput
149178
| DeleteHostedConfigurationVersionCommandInput
150179
| GetApplicationCommandInput
151180
| GetConfigurationCommandInput
152181
| GetConfigurationProfileCommandInput
153182
| GetDeploymentCommandInput
154183
| GetDeploymentStrategyCommandInput
155184
| GetEnvironmentCommandInput
185+
| GetExtensionAssociationCommandInput
186+
| GetExtensionCommandInput
156187
| GetHostedConfigurationVersionCommandInput
157188
| ListApplicationsCommandInput
158189
| ListConfigurationProfilesCommandInput
159190
| ListDeploymentStrategiesCommandInput
160191
| ListDeploymentsCommandInput
161192
| ListEnvironmentsCommandInput
193+
| ListExtensionAssociationsCommandInput
194+
| ListExtensionsCommandInput
162195
| ListHostedConfigurationVersionsCommandInput
163196
| ListTagsForResourceCommandInput
164197
| StartDeploymentCommandInput
@@ -169,31 +202,41 @@ export type ServiceInputTypes =
169202
| UpdateConfigurationProfileCommandInput
170203
| UpdateDeploymentStrategyCommandInput
171204
| UpdateEnvironmentCommandInput
205+
| UpdateExtensionAssociationCommandInput
206+
| UpdateExtensionCommandInput
172207
| ValidateConfigurationCommandInput;
173208

174209
export type ServiceOutputTypes =
175210
| CreateApplicationCommandOutput
176211
| CreateConfigurationProfileCommandOutput
177212
| CreateDeploymentStrategyCommandOutput
178213
| CreateEnvironmentCommandOutput
214+
| CreateExtensionAssociationCommandOutput
215+
| CreateExtensionCommandOutput
179216
| CreateHostedConfigurationVersionCommandOutput
180217
| DeleteApplicationCommandOutput
181218
| DeleteConfigurationProfileCommandOutput
182219
| DeleteDeploymentStrategyCommandOutput
183220
| DeleteEnvironmentCommandOutput
221+
| DeleteExtensionAssociationCommandOutput
222+
| DeleteExtensionCommandOutput
184223
| DeleteHostedConfigurationVersionCommandOutput
185224
| GetApplicationCommandOutput
186225
| GetConfigurationCommandOutput
187226
| GetConfigurationProfileCommandOutput
188227
| GetDeploymentCommandOutput
189228
| GetDeploymentStrategyCommandOutput
190229
| GetEnvironmentCommandOutput
230+
| GetExtensionAssociationCommandOutput
231+
| GetExtensionCommandOutput
191232
| GetHostedConfigurationVersionCommandOutput
192233
| ListApplicationsCommandOutput
193234
| ListConfigurationProfilesCommandOutput
194235
| ListDeploymentStrategiesCommandOutput
195236
| ListDeploymentsCommandOutput
196237
| ListEnvironmentsCommandOutput
238+
| ListExtensionAssociationsCommandOutput
239+
| ListExtensionsCommandOutput
197240
| ListHostedConfigurationVersionsCommandOutput
198241
| ListTagsForResourceCommandOutput
199242
| StartDeploymentCommandOutput
@@ -204,6 +247,8 @@ export type ServiceOutputTypes =
204247
| UpdateConfigurationProfileCommandOutput
205248
| UpdateDeploymentStrategyCommandOutput
206249
| UpdateEnvironmentCommandOutput
250+
| UpdateExtensionAssociationCommandOutput
251+
| UpdateExtensionCommandOutput
207252
| ValidateConfigurationCommandOutput;
208253

209254
export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
@@ -360,51 +405,52 @@ type AppConfigClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHan
360405
export interface AppConfigClientResolvedConfig extends AppConfigClientResolvedConfigType {}
361406

362407
/**
363-
* <p>Use AppConfig, a capability of Amazon Web Services Systems Manager, to create, manage, and quickly deploy
364-
* application configurations. AppConfig supports controlled deployments to applications of
365-
* any size and includes built-in validation checks and monitoring. You can use AppConfig with
366-
* applications hosted on Amazon EC2 instances, Lambda, containers, mobile applications, or IoT
367-
* devices.</p>
408+
* <p>Use AppConfig, a capability of Amazon Web Services Systems Manager, to create, manage, and quickly
409+
* deploy application configurations. AppConfig supports controlled deployments to
410+
* applications of any size and includes built-in validation checks and monitoring. You can
411+
* use AppConfig with applications hosted on Amazon EC2 instances, Lambda, containers,
412+
* mobile applications, or IoT devices.</p>
368413
* <p>To prevent errors when deploying application configurations, especially for production
369414
* systems where a simple typo could cause an unexpected outage, AppConfig includes
370415
* validators. A validator provides a syntactic or semantic check to ensure that the
371416
* configuration you want to deploy works as intended. To validate your application
372417
* configuration data, you provide a schema or an Amazon Web Services Lambda function that runs against
373418
* the configuration. The configuration deployment or update can only proceed when the
374419
* configuration data is valid.</p>
375-
* <p>During a configuration deployment, AppConfig monitors the application to ensure that the
376-
* deployment is successful. If the system encounters an error, AppConfig rolls back the
377-
* change to minimize impact for your application users. You can configure a deployment
378-
* strategy for each application or environment that includes deployment criteria, including
379-
* velocity, bake time, and alarms to monitor. Similar to error monitoring, if a deployment
380-
* triggers an alarm, AppConfig automatically rolls back to the previous version. </p>
420+
* <p>During a configuration deployment, AppConfig monitors the application to
421+
* ensure that the deployment is successful. If the system encounters an error, AppConfig rolls back the change to minimize impact for your application users. You can
422+
* configure a deployment strategy for each application or environment that includes
423+
* deployment criteria, including velocity, bake time, and alarms to monitor. Similar to error
424+
* monitoring, if a deployment triggers an alarm, AppConfig automatically rolls back
425+
* to the previous version. </p>
381426
* <p>AppConfig supports multiple use cases. Here are some examples:</p>
382427
* <ul>
383428
* <li>
384429
* <p>
385-
* <b>Feature flags</b>: Use AppConfig to turn on new
386-
* features that require a timely deployment, such as a product launch or announcement.
387-
* </p>
430+
* <b>Feature flags</b>: Use AppConfig to turn on
431+
* new features that require a timely deployment, such as a product launch or
432+
* announcement. </p>
388433
* </li>
389434
* <li>
390435
* <p>
391-
* <b>Application tuning</b>: Use AppConfig to carefully
392-
* introduce changes to your application that can only be tested with production
393-
* traffic.</p>
436+
* <b>Application tuning</b>: Use AppConfig to
437+
* carefully introduce changes to your application that can only be tested with
438+
* production traffic.</p>
394439
* </li>
395440
* <li>
396441
* <p>
397-
* <b>Allow list</b>: Use AppConfig to allow premium
398-
* subscribers to access paid content. </p>
442+
* <b>Allow list</b>: Use AppConfig to allow
443+
* premium subscribers to access paid content. </p>
399444
* </li>
400445
* <li>
401446
* <p>
402-
* <b>Operational issues</b>: Use AppConfig to reduce
403-
* stress on your application when a dependency or other external factor impacts the
404-
* system.</p>
447+
* <b>Operational issues</b>: Use AppConfig to
448+
* reduce stress on your application when a dependency or other external factor impacts
449+
* the system.</p>
405450
* </li>
406451
* </ul>
407-
* <p>This reference is intended to be used with the <a href="http://docs.aws.amazon.com/appconfig/latest/userguide/what-is-appconfig.html">AppConfig User Guide</a>.</p>
452+
* <p>This reference is intended to be used with the <a href="http://docs.aws.amazon.com/appconfig/latest/userguide/what-is-appconfig.html">AppConfig User
453+
* Guide</a>.</p>
408454
*/
409455
export class AppConfigClient extends __Client<
410456
__HttpHandlerOptions,

clients/client-appconfig/src/commands/CreateApplicationCommand.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,11 +23,11 @@ export interface CreateApplicationCommandInput extends CreateApplicationRequest
2323
export interface CreateApplicationCommandOutput extends Application, __MetadataBearer {}
2424

2525
/**
26-
* <p>Creates an application. An application in AppConfig is a logical unit of code that
27-
* provides capabilities for your customers. For example, an application can be a microservice
28-
* that runs on Amazon EC2 instances, a mobile application installed by your users, a serverless
29-
* application using Amazon API Gateway and Lambda, or any system you run on behalf of
30-
* others.</p>
26+
* <p>Creates an application. In AppConfig, an application is simply an
27+
* organizational construct like a folder. This organizational construct has a relationship
28+
* with some unit of executable code. For example, you could create an application called
29+
* MyMobileApp to organize and manage configuration data for a mobile application installed by
30+
* your users.</p>
3131
* @example
3232
* Use a bare-bones client and the command you need to make an API call.
3333
* ```javascript

clients/client-appconfig/src/commands/CreateConfigurationProfileCommand.ts

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -23,10 +23,9 @@ export interface CreateConfigurationProfileCommandInput extends CreateConfigurat
2323
export interface CreateConfigurationProfileCommandOutput extends ConfigurationProfile, __MetadataBearer {}
2424

2525
/**
26-
* <p>Creates a configuration profile, which is information that enables AppConfig to access
27-
* the configuration source. Valid configuration sources include the AppConfig hosted
28-
* configuration store, Amazon Web Services Systems Manager (SSM) documents, SSM Parameter Store parameters, Amazon S3
29-
* objects, or any <a href="http://docs.aws.amazon.com/codepipeline/latest/userguide/integrations-action-type.html#integrations-source">integration source
26+
* <p>Creates a configuration profile, which is information that enables AppConfig
27+
* to access the configuration source. Valid configuration sources include the AppConfig hosted configuration store, Amazon Web Services Systems Manager (SSM) documents, SSM Parameter Store
28+
* parameters, Amazon S3 objects, or any <a href="http://docs.aws.amazon.com/codepipeline/latest/userguide/integrations-action-type.html#integrations-source">integration source
3029
* action</a> supported by CodePipeline. A configuration profile includes the following
3130
* information:</p>
3231
*
@@ -43,8 +42,8 @@ export interface CreateConfigurationProfileCommandOutput extends ConfigurationPr
4342
* </li>
4443
* </ul>
4544
* <p>For more information, see <a href="http://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-creating-configuration-and-profile.html">Create a
46-
* Configuration and a Configuration Profile</a> in the <i>AppConfig User
47-
* Guide</i>.</p>
45+
* Configuration and a Configuration Profile</a> in the <i>AppConfig
46+
* User Guide</i>.</p>
4847
* @example
4948
* Use a bare-bones client and the command you need to make an API call.
5049
* ```javascript

clients/client-appconfig/src/commands/CreateEnvironmentCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ export interface CreateEnvironmentCommandOutput extends Environment, __MetadataB
2424

2525
/**
2626
* <p>Creates an environment. For each application, you define one or more environments. An
27-
* environment is a logical deployment group of AppConfig targets, such as applications in a
27+
* environment is a deployment group of AppConfig targets, such as applications in a
2828
* <code>Beta</code> or <code>Production</code> environment. You can also define
2929
* environments for application subcomponents such as the <code>Web</code>,
3030
* <code>Mobile</code> and <code>Back-end</code> components for your application. You can

0 commit comments

Comments
 (0)