Deployment prerequisites - AWS CodeDeploy
Deployment prerequisites on an AWS Lambda compute platformDeployment prerequisites on an EC2/on-premises compute platformDeployment prerequisites for a blue/green deployment through AWS CloudFormation

Deployment prerequisites

Make sure the following steps are complete before you start a deployment.

Deployment prerequisites on an AWS Lambda compute platform

Deployment prerequisites on an EC2/on-premises compute platform

  • For an in-place deployment, create or configure the instances you want to deploy to. For information, see Working with instances for CodeDeploy. For a blue/green deployment, you either have an existing Amazon EC2 Auto Scaling group to use as a template for your replacement environment, or you have one or more instances or Amazon EC2 Auto Scaling groups that you specify as your original environment. For more information, see Tutorial: Use CodeDeploy to deploy an application to an Auto Scaling group and Integrating CodeDeploy with Amazon EC2 Auto Scaling.

  • Create an application that includes at least one deployment group. For information, see Create an application with CodeDeploy and Create a deployment group with CodeDeploy.

  • Prepare the application revision that you want to deploy to the instances in your deployment group. For information, see Working with application revisions for CodeDeploy.

  • If you want to use a custom deployment configuration for your deployment, create it before you start the deployment process. For information, see Create a Deployment Configuration.

  • If you are deploying your application revision from an Amazon S3 bucket, the bucket is in the same AWS Region as the instances in your deployment group.

  • If you are deploying your application revision from an Amazon S3 bucket, an Amazon S3 bucket policy has been applied to the bucket. This policy grants your instances the permissions required to download the application revision.

    For example, the following Amazon S3 bucket policy allows any Amazon EC2 instance with an attached IAM instance profile containing the ARN arn:aws:iam::444455556666:role/CodeDeployDemo to download from anywhere in the Amazon S3 bucket named codedeploydemobucket:

    {
    "Statement": [
        {
            "Action": [
                "s3:Get*",
                "s3:List*"
            ],
            "Effect": "Allow",
            "Resource": "arn:aws:s3:::codedeploydemobucket/*",
            "Principal": {
                "AWS": [
                    "arn:aws:iam::444455556666:role/CodeDeployDemo"
                ]
            }
        }
    ]
}

    The following Amazon S3 bucket policy allows any on-premises instance with an associated IAM user containing the ARN arn:aws:iam::444455556666:user/CodeDeployUser to download from anywhere in the Amazon S3 bucket named codedeploydemobucket:

    {
    "Statement": [
        {
            "Action": [
                "s3:Get*",
                "s3:List*"
            ],
            "Effect": "Allow",
            "Resource": "arn:aws:s3:::codedeploydemobucket/*",
            "Principal": {
                "AWS": [
                    "arn:aws:iam::444455556666:user/CodeDeployUser"
                ]
            }
        }
    ]
}

    For information about how to generate and attach an Amazon S3 bucket policy, see Bucket policy examples.

  • If you are creating a blue/green deployment, or you have specified an optional Classic Load Balancer, Application Load Balancer, or Network Load Balancer in the deployment group for an in-place deployment, you have created a VPC using Amazon VPC that contains at least two subnets. (CodeDeploy uses Elastic Load Balancing, which requires all instances in a load balancer group to be in a single VPC.)

    If you have not created a VPC yet, see the Amazon VPC Getting Started Guide.

  • If you are creating a blue/green deployment, you have configured a Classic Load Balancer, Application Load Balancer, or Network Load Balancer in Elastic Load Balancing and used it to register the instances that make up your original environment.

    Note

    The instances in your replacement environment will be registered with the load balancer later.

    To configure a Classic Load Balancer, complete the steps in Tutorial: Create a Classic Load Balancer in User Guide for Classic Load Balancers. As you do, make note of the following:

    • In Step 2: Define Load Balancer, in Create LB Inside, choose the same VPC you selected when you created your instances.

    • In Step 5: Register EC2 Instances with Your Load Balancer, select the instances in your original environment.

    • In Step 7: Create and Verify Your Load Balancer, make a note of the DNS address of your load balancer.

      For example, if you named your load balancer my-load-balancer, your DNS address appears in a format such as my-load-balancer-1234567890.us-east-2.elb.amazonaws.com.

      When you paste the DNS name into the address field of a web browser, you should see the application you have deployed for your original environment.

    To configure an Application Load Balancer, follow the instructions in one of the following topics:

    To configure a Network Load Balancer, follow the instructions in one of the following topics:

Deployment prerequisites for a blue/green deployment through AWS CloudFormation

  • Your template does not need to model resources for a CodeDeploy application or deployment group.

  • Your template must include resources for a VPC using Amazon VPC that contains at least two subnets.

  • Your template must include resources for a Classic Load Balancer, Application Load Balancer, or Network Load Balancer in Elastic Load Balancing that is used to direct traffic to your target groups.