AppConfig class

Use AWS AppConfig, a capability of AWS Systems Manager, to create, manage, and quickly deploy application configurations. AppConfig supports controlled deployments to applications of any size and includes built-in validation checks and monitoring. You can use AppConfig with applications hosted on Amazon EC2 instances, AWS Lambda, containers, mobile applications, or IoT devices.

Constructors

AppConfig({required String region, AwsClientCredentials? credentials, AwsClientCredentialsProvider? credentialsProvider, Client? client, String? endpointUrl})

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

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>

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.

createConfigurationProfile({required String applicationId, required String locationUri, required String name, String? description, String? retrievalRoleArn, Map<String, String>? tags, List<Validator>? validators}) → Future<ConfigurationProfile>

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.

createDeploymentStrategy({required int deploymentDurationInMinutes, required double growthFactor, required String name, required ReplicateTo replicateTo, String? description, int? finalBakeTimeInMinutes, GrowthType? growthType, Map<String, String>? tags}) → Future<DeploymentStrategy>

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.

createEnvironment({required String applicationId, required String name, String? description, List<Monitor>? monitors, Map<String, String>? tags}) → Future<Environment>

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.

createHostedConfigurationVersion({required String applicationId, required String configurationProfileId, required Uint8List content, required String contentType, String? description, int? latestVersionNumber}) → Future<HostedConfigurationVersion>

Create a new configuration in the AppConfig configuration store.

deleteApplication({required String applicationId}) → Future<void>

Delete an application. Deleting an application does not delete a configuration from a host.

deleteConfigurationProfile({required String applicationId, required String configurationProfileId}) → Future<void>

Delete a configuration profile. Deleting a configuration profile does not delete a configuration from a host.

deleteDeploymentStrategy({required String deploymentStrategyId}) → Future<void>

Delete a deployment strategy. Deleting a deployment strategy does not delete a configuration from a host.

deleteEnvironment({required String applicationId, required String environmentId}) → Future<void>

Delete an environment. Deleting an environment does not delete a configuration from a host.

deleteHostedConfigurationVersion({required String applicationId, required String configurationProfileId, required int versionNumber}) → Future<void>

Delete a version of a configuration from the AppConfig configuration store.

getApplication({required String applicationId}) → Future<Application>

Retrieve information about an application.

getConfiguration({required String application, required String clientId, required String configuration, required String environment, String? clientConfigurationVersion}) → Future<Configuration>

Receive information about a configuration.

getConfigurationProfile({required String applicationId, required String configurationProfileId}) → Future<ConfigurationProfile>

Retrieve information about a configuration profile.

getDeployment({required String applicationId, required int deploymentNumber, required String environmentId}) → Future<Deployment>

Retrieve information about a configuration deployment.

getDeploymentStrategy({required String deploymentStrategyId}) → Future<DeploymentStrategy>

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.

getEnvironment({required String applicationId, required String environmentId}) → Future<Environment>

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.

getHostedConfigurationVersion({required String applicationId, required String configurationProfileId, required int versionNumber}) → Future<HostedConfigurationVersion>

Get information about a specific configuration version.

listApplications({int? maxResults, String? nextToken}) → Future<Applications>

List all applications in your AWS account.

listConfigurationProfiles({required String applicationId, int? maxResults, String? nextToken}) → 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.

listDeploymentStrategies({int? maxResults, String? nextToken}) → Future<DeploymentStrategies>

List deployment strategies.

listEnvironments({required String applicationId, int? maxResults, String? nextToken}) → Future<Environments>

List the environments for an application.

listHostedConfigurationVersions({required String applicationId, required String configurationProfileId, int? maxResults, String? nextToken}) → Future<HostedConfigurationVersions>

View a list of configurations stored in the AppConfig 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>? tags}) → Future<Deployment>

Starts a deployment.

stopDeployment({required String applicationId, required int deploymentNumber, required String environmentId}) → Future<Deployment>

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.

tagResource({required String resourceArn, required Map<String, String> tags}) → Future<void>

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.

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.

updateApplication({required String applicationId, String? description, String? name}) → Future<Application>

Updates an application.

updateConfigurationProfile({required String applicationId, required String configurationProfileId, String? description, 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.

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