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
+19-24
Original file line number
Diff line number
Diff line change
@@ -7,30 +7,25 @@
7
7
8
8
AWS SDK for JavaScript AppConfig Client for Node.js, Browser and React Native.
9
9
10
-
<fullname>AWS AppConfig</fullname>
11
-
12
-
<p>Use AWS AppConfig, a capability of AWS Systems Manager, to create, manage, and quickly deploy
13
-
application configurations. AppConfig supports controlled deployments to applications of any
14
-
size and includes built-in validation checks and monitoring. You can use AppConfig with
15
-
applications hosted on Amazon EC2 instances, AWS Lambda, containers, mobile applications, or IoT
10
+
<p>Use AppConfig, a capability of Amazon Web Services Systems Manager, to create, manage, and quickly deploy
11
+
application configurations. AppConfig supports controlled deployments to applications of
12
+
any size and includes built-in validation checks and monitoring. You can use AppConfig with
13
+
applications hosted on Amazon EC2 instances, Lambda, containers, mobile applications, or IoT
16
14
devices.</p>
17
-
18
15
<p>To prevent errors when deploying application configurations, especially for production
19
-
systems where a simple typo could cause an unexpected outage, AppConfig includes validators.
20
-
A validator provides a syntactic or semantic check to ensure that the configuration you
21
-
want to deploy works as intended. To validate your application configuration data, you
22
-
provide a schema or a Lambda function that runs against the configuration. The
23
-
configuration deployment or update can only proceed when the configuration data is
24
-
valid.</p>
25
-
16
+
systems where a simple typo could cause an unexpected outage, AppConfig includes
17
+
validators. A validator provides a syntactic or semantic check to ensure that the
18
+
configuration you want to deploy works as intended. To validate your application
19
+
configuration data, you provide a schema or a Lambda function that runs against the
20
+
configuration. The configuration deployment or update can only proceed when the
21
+
configuration data is valid.</p>
26
22
<p>During a configuration deployment, AppConfig monitors the application to ensure that the
27
-
deployment is successful. If the system encounters an error, AppConfig rolls back the change
28
-
to minimize impact for your application users. You can configure a deployment strategy for
29
-
each application or environment that includes deployment criteria, including velocity, bake
30
-
time, and alarms to monitor. Similar to error monitoring, if a deployment triggers an
31
-
alarm, AppConfig automatically rolls back to the previous version. </p>
32
-
33
-
<p>AppConfig supports multiple use cases. Here are some examples.</p>
23
+
deployment is successful. If the system encounters an error, AppConfig rolls back the
24
+
change to minimize impact for your application users. You can configure a deployment
25
+
strategy for each application or environment that includes deployment criteria, including
26
+
velocity, bake time, and alarms to monitor. Similar to error monitoring, if a deployment
27
+
triggers an alarm, AppConfig automatically rolls back to the previous version. </p>
28
+
<p>AppConfig supports multiple use cases. Here are some examples:</p>
34
29
<ul>
35
30
<li>
36
31
<p>
@@ -51,12 +46,12 @@ subscribers to access paid content. </p>
51
46
</li>
52
47
<li>
53
48
<p>
54
-
<b>Operational issues</b>: Use AppConfig to reduce stress
55
-
on your application when a dependency or other external factor impacts the
49
+
<b>Operational issues</b>: Use AppConfig to reduce
50
+
stress on your application when a dependency or other external factor impacts the
56
51
system.</p>
57
52
</li>
58
53
</ul>
59
-
<p>This reference is intended to be used with the <ahref="http://docs.aws.amazon.com/systems-manager/latest/userguide/appconfig.html">AWS AppConfig User Guide</a>.</p>
54
+
<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>
* <b>Operational issues</b>: Use AppConfig to reduce stress
398
-
* on your application when a dependency or other external factor impacts the
393
+
* <b>Operational issues</b>: Use AppConfig to reduce
394
+
* stress on your application when a dependency or other external factor impacts the
399
395
* system.</p>
400
396
* </li>
401
397
* </ul>
402
-
* <p>This reference is intended to be used with the <a href="http://docs.aws.amazon.com/systems-manager/latest/userguide/appconfig.html">AWS AppConfig User Guide</a>.</p>
398
+
* <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>
* <p>Information that enables AppConfig to access the configuration source. Valid
26
-
* configuration sources include Systems Manager (SSM) documents, SSM Parameter Store parameters, and
27
-
* Amazon S3 objects. A configuration profile includes the following information.</p>
25
+
* <p>Creates a configuration profile, which is information that enables AppConfig to access
26
+
* the configuration source. Valid configuration sources include the AppConfig hosted
27
+
* configuration store, Amazon Web Services Systems Manager (SSM) documents, SSM Parameter Store parameters, Amazon S3
28
+
* objects, or any <a href="http://docs.aws.amazon.com/codepipeline/latest/userguide/integrations-action-type.html#integrations-source">integration source
29
+
* action</a> supported by CodePipeline. A configuration profile includes the following
30
+
* information:</p>
31
+
*
28
32
* <ul>
29
33
* <li>
30
-
* <p>The Uri location of the configuration data.</p>
34
+
* <p>The URI location of the configuration data.</p>
31
35
* </li>
32
36
* <li>
33
-
* <p>The AWS Identity and Access Management (IAM) role that provides access to the configuration data.</p>
37
+
* <p>The Identity and Access Management (IAM) role that provides access to the configuration data.</p>
34
38
* </li>
35
39
* <li>
36
40
* <p>A validator for the configuration data. Available validators include either a JSON
37
-
* Schema or an AWS Lambda function.</p>
41
+
* Schema or an Lambda function.</p>
38
42
* </li>
39
43
* </ul>
40
-
* <p>For more information, see <a href="http://docs.aws.amazon.com/systems-manager/latest/userguide/appconfig-creating-configuration-and-profile.html">Create a
41
-
* Configuration and a Configuration Profile</a> in the
42
-
* <i>AWS AppConfig User Guide</i>.</p>
44
+
* <p>For more information, see <a href="http://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-creating-configuration-and-profile.html">Create a
45
+
* Configuration and a Configuration Profile</a> in the <i>AppConfig User
46
+
* Guide</i>.</p>
43
47
* @example
44
48
* Use a bare-bones client and the command you need to make an API call.
0 commit comments