Menu
AWS CodeBuild
User Guide (API Version 2016-10-06)

Overview of Managing Access Permissions to Your AWS CodeBuild Resources

Every AWS resource is owned by an AWS account, and permissions to create or access a resource are governed by permissions policies. An account administrator can attach permissions policies to IAM identities (that is, users, groups, and roles).

Note

An account administrator (or administrator user) is a user with administrator privileges. For more information, see IAM Best Practices in the IAM User Guide Guide.

When you grant permissions, you decide who is getting the permissions, the resources they can access, and the actions that can be performed on those resources.

AWS CodeBuild Resources and Operations

In AWS CodeBuild, the primary resource is a build project. In a policy, you use an Amazon Resource Name (ARN) to identify the resource the policy applies to. Builds are also resources and have ARNs associated with them. For more information, see Amazon Resource Names (ARN) and AWS Service Namespaces in the Amazon Web Services General Reference.

Resource type ARN format
Build project

arn:aws:codebuild:region-ID:account-ID:project/project-name

Build

arn:aws:codebuild:region-ID:account-ID:build/build-ID

All AWS CodeBuild resources

arn:aws:codebuild:*

All AWS CodeBuild resources owned by the specified account in the specified region

arn:aws:codebuild:region-ID:account-ID:*

Note

Most AWS services treat a colon (:) or a forward slash (/) as the same character in ARNs. However, AWS CodeBuild uses an exact match in resource patterns and rules. Be sure to use the correct characters when you create event patterns so that they match the ARN syntax in the resource.

For example, you can indicate a specific build project (myBuildProject) in your statement using its ARN as follows:

Copy
"Resource": "arn:aws:codebuild:us-east-2:123456789012:project/myBuildProject"

To specify all resources, or if an API action does not support ARNs, use the wildcard character (*) in the Resource element as follows:

Copy
"Resource": "*"

Some AWS CodeBuild API actions accept multiple resources (for example, BatchGetProjects). To specify multiple resources in a single statement, separate their ARNs with commas, as follows:

Copy
"Resource": [ "arn:aws:codebuild:us-east-2:123456789012:project/myBuildProject", "arn:aws:codebuild:us-east-2:123456789012:project/myOtherBuildProject" ]

AWS CodeBuild provides a set of operations to work with the AWS CodeBuild resources. For a list, see AWS CodeBuild Permissions Reference.

Understanding Resource Ownership

The AWS account owns the resources that are created in the account, regardless of who created the resources. Specifically, the resource owner is the AWS account of the principal entity (that is, the root account, an IAM user, or an IAM role) that authenticates the resource creation request. The following examples illustrate how this works:

  • If you use the root account credentials of your AWS account to create a rule, your AWS account is the owner of the AWS CodeBuild resource.

  • If you create an IAM user in your AWS account and grant permissions to create AWS CodeBuild resources to that user, the user can create AWS CodeBuild resources. However, your AWS account, to which the user belongs, owns the AWS CodeBuild resources.

  • If you create an IAM role in your AWS account with permissions to create AWS CodeBuild resources, anyone who can assume the role can create AWS CodeBuild resources. Your AWS account, to which the role belongs, owns the AWS CodeBuild resources.

Managing Access to Resources

A permissions policy describes who has access to which resources.

Note

This section discusses the use of IAM in AWS CodeBuild. It doesn't provide detailed information about the IAM service. For complete IAM documentation, see What Is IAM? in the IAM User Guide Guide. For information about IAM policy syntax and descriptions, see AWS IAM Policy Reference in the IAM User Guide Guide.

Policies attached to an IAM identity are referred to as identity-based policies (IAM polices). Policies attached to a resource are referred to as resource-based policies. AWS CodeBuild supports identity-based (IAM policies) only.

Identity-Based Policies (IAM Policies)

You can attach policies to IAM identities.

  • Attach a permissions policy to a user or a group in your account – To grant a user permissions to view build projects and other AWS CodeBuild resources in the AWS CodeBuild console, you can attach a permissions policy to a user or group that the user belongs to.

  • Attach a permissions policy to a role (grant cross-account permissions) – You can attach an identity-based permissions policy to an IAM role to grant cross-account permissions. For example, the administrator in Account A can create a role to grant cross-account permissions to another AWS account (for example, Account B) or an AWS service as follows:

    1. Account A administrator creates an IAM role and attaches a permissions policy to the role that grants permissions on resources in Account A.

    2. Account A administrator attaches a trust policy to the role identifying Account B as the principal who can assume the role.

    3. Account B administrator can then delegate permissions to assume the role to any users in Account B. Doing this allows users in Account B to create or access resources in Account A. The principal in the trust policy must also be an AWS service principal if you want to grant an AWS service permissions to assume the role.

    For more information about using IAM to delegate permissions, see Access Management in the IAM User Guide Guide.

In AWS CodeBuild, identity-based policies are used to manage permissions to the resources related to the deployment process. For example, you can control access to build projects.

You can create IAM policies to restrict the calls and resources that users in your account have access to, and then attach those policies to IAM users. For more information about how to create IAM roles and to explore example IAM policy statements for AWS CodeBuild, see Overview of Managing Access Permissions to Your AWS CodeBuild Resources.

Specifying Policy Elements: Actions, Effects, and Principals

For each AWS CodeBuild resource, the service defines a set of API operations. To grant permissions for these API operations, AWS CodeBuild defines a set of actions that you can specify in a policy. Some API operations can require permissions for more than one action in order to perform the API operation. For more information, see AWS CodeBuild Resources and Operations and AWS CodeBuild Permissions Reference.

The following are the basic policy elements:

  • Resource – You use an Amazon Resource Name (ARN) to identify the resource that the policy applies to.

  • Action – You use action keywords to identify resource operations you want to allow or deny. For example, the codebuild:CreateProject permission gives the user permissions to perform the CreateProject operation.

  • Effect – You specify the effect, either allow or deny, when the user requests the action. If you don't explicitly grant access to (allow) a resource, access is implicitly denied. You can also explicitly deny access to a resource. You might do this to make sure a user cannot access a resource, even if a different policy grants access.

  • Principal – In identity-based policies (IAM policies), the user the policy is attached to is the implicit principal. For resource-based policies, you specify the user, account, service, or other entity that you want to receive permissions.

To learn more about IAM policy syntax and descriptions, see AWS IAM Policy Reference in the IAM User Guide Guide.

For a table showing all of the AWS CodeBuild API actions and the resources they apply to, see the AWS CodeBuild Permissions Reference.