AppConfig class

AppConfig helps you safely change application behavior in production without redeploying code. Using feature flags and dynamic free-form configurations, you can control how your application runs in real time. This approach reduces risk, accelerates releases, and enables faster responses to issues. You can gradually roll out new features to specific users, monitor their impact, and expand availability with confidence. You can also update block lists, allow lists, throttling limits, and logging levels instantly, allowing you to mitigate issues and fine-tune performance without a deployment.

AppConfig supports a broad spectrum of use cases:

  • Feature flags and toggles – Gradually release new capabilities to targeted users, monitor impact, and instantly roll back changes if issues occur.
  • Application tuning – Introduce changes safely in production, measure their effects, and refine behavior without redeploying code.
  • Allow list or block list – Control access to features or restrict specific users in real time, without modifying application code.
  • Centralized configuration storage – Manage configuration data consistently across workloads. AppConfig can deploy configuration from the AppConfig hosted configuration store, Secrets Manager, Systems 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.

1. Identify configuration data to manage in AppConfig
Before creating a configuration profile, identify the configuration data in your code that you want to manage dynamically using AppConfig. Common examples include feature flags, allow and block lists, logging levels, service limits, and throttling rules. These values tend to change frequently and can cause issues if misconfigured.

If your configuration data already exists in cloud services such as Systems Manager Parameter Store or Amazon S3, you can use AppConfig to validate, deploy, and manage that data more effectively.

2. Create a configuration profile in AppConfig
A configuration profile defines how AppConfig locates and manages your configuration data. It includes a URI that points to the data source and a profile type.

AppConfig supports two profile types

  • Feature flags – Enable controlled feature releases, gradual rollouts, and testing in production.
  • Free-form configurations – Store and retrieve configuration data from external sources and update it without redeploying code.
Both profile types help decouple configuration from code, support continuous delivery, and reduce deployment risk.

You can also add optional validators to ensure that configuration data is syntactically and semantically correct. During deployment, AppConfig evaluates these validators and automatically rolls back changes if validation fails.

Each configuration profile is associated with an application, which acts as a logical container for your configuration resources. For more information about creating a configuration profile, see Creating a configuration profile in AppConfig in the the AppConfig User Guide.

3. Deploy configuration data
When you start a deployment, AppConfig:
  1. Retrieves configuration data from the source defined in the configuration profile
  2. Validates the data using the configured validators
  3. Delivers the validated configuration to AppConfig Agent
The delivered configuration becomes the deployed version used by your application. For more information about deploying a configuration, see Deploying feature flags and configuration data in AppConfig.
4. Retrieve configuration data
Your application retrieves configuration data by calling a local endpoint exposed by AppConfig Agent, which caches the deployed configuration. Retrieving data is a metered event. AppConfig Agent supports a variety of use cases, as described in How to use AppConfig Agent to retrieve configuration data.

If the agent is not suitable for your use case, your application can retrieve configuration data directly from AppConfig by calling the StartConfigurationSession and GetLatestConfiguration API actions.

For more information about retrieving a configuration, see Retrieving feature flags and configuration data in AppConfig.

This reference is intended to be used with the AppConfig User Guide.

Constructors

AppConfig({required String region, AwsClientCredentials? credentials, AwsClientCredentialsProvider? credentialsProvider, Client? client, String? endpointUrl, bool useFipsEndpoint = false, bool useDualStackEndpoint = false})
factory

Properties

hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

close() → void
Closes the internal HTTP client if none was provided at creation. If a client was passed as a constructor argument, this becomes a noop.
createApplication({required String name, String? description, Map<String, String>? tags}) → Future<Application>
Creates an application. In AppConfig, an application is simply an organizational construct like a folder. This organizational construct has a relationship with some unit of executable code. For example, you could create an application called MyMobileApp to organize and manage configuration data for a mobile application installed by your users.
createConfigurationProfile({required String applicationId, required String locationUri, required String name, String? description, String? kmsKeyIdentifier, String? retrievalRoleArn, Map<String, String>? tags, String? type, List<Validator>? validators}) → Future<ConfigurationProfile>
Creates a configuration profile, which is information that enables AppConfig to access the configuration source. Valid configuration sources include the following:
createDeploymentStrategy({required int deploymentDurationInMinutes, required double growthFactor, required String name, String? description, int? finalBakeTimeInMinutes, GrowthType? growthType, ReplicateTo? replicateTo, Map<String, String>? tags}) → Future<DeploymentStrategy>
Creates a deployment strategy that 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.
createEnvironment({required String applicationId, required String name, String? description, List<Monitor>? monitors, Map<String, String>? tags}) → Future<Environment>
Creates an environment. For each application, you define one or more environments. An environment is a 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.
createExperimentDefinition({required String applicationIdentifier, required String audienceRule, required String configurationProfileIdentifier, required TreatmentInput control, required String environmentIdentifier, required String flagKey, required String name, required List<TreatmentInput> treatments, String? audienceDescription, String? hypothesis, String? launchCriteria, Map<String, String>? tags}) → Future<ExperimentDefinition>
Creates an experiment definition in AppConfig. An experiment definition describes the purpose, scope, and operational configuration of an experiment, including the target audience, feature flag, and treatment configurations.
createExtension({required Map<ActionPoint, List<Action>> actions, required String name, String? description, int? latestVersionNumber, Map<String, Parameter>? parameters, Map<String, String>? tags}) → Future<Extension>
Creates an AppConfig extension. An extension augments your ability to inject logic or behavior at different points during the AppConfig workflow of creating or deploying a configuration.
createExtensionAssociation({required String extensionIdentifier, required String resourceIdentifier, int? extensionVersionNumber, Map<String, String>? parameters, Map<String, String>? tags}) → Future<ExtensionAssociation>
When you create an extension or configure an Amazon Web Services authored extension, you associate the extension with an AppConfig application, environment, or configuration profile. For example, you can choose to run the AppConfig deployment events to Amazon SNS Amazon Web Services authored extension and receive notifications on an Amazon SNS topic anytime a configuration deployment is started for a specific application. Defining which extension to associate with an AppConfig resource is called an extension association. An extension association is a specified relationship between an extension and an AppConfig resource, such as an application or a configuration profile. For more information about extensions and associations, see Extending workflows in the AppConfig User Guide.
createHostedConfigurationVersion({required String applicationId, required String configurationProfileId, required Uint8List content, required String contentType, String? description, int? latestVersionNumber, String? versionLabel}) → Future<HostedConfigurationVersion>
Creates a new configuration in the AppConfig hosted configuration store. If you're creating a feature flag, we recommend you familiarize yourself with the JSON schema for feature flag data. For more information, see Type reference for AWS.AppConfig.FeatureFlags in the AppConfig User Guide.
deleteApplication({required String applicationId}) → Future<void>
Deletes an application.
deleteConfigurationProfile({required String applicationId, required String configurationProfileId, DeletionProtectionCheck? deletionProtectionCheck}) → Future<void>
Deletes a configuration profile.
deleteDeploymentStrategy({required String deploymentStrategyId}) → Future<void>
Deletes a deployment strategy.
deleteEnvironment({required String applicationId, required String environmentId, DeletionProtectionCheck? deletionProtectionCheck}) → Future<void>
Deletes an environment.
deleteExperimentDefinition({required String applicationIdentifier, required String experimentDefinitionIdentifier, DeleteType? deleteType}) → Future<void>
Deletes an experiment definition. You can archive the definition to hide it from the active list while preserving it for future reference, or permanently delete it along with all associated run history.
deleteExtension({required String extensionIdentifier, int? versionNumber}) → Future<void>
Deletes an AppConfig extension. You must delete all associations to an extension before you delete the extension.
deleteExtensionAssociation({required String extensionAssociationId}) → Future<void>
Deletes an extension association. This action doesn't delete extensions defined in the association.
deleteHostedConfigurationVersion({required String applicationId, required String configurationProfileId, required int versionNumber}) → Future<void>
Deletes a version of a configuration from the AppConfig hosted configuration store.
getAccountSettings() → Future<AccountSettings>
Returns information about the status of the DeletionProtection parameter.
getApplication({required String applicationId}) → Future<Application>
Retrieves information about an application.
getConfiguration({required String application, required String clientId, required String configuration, required String environment, String? clientConfigurationVersion}) → Future<Configuration>
(Deprecated) Retrieves the latest deployed configuration.
getConfigurationProfile({required String applicationId, required String configurationProfileId}) → Future<ConfigurationProfile>
Retrieves information about a configuration profile.
getDeployment({required String applicationId, required int deploymentNumber, required String environmentId}) → Future<Deployment>
Retrieves information about a configuration deployment.
getDeploymentStrategy({required String deploymentStrategyId}) → Future<DeploymentStrategy>
Retrieves 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.
getEnvironment({required String applicationId, required String environmentId}) → Future<Environment>
Retrieves information about an environment. An environment is a 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.
getExperimentDefinition({required String applicationIdentifier, required String experimentDefinitionIdentifier}) → Future<ExperimentDefinition>
Retrieves information about an experiment definition.
getExperimentRun({required String applicationIdentifier, required String experimentDefinitionIdentifier, required int run}) → Future<ExperimentRun>
Retrieves information about an experiment run, including its status, start time, and exposure settings.
getExtension({required String extensionIdentifier, int? versionNumber}) → Future<Extension>
Returns information about an AppConfig extension.
getExtensionAssociation({required String extensionAssociationId}) → Future<ExtensionAssociation>
Returns information about an AppConfig extension association. For more information about extensions and associations, see Extending workflows in the AppConfig User Guide.
getHostedConfigurationVersion({required String applicationId, required String configurationProfileId, required int versionNumber}) → Future<HostedConfigurationVersion>
Retrieves information about a specific configuration version.
listApplications({int? maxResults, String? nextToken}) → Future<Applications>
Lists all applications in your Amazon Web Services account.
listConfigurationProfiles({required String applicationId, int? maxResults, String? nextToken, String? type}) → Future<ConfigurationProfiles>
Lists the configuration profiles for an application.
listDeployments({required String applicationId, required String environmentId, int? maxResults, String? nextToken}) → Future<Deployments>
Lists the deployments for an environment in descending deployment number order.
listDeploymentStrategies({int? maxResults, String? nextToken}) → Future<DeploymentStrategies>
Lists deployment strategies.
listEnvironments({required String applicationId, int? maxResults, String? nextToken}) → Future<Environments>
Lists the environments for an application.
listExperimentDefinitions({String? applicationIdentifier, String? configurationProfileIdentifier, String? environmentIdentifier, int? maxResults, String? nextToken, ExperimentDefinitionStatus? status}) → Future<ExperimentDefinitions>
Lists the experiment definitions for an account. You can filter results by application, configuration profile, environment, or status.
listExperimentRunEvents({required String applicationIdentifier, required String experimentDefinitionIdentifier, required int run, int? maxResults, String? nextToken}) → Future<ExperimentRunEvents>
Lists the events for a specified experiment run. Events provide a timeline of actions and state changes that occurred during the run.
listExperimentRuns({required String applicationIdentifier, required String experimentDefinitionIdentifier, int? maxResults, String? nextToken, ExperimentRunStatus? status}) → Future<ExperimentRuns>
Lists the experiment runs for a specified experiment definition. You can filter by status.
listExtensionAssociations({String? extensionIdentifier, int? extensionVersionNumber, int? maxResults, String? nextToken, String? resourceIdentifier}) → Future<ExtensionAssociations>
Lists all AppConfig extension associations in the account. For more information about extensions and associations, see Extending workflows in the AppConfig User Guide.
listExtensions({int? maxResults, String? name, String? nextToken}) → Future<Extensions>
Lists all custom and Amazon Web Services authored AppConfig extensions in the account. For more information about extensions, see Extending workflows in the AppConfig User Guide.
listHostedConfigurationVersions({required String applicationId, required String configurationProfileId, int? maxResults, String? nextToken, String? versionLabel}) → Future<HostedConfigurationVersions>
Lists configurations stored in the AppConfig hosted configuration store by version.
listTagsForResource({required String resourceArn}) → Future<ResourceTags>
Retrieves the list of key-value tags assigned to the resource.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
startDeployment({required String applicationId, required String configurationProfileId, required String configurationVersion, required String deploymentStrategyId, required String environmentId, String? description, Map<String, String>? dynamicExtensionParameters, String? kmsKeyIdentifier, int? latestDeploymentNumber, Map<String, String>? tags}) → Future<Deployment>
Starts a deployment.
startExperimentRun({required String applicationIdentifier, required String experimentDefinitionIdentifier, DeploymentParameters? deploymentParameters, String? description, double? exposurePercentage, Map<String, String>? tags, TreatmentOverrides? treatmentOverrides}) → Future<ExperimentRun>
Starts an experiment run for the specified experiment definition. An experiment run delivers treatments to the target audience and collects metrics. You can start multiple experiment runs from the same experiment definition.
stopDeployment({required String applicationId, required int deploymentNumber, required String environmentId, bool? allowRevert}) → Future<Deployment>
Stops a deployment. This API action works only on deployments that have a status of DEPLOYING, unless an AllowRevert parameter is supplied. If the AllowRevert parameter is supplied, the status of an in-progress deployment will be ROLLED_BACK. The status of a completed deployment will be REVERTED. AppConfig only allows a revert within 72 hours of deployment completion.
stopExperimentRun({required String applicationIdentifier, required String experimentDefinitionIdentifier, required int run, DeploymentParameters? deploymentParameters, ExperimentRunResult? result}) → Future<ExperimentRun>
Stops a running experiment. Stopping an experiment run ends audience exposure and returns users to the currently deployed feature flag configuration.
tagResource({required String resourceArn, required Map<String, String> tags}) → Future<void>
Assigns metadata 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.
toString() → String
A string representation of this object.
inherited
untagResource({required String resourceArn, required List<String> tagKeys}) → Future<void>
Deletes a tag key and value from an AppConfig resource.
updateAccountSettings({DeletionProtectionSettings? deletionProtection, VendedMetricsSettings? vendedMetrics}) → Future<AccountSettings>
Updates the value of the DeletionProtection parameter.
updateApplication({required String applicationId, String? description, String? name}) → Future<Application>
Updates an application.
updateConfigurationProfile({required String applicationId, required String configurationProfileId, String? description, String? kmsKeyIdentifier, String? name, String? retrievalRoleArn, List<Validator>? validators}) → Future<ConfigurationProfile>
Updates a configuration profile.
updateDeploymentStrategy({required String deploymentStrategyId, int? deploymentDurationInMinutes, String? description, int? finalBakeTimeInMinutes, double? growthFactor, GrowthType? growthType}) → Future<DeploymentStrategy>
Updates a deployment strategy.
updateEnvironment({required String applicationId, required String environmentId, String? description, List<Monitor>? monitors, String? name}) → Future<Environment>
Updates an environment.
updateExperimentDefinition({required String applicationIdentifier, required String experimentDefinitionIdentifier, String? audienceDescription, String? audienceRule, TreatmentInput? control, String? hypothesis, String? launchCriteria, List<TreatmentInput>? treatments}) → Future<ExperimentDefinition>
Updates an experiment definition. You can update treatments, the control, audience rules, and other properties. You cannot update an experiment definition while an experiment run is active.
updateExperimentRun({required String applicationIdentifier, required String experimentDefinitionIdentifier, required int run, DeploymentParameters? deploymentParameters, String? description, double? exposurePercentage, TreatmentOverrides? treatmentOverrides}) → Future<ExperimentRun>
Updates a running experiment. Use this operation to increase audience exposure, modify treatment assignment overrides, or update the description of an active experiment run. Audience exposure can only be increased, not decreased.
updateExtension({required String extensionIdentifier, Map<ActionPoint, List<Action>>? actions, String? description, Map<String, Parameter>? parameters, int? versionNumber}) → Future<Extension>
Updates an AppConfig extension. For more information about extensions, see Extending workflows in the AppConfig User Guide.
updateExtensionAssociation({required String extensionAssociationId, Map<String, String>? parameters}) → Future<ExtensionAssociation>
Updates an association. For more information about extensions and associations, see Extending workflows in the AppConfig User Guide.
validateConfiguration({required String applicationId, required String configurationProfileId, required String configurationVersion}) → Future<void>
Uses the validators in a configuration profile to validate a configuration.

Operators

operator ==(Object other) → bool
The equality operator.
inherited