AppConfig
import { AppConfig } from "https://aws-api.deno.dev/v0.2/services/appconfig.ts?docs=full";
§Constructors
§Methods
An application in AppConfig is a logical unit of code that provides capabilities for your customers. For example, an application can be a microservice that runs on Amazon EC2 instances, a mobile application installed by your users, a serverless application using Amazon API Gateway and AWS Lambda, or any system you run on behalf of others.
Information that enables AppConfig to access the configuration source. Valid configuration sources include Systems Manager (SSM) documents, SSM Parameter Store parameters, and Amazon S3 objects. A configuration profile includes the following information.
- The Uri location of the configuration data.
- The AWS Identity and Access Management (IAM) role that provides access to the configuration data.
- A validator for the configuration data. Available validators include either a JSON Schema or an AWS Lambda function.
For more information, see Create a Configuration and a Configuration Profile in the AWS AppConfig User Guide.
A deployment strategy defines important criteria for rolling out your configuration to the designated targets. A deployment strategy includes: the overall duration required, a percentage of targets to receive the deployment during each interval, an algorithm that defines how percentage grows, and bake time.
For each application, you define one or more environments.
An environment is a logical deployment group of AppConfig targets, such as applications in a Beta
or Production
environment.
You can also define environments for application subcomponents such as the Web
, Mobile
and Back-end
components for your application.
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.
Create a new configuration in the AppConfig configuration store.
Delete a configuration profile. Deleting a configuration profile does not delete a configuration from a host.
Delete a deployment strategy. Deleting a deployment strategy does not delete a configuration from a host.
Delete a version of a configuration from the AppConfig configuration store.
Receive information about a configuration.
! IMPORTANT:
! AWS AppConfig uses the value of the ClientConfigurationVersion
parameter to identify the configuration version on your clients.
! If you don’t send ClientConfigurationVersion
with each call to GetConfiguration
, your clients receive the current configuration.
! You are charged each time your clients receive a configuration.
! To avoid excess charges, we recommend that you include the ClientConfigurationVersion
value with every call to GetConfiguration
.
! This value must be saved on your client.
! Subsequent calls to GetConfiguration
must pass this value by using the ClientConfigurationVersion
parameter.
Retrieve information about a configuration profile.
Retrieve information about a deployment strategy. A deployment strategy defines important criteria for rolling out your configuration to the designated targets. A deployment strategy includes: the overall duration required, a percentage of targets to receive the deployment during each interval, an algorithm that defines how percentage grows, and bake time.
Retrieve information about an environment.
An environment is a logical deployment group of AppConfig applications, such as applications in a Production
environment or in an EU_Region
environment.
Each configuration deployment targets an environment.
You can enable one or more Amazon CloudWatch alarms for an environment.
If an alarm is triggered during a deployment, AppConfig roles back the configuration.
Get information about a specific configuration version.
List all applications in your AWS account.
Lists the configuration profiles for an application.
List deployment strategies.
List the environments for an application.
View a list of configurations stored in the AppConfig configuration store by version.
Retrieves the list of key-value tags assigned to the resource.
Stops a deployment.
This API action works only on deployments that have a status of DEPLOYING
.
This action moves the deployment to a status of ROLLED_BACK
.
Metadata to assign to an AppConfig resource. Tags help organize and categorize your AppConfig resources. Each tag consists of a key and an optional value, both of which you define. You can specify a maximum of 50 tags for a resource.
Updates an application.
Updates a configuration profile.
Updates a deployment strategy.
Updates an environment.
Uses the validators in a configuration profile to validate a configuration.