You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: clients/client-appconfig/README.md
+24-23Lines changed: 24 additions & 23 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,51 +9,52 @@
9
9
10
10
AWS SDK for JavaScript AppConfig Client for Node.js, Browser and React Native.
11
11
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>
17
17
<p>To prevent errors when deploying application configurations, especially for production
18
18
systems where a simple typo could cause an unexpected outage, AppConfig includes
19
19
validators. A validator provides a syntactic or semantic check to ensure that the
20
20
configuration you want to deploy works as intended. To validate your application
21
21
configuration data, you provide a schema or an Amazon Web Services Lambda function that runs against
22
22
the configuration. The configuration deployment or update can only proceed when the
23
23
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>
30
30
<p>AppConfig supports multiple use cases. Here are some examples:</p>
31
31
<ul>
32
32
<li>
33
33
<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>
37
37
</li>
38
38
<li>
39
39
<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>
43
43
</li>
44
44
<li>
45
45
<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>
48
48
</li>
49
49
<li>
50
50
<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>
54
54
</li>
55
55
</ul>
56
-
<p>This reference is intended to be used with the <ahref="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 <ahref="http://docs.aws.amazon.com/appconfig/latest/userguide/what-is-appconfig.html">AppConfig User
* <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>
368
413
* <p>To prevent errors when deploying application configurations, especially for production
369
414
* systems where a simple typo could cause an unexpected outage, AppConfig includes
370
415
* validators. A validator provides a syntactic or semantic check to ensure that the
371
416
* configuration you want to deploy works as intended. To validate your application
372
417
* configuration data, you provide a schema or an Amazon Web Services Lambda function that runs against
373
418
* the configuration. The configuration deployment or update can only proceed when the
374
419
* 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>
381
426
* <p>AppConfig supports multiple use cases. Here are some examples:</p>
382
427
* <ul>
383
428
* <li>
384
429
* <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>
388
433
* </li>
389
434
* <li>
390
435
* <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>
394
439
* </li>
395
440
* <li>
396
441
* <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>
399
444
* </li>
400
445
* <li>
401
446
* <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>
405
450
* </li>
406
451
* </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
* <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
30
29
* action</a> supported by CodePipeline. A configuration profile includes the following
* <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>
48
47
* @example
49
48
* Use a bare-bones client and the command you need to make an API call.
0 commit comments