Action type Configuration parameters Input artifacts Output artifacts Action declaration See also

Amazon Elastic Container Service and CodeDeploy blue-green deploy action reference

You can configure a pipeline in AWS CodePipeline that deploys container applications using a blue/green deployment. In a blue/green deployment, you can launch a new version of your application alongside the old version, and you can test the new version before you reroute traffic to it. You can also monitor the deployment process and rapidly roll back if there is an issue.

The completed pipeline detects changes to your images or task definition file and and uses CodeDeploy to route and deploy traffic to an Amazon ECS cluster and load balancer. CodeDeploy creates a new listener on your load balancer which can target your new task through a special port. You can also configure the pipeline to use a source location, such as a CodeCommit repository, where your Amazon ECS task definition is stored.

Before you create your pipeline, you must have already created the Amazon ECS resources, the CodeDeploy resources, and the load balancer and target group. You must have already tagged and stored the image in your image repository, and uploaded the task definition and AppSpec file to your file repository.

Note

This topic describes the Amazon ECS to CodeDeploy blue/green deployment action for CodePipeline. For reference information about Amazon ECS standard deployment actions in CodePipeline, see Amazon Elastic Container Service deploy action reference.

Action type

Category: Deploy
Owner: AWS
Provider: CodeDeployToECS
Version: 1

Configuration parameters

ApplicationName

Required: Yes

The name of the application in CodeDeploy. Before you create your pipeline, you must have already created the application in CodeDeploy.

DeploymentGroupName

Required: Yes

The deployment group specified for Amazon ECS task sets that you created for your CodeDeploy application. Before you create your pipeline, you must have already created the deployment group in CodeDeploy.

TaskDefinitionTemplateArtifact

Required: Yes

The name of the input artifact that provides the task definition file to the deployment action. This is generally the name of the output artifact from the source action. When you use the console, the default name for the source action output artifact is SourceArtifact.

AppSpecTemplateArtifact

Required: Yes

The name of the input artifact that provides the AppSpec file to the deployment action. This value is updated when your pipeline runs. This is generally the name of the output artifact from the source action. When you use the console, the default name for the source action output artifact is SourceArtifact. For TaskDefinition in AppSpec file, you can keep the <TASK_DEFINITION> placeholder text as shown here.

AppSpecTemplatePath

Required: No

The file name of the AppSpec file stored in the pipeline source file location, such as your pipeline's CodeCommit repository. The default file name is appspec.yaml. If your AppSpec file has the same name and is stored at the root level in your file repository, you do not need to provide the file name. If the path is not the default, enter the path and file name.

TaskDefinitionTemplatePath

Required: No

The file name of the task definition stored in the pipeline file source location, such as your pipeline's CodeCommit repository. The default file name is taskdef.json. If your task definition file has the same name and is stored at the root level in your file repository, you do not need to provide the file name. If the path is not the default, enter the path and file name.

Image<Number>ArtifactName

Required: No

The name of the input artifact that provides the image to the deployment action. This is generally the image repository's output artifact, such as output from the Amazon ECR source action.

Available values for <Number> are 1 through 4.

Image<Number>ContainerName

Required: No

The name of the image available from the image repository, such as the Amazon ECR source repository.

Available values for <Number> are 1 through 4.

Input artifacts

Number of Artifacts: 1 to 5
Description: The CodeDeployToECS action first looks for the task definition file and the AppSpec file in the source file repository, next looks for the image in the image repository, then dynamically generates a new revision of task definition, and finallyruns the AppSpec commands to deploy the task set and container to the cluster.

The CodeDeployToECS action looks for an imageDetail.json file that maps the image URI to the image. When you commit a change to your Amazon ECR image repository, the pipeline ECR source action creates an imageDetail.json file for that commit. You can also manually add an imageDetail.json file for a pipeline where the action is not automated. For information about the imageDetail.json file, see imageDetail.json file for Amazon ECS blue/green deployment actions.

The CodeDeployToECS action dynamically generates a new revision of the task definition. In this phase, this action replaces placeholders in task definition file into image URI retrieved from imageDetail.json files. For example, if you set IMAGE1_NAME as Image1ContainerName parameter, you should specify the placeholder <IMAGE1_NAME> as the value of image field in your task definition file. In this case, the CodeDeployToECS action replaces the placeholder <IMAGE1_NAME> into actual image URI retrieved from imageDetail.json in the artifact which you specify as Image1ArtifactName.

For task definition updates, the CodeDeploy AppSpec.yaml file contains the TaskDefinition property.
```
TaskDefinition: <TASK_DEFINITION>
```
This property will be updated by the CodeDeployToECS action after the new task definition is created.

For the value of the TaskDefinition field, the placeholder text must be <TASK_DEFINITION>. The CodeDeployToECS action replaces this placeholder with the actual ARN of the dynamically generated task definition.

Output artifacts

Number of Artifacts: 0
Description: Output artifacts do not apply for this action type.