CDK Constructs for AWS CodeBuild
Project description
AWS CodeBuild Construct Library
---AWS CodeBuild is a fully managed continuous integration service that compiles source code, runs tests, and produces software packages that are ready to deploy. With CodeBuild, you don’t need to provision, manage, and scale your own build servers. CodeBuild scales continuously and processes multiple builds concurrently, so your builds are not left waiting in a queue. You can get started quickly by using prepackaged build environments, or you can create custom build environments that use your own build tools. With CodeBuild, you are charged by the minute for the compute resources you use.
Installation
Install the module:
$ npm i @aws-cdk/aws-codebuild
Import it into your code:
# Example automatically generated. See https://github.com/aws/jsii/issues/826
import aws_cdk.aws_codebuild as codebuild
The codebuild.Project
construct represents a build project resource. See the
reference documentation for a comprehensive list of initialization properties,
methods and attributes.
Source
Build projects are usually associated with a source, which is specified via
the source
property which accepts a class that extends the Source
abstract base class.
The default is to have no source associated with the build project;
the buildSpec
option is required in that case.
Here's a CodeBuild project with no source which simply prints Hello, CodeBuild!
:
# Example automatically generated. See https://github.com/aws/jsii/issues/826
codebuild.Project(self, "MyProject",
build_spec=codebuild.BuildSpec.from_object({
"version": "0.2",
"phases": {
"build": {
"commands": ["echo \"Hello, CodeBuild!\""
]
}
}
})
)
CodeCommitSource
Use an AWS CodeCommit repository as the source of this build:
# Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
import aws_cdk.aws_codebuild as codebuild
import aws_cdk.aws_codecommit as codecommit
repository = codecommit.Repository(self, "MyRepo", repository_name="foo")
codebuild.Project(self, "MyFirstCodeCommitProject",
source=codebuild.Source.code_commit(repository=repository)
)
S3Source
Create a CodeBuild project with an S3 bucket as the source:
# Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
import aws_cdk.aws_codebuild as codebuild
import aws_cdk.aws_s3 as s3
bucket = s3.Bucket(self, "MyBucket")
codebuild.Project(self, "MyProject",
source=codebuild.Source.s3(
bucket=bucket,
path="path/to/file.zip"
)
)
GitHubSource
and GitHubEnterpriseSource
These source types can be used to build code from a GitHub repository. Example:
# Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
git_hub_source = codebuild.Source.git_hub(
owner="awslabs",
repo="aws-cdk",
webhook=True, # optional, default: true if `webhookFilters` were provided, false otherwise
webhook_filters=[
codebuild.FilterGroup.in_event_of(codebuild.EventAction.PUSH).and_branch_is("master")
]
)
To provide GitHub credentials, please either go to AWS CodeBuild Console to connect
or call ImportSourceCredentials
to persist your personal access token.
Example:
aws codebuild import-source-credentials --server-type GITHUB --auth-type PERSONAL_ACCESS_TOKEN --token <token_value>
BitBucketSource
This source type can be used to build code from a BitBucket repository.
# Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
bb_source = codebuild.Source.bit_bucket(
owner="owner",
repo="repo"
)
For all Git sources
For all Git sources, you can fetch submodules while cloing git repo.
# Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
git_hub_source = codebuild.Source.git_hub(
owner="awslabs",
repo="aws-cdk",
fetch_submodules=True
)
Artifacts
CodeBuild Projects can produce Artifacts and upload them to S3. For example:
# Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
project = codebuild.Project(stack, "MyProject",
build_spec=codebuild.BuildSpec.from_object(
version="0.2"
),
artifacts=codebuild.Artifacts.s3(
bucket=bucket,
include_build_id=False,
package_zip=True,
path="another/path",
identifier="AddArtifact1"
)
)
Because we've not set the name
property, this example will set the
overrideArtifactName
parameter, and produce an artifact named as defined in
the Buildspec file, uploaded to an S3 bucket (bucket
). The path will be
another/path
and the artifact will be a zipfile.
CodePipeline
To add a CodeBuild Project as an Action to CodePipeline,
use the PipelineProject
class instead of Project
.
It's a simple class that doesn't allow you to specify sources
,
secondarySources
, artifacts
or secondaryArtifacts
,
as these are handled by setting input and output CodePipeline Artifact
instances on the Action,
instead of setting them on the Project.
# Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
project = codebuild.PipelineProject(self, "Project")
For more details, see the readme of the @aws-cdk/@aws-codepipeline-actions
package.
Caching
You can save time when your project builds by using a cache. A cache can store reusable pieces of your build environment and use them across multiple builds. Your build project can use one of two types of caching: Amazon S3 or local. In general, S3 caching is a good option for small and intermediate build artifacts that are more expensive to build than to download. Local caching is a good option for large intermediate build artifacts because the cache is immediately available on the build host.
S3 Caching
With S3 caching, the cache is stored in an S3 bucket which is available from multiple hosts.
# Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
codebuild.Project(self, "Project",
source=codebuild.Source.bit_bucket(
owner="awslabs",
repo="aws-cdk"
),
cache=codebuild.Cache.bucket(Bucket(self, "Bucket"))
)
Local Caching
With local caching, the cache is stored on the codebuild instance itself. This is simple, cheap and fast, but CodeBuild cannot guarantee a reuse of instance and hence cannot guarantee cache hits. For example, when a build starts and caches files locally, if two subsequent builds start at the same time afterwards only one of those builds would get the cache. Three different cache modes are supported, which can be turned on individually.
LocalCacheMode.SOURCE
caches Git metadata for primary and secondary sources.LocalCacheMode.DOCKER_LAYER
caches existing Docker layers.LocalCacheMode.CUSTOM
caches directories you specify in the buildspec file.
# Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
codebuild.Project(self, "Project",
source=codebuild.Source.git_hub_enterprise(
https_clone_url="https://my-github-enterprise.com/owner/repo"
),
# Enable Docker AND custom caching
cache=codebuild.Cache.local(LocalCacheMode.DOCKER_LAYER, LocalCacheMode.CUSTOM)
)
Environment
By default, projects use a small instance with an Ubuntu 18.04 image. You
can use the environment
property to customize the build environment:
buildImage
defines the Docker image used. See Images below for details on how to define build images.computeType
defines the instance type used for the build.privileged
can be set totrue
to allow privileged access.environmentVariables
can be set at this level (and also at the project level).
Images
The CodeBuild library supports both Linux and Windows images via the
LinuxBuildImage
and WindowsBuildImage
classes, respectively.
You can specify one of the predefined Windows/Linux images by using one
of the constants such as WindowsBuildImage.WIN_SERVER_CORE_2019_BASE
,
WindowsBuildImage.WINDOWS_BASE_2_0
or LinuxBuildImage.STANDARD_2_0
.
Alternatively, you can specify a custom image using one of the static methods on
LinuxBuildImage
:
LinuxBuildImage.fromDockerRegistry(image[, { secretsManagerCredentials }])
to reference an image in any public or private Docker registry.LinuxBuildImage.fromEcrRepository(repo[, tag])
to reference an image available in an ECR repository.LinuxBuildImage.fromAsset(parent, id, props)
to use an image created from a local asset.LinuxBuildImage.fromCodeBuildImageId(id)
to reference a pre-defined, CodeBuild-provided Docker image.
or one of the corresponding methods on WindowsBuildImage
:
WindowsBuildImage.fromDockerRegistry(image[, { secretsManagerCredentials }, imageType])
WindowsBuildImage.fromEcrRepository(repo[, tag, imageType])
WindowsBuildImage.fromAsset(parent, id, props, [, imageType])
Note that the WindowsBuildImage
version of the static methods accepts an optional parameter of type WindowsImageType
,
which can be either WindowsImageType.STANDARD
, the default, or WindowsImageType.SERVER_2019
:
# Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
codebuild.Project(self, "Project",
environment={
"build_image": codebuild.WindowsBuildImage.from_ecr_repository(ecr_repository, "v1.0", codebuild.WindowsImageType.SERVER_2019)
}, ...
)
The following example shows how to define an image from a Docker asset:
# Example automatically generated. See https://github.com/aws/jsii/issues/826
environment=BuildEnvironment(
build_image=codebuild.LinuxBuildImage.from_asset(self, "MyImage",
directory=path.join(__dirname, "demo-image")
)
)
The following example shows how to define an image from an ECR repository:
# Example automatically generated. See https://github.com/aws/jsii/issues/826
environment=BuildEnvironment(
build_image=codebuild.LinuxBuildImage.from_ecr_repository(ecr_repository, "v1.0")
)
The following example shows how to define an image from a private docker registry:
# Example automatically generated. See https://github.com/aws/jsii/issues/826
environment=BuildEnvironment(
build_image=codebuild.LinuxBuildImage.from_docker_registry("my-registry/my-repo",
secrets_manager_credentials=secrets
)
)
GPU images
The class LinuxGpuBuildImage
contains constants for working with
AWS Deep Learning Container images:
# Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
codebuild.Project(self, "Project",
environment={
"build_image": codebuild.LinuxGpuBuildImage.DLC_TENSORFLOW_2_1_0_INFERENCE
}, ...
)
One complication is that the repositories for the DLC images are in
different accounts in different AWS regions.
In most cases, the CDK will handle providing the correct account for you;
in rare cases (for example, deploying to new regions)
where our information might be out of date,
you can always specify the account
(along with the repository name and tag)
explicitly using the awsDeepLearningContainersImage
method:
# Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
codebuild.Project(self, "Project",
environment={
"build_image": codebuild.LinuxGpuBuildImage.aws_deep_learning_containers_image("tensorflow-inference", "2.1.0-gpu-py36-cu101-ubuntu18.04", "123456789012")
}, ...
)
Credentials
CodeBuild allows you to store credentials used when communicating with various sources, like GitHub:
# Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
codebuild.GitHubSourceCredentials(self, "CodeBuildGitHubCreds",
access_token=cdk.SecretValue.secrets_manager("my-token")
)
and BitBucket:
# Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
codebuild.BitBucketSourceCredentials(self, "CodeBuildBitBucketCreds",
username=cdk.SecretValue.secrets_manager("my-bitbucket-creds", json_field="username"),
password=cdk.SecretValue.secrets_manager("my-bitbucket-creds", json_field="password")
)
Note: the credentials are global to a given account in a given region -
they are not defined per CodeBuild project.
CodeBuild only allows storing a single credential of a given type
(GitHub, GitHub Enterprise or BitBucket)
in a given account in a given region -
any attempt to save more than one will result in an error.
You can use the list-source-credentials
AWS CLI operation
to inspect what credentials are stored in your account.
Test reports
You can specify a test report in your buildspec:
# Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
project = codebuild.Project(self, "Project",
build_spec=codebuild.BuildSpec.from_object(
# ...
reports={
"my_report": {
"files": "**/*",
"base-directory": "build/test-results"
}
}
)
)
This will create a new test report group,
with the name <ProjectName>-myReport
.
The project's role in the CDK will always be granted permissions to create and use report groups with names starting with the project's name; if you'd rather not have those permissions added, you can opt out of it when creating the project:
# Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
project = codebuild.Project(self, "Project",
# ...
grant_report_group_permissions=False
)
Alternatively, you can specify an ARN of an existing resource group, instead of a simple name, in your buildspec:
# Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
# create a new ReportGroup
report_group = codebuild.ReportGroup(self, "ReportGroup")
project = codebuild.Project(self, "Project",
build_spec=codebuild.BuildSpec.from_object(
# ...
reports={
"[reportGroup.reportGroupArn]": {
"files": "**/*",
"base-directory": "build/test-results"
}
}
)
)
If you do that, you need to grant the project's role permissions to write reports to that report group:
# Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
report_group.grant_write(project)
For more information on the test reports feature, see the AWS CodeBuild documentation.
Events
CodeBuild projects can be used either as a source for events or be triggered by events via an event rule.
Using Project as an event target
The @aws-cdk/aws-events-targets.CodeBuildProject
allows using an AWS CodeBuild
project as a AWS CloudWatch event rule target:
# Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
# start build when a commit is pushed
import aws_cdk.aws_events_targets as targets
code_commit_repository.on_commit("OnCommit",
target=targets.CodeBuildProject(project)
)
Using Project as an event source
To define Amazon CloudWatch event rules for build projects, use one of the onXxx
methods:
# Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
rule = project.on_state_change("BuildStateChange",
target=targets.LambdaFunction(fn)
)
Secondary sources and artifacts
CodeBuild Projects can get their sources from multiple places, and produce multiple outputs. For example:
# Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
project = codebuild.Project(self, "MyProject",
secondary_sources=[
codebuild.Source.code_commit(
identifier="source2",
repository=repo
)
],
secondary_artifacts=[
codebuild.Artifacts.s3(
identifier="artifact2",
bucket=bucket,
path="some/path",
name="file.zip"
)
]
)
Note that the identifier
property is required for both secondary sources and
artifacts.
The contents of the secondary source is available to the build under the
directory specified by the CODEBUILD_SRC_DIR_<identifier>
environment variable
(so, CODEBUILD_SRC_DIR_source2
in the above case).
The secondary artifacts have their own section in the buildspec, under the
regular artifacts
one. Each secondary artifact has its own section, beginning
with their identifier.
So, a buildspec for the above Project could look something like this:
# Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
project = codebuild.Project(self, "MyProject",
# secondary sources and artifacts as above...
build_spec=codebuild.BuildSpec.from_object(
version="0.2",
phases={
"build": {
"commands": ["cd $CODEBUILD_SRC_DIR_source2", "touch output2.txt"
]
}
},
artifacts={
"secondary-artifacts": {
"artifact2": {
"base-directory": "$CODEBUILD_SRC_DIR_source2",
"files": ["output2.txt"
]
}
}
}
)
)
Definition of VPC configuration in CodeBuild Project
Typically, resources in an VPC are not accessible by AWS CodeBuild. To enable access, you must provide additional VPC-specific configuration information as part of your CodeBuild project configuration. This includes the VPC ID, the VPC subnet IDs, and the VPC security group IDs. VPC-enabled builds are then able to access resources inside your VPC.
For further Information see https://docs.aws.amazon.com/codebuild/latest/userguide/vpc-support.html
Use Cases VPC connectivity from AWS CodeBuild builds makes it possible to:
- Run integration tests from your build against data in an Amazon RDS database that's isolated on a private subnet.
- Query data in an Amazon ElastiCache cluster directly from tests.
- Interact with internal web services hosted on Amazon EC2, Amazon ECS, or services that use internal Elastic Load Balancing.
- Retrieve dependencies from self-hosted, internal artifact repositories, such as PyPI for Python, Maven for Java, and npm for Node.js.
- Access objects in an Amazon S3 bucket configured to allow access through an Amazon VPC endpoint only.
- Query external web services that require fixed IP addresses through the Elastic IP address of the NAT gateway or NAT instance associated with your subnet(s).
Your builds can access any resource that's hosted in your VPC.
Enable Amazon VPC Access in your CodeBuild Projects
Pass the VPC when defining your Project, then make sure to
give the CodeBuild's security group the right permissions
to access the resources that it needs by using the
connections
object.
For example:
# Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
vpc = ec2.Vpc(self, "MyVPC")
project = codebuild.Project(self, "MyProject",
vpc=vpc,
build_spec=codebuild.BuildSpec.from_object()
)
project.connections.allow_to(load_balancer, ec2.Port.tcp(443))
Project File System Location EFS
Add support for CodeBuild to build on AWS EFS file system mounts using
the new ProjectFileSystemLocation.
The fileSystemLocations
property which accepts a list ProjectFileSystemLocation
as represented by the interface IFileSystemLocations
.
The only supported file system type is EFS
.
For example:
# Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
codebuild.Project(stack, "MyProject",
build_spec=codebuild.BuildSpec.from_object(
version="0.2"
),
file_system_locations=[
codebuild.FileSystemLocation.efs(
identifier="myidentifier2",
location="myclodation.mydnsroot.com:/loc",
mount_point="/media",
mount_options="opts"
)
]
)
Here's a CodeBuild project with a simple example that creates a project mounted on AWS EFS:
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for aws-cdk.aws-codebuild-1.63.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ff762077c43c6235704cd909151093e67ab35126e89dd77f3a97df3a5e064b67 |
|
MD5 | 91fec5f4eeb18bb764092f9a20f6fe0b |
|
BLAKE2b-256 | e09b38026905c7e08c39c72db165077b99d042c30d43ad87e3572ad94a0d3b3c |
Hashes for aws_cdk.aws_codebuild-1.63.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | da03df7ff42ea8c43b5d09b4259da54a914d1772730c6ee889a250bf52d6c830 |
|
MD5 | 0b557f29096c03bc1ae6536c370923d6 |
|
BLAKE2b-256 | e060d98119e654a0d4e57ad5aaaa44531f144ee8fdf607eece75a966ba9f486f |