AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Implementation for accessing AppConfig AWS AppConfig

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.

To prevent errors when deploying application configurations, especially for production systems where a simple typo could cause an unexpected outage, AppConfig includes validators. A validator provides a syntactic or semantic check to ensure that the configuration you want to deploy works as intended. To validate your application configuration data, you provide a schema or a Lambda function that runs against the configuration. The configuration deployment or update can only proceed when the configuration data is valid.

During a configuration deployment, AppConfig monitors the application to ensure that the deployment is successful. If the system encounters an error, AppConfig rolls back the change to minimize impact for your application users. You can configure a deployment strategy for each application or environment that includes deployment criteria, including velocity, bake time, and alarms to monitor. Similar to error monitoring, if a deployment triggers an alarm, AppConfig automatically rolls back to the previous version.

AppConfig supports multiple use cases. Here are some examples.

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

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonServiceClient
    Amazon.AppConfig.AmazonAppConfigClient

Namespace: Amazon.AppConfig
Assembly: AWSSDK.AppConfig.dll
Version: 3.x.y.z

Syntax

C#
public class AmazonAppConfigClient : AmazonServiceClient
         IAmazonAppConfig, IAmazonService, IDisposable

The AmazonAppConfigClient type exposes the following members

Constructors

NameDescription
Public Method AmazonAppConfigClient()

Constructs AmazonAppConfigClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.



    
        
    

             

Public Method AmazonAppConfigClient(RegionEndpoint)

Constructs AmazonAppConfigClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.



    
        
    

             

Public Method AmazonAppConfigClient(AmazonAppConfigConfig)

Constructs AmazonAppConfigClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.



    
        
    

             

Public Method AmazonAppConfigClient(AWSCredentials)

Constructs AmazonAppConfigClient with AWS Credentials

Public Method AmazonAppConfigClient(AWSCredentials, RegionEndpoint)

Constructs AmazonAppConfigClient with AWS Credentials

Public Method AmazonAppConfigClient(AWSCredentials, AmazonAppConfigConfig)

Constructs AmazonAppConfigClient with AWS Credentials and an AmazonAppConfigClient Configuration object.

Public Method AmazonAppConfigClient(string, string)

Constructs AmazonAppConfigClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonAppConfigClient(string, string, RegionEndpoint)

Constructs AmazonAppConfigClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonAppConfigClient(string, string, AmazonAppConfigConfig)

Constructs AmazonAppConfigClient with AWS Access Key ID, AWS Secret Key and an AmazonAppConfigClient Configuration object.

Public Method AmazonAppConfigClient(string, string, string)

Constructs AmazonAppConfigClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonAppConfigClient(string, string, string, RegionEndpoint)

Constructs AmazonAppConfigClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonAppConfigClient(string, string, string, AmazonAppConfigConfig)

Constructs AmazonAppConfigClient with AWS Access Key ID, AWS Secret Key and an AmazonAppConfigClient Configuration object.

Properties

NameTypeDescription
Public Property Config Amazon.Runtime.IClientConfig Inherited from Amazon.Runtime.AmazonServiceClient.

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

NameDescription
Public Method CreateApplication(CreateApplicationRequest)

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.

Public Method CreateApplicationAsync(CreateApplicationRequest, CancellationToken)

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.

Public Method CreateConfigurationProfile(CreateConfigurationProfileRequest)

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.

Public Method CreateConfigurationProfileAsync(CreateConfigurationProfileRequest, CancellationToken)

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.

Public Method CreateDeploymentStrategy(CreateDeploymentStrategyRequest)

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.

Public Method CreateDeploymentStrategyAsync(CreateDeploymentStrategyRequest, CancellationToken)

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.

Public Method CreateEnvironment(CreateEnvironmentRequest)

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.

Public Method CreateEnvironmentAsync(CreateEnvironmentRequest, CancellationToken)

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.

Public Method DeleteApplication(DeleteApplicationRequest)

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

Public Method DeleteApplicationAsync(DeleteApplicationRequest, CancellationToken)

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

Public Method DeleteConfigurationProfile(DeleteConfigurationProfileRequest)

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

Public Method DeleteConfigurationProfileAsync(DeleteConfigurationProfileRequest, CancellationToken)

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

Public Method DeleteDeploymentStrategy(DeleteDeploymentStrategyRequest)

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

Public Method DeleteDeploymentStrategyAsync(DeleteDeploymentStrategyRequest, CancellationToken)

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

Public Method DeleteEnvironment(DeleteEnvironmentRequest)

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

Public Method DeleteEnvironmentAsync(DeleteEnvironmentRequest, CancellationToken)

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

Public Method Dispose() Inherited from Amazon.Runtime.AmazonServiceClient.
Public Method GetApplication(GetApplicationRequest)

Retrieve information about an application.

Public Method GetApplicationAsync(GetApplicationRequest, CancellationToken)

Retrieve information about an application.

Public Method GetConfiguration(GetConfigurationRequest)

Receive information about a configuration.

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.

Public Method GetConfigurationAsync(GetConfigurationRequest, CancellationToken)

Receive information about a configuration.

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.

Public Method GetConfigurationProfile(GetConfigurationProfileRequest)

Retrieve information about a configuration profile.

Public Method GetConfigurationProfileAsync(GetConfigurationProfileRequest, CancellationToken)

Retrieve information about a configuration profile.

Public Method GetDeployment(GetDeploymentRequest)

Retrieve information about a configuration deployment.

Public Method GetDeploymentAsync(GetDeploymentRequest, CancellationToken)

Retrieve information about a configuration deployment.

Public Method GetDeploymentStrategy(GetDeploymentStrategyRequest)

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.

Public Method GetDeploymentStrategyAsync(GetDeploymentStrategyRequest, CancellationToken)

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.

Public Method GetEnvironment(GetEnvironmentRequest)

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.

Public Method GetEnvironmentAsync(GetEnvironmentRequest, CancellationToken)

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.

Public Method ListApplications(ListApplicationsRequest)

List all applications in your AWS account.

Public Method ListApplicationsAsync(ListApplicationsRequest, CancellationToken)

List all applications in your AWS account.

Public Method ListConfigurationProfiles(ListConfigurationProfilesRequest)

Lists the configuration profiles for an application.

Public Method ListConfigurationProfilesAsync(ListConfigurationProfilesRequest, CancellationToken)

Lists the configuration profiles for an application.

Public Method ListDeployments(ListDeploymentsRequest)

Lists the deployments for an environment.

Public Method ListDeploymentsAsync(ListDeploymentsRequest, CancellationToken)

Lists the deployments for an environment.

Public Method ListDeploymentStrategies(ListDeploymentStrategiesRequest)

List deployment strategies.

Public Method ListDeploymentStrategiesAsync(ListDeploymentStrategiesRequest, CancellationToken)

List deployment strategies.

Public Method ListEnvironments(ListEnvironmentsRequest)

List the environments for an application.

Public Method ListEnvironmentsAsync(ListEnvironmentsRequest, CancellationToken)

List the environments for an application.

Public Method ListTagsForResource(ListTagsForResourceRequest)

Retrieves the list of key-value tags assigned to the resource.

Public Method ListTagsForResourceAsync(ListTagsForResourceRequest, CancellationToken)

Retrieves the list of key-value tags assigned to the resource.

Public Method StartDeployment(StartDeploymentRequest)

Starts a deployment.

Public Method StartDeploymentAsync(StartDeploymentRequest, CancellationToken)

Starts a deployment.

Public Method StopDeployment(StopDeploymentRequest)

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.

Public Method StopDeploymentAsync(StopDeploymentRequest, CancellationToken)

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.

Public Method TagResource(TagResourceRequest)

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.

Public Method TagResourceAsync(TagResourceRequest, CancellationToken)

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.

Public Method UntagResource(UntagResourceRequest)

Deletes a tag key and value from an AppConfig resource.

Public Method UntagResourceAsync(UntagResourceRequest, CancellationToken)

Deletes a tag key and value from an AppConfig resource.

Public Method UpdateApplication(UpdateApplicationRequest)

Updates an application.

Public Method UpdateApplicationAsync(UpdateApplicationRequest, CancellationToken)

Updates an application.

Public Method UpdateConfigurationProfile(UpdateConfigurationProfileRequest)

Updates a configuration profile.

Public Method UpdateConfigurationProfileAsync(UpdateConfigurationProfileRequest, CancellationToken)

Updates a configuration profile.

Public Method UpdateDeploymentStrategy(UpdateDeploymentStrategyRequest)

Updates a deployment strategy.

Public Method UpdateDeploymentStrategyAsync(UpdateDeploymentStrategyRequest, CancellationToken)

Updates a deployment strategy.

Public Method UpdateEnvironment(UpdateEnvironmentRequest)

Updates an environment.

Public Method UpdateEnvironmentAsync(UpdateEnvironmentRequest, CancellationToken)

Updates an environment.

Public Method ValidateConfiguration(ValidateConfigurationRequest)

Uses the validators in a configuration profile to validate a configuration.

Public Method ValidateConfigurationAsync(ValidateConfigurationRequest, CancellationToken)

Uses the validators in a configuration profile to validate a configuration.

Events

NameDescription
Event AfterResponseEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event BeforeRequestEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event ExceptionEvent Inherited from Amazon.Runtime.AmazonServiceClient.

Version Information

.NET Standard:
Supported in: 2.0, 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms