@aws-cdk/aws-codebuild

constructor

protected constructor(props: ArtifactsProps);

property identifier

readonly identifier?: string;

property type

abstract readonly type: string;

method bind

bind: (_scope: CoreConstruct, _project: IProject) => ArtifactsConfig;

method s3

static s3: (props: S3ArtifactsProps) => IArtifacts;

constructor

constructor(
    scope: Construct,
    id: string,
    props: BitBucketSourceCredentialsProps
);

constructor

protected constructor();

property isImmediate

abstract readonly isImmediate: boolean;

• Whether the buildspec is directly available or deferred until build-time

method fromObject

static fromObject: (value: { [key: string]: any }) => BuildSpec;

method fromObjectToYaml

static fromObjectToYaml: (value: { [key: string]: any }) => BuildSpec;

• Create a buildspec from an object that will be rendered as YAML in the resulting CloudFormation template.

  Parameter value

  the object containing the buildspec that will be rendered as YAML

method fromSourceFilename

static fromSourceFilename: (filename: string) => BuildSpec;

• Use a file from the source as buildspec

  Use this if you want to use a file different from 'buildspec.yml'`

method toBuildSpec

abstract toBuildSpec: () => string;

• Render the represented BuildSpec

method bucket

static bucket: (bucket: IBucket, options?: BucketCacheOptions) => Cache;

• Create an S3 caching strategy.

  Parameter bucket

  the S3 bucket to use for caching

  Parameter options

  additional options to pass to the S3 caching

method local

static local: (...modes: LocalCacheMode[]) => Cache;

• Create a local caching strategy.

  Parameter modes

  the mode(s) to enable for local caching

method none

static none: () => Cache;

constructor

constructor(scope: cdk.Construct, id: string, props: CfnProjectProps);

• Create a new AWS::CodeBuild::Project.

  Parameter scope

  scope in which this resource is defined

  Parameter id

  scoped id of the resource

  Parameter props

  resource properties

property artifacts

artifacts: any;

• Artifacts is a property of the [AWS::CodeBuild::Project](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html) resource that specifies output settings for artifacts generated by an AWS CodeBuild build.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-artifacts

property attrArn

readonly attrArn: string;

• The ARN of the AWS CodeBuild project, such as arn:aws:codebuild:us-west-2:123456789012:project/myProjectName . Arn

property badgeEnabled

badgeEnabled: any;

• Indicates whether AWS CodeBuild generates a publicly accessible URL for your project's build badge. For more information, see [Build Badges Sample](https://docs.aws.amazon.com/codebuild/latest/userguide/sample-build-badges.html) in the *AWS CodeBuild User Guide* .

  > Including build badges with your project is currently not supported if the source type is CodePipeline. If you specify CODEPIPELINE for the Source property, do not specify the BadgeEnabled property.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-badgeenabled

property buildBatchConfig

buildBatchConfig: any;

• A ProjectBuildBatchConfig object that defines the batch build options for the project.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-buildbatchconfig

property cache

cache: any;

• Settings that AWS CodeBuild uses to store and reuse build dependencies.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-cache

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

• The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property concurrentBuildLimit

concurrentBuildLimit: number;

• The maximum number of concurrent builds that are allowed for this project.

  New builds are only started if the current number of builds is less than or equal to this limit. If the current build count meets this limit, new builds are throttled and are not run.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-concurrentbuildlimit

property description

description: string;

• A description that makes the build project easy to identify.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-description

property encryptionKey

encryptionKey: string;

• The AWS Key Management Service customer master key (CMK) to be used for encrypting the build output artifacts.

  > You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key.

  You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format alias/<alias-name> ). If you don't specify a value, CodeBuild uses the managed CMK for Amazon Simple Storage Service (Amazon S3).

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-encryptionkey

property environment

environment: any;

• The build environment settings for the project, such as the environment type or the environment variables to use for the build environment.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-environment

property fileSystemLocations

fileSystemLocations: any;

• An array of ProjectFileSystemLocation objects for a CodeBuild build project. A ProjectFileSystemLocation object specifies the identifier , location , mountOptions , mountPoint , and type of a file system created using Amazon Elastic File System.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-filesystemlocations

property logsConfig

logsConfig: any;

• Information about logs for the build project. A project can create logs in CloudWatch Logs, an S3 bucket, or both.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-logsconfig

property name

name: string;

• The name of the build project. The name must be unique across all of the projects in your AWS account .

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-name

property queuedTimeoutInMinutes

queuedTimeoutInMinutes: number;

• The number of minutes a build is allowed to be queued before it times out.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-queuedtimeoutinminutes

property resourceAccessRole

resourceAccessRole: string;

• The ARN of the IAM role that enables CodeBuild to access the CloudWatch Logs and Amazon S3 artifacts for the project's builds.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-resourceaccessrole

property secondaryArtifacts

secondaryArtifacts: any;

• A list of Artifacts objects. Each artifacts object specifies output settings that the project generates during a build.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-secondaryartifacts

property secondarySources

secondarySources: any;

• An array of ProjectSource objects.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-secondarysources

property secondarySourceVersions

secondarySourceVersions: any;

• An array of ProjectSourceVersion objects. If secondarySourceVersions is specified at the build level, then they take over these secondarySourceVersions (at the project level).

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-secondarysourceversions

property serviceRole

serviceRole: string;

• The ARN of the IAM role that enables AWS CodeBuild to interact with dependent AWS services on behalf of the AWS account.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-servicerole

property source

source: any;

• The source code settings for the project, such as the source code's repository type and location.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-source

property sourceVersion

sourceVersion: string;

• A version of the build input to be built for this project. If not specified, the latest version is used. If specified, it must be one of:

  - For CodeCommit: the commit ID, branch, or Git tag to use. - For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for example pr/25 ). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used. - For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used. - For Amazon S3: the version ID of the object that represents the build input ZIP file to use.

  If sourceVersion is specified at the build level, then that version takes precedence over this sourceVersion (at the project level).

  For more information, see [Source Version Sample with CodeBuild](https://docs.aws.amazon.com/codebuild/latest/userguide/sample-source-version.html) in the *AWS CodeBuild User Guide* .

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-sourceversion

property tags

readonly tags: cdk.TagManager;

• An arbitrary set of tags (key-value pairs) for the AWS CodeBuild project.

  These tags are available for use by AWS services that support AWS CodeBuild build project tags.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-tags

property timeoutInMinutes

timeoutInMinutes: number;

• How long, in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait before timing out any related build that did not get marked as completed. The default is 60 minutes.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-timeoutinminutes

property triggers

triggers: any;

• For an existing AWS CodeBuild build project that has its source code stored in a GitHub repository, enables AWS CodeBuild to begin automatically rebuilding the source code every time a code change is pushed to the repository.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-triggers

property visibility

visibility: string;

• Specifies the visibility of the project's builds. Possible values are:

  - **PUBLIC_READ** - The project builds are visible to the public. - **PRIVATE** - The project builds are not visible to the public.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-visibility

property vpcConfig

vpcConfig: any;

• VpcConfig specifies settings that enable AWS CodeBuild to access resources in an Amazon VPC. For more information, see [Use AWS CodeBuild with Amazon Virtual Private Cloud](https://docs.aws.amazon.com/codebuild/latest/userguide/vpc-support.html) in the *AWS CodeBuild User Guide* .

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-vpcconfig

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

• Examines the CloudFormation resource and discloses attributes.

  Parameter inspector

  tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

constructor

constructor(scope: cdk.Construct, id: string, props: CfnReportGroupProps);

• Create a new AWS::CodeBuild::ReportGroup.

  Parameter scope

  scope in which this resource is defined

  Parameter id

  scoped id of the resource

  Parameter props

  resource properties

property attrArn

readonly attrArn: string;

• The ARN of the AWS CodeBuild report group, such as arn:aws:codebuild:region:123456789012:report-group/myReportGroupName . Arn

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

• The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property deleteReports

deleteReports: any;

• When deleting a report group, specifies if reports within the report group should be deleted.

  - **true** - Deletes any reports that belong to the report group before deleting the report group. - **false** - You must delete any reports in the report group. This is the default value. If you delete a report group that contains one or more reports, an exception is thrown.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-reportgroup.html#cfn-codebuild-reportgroup-deletereports

property exportConfig

exportConfig: any;

• Information about the destination where the raw data of this ReportGroup is exported.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-reportgroup.html#cfn-codebuild-reportgroup-exportconfig

property name

name: string;

• The name of the ReportGroup .

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-reportgroup.html#cfn-codebuild-reportgroup-name

property tags

readonly tags: cdk.TagManager;

• A list of tag key and value pairs associated with this report group.

  These tags are available for use by AWS services that support AWS CodeBuild report group tags.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-reportgroup.html#cfn-codebuild-reportgroup-tags

property type

type: string;

• The type of the ReportGroup . This can be one of the following values:

  - **CODE_COVERAGE** - The report group contains code coverage reports. - **TEST** - The report group contains test reports.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-reportgroup.html#cfn-codebuild-reportgroup-type

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

• Examines the CloudFormation resource and discloses attributes.

  Parameter inspector

  tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

constructor

constructor(scope: cdk.Construct, id: string, props: CfnSourceCredentialProps);

• Create a new AWS::CodeBuild::SourceCredential.

  Parameter scope

  scope in which this resource is defined

  Parameter id

  scoped id of the resource

  Parameter props

  resource properties

property authType

authType: string;

• The type of authentication used by the credentials. Valid options are OAUTH, BASIC_AUTH, or PERSONAL_ACCESS_TOKEN.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-sourcecredential.html#cfn-codebuild-sourcecredential-authtype

property CFN_RESOURCE_TYPE_NAME

static readonly CFN_RESOURCE_TYPE_NAME: string;

• The CloudFormation resource type name for this resource class.

property cfnProperties

readonly cfnProperties: { [key: string]: any };

property serverType

serverType: string;

• The type of source provider. The valid options are GITHUB, GITHUB_ENTERPRISE, or BITBUCKET.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-sourcecredential.html#cfn-codebuild-sourcecredential-servertype

property token

token: string;

• For GitHub or GitHub Enterprise, this is the personal access token. For Bitbucket, this is the app password.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-sourcecredential.html#cfn-codebuild-sourcecredential-token

property username

username: string;

• The Bitbucket username when the authType is BASIC_AUTH. This parameter is not valid for other types of source providers or connections.

  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-sourcecredential.html#cfn-codebuild-sourcecredential-username

method inspect

inspect: (inspector: cdk.TreeInspector) => void;

• Examines the CloudFormation resource and discloses attributes.

  Parameter inspector

  tree inspector to collect and process attributes

method renderProperties

protected renderProperties: (props: { [key: string]: any }) => {
    [key: string]: any;
};

method efs

static efs: (props: EfsFileSystemLocationProps) => IFileSystemLocation;

• EFS file system provider.

  Parameter props

  the EFS File System location property.

method andActorAccountIs

andActorAccountIs: (pattern: string) => FilterGroup;

• Create a new FilterGroup with an added condition: the account ID of the actor initiating the event must match the given pattern.

  Parameter pattern

  a regular expression

method andActorAccountIsNot

andActorAccountIsNot: (pattern: string) => FilterGroup;

• Create a new FilterGroup with an added condition: the account ID of the actor initiating the event must not match the given pattern.

  Parameter pattern

  a regular expression

method andBaseBranchIs

andBaseBranchIs: (branchName: string) => FilterGroup;

• Create a new FilterGroup with an added condition: the Pull Request that is the source of the event must target the given base branch. Note that you cannot use this method if this Group contains the PUSH event action.

  Parameter branchName

  the name of the branch (can be a regular expression)

method andBaseBranchIsNot

andBaseBranchIsNot: (branchName: string) => FilterGroup;

• Create a new FilterGroup with an added condition: the Pull Request that is the source of the event must not target the given base branch. Note that you cannot use this method if this Group contains the PUSH event action.

  Parameter branchName

  the name of the branch (can be a regular expression)

method andBaseRefIs

andBaseRefIs: (pattern: string) => FilterGroup;

• Create a new FilterGroup with an added condition: the Pull Request that is the source of the event must target the given Git reference. Note that you cannot use this method if this Group contains the PUSH event action.

  Parameter pattern

  a regular expression

method andBaseRefIsNot

andBaseRefIsNot: (pattern: string) => FilterGroup;

• Create a new FilterGroup with an added condition: the Pull Request that is the source of the event must not target the given Git reference. Note that you cannot use this method if this Group contains the PUSH event action.

  Parameter pattern

  a regular expression

method andBranchIs

andBranchIs: (branchName: string) => FilterGroup;

• Create a new FilterGroup with an added condition: the event must affect the given branch.

  Parameter branchName

  the name of the branch (can be a regular expression)

method andBranchIsNot

andBranchIsNot: (branchName: string) => FilterGroup;

• Create a new FilterGroup with an added condition: the event must not affect the given branch.

  Parameter branchName

  the name of the branch (can be a regular expression)

method andCommitMessageIs

andCommitMessageIs: (commitMessage: string) => FilterGroup;

• Create a new FilterGroup with an added condition: the event must affect a head commit with the given message.

  Parameter commitMessage

  the commit message (can be a regular expression)

method andCommitMessageIsNot

andCommitMessageIsNot: (commitMessage: string) => FilterGroup;

• Create a new FilterGroup with an added condition: the event must not affect a head commit with the given message.

  Parameter commitMessage

  the commit message (can be a regular expression)

method andFilePathIs

andFilePathIs: (pattern: string) => FilterGroup;

• Create a new FilterGroup with an added condition: the push that is the source of the event must affect a file that matches the given pattern. Note that you can only use this method if this Group contains only the PUSH event action, and only for GitHub, Bitbucket and GitHubEnterprise sources.

  Parameter pattern

  a regular expression

method andFilePathIsNot

andFilePathIsNot: (pattern: string) => FilterGroup;

• Create a new FilterGroup with an added condition: the push that is the source of the event must not affect a file that matches the given pattern. Note that you can only use this method if this Group contains only the PUSH event action, and only for GitHub, Bitbucket and GitHubEnterprise sources.

  Parameter pattern

  a regular expression

method andHeadRefIs

andHeadRefIs: (pattern: string) => FilterGroup;

• Create a new FilterGroup with an added condition: the event must affect a Git reference (ie., a branch or a tag) that matches the given pattern.

  Parameter pattern

  a regular expression

method andHeadRefIsNot

andHeadRefIsNot: (pattern: string) => FilterGroup;

• Create a new FilterGroup with an added condition: the event must not affect a Git reference (ie., a branch or a tag) that matches the given pattern.

  Parameter pattern

  a regular expression

method andTagIs

andTagIs: (tagName: string) => FilterGroup;

• Create a new FilterGroup with an added condition: the event must affect the given tag.

  Parameter tagName

  the name of the tag (can be a regular expression)

method andTagIsNot

andTagIsNot: (tagName: string) => FilterGroup;

• Create a new FilterGroup with an added condition: the event must not affect the given tag.

  Parameter tagName

  the name of the tag (can be a regular expression)

method inEventOf

static inEventOf: (...actions: EventAction[]) => FilterGroup;

• Creates a new event FilterGroup that triggers on any of the provided actions.

  Parameter actions

  the actions to trigger the webhook on

constructor

constructor(
    scope: Construct,
    id: string,
    props: GitHubEnterpriseSourceCredentialsProps
);

constructor

constructor(scope: Construct, id: string, props: GitHubSourceCredentialsProps);

property AMAZON_LINUX_2_STANDARD_1_0

static readonly AMAZON_LINUX_2_STANDARD_1_0: IBuildImage;

• Image "aws/codebuild/amazonlinux2-aarch64-standard:1.0".

property AMAZON_LINUX_2_STANDARD_2_0

static readonly AMAZON_LINUX_2_STANDARD_2_0: IBuildImage;

• Image "aws/codebuild/amazonlinux2-aarch64-standard:2.0".

property defaultComputeType

readonly defaultComputeType: string;

property imageId

readonly imageId: string;

property imagePullPrincipalType

readonly imagePullPrincipalType?: ImagePullPrincipalType;

property repository

readonly repository?: ecr.IRepository;

property secretsManagerCredentials

readonly secretsManagerCredentials?: secretsmanager.ISecret;

property type

readonly type: string;

method fromCodeBuildImageId

static fromCodeBuildImageId: (id: string) => IBuildImage;

• Uses a Docker image provided by CodeBuild.

  Parameter id

  The image identifier

  Returns

  A Docker image provided by CodeBuild.

  Example 1

  'aws/codebuild/amazonlinux2-aarch64-standard:1.0'

  See Also

  • https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-available.html

method fromEcrRepository

static fromEcrRepository: (
    repository: ecr.IRepository,
    tagOrDigest?: string
) => IBuildImage;

• Returns an ARM image running Linux from an ECR repository.

  NOTE: if the repository is external (i.e. imported), then we won't be able to add a resource policy statement for it so CodeBuild can pull the image.

  Parameter repository

  The ECR repository

  Parameter tagOrDigest

  Image tag or digest (default "latest", digests must start with sha256:)

  Returns

  An aarch64 Linux build image from an ECR repository.

  See Also

  • https://docs.aws.amazon.com/codebuild/latest/userguide/sample-ecr.html

method runScriptBuildspec

runScriptBuildspec: (entrypoint: string) => BuildSpec;

method validate

validate: (buildEnvironment: BuildEnvironment) => string[];

• Validates by checking the BuildEnvironment computeType as aarch64 images only support ComputeType.SMALL and ComputeType.LARGE

  Parameter buildEnvironment

  BuildEnvironment

property AMAZON_LINUX_2

static readonly AMAZON_LINUX_2: IBuildImage;

property AMAZON_LINUX_2_2

static readonly AMAZON_LINUX_2_2: IBuildImage;

property AMAZON_LINUX_2_3

static readonly AMAZON_LINUX_2_3: IBuildImage;

• The Amazon Linux 2 x86_64 standard image, version 3.0.

property AMAZON_LINUX_2_ARM

static readonly AMAZON_LINUX_2_ARM: IBuildImage;

• Deprecated

  Use LinuxArmBuildImage.AMAZON_LINUX_2_STANDARD_1_0 instead.

property AMAZON_LINUX_2_ARM_2

static readonly AMAZON_LINUX_2_ARM_2: IBuildImage;

• Image "aws/codebuild/amazonlinux2-aarch64-standard:2.0".

  Deprecated

  Use LinuxArmBuildImage.AMAZON_LINUX_2_STANDARD_2_0 instead.

property defaultComputeType

readonly defaultComputeType: string;

property imageId

readonly imageId: string;

property imagePullPrincipalType

readonly imagePullPrincipalType?: ImagePullPrincipalType;

property repository

readonly repository?: ecr.IRepository;

property secretsManagerCredentials

readonly secretsManagerCredentials?: secretsmanager.ISecret;

property STANDARD_1_0

static readonly STANDARD_1_0: IBuildImage;

property STANDARD_2_0

static readonly STANDARD_2_0: IBuildImage;

property STANDARD_3_0

static readonly STANDARD_3_0: IBuildImage;

property STANDARD_4_0

static readonly STANDARD_4_0: IBuildImage;

• The aws/codebuild/standard:4.0 build image.

property STANDARD_5_0

static readonly STANDARD_5_0: IBuildImage;

• The aws/codebuild/standard:5.0 build image.

property type

readonly type: string;

property UBUNTU_14_04_ANDROID_JAVA8_24_4_1

static readonly UBUNTU_14_04_ANDROID_JAVA8_24_4_1: IBuildImage;

• Deprecated

  Use STANDARD_2_0 and specify runtime in buildspec runtime-versions section

property UBUNTU_14_04_ANDROID_JAVA8_26_1_1

static readonly UBUNTU_14_04_ANDROID_JAVA8_26_1_1: IBuildImage;

• Deprecated

  Use STANDARD_2_0 and specify runtime in buildspec runtime-versions section

property UBUNTU_14_04_BASE

static readonly UBUNTU_14_04_BASE: IBuildImage;

• Deprecated

  Use STANDARD_2_0 and specify runtime in buildspec runtime-versions section

property UBUNTU_14_04_DOCKER_17_09_0

static readonly UBUNTU_14_04_DOCKER_17_09_0: IBuildImage;

• Deprecated

  Use STANDARD_2_0 and specify runtime in buildspec runtime-versions section

property UBUNTU_14_04_DOCKER_18_09_0

static readonly UBUNTU_14_04_DOCKER_18_09_0: IBuildImage;

• Deprecated

  Use STANDARD_2_0 and specify runtime in buildspec runtime-versions section

property UBUNTU_14_04_DOTNET_CORE_1_1

static readonly UBUNTU_14_04_DOTNET_CORE_1_1: IBuildImage;

• Deprecated

  Use STANDARD_2_0 and specify runtime in buildspec runtime-versions section

property UBUNTU_14_04_DOTNET_CORE_2_0

static readonly UBUNTU_14_04_DOTNET_CORE_2_0: IBuildImage;

• Deprecated

  Use STANDARD_2_0 and specify runtime in buildspec runtime-versions section

property UBUNTU_14_04_DOTNET_CORE_2_1

static readonly UBUNTU_14_04_DOTNET_CORE_2_1: IBuildImage;

• Deprecated

  Use STANDARD_2_0 and specify runtime in buildspec runtime-versions section

property UBUNTU_14_04_GOLANG_1_10

static readonly UBUNTU_14_04_GOLANG_1_10: IBuildImage;

• Deprecated

  Use STANDARD_2_0 and specify runtime in buildspec runtime-versions section

property UBUNTU_14_04_GOLANG_1_11

static readonly UBUNTU_14_04_GOLANG_1_11: IBuildImage;

• Deprecated

  Use STANDARD_2_0 and specify runtime in buildspec runtime-versions section

property UBUNTU_14_04_NODEJS_10_1_0

static readonly UBUNTU_14_04_NODEJS_10_1_0: IBuildImage;

• Deprecated

  Use STANDARD_2_0 and specify runtime in buildspec runtime-versions section

property UBUNTU_14_04_NODEJS_10_14_1

static readonly UBUNTU_14_04_NODEJS_10_14_1: IBuildImage;

• Deprecated

  Use STANDARD_2_0 and specify runtime in buildspec runtime-versions section

property UBUNTU_14_04_NODEJS_6_3_1

static readonly UBUNTU_14_04_NODEJS_6_3_1: IBuildImage;

• Deprecated

  Use STANDARD_2_0 and specify runtime in buildspec runtime-versions section

property UBUNTU_14_04_NODEJS_8_11_0

static readonly UBUNTU_14_04_NODEJS_8_11_0: IBuildImage;

• Deprecated

  Use STANDARD_2_0 and specify runtime in buildspec runtime-versions section

property UBUNTU_14_04_OPEN_JDK_11

static readonly UBUNTU_14_04_OPEN_JDK_11: IBuildImage;

• Deprecated

  Use STANDARD_2_0 and specify runtime in buildspec runtime-versions section

property UBUNTU_14_04_OPEN_JDK_8

static readonly UBUNTU_14_04_OPEN_JDK_8: IBuildImage;

• Deprecated

  Use STANDARD_2_0 and specify runtime in buildspec runtime-versions section

property UBUNTU_14_04_OPEN_JDK_9

static readonly UBUNTU_14_04_OPEN_JDK_9: IBuildImage;

• Deprecated

  Use STANDARD_2_0 and specify runtime in buildspec runtime-versions section

property UBUNTU_14_04_PHP_5_6

static readonly UBUNTU_14_04_PHP_5_6: IBuildImage;

• Deprecated

  Use STANDARD_2_0 and specify runtime in buildspec runtime-versions section

property UBUNTU_14_04_PHP_7_0

static readonly UBUNTU_14_04_PHP_7_0: IBuildImage;

• Deprecated

  Use STANDARD_2_0 and specify runtime in buildspec runtime-versions section

property UBUNTU_14_04_PHP_7_1

static readonly UBUNTU_14_04_PHP_7_1: IBuildImage;

• Deprecated

  Use STANDARD_2_0 and specify runtime in buildspec runtime-versions section

property UBUNTU_14_04_PYTHON_2_7_12

static readonly UBUNTU_14_04_PYTHON_2_7_12: IBuildImage;

• Deprecated

  Use STANDARD_2_0 and specify runtime in buildspec runtime-versions section

property UBUNTU_14_04_PYTHON_3_3_6

static readonly UBUNTU_14_04_PYTHON_3_3_6: IBuildImage;

• Deprecated

  Use STANDARD_2_0 and specify runtime in buildspec runtime-versions section

property UBUNTU_14_04_PYTHON_3_4_5

static readonly UBUNTU_14_04_PYTHON_3_4_5: IBuildImage;

• Deprecated

  Use STANDARD_2_0 and specify runtime in buildspec runtime-versions section

property UBUNTU_14_04_PYTHON_3_5_2

static readonly UBUNTU_14_04_PYTHON_3_5_2: IBuildImage;

• Deprecated

  Use STANDARD_2_0 and specify runtime in buildspec runtime-versions section

property UBUNTU_14_04_PYTHON_3_6_5

static readonly UBUNTU_14_04_PYTHON_3_6_5: IBuildImage;

• Deprecated

  Use STANDARD_2_0 and specify runtime in buildspec runtime-versions section

property UBUNTU_14_04_PYTHON_3_7_1

static readonly UBUNTU_14_04_PYTHON_3_7_1: IBuildImage;

• Deprecated

  Use STANDARD_2_0 and specify runtime in buildspec runtime-versions section

property UBUNTU_14_04_RUBY_2_2_5

static readonly UBUNTU_14_04_RUBY_2_2_5: IBuildImage;

• Deprecated

  Use STANDARD_2_0 and specify runtime in buildspec runtime-versions section

property UBUNTU_14_04_RUBY_2_3_1

static readonly UBUNTU_14_04_RUBY_2_3_1: IBuildImage;

• Deprecated

  Use STANDARD_2_0 and specify runtime in buildspec runtime-versions section

property UBUNTU_14_04_RUBY_2_5_1

static readonly UBUNTU_14_04_RUBY_2_5_1: IBuildImage;

• Deprecated

  Use STANDARD_2_0 and specify runtime in buildspec runtime-versions section

property UBUNTU_14_04_RUBY_2_5_3

static readonly UBUNTU_14_04_RUBY_2_5_3: IBuildImage;

• Deprecated

  Use STANDARD_2_0 and specify runtime in buildspec runtime-versions section

method fromAsset

static fromAsset: (
    scope: Construct,
    id: string,
    props: DockerImageAssetProps
) => IBuildImage;

• Uses an Docker image asset as a x86-64 Linux build image.

method fromCodeBuildImageId

static fromCodeBuildImageId: (id: string) => IBuildImage;

• Uses a Docker image provided by CodeBuild.

  Parameter id

  The image identifier

  Returns

  A Docker image provided by CodeBuild.

  Example 1

  'aws/codebuild/standard:4.0'

  See Also

  • https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-available.html

method fromDockerRegistry

static fromDockerRegistry: (
    name: string,
    options?: DockerImageOptions
) => IBuildImage;

• Returns

  a x86-64 Linux build image from a Docker Hub image.

method fromEcrRepository

static fromEcrRepository: (
    repository: ecr.IRepository,
    tagOrDigest?: string
) => IBuildImage;

• Parameter repository

  The ECR repository

  Parameter tagOrDigest

  Image tag or digest (default "latest", digests must start with sha256:)

  Returns

  A x86-64 Linux build image from an ECR repository.

  NOTE: if the repository is external (i.e. imported), then we won't be able to add a resource policy statement for it so CodeBuild can pull the image.

  See Also

  • https://docs.aws.amazon.com/codebuild/latest/userguide/sample-ecr.html

method runScriptBuildspec

runScriptBuildspec: (entrypoint: string) => BuildSpec;

method validate

validate: (_: BuildEnvironment) => string[];

property defaultComputeType

readonly defaultComputeType: string;

property DLC_MXNET_1_4_1

static readonly DLC_MXNET_1_4_1: IBuildImage;

• MXNet 1.4.1 GPU image from AWS Deep Learning Containers.

property DLC_MXNET_1_6_0

static readonly DLC_MXNET_1_6_0: IBuildImage;

• MXNet 1.6.0 GPU image from AWS Deep Learning Containers.

property DLC_PYTORCH_1_2_0

static readonly DLC_PYTORCH_1_2_0: IBuildImage;

• PyTorch 1.2.0 GPU image from AWS Deep Learning Containers.

property DLC_PYTORCH_1_3_1

static readonly DLC_PYTORCH_1_3_1: IBuildImage;

• PyTorch 1.3.1 GPU image from AWS Deep Learning Containers.

property DLC_PYTORCH_1_4_0_INFERENCE

static readonly DLC_PYTORCH_1_4_0_INFERENCE: IBuildImage;

• PyTorch 1.4.0 GPU inference image from AWS Deep Learning Containers.

property DLC_PYTORCH_1_4_0_TRAINING

static readonly DLC_PYTORCH_1_4_0_TRAINING: IBuildImage;

• PyTorch 1.4.0 GPU training image from AWS Deep Learning Containers.

property DLC_PYTORCH_1_5_0_INFERENCE

static readonly DLC_PYTORCH_1_5_0_INFERENCE: IBuildImage;

• PyTorch 1.5.0 GPU inference image from AWS Deep Learning Containers.

property DLC_PYTORCH_1_5_0_TRAINING

static readonly DLC_PYTORCH_1_5_0_TRAINING: IBuildImage;

• PyTorch 1.5.0 GPU training image from AWS Deep Learning Containers.

property DLC_TENSORFLOW_1_14_0

static readonly DLC_TENSORFLOW_1_14_0: IBuildImage;

• Tensorflow 1.14.0 GPU image from AWS Deep Learning Containers.

property DLC_TENSORFLOW_1_15_0

static readonly DLC_TENSORFLOW_1_15_0: IBuildImage;

• Tensorflow 1.15.0 GPU image from AWS Deep Learning Containers.

property DLC_TENSORFLOW_1_15_2_INFERENCE

static readonly DLC_TENSORFLOW_1_15_2_INFERENCE: IBuildImage;

• Tensorflow 1.15.2 GPU inference image from AWS Deep Learning Containers.

property DLC_TENSORFLOW_1_15_2_TRAINING

static readonly DLC_TENSORFLOW_1_15_2_TRAINING: IBuildImage;

• Tensorflow 1.15.2 GPU training image from AWS Deep Learning Containers.

property DLC_TENSORFLOW_2_0_0

static readonly DLC_TENSORFLOW_2_0_0: IBuildImage;

• Tensorflow 2.0.0 GPU image from AWS Deep Learning Containers.

property DLC_TENSORFLOW_2_0_1

static readonly DLC_TENSORFLOW_2_0_1: IBuildImage;

• Tensorflow 2.0.1 GPU image from AWS Deep Learning Containers.

property DLC_TENSORFLOW_2_1_0_INFERENCE

static readonly DLC_TENSORFLOW_2_1_0_INFERENCE: IBuildImage;

• Tensorflow 2.1.0 GPU inference image from AWS Deep Learning Containers.

property DLC_TENSORFLOW_2_1_0_TRAINING

static readonly DLC_TENSORFLOW_2_1_0_TRAINING: IBuildImage;

• Tensorflow 2.1.0 GPU training image from AWS Deep Learning Containers.

property DLC_TENSORFLOW_2_2_0_TRAINING

static readonly DLC_TENSORFLOW_2_2_0_TRAINING: IBuildImage;

• Tensorflow 2.2.0 GPU training image from AWS Deep Learning Containers.

property imageId

readonly imageId: string;

property imagePullPrincipalType

readonly imagePullPrincipalType?: ImagePullPrincipalType;

property type

readonly type: string;

method awsDeepLearningContainersImage

static awsDeepLearningContainersImage: (
    repositoryName: string,
    tag: string,
    account?: string
) => IBuildImage;

• Returns a Linux GPU build image from AWS Deep Learning Containers.

  Parameter repositoryName

  the name of the repository, for example "pytorch-inference"

  Parameter tag

  the tag of the image, for example "1.5.0-gpu-py36-cu101-ubuntu16.04"

  Parameter account

  the AWS account ID where the DLC repository for this region is hosted in. In many cases, the CDK can infer that for you, but for some newer region our information might be out of date; in that case, you can specify the region explicitly using this optional parameter

  See Also

  • https://aws.amazon.com/releasenotes/available-deep-learning-containers-images

method bind

bind: (
    scope: Construct,
    project: IProject,
    _options: BuildImageBindOptions
) => BuildImageConfig;

method fromEcrRepository

static fromEcrRepository: (
    repository: ecr.IRepository,
    tag?: string
) => IBuildImage;

• Returns a GPU image running Linux from an ECR repository.

  NOTE: if the repository is external (i.e. imported), then we won't be able to add a resource policy statement for it so CodeBuild can pull the image.

  Parameter repository

  The ECR repository

  Parameter tag

  Image tag (default "latest")

  See Also

  • https://docs.aws.amazon.com/codebuild/latest/userguide/sample-ecr.html

method runScriptBuildspec

runScriptBuildspec: (entrypoint: string) => BuildSpec;

method validate

validate: (buildEnvironment: BuildEnvironment) => string[];

property buildComplete

static readonly buildComplete: string;

• Whether the build is complete

property buildId

static readonly buildId: string;

• The triggering build's id

property completedPhase

static readonly completedPhase: string;

• The phase that was just completed

property completedPhaseDurationSeconds

static readonly completedPhaseDurationSeconds: string;

• The duration of the completed phase

property completedPhaseStatus

static readonly completedPhaseStatus: string;

• The status of the completed phase

property projectName

static readonly projectName: string;

• The triggering build's project name

constructor

constructor(scope: Construct, id: string, props?: PipelineProjectProps);

constructor

constructor(scope: Construct, id: string, props: ProjectProps);

property grantPrincipal

readonly grantPrincipal: iam.IPrincipal;

property projectArn

readonly projectArn: string;

• The ARN of the project.

property projectName

readonly projectName: string;

• The name of the project.

property role

readonly role?: iam.IRole;

• The IAM role for this project.

method addFileSystemLocation

addFileSystemLocation: (fileSystemLocation: IFileSystemLocation) => void;

• Adds a fileSystemLocation to the Project.

  Parameter fileSystemLocation

  the fileSystemLocation to add

method addSecondaryArtifact

addSecondaryArtifact: (secondaryArtifact: IArtifacts) => void;

• Adds a secondary artifact to the Project.

  Parameter secondaryArtifact

  the artifact to add as a secondary artifact

  See Also

  • https://docs.aws.amazon.com/codebuild/latest/userguide/sample-multi-in-out.html

method addSecondarySource

addSecondarySource: (secondarySource: ISource) => void;

• Adds a secondary source to the Project.

  Parameter secondarySource

  the source to add as a secondary source

  See Also

  • https://docs.aws.amazon.com/codebuild/latest/userguide/sample-multi-in-out.html

method bindToCodePipeline

bindToCodePipeline: (
    _scope: CoreConstruct,
    options: BindToCodePipelineOptions
) => void;

• A callback invoked when the given project is added to a CodePipeline.

  Parameter _scope

  the construct the binding is taking place in

  Parameter options

  additional options for the binding

method enableBatchBuilds

enableBatchBuilds: () => BatchBuildConfig | undefined;

method fromProjectArn

static fromProjectArn: (
    scope: Construct,
    id: string,
    projectArn: string
) => IProject;

method fromProjectName

static fromProjectName: (
    scope: Construct,
    id: string,
    projectName: string
) => IProject;

• Import a Project defined either outside the CDK, or in a different CDK Stack (and exported using the export method).

  if you're importing a CodeBuild Project for use in a CodePipeline, make sure the existing Project has permissions to access the S3 Bucket of that Pipeline - otherwise, builds in that Pipeline will always fail.

  Parameter scope

  the parent Construct for this Construct

  Parameter id

  the logical name of this Construct

  Parameter projectName

  the name of the project to import

  Returns

  a reference to the existing Project

method serializeEnvVariables

static serializeEnvVariables: (
    environmentVariables: { [name: string]: BuildEnvironmentVariable },
    validateNoPlainTextSecrets?: boolean,
    principal?: iam.IGrantable
) => CfnProject.EnvironmentVariableProperty[];

• Convert the environment variables map of string to BuildEnvironmentVariable, which is the customer-facing type, to a list of CfnProject.EnvironmentVariableProperty, which is the representation of environment variables in CloudFormation.

  Parameter environmentVariables

  the map of string to environment variables

  Parameter validateNoPlainTextSecrets

  whether to throw an exception if any of the plain text environment variables contain secrets, defaults to 'false'

  Returns

  an array of CfnProject.EnvironmentVariableProperty instances

method validate

protected validate: () => string[];

• Modifiers

  • @override

constructor

constructor(scope: Construct, id: string, props?: ReportGroupProps);

property exportBucket

protected readonly exportBucket?: s3.IBucket;

property reportGroupArn

readonly reportGroupArn: string;

property reportGroupName

readonly reportGroupName: string;

method fromReportGroupName

static fromReportGroupName: (
    scope: Construct,
    id: string,
    reportGroupName: string
) => IReportGroup;

• Reference an existing ReportGroup, defined outside of the CDK code, by name.

constructor

protected constructor(props: SourceProps);

property badgeSupported

readonly badgeSupported: boolean;

property identifier

readonly identifier?: string;

property type

abstract readonly type: string;

method bind

bind: (_scope: CoreConstruct, _project: IProject) => SourceConfig;

• Called by the project when the source is added so that the source can perform binding operations on the source. For example, it can grant permissions to the code build project to read from the S3 bucket.