@aws-sdk/client-appconfig
Advanced tools
AWS SDK for JavaScript Appconfig Client for Node.js, Browser and React Native
@aws-sdk/client-appconfig is a part of the AWS SDK for JavaScript, which allows developers to interact with AWS AppConfig. AWS AppConfig is a service that helps you manage application configurations in a secure, scalable, and reliable way. It is particularly useful for deploying feature flags, toggles, and other configuration data without requiring a redeployment of your application.
Create Configuration Profile
This feature allows you to create a new configuration profile in AWS AppConfig. Configuration profiles are used to define the source of your configuration data, such as an SSM parameter or an S3 object.
const { AppConfigClient, CreateConfigurationProfileCommand } = require('@aws-sdk/client-appconfig');
const client = new AppConfigClient({ region: 'us-west-2' });
const params = {
ApplicationId: 'your-application-id',
Name: 'MyConfigurationProfile',
LocationUri: 'ssm-parameter://my-parameter',
Type: 'AWS.AppConfig.FeatureFlags'
};
const command = new CreateConfigurationProfileCommand(params);
client.send(command).then(
(data) => console.log(data),
(error) => console.error(error)
);Get Configuration
This feature allows you to retrieve the latest configuration data for a specified application, environment, and configuration profile. This is useful for dynamically updating your application's configuration without redeploying.
const { AppConfigClient, GetConfigurationCommand } = require('@aws-sdk/client-appconfig');
const client = new AppConfigClient({ region: 'us-west-2' });
const params = {
Application: 'your-application-id',
Environment: 'your-environment-id',
Configuration: 'your-configuration-profile-id',
ClientId: 'your-client-id'
};
const command = new GetConfigurationCommand(params);
client.send(command).then(
(data) => console.log(data),
(error) => console.error(error)
);Update Configuration Profile
This feature allows you to update an existing configuration profile. You can change the name, location URI, and other properties of the configuration profile.
const { AppConfigClient, UpdateConfigurationProfileCommand } = require('@aws-sdk/client-appconfig');
const client = new AppConfigClient({ region: 'us-west-2' });
const params = {
ApplicationId: 'your-application-id',
ConfigurationProfileId: 'your-configuration-profile-id',
Name: 'UpdatedConfigurationProfile',
LocationUri: 'ssm-parameter://updated-parameter'
};
const command = new UpdateConfigurationProfileCommand(params);
client.send(command).then(
(data) => console.log(data),
(error) => console.error(error)
);The 'config' package is a popular Node.js package for managing configuration files in a Node.js application. It allows you to define configuration settings for different environments and load them dynamically. Unlike @aws-sdk/client-appconfig, it does not provide integration with AWS services and is more suitable for local configuration management.
The 'dotenv' package is used to load environment variables from a .env file into process.env in Node.js applications. It is a simple and effective way to manage configuration settings, especially for local development. However, it lacks the advanced features and scalability provided by AWS AppConfig.
The 'convict' package is a configuration management tool for Node.js applications that allows you to define a schema for your configuration files. It supports environment-based configurations and validation. While it offers more structure and validation compared to 'config' and 'dotenv', it does not integrate with AWS services like @aws-sdk/client-appconfig.
AWS SDK for JavaScript AppConfig Client for Node.js, Browser and React Native.
AppConfig feature flags and dynamic configurations help software builders quickly and securely adjust application behavior in production environments without full code deployments. AppConfig speeds up software release frequency, improves application resiliency, and helps you address emergent issues more quickly. With feature flags, you can gradually release new capabilities to users and measure the impact of those changes before fully deploying the new capabilities to all users. With operational flags and dynamic configurations, you can update block lists, allow lists, throttling limits, logging verbosity, and perform other operational tuning to quickly respond to issues in production environments.
AppConfig is a capability of Amazon Web Services Systems Manager.
Despite the fact that application configuration content can vary greatly from application to application, AppConfig supports the following use cases, which cover a broad spectrum of customer needs:
Feature flags and toggles - Safely release new capabilities to your customers in a controlled environment. Instantly roll back changes if you experience a problem.
Application tuning - Carefully introduce application changes while testing the impact of those changes with users in production environments.
Allow list or block list - Control access to premium features or instantly block specific users without deploying new code.
Centralized configuration storage - Keep your configuration data organized and consistent across all of your workloads. You can use AppConfig to deploy configuration data stored in the AppConfig hosted configuration store, Secrets Manager, Systems Manager, Parameter Store, or Amazon S3.
How AppConfig works
This section provides a high-level description of how AppConfig works and how you get started.
Before you start creating AppConfig artifacts, we recommend you identify configuration data in your code that you want to dynamically manage using AppConfig. Good examples include feature flags or toggles, allow and block lists, logging verbosity, service limits, and throttling rules, to name a few.
If your configuration data already exists in the cloud, you can take advantage of AppConfig validation, deployment, and extension features to further streamline configuration data management.
To create a namespace, you create an AppConfig artifact called an application. An application is simply an organizational construct like a folder.
For each AppConfig application, you define one or more environments.
An environment is a logical grouping of targets, such as applications in a
Beta or Production environment, Lambda functions,
or containers. You can also define environments for application subcomponents,
such as the Web, Mobile, and
Back-end.
You can configure Amazon CloudWatch alarms for each environment. The system monitors alarms during a configuration deployment. If an alarm is triggered, the system rolls back the configuration.
A configuration profile includes, among other things, a URI that enables
AppConfig to locate your configuration data in its stored location
and a profile type. AppConfig supports two configuration profile types:
feature flags and freeform configurations. Feature flag configuration profiles
store their data in the AppConfig hosted configuration store and the URI
is simply hosted. For freeform configuration profiles, you can store
your data in the AppConfig hosted configuration store or any Amazon Web Services
service that integrates with AppConfig, as described in Creating
a free form configuration profile in the the AppConfig User Guide.
A configuration profile can also include optional validators to ensure your configuration data is syntactically and semantically correct. AppConfig performs a check using the validators when you start a deployment. If any errors are detected, the deployment rolls back to the previous configuration data.
When you create a new deployment, you specify the following:
An application ID
A configuration profile ID
A configuration version
An environment ID where you want to deploy the configuration data
A deployment strategy ID that defines how fast you want the changes to take effect
When you call the StartDeployment API action, AppConfig performs the following tasks:
Retrieves the configuration data from the underlying data store by using the location URI in the configuration profile.
Verifies the configuration data is syntactically and semantically correct by using the validators you specified when you created your configuration profile.
Caches a copy of the data so it is ready to be retrieved by your application. This cached copy is called the deployed data.
You can configure AppConfig Agent as a local host and have the agent poll AppConfig for configuration updates. The agent calls the StartConfigurationSession and GetLatestConfiguration API actions and caches your configuration data locally. To retrieve the data, your application makes an HTTP call to the localhost server. AppConfig Agent supports several use cases, as described in Simplified retrieval methods in the the AppConfig User Guide.
If AppConfig Agent isn't supported for your use case, you can configure your application to poll AppConfig for configuration updates by directly calling the StartConfigurationSession and GetLatestConfiguration API actions.
This reference is intended to be used with the AppConfig User Guide.
To install this package, simply type add or install @aws-sdk/client-appconfig using your favorite package manager:
npm install @aws-sdk/client-appconfigyarn add @aws-sdk/client-appconfigpnpm add @aws-sdk/client-appconfigThe AWS SDK is modulized by clients and commands.
To send a request, you only need to import the AppConfigClient and
the commands you need, for example ListApplicationsCommand:
// ES5 example
const { AppConfigClient, ListApplicationsCommand } = require("@aws-sdk/client-appconfig");
// ES6+ example
import { AppConfigClient, ListApplicationsCommand } from "@aws-sdk/client-appconfig";
To send a request, you:
send operation on client with command object as input.destroy() to close open connections.// a client can be shared by different commands.
const client = new AppConfigClient({ region: "REGION" });
const params = {
/** input parameters */
};
const command = new ListApplicationsCommand(params);
We recommend using await operator to wait for the promise returned by send operation as follows:
// async/await.
try {
const data = await client.send(command);
// process data.
} catch (error) {
// error handling.
} finally {
// finally.
}
Async-await is clean, concise, intuitive, easy to debug and has better error handling as compared to using Promise chains or callbacks.
You can also use Promise chaining to execute send operation.
client.send(command).then(
(data) => {
// process data.
},
(error) => {
// error handling.
}
);
Promises can also be called using .catch() and .finally() as follows:
client
.send(command)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
})
.finally(() => {
// finally.
});
We do not recommend using callbacks because of callback hell, but they are supported by the send operation.
// callbacks.
client.send(command, (err, data) => {
// process err and data.
});
The client can also send requests using v2 compatible style. However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post on modular packages in AWS SDK for JavaScript
import * as AWS from "@aws-sdk/client-appconfig";
const client = new AWS.AppConfig({ region: "REGION" });
// async/await.
try {
const data = await client.listApplications(params);
// process data.
} catch (error) {
// error handling.
}
// Promises.
client
.listApplications(params)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
});
// callbacks.
client.listApplications(params, (err, data) => {
// process err and data.
});
When the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).
try {
const data = await client.send(command);
// process data.
} catch (error) {
const { requestId, cfId, extendedRequestId } = error.$metadata;
console.log({ requestId, cfId, extendedRequestId });
/**
* The keys within exceptions are also parsed.
* You can access them by specifying exception names:
* if (error.name === 'SomeServiceException') {
* const value = error.specialKeyInException;
* }
*/
}
Please use these community resources for getting help. We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
aws-sdk-js
on AWS Developer Blog.aws-sdk-js.To test your universal JavaScript code in Node.js, browser and react-native environments, visit our code samples repo.
This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-appconfig package is updated.
To contribute to client you can check our generate clients scripts.
This SDK is distributed under the Apache License, Version 2.0, see LICENSE for more information.
FAQs
AWS SDK for JavaScript Appconfig Client for Node.js, Browser and React Native
We found that @aws-sdk/client-appconfig demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
OpenSSF has published OSPS Baseline, an initiative designed to establish a minimum set of security-related best practices for open source software projects.
Security News
Michigan TypeScript founder Dimitri Mitropoulos implements WebAssembly runtime in TypeScript types, enabling Doom to run after processing 177 terabytes of type definitions.
Security News
vlt's new "reproduce" tool verifies npm packages against their source code, outperforming traditional provenance adoption in the JavaScript ecosystem.