Menu
AWS CodeDeploy
User Guide (API Version 2014-10-06)

Step 3: Create a Service Role for AWS CodeDeploy

In AWS, service roles are used to grant permissions to an AWS service so it can access AWS resources. The policies that you attach to the service role determine which AWS resources the service can access and what it can do with those resources.

The service role you create for AWS CodeDeploy must be granted the permissions to access the instances to which you will deploy applications. These permissions enable AWS CodeDeploy to read the tags applied to the instances or the Auto Scaling group names associated with the instances.

The permissions you add to the service role specify the operations AWS CodeDeploy can perform when it accesses your Amazon EC2 instances and Auto Scaling groups. To add these permissions, attach an AWS-supplied policy, AWSCodeDeployRole, to the service role.

As part of setting up the service role, you also update its trust relationship to specify the endpoints to which you want to grant it access.

You can create a service role with the IAM console, the AWS CLI, or the IAM APIs.

Create a Service Role (Console)

  1. Sign in to the AWS Management Console and open the IAM console at https://console.aws.amazon.com/iam/.

  2. In the navigation pane, choose Roles, and then choose Create role.

  3. On the Select role type page, choose AWS service, and from the Choose the service that will use this role list, choose CodeDeploy.

  4. Choose Next: Permissions.

  5. On the Attached permissions policy page, if there is a box next to AWSCodeDeployRole , select it, and then choose Next: Review.

    The AWSCodeDeployRole policy provides the permissions required for your service role to:

    • Read the tags on your instances or identify your Amazon EC2 instances by Auto Scaling group names.

    • Publish information to Amazon SNS topics.

    • Retrieve information about CloudWatch alarms.

  6. On the Review page, in Role name, type a name for the service role (for example CodeDeployServiceRole), and then choose Create role.

    You can also type a description for this service role in the Role description box.

  7. If you want this service role to have permission to access all currently supported endpoints, you are finished with this procedure.

    If you want to restrict this service role from access to some endpoints, in the list of roles, browse to and choose the role you just created, and continue with the next step.

  8. On the Trust relationships tab, choose Edit trust relationship.

  9. You should see the following policy, which provides the service role permission to access all supported endpoints:

    Copy
    { "Version": "2012-10-17", "Statement": [ { "Sid": "", "Effect": "Allow", "Principal": { "Service": [ "codedeploy.amazonaws.com" ] }, "Action": "sts:AssumeRole" } ] }

    To grant the service role access to only some supported endpoints, replace the contents of the Policy Document box with the following policy, remove the lines for the endpoints you want to prevent access to, and then choose Update Trust Policy.

    Copy
    { "Version": "2012-10-17", "Statement": [ { "Sid": "", "Effect": "Allow", "Principal": { "Service": [ "codedeploy.us-east-2.amazonaws.com", "codedeploy.us-east-1.amazonaws.com", "codedeploy.us-west-1.amazonaws.com", "codedeploy.us-west-2.amazonaws.com", "codedeploy.ca-central-1.amazonaws.com", "codedeploy.eu-west-1.amazonaws.com", "codedeploy.eu-west-2.amazonaws.com", "codedeploy.eu-central-1.amazonaws.com", "codedeploy.ap-northeast-1.amazonaws.com", "codedeploy.ap-northeast-2.amazonaws.com", "codedeploy.ap-southeast-1.amazonaws.com", "codedeploy.ap-southeast-2.amazonaws.com", "codedeploy.ap-south-1.amazonaws.com", "codedeploy.sa-east-1.amazonaws.com" ] }, "Action": "sts:AssumeRole" } ] }

For more information about creating service roles, see Creating a Role to Delegate Permissions to an AWS Service in the IAM User Guide.

Create a Service Role (CLI)

  1. On your development machine, create a text file named, for example, CodeDeployDemo-Trust.json. This file will be used to allow AWS CodeDeploy to work on your behalf.

    Do one of the following:

    • To grant access to all supported regions, save the following content in the file:

      Copy
      { "Version": "2012-10-17", "Statement": [ { "Sid": "", "Effect": "Allow", "Principal": { "Service": [ "codedeploy.amazonaws.com" ] }, "Action": "sts:AssumeRole" } ] }
    • To grant access to only some supported regions, type the following content into the file, and remove the lines for the regions to which you want to exclude access:

      Copy
      { "Version": "2012-10-17", "Statement": [ { "Sid": "", "Effect": "Allow", "Principal": { "Service": [ "codedeploy.us-east-2.amazonaws.com", "codedeploy.us-east-1.amazonaws.com", "codedeploy.us-west-1.amazonaws.com", "codedeploy.us-west-2.amazonaws.com", "codedeploy.ca-central-1.amazonaws.com", "codedeploy.eu-west-1.amazonaws.com", "codedeploy.eu-west-2.amazonaws.com", "codedeploy.eu-central-1.amazonaws.com", "codedeploy.ap-northeast-1.amazonaws.com", "codedeploy.ap-northeast-2.amazonaws.com", "codedeploy.ap-southeast-1.amazonaws.com", "codedeploy.ap-southeast-2.amazonaws.com", "codedeploy.ap-south-1.amazonaws.com", "codedeploy.sa-east-1.amazonaws.com" ] }, "Action": "sts:AssumeRole" } ] }

      Note

      Do not use a comma after the last endpoint in the list.

  2. From the same directory, call the create-role command to create a service role named CodeDeployServiceRole based on the information in the text file you just created:

    Important

    Be sure to include file:// before the file name. It is required in this command.

    Copy
    aws iam create-role --role-name CodeDeployServiceRole --assume-role-policy-document file://CodeDeployDemo-Trust.json

    In the command's output, note the value of the Arn entry under the Role object. You will need it later when you create deployment groups. If you forget the value, follow the instructions in Get the Service Role ARN (CLI) .

  3. Call the attach-role-policy command to give the service role named CodeDeployServiceRole the permissions based on the IAM managed policy named AWSCodeDeployRole. For example:

    Copy
    aws iam attach-role-policy --role-name CodeDeployServiceRole --policy-arn arn:aws:iam::aws:policy/service-role/AWSCodeDeployRole

For more information about creating service roles, see Creating a Role for an AWS Service in the IAM User Guide.

Get the Service Role ARN (Console)

To use the IAM console to get the ARN of the service role:

  1. Sign in to the AWS Management Console and open the IAM console at https://console.aws.amazon.com/iam/.

  2. In the navigation pane, choose Roles.

  3. In the Filter box, type CodeDeployServiceRole, and then press Enter.

  4. Choose CodeDeployServiceRole.

  5. Note the value of the Role ARN field.

Get the Service Role ARN (CLI)

To use the AWS CLI to get the ARN of the service role, call the get-role command against the service role named CodeDeployServiceRole:

Copy
aws iam get-role --role-name CodeDeployServiceRole --query "Role.Arn" --output text

The value returned is the ARN of the service role.