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 AmazonCodeDeployClient

Implementation for accessing CodeDeploy AWS CodeDeploy

AWS CodeDeploy is a deployment service that automates application deployments to Amazon EC2 instances, on-premises instances running in your own facility, or serverless AWS Lambda functions.

You can deploy a nearly unlimited variety of application content, such as an updated Lambda function, code, web and configuration files, executables, packages, scripts, multimedia files, and so on. AWS CodeDeploy can deploy application content stored in Amazon S3 buckets, GitHub repositories, or Bitbucket repositories. You do not need to make changes to your existing code before you can use AWS CodeDeploy.

AWS CodeDeploy makes it easier for you to rapidly release new features, helps you avoid downtime during application deployment, and handles the complexity of updating your applications, without many of the risks associated with error-prone manual deployments.

AWS CodeDeploy Components

Use the information in this guide to help you work with the following AWS CodeDeploy components:

  • Application: A name that uniquely identifies the application you want to deploy. AWS CodeDeploy uses this name, which functions as a container, to ensure the correct combination of revision, deployment configuration, and deployment group are referenced during a deployment.

  • Deployment group: A set of individual instances or CodeDeploy Lambda applications. A Lambda deployment group contains a group of applications. An EC2/On-premises deployment group contains individually tagged instances, Amazon EC2 instances in Auto Scaling groups, or both.

  • Deployment configuration: A set of deployment rules and deployment success and failure conditions used by AWS CodeDeploy during a deployment.

  • Deployment: The process and the components used in the process of updating a Lambda function or of installing content on one or more instances.

  • Application revisions: For an AWS Lambda deployment, this is an AppSpec file that specifies the Lambda function to update and one or more functions to validate deployment lifecycle events. For an EC2/On-premises deployment, this is an archive file containing source content—source code, web pages, executable files, and deployment scripts—along with an AppSpec file. Revisions are stored in Amazon S3 buckets or GitHub repositories. For Amazon S3, a revision is uniquely identified by its Amazon S3 object key and its ETag, version, or both. For GitHub, a revision is uniquely identified by its commit ID.

This guide also contains information to help you get details about the instances in your deployments, to make on-premises instances available for AWS CodeDeploy deployments, and to get details about a Lambda function deployment.

AWS CodeDeploy Information Resources

Class AmazonCodeDeployConfig

Configuration for accessing Amazon CodeDeploy service

Class AmazonCodeDeployException

Common exception for the CodeDeploy service.

Class AmazonCodeDeployRequest

Base class for CodeDeploy operation requests.

Class ApplicationRevisionSortBy

Constants used for properties of type ApplicationRevisionSortBy.

Class AutoRollbackEvent

Constants used for properties of type AutoRollbackEvent.

Class BundleType

Constants used for properties of type BundleType.

Class ComputePlatform

Constants used for properties of type ComputePlatform.

Class DeploymentCreator

Constants used for properties of type DeploymentCreator.

Class DeploymentOption

Constants used for properties of type DeploymentOption.

Class DeploymentReadyAction

Constants used for properties of type DeploymentReadyAction.

Class DeploymentStatus

Constants used for properties of type DeploymentStatus.

Class DeploymentType

Constants used for properties of type DeploymentType.

Class EC2TagFilterType

Constants used for properties of type EC2TagFilterType.

Class ErrorCode

Constants used for properties of type ErrorCode.

Class FileExistsBehavior

Constants used for properties of type FileExistsBehavior.

Class GreenFleetProvisioningAction

Constants used for properties of type GreenFleetProvisioningAction.

Class InstanceAction

Constants used for properties of type InstanceAction.

Class InstanceStatus

Constants used for properties of type InstanceStatus.

Class InstanceType

Constants used for properties of type InstanceType.

Class LifecycleErrorCode

Constants used for properties of type LifecycleErrorCode.

Class LifecycleEventStatus

Constants used for properties of type LifecycleEventStatus.

Class ListStateFilterAction

Constants used for properties of type ListStateFilterAction.

Class MinimumHealthyHostsType

Constants used for properties of type MinimumHealthyHostsType.

Class RegistrationStatus

Constants used for properties of type RegistrationStatus.

Class RevisionLocationType

Constants used for properties of type RevisionLocationType.

Class SortOrder

Constants used for properties of type SortOrder.

Class StopStatus

Constants used for properties of type StopStatus.

Class TagFilterType

Constants used for properties of type TagFilterType.

Class TrafficRoutingType

Constants used for properties of type TrafficRoutingType.

Class TriggerEventType

Constants used for properties of type TriggerEventType.

Interfaces

NameDescription
Interface IAmazonCodeDeploy

Interface for accessing CodeDeploy AWS CodeDeploy

AWS CodeDeploy is a deployment service that automates application deployments to Amazon EC2 instances, on-premises instances running in your own facility, or serverless AWS Lambda functions.

You can deploy a nearly unlimited variety of application content, such as an updated Lambda function, code, web and configuration files, executables, packages, scripts, multimedia files, and so on. AWS CodeDeploy can deploy application content stored in Amazon S3 buckets, GitHub repositories, or Bitbucket repositories. You do not need to make changes to your existing code before you can use AWS CodeDeploy.

AWS CodeDeploy makes it easier for you to rapidly release new features, helps you avoid downtime during application deployment, and handles the complexity of updating your applications, without many of the risks associated with error-prone manual deployments.

AWS CodeDeploy Components

Use the information in this guide to help you work with the following AWS CodeDeploy components:

  • Application: A name that uniquely identifies the application you want to deploy. AWS CodeDeploy uses this name, which functions as a container, to ensure the correct combination of revision, deployment configuration, and deployment group are referenced during a deployment.

  • Deployment group: A set of individual instances or CodeDeploy Lambda applications. A Lambda deployment group contains a group of applications. An EC2/On-premises deployment group contains individually tagged instances, Amazon EC2 instances in Auto Scaling groups, or both.

  • Deployment configuration: A set of deployment rules and deployment success and failure conditions used by AWS CodeDeploy during a deployment.

  • Deployment: The process and the components used in the process of updating a Lambda function or of installing content on one or more instances.

  • Application revisions: For an AWS Lambda deployment, this is an AppSpec file that specifies the Lambda function to update and one or more functions to validate deployment lifecycle events. For an EC2/On-premises deployment, this is an archive file containing source content—source code, web pages, executable files, and deployment scripts—along with an AppSpec file. Revisions are stored in Amazon S3 buckets or GitHub repositories. For Amazon S3, a revision is uniquely identified by its Amazon S3 object key and its ETag, version, or both. For GitHub, a revision is uniquely identified by its commit ID.

This guide also contains information to help you get details about the instances in your deployments, to make on-premises instances available for AWS CodeDeploy deployments, and to get details about a Lambda function deployment.

AWS CodeDeploy Information Resources