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.

Classes

NameDescription
Class Application

Class BadRequestException

AppConfig exception

Class ConfigurationProfileSummary

A summary of a configuration profile.

Class ConflictException

AppConfig exception

Class CreateApplicationRequest

Container for the parameters to the CreateApplication operation. 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.

Class CreateApplicationResponse

This is the response object from the CreateApplication operation.

Class CreateConfigurationProfileRequest

Container for the parameters to the CreateConfigurationProfile operation. 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.

Class CreateConfigurationProfileResponse

This is the response object from the CreateConfigurationProfile operation.

Class CreateDeploymentStrategyRequest

Container for the parameters to the CreateDeploymentStrategy operation. 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.

Class CreateDeploymentStrategyResponse

This is the response object from the CreateDeploymentStrategy operation.

Class CreateEnvironmentRequest

Container for the parameters to the CreateEnvironment operation. 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.

Class CreateEnvironmentResponse

This is the response object from the CreateEnvironment operation.

Class DeleteApplicationRequest

Container for the parameters to the DeleteApplication operation. Delete an application. Deleting an application does not delete a configuration from a host.

Class DeleteApplicationResponse

This is the response object from the DeleteApplication operation.

Class DeleteConfigurationProfileRequest

Container for the parameters to the DeleteConfigurationProfile operation. Delete a configuration profile. Deleting a configuration profile does not delete a configuration from a host.

Class DeleteConfigurationProfileResponse

This is the response object from the DeleteConfigurationProfile operation.

Class DeleteDeploymentStrategyRequest

Container for the parameters to the DeleteDeploymentStrategy operation. Delete a deployment strategy. Deleting a deployment strategy does not delete a configuration from a host.

Class DeleteDeploymentStrategyResponse

This is the response object from the DeleteDeploymentStrategy operation.

Class DeleteEnvironmentRequest

Container for the parameters to the DeleteEnvironment operation. Delete an environment. Deleting an environment does not delete a configuration from a host.

Class DeleteEnvironmentResponse

This is the response object from the DeleteEnvironment operation.

Class DeploymentEvent

An object that describes a deployment event.

Class DeploymentStrategy

Class DeploymentSummary

Information about the deployment.

Class Environment

Class GetApplicationRequest

Container for the parameters to the GetApplication operation. Retrieve information about an application.

Class GetApplicationResponse

This is the response object from the GetApplication operation.

Class GetConfigurationProfileRequest

Container for the parameters to the GetConfigurationProfile operation. Retrieve information about a configuration profile.

Class GetConfigurationProfileResponse

This is the response object from the GetConfigurationProfile operation.

Class GetConfigurationRequest

Container for the parameters to the GetConfiguration operation. Retrieve information about a configuration.

Class GetConfigurationResponse

This is the response object from the GetConfiguration operation.

Class GetDeploymentRequest

Container for the parameters to the GetDeployment operation. Retrieve information about a configuration deployment.

Class GetDeploymentResponse

This is the response object from the GetDeployment operation.

Class GetDeploymentStrategyRequest

Container for the parameters to the GetDeploymentStrategy operation. 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.

Class GetDeploymentStrategyResponse

This is the response object from the GetDeploymentStrategy operation.

Class GetEnvironmentRequest

Container for the parameters to the GetEnvironment operation. 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.

Class GetEnvironmentResponse

This is the response object from the GetEnvironment operation.

Class InternalServerException

AppConfig exception

Class ListApplicationsRequest

Container for the parameters to the ListApplications operation. List all applications in your AWS account.

Class ListApplicationsResponse

This is the response object from the ListApplications operation.

Class ListConfigurationProfilesRequest

Container for the parameters to the ListConfigurationProfiles operation. Lists the configuration profiles for an application.

Class ListConfigurationProfilesResponse

This is the response object from the ListConfigurationProfiles operation.

Class ListDeploymentsRequest

Container for the parameters to the ListDeployments operation. Lists the deployments for an environment.

Class ListDeploymentsResponse

This is the response object from the ListDeployments operation.

Class ListDeploymentStrategiesRequest

Container for the parameters to the ListDeploymentStrategies operation. List deployment strategies.

Class ListDeploymentStrategiesResponse

This is the response object from the ListDeploymentStrategies operation.

Class ListEnvironmentsRequest

Container for the parameters to the ListEnvironments operation. List the environments for an application.

Class ListEnvironmentsResponse

This is the response object from the ListEnvironments operation.

Class ListTagsForResourceRequest

Container for the parameters to the ListTagsForResource operation. Retrieves the list of key-value tags assigned to the resource.

Class ListTagsForResourceResponse

This is the response object from the ListTagsForResource operation.

Class Monitor

Amazon CloudWatch alarms to monitor during the deployment process.

Class ResourceNotFoundException

AppConfig exception

Class StartDeploymentRequest

Container for the parameters to the StartDeployment operation. Starts a deployment.

Class StartDeploymentResponse

This is the response object from the StartDeployment operation.

Class StopDeploymentRequest

Container for the parameters to the StopDeployment operation. 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.

Class StopDeploymentResponse

This is the response object from the StopDeployment operation.

Class TagResourceRequest

Container for the parameters to the TagResource operation. 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.

Class TagResourceResponse

This is the response object from the TagResource operation.

Class UntagResourceRequest

Container for the parameters to the UntagResource operation. Deletes a tag key and value from an AppConfig resource.

Class UntagResourceResponse

This is the response object from the UntagResource operation.

Class UpdateApplicationRequest

Container for the parameters to the UpdateApplication operation. Updates an application.

Class UpdateApplicationResponse

This is the response object from the UpdateApplication operation.

Class UpdateConfigurationProfileRequest

Container for the parameters to the UpdateConfigurationProfile operation. Updates a configuration profile.

Class UpdateConfigurationProfileResponse

This is the response object from the UpdateConfigurationProfile operation.

Class UpdateDeploymentStrategyRequest

Container for the parameters to the UpdateDeploymentStrategy operation. Updates a deployment strategy.

Class UpdateDeploymentStrategyResponse

This is the response object from the UpdateDeploymentStrategy operation.

Class UpdateEnvironmentRequest

Container for the parameters to the UpdateEnvironment operation. Updates an environment.

Class UpdateEnvironmentResponse

This is the response object from the UpdateEnvironment operation.

Class ValidateConfigurationRequest

Container for the parameters to the ValidateConfiguration operation. Uses the validators in a configuration profile to validate a configuration.

Class ValidateConfigurationResponse

This is the response object from the ValidateConfiguration operation.

Class Validator

A validator provides a syntactic or semantic check to ensure the configuration you want to deploy functions 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.