CodeDeploy is a deployment service that automates application deployments to Amazon EC2 instances, on-premises instances running in your own facility, serverless Lambda functions, or applications in an Amazon ECS service.
You can deploy a nearly unlimited variety of application content, such as an updated Lambda function, updated applications in an Amazon ECS service, code, web and configuration files, executables, packages, scripts, multimedia files, and so on. 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 CodeDeploy.
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.
CodeDeploy Components
Use the information in this guide to help you work with the following CodeDeploy components:
Application: A name that uniquely identifies the application you want to deploy. 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, CodeDeploy Lambda deployment configuration settings, or an Amazon ECS service and network details. A Lambda deployment group specifies how to route traffic to a new version of a Lambda function. An Amazon ECS deployment group specifies the service created in Amazon ECS to deploy, a load balancer, and a listener to reroute production traffic to an updated containerized application. An Amazon EC2/On-premises deployment group contains individually tagged instances, Amazon EC2 instances in Amazon EC2 Auto Scaling groups, or both. All deployment groups can specify optional trigger, alarm, and rollback settings.
Deployment configuration: A set of deployment rules and deployment success and failure conditions used by CodeDeploy during a deployment.
Deployment: The process and the components used when updating a Lambda function, a containerized application in an Amazon ECS service, or of installing content on one or more instances.
Application revisions: For an Lambda deployment, this is an AppSpec file that specifies the Lambda function to be updated and one or more functions to validate deployment lifecycle events. For an Amazon ECS deployment, this is an AppSpec file that specifies the Amazon ECS task definition, container, and port where production traffic is rerouted. For an EC2/On-premises deployment, this is an archive file that contains source content—source code, webpages, 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 CodeDeploy deployments, to get details about a Lambda function deployment, and to get details about Amazon ECS service deployments.
CodeDeploy Information Resources
' x-logo: url: https://twitter.com/awscloud/profile_image?size=original backgroundColor: '#FFFFFF' termsOfService: https://aws.amazon.com/service-terms/ contact: name: Mike Ralphson email: mike.ralphson@gmail.com url: https://github.com/mermade/aws2openapi x-twitter: PermittedSoc license: name: Apache 2.0 License url: http://www.apache.org/licenses/ x-providerName: amazonaws.com x-serviceName: codedeploy x-origin: - contentType: application/json url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/codedeploy-2014-10-06.normal.json converter: url: https://github.com/mermade/aws2openapi version: 1.0.0 x-apisguru-driver: external x-apiClientRegistration: url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct x-apisguru-categories: - cloud x-preferred: true servers: - url: http://codedeploy.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The CodeDeploy multi-region endpoint - url: https://codedeploy.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The CodeDeploy multi-region endpoint - url: http://codedeploy.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The CodeDeploy endpoint for China (Beijing) and China (Ningxia) - url: https://codedeploy.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The CodeDeploy endpoint for China (Beijing) and China (Ningxia) security: - hmac: [] tags: - name: '#X Amz Target=CodeDeploy 20141006.SkipWaitTimeForInstanceTermination' paths: /#X-Amz-Target=CodeDeploy_20141006.SkipWaitTimeForInstanceTermination: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: deprecated: true operationId: SkipWaitTimeForInstanceTermination description: In a blue/green deployment, overrides any specified wait time and starts terminating instances immediately after the traffic routing is complete. responses: '200': description: Success '480': description: DeploymentIdRequiredException content: application/json: schema: $ref: '#/components/schemas/DeploymentIdRequiredException' examples: SkipWaitTimeForInstanceTermination480Example: summary: Default SkipWaitTimeForInstanceTermination 480 response x-microcks-default: true value: example-value '481': description: DeploymentDoesNotExistException content: application/json: schema: $ref: '#/components/schemas/DeploymentDoesNotExistException' examples: SkipWaitTimeForInstanceTermination481Example: summary: Default SkipWaitTimeForInstanceTermination 481 response x-microcks-default: true value: example-value '482': description: DeploymentAlreadyCompletedException content: application/json: schema: $ref: '#/components/schemas/DeploymentAlreadyCompletedException' examples: SkipWaitTimeForInstanceTermination482Example: summary: Default SkipWaitTimeForInstanceTermination 482 response x-microcks-default: true value: example-value '483': description: InvalidDeploymentIdException content: application/json: schema: $ref: '#/components/schemas/InvalidDeploymentIdException' examples: SkipWaitTimeForInstanceTermination483Example: summary: Default SkipWaitTimeForInstanceTermination 483 response x-microcks-default: true value: example-value '484': description: DeploymentNotStartedException content: application/json: schema: $ref: '#/components/schemas/DeploymentNotStartedException' examples: SkipWaitTimeForInstanceTermination484Example: summary: Default SkipWaitTimeForInstanceTermination 484 response x-microcks-default: true value: example-value '485': description: UnsupportedActionForDeploymentTypeException content: application/json: schema: $ref: '#/components/schemas/UnsupportedActionForDeploymentTypeException' examples: SkipWaitTimeForInstanceTermination485Example: summary: Default SkipWaitTimeForInstanceTermination 485 response x-microcks-default: true value: example-value requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SkipWaitTimeForInstanceTerminationInput' examples: SkipWaitTimeForInstanceTerminationRequestExample: summary: Default SkipWaitTimeForInstanceTermination request x-microcks-default: true value: deploymentId: '500123' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - CodeDeploy_20141006.SkipWaitTimeForInstanceTermination summary: Amazon CodeDeploy Skip Wait Time for Instance Termination x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - '#X Amz Target=CodeDeploy 20141006.SkipWaitTimeForInstanceTermination' components: schemas: DeploymentNotStartedException: {} DeploymentAlreadyCompletedException: {} DeploymentId: type: string DeploymentDoesNotExistException: {} SkipWaitTimeForInstanceTerminationInput: type: object title: SkipWaitTimeForInstanceTerminationInput properties: deploymentId: allOf: - $ref: '#/components/schemas/DeploymentId' - description: ' The unique ID of a blue/green deployment for which you want to skip the instance termination wait time. ' DeploymentIdRequiredException: {} UnsupportedActionForDeploymentTypeException: {} InvalidDeploymentIdException: {} parameters: X-Amz-Algorithm: name: X-Amz-Algorithm in: header schema: type: string required: false X-Amz-Credential: name: X-Amz-Credential in: header schema: type: string required: false X-Amz-Signature: name: X-Amz-Signature in: header schema: type: string required: false X-Amz-Content-Sha256: name: X-Amz-Content-Sha256 in: header schema: type: string required: false X-Amz-Security-Token: name: X-Amz-Security-Token in: header schema: type: string required: false X-Amz-SignedHeaders: name: X-Amz-SignedHeaders in: header schema: type: string required: false X-Amz-Date: name: X-Amz-Date in: header schema: type: string required: false securitySchemes: hmac: type: apiKey name: Authorization in: header description: Amazon Signature authorization v4 x-amazon-apigateway-authtype: awsSigv4 externalDocs: description: Amazon Web Services documentation url: https://docs.aws.amazon.com/codedeploy/ x-hasEquivalentPaths: true