@aws-cdk/aws-codebuild
- Version 1.204.0
- Published
- 2.81 MB
- 18 dependencies
- Apache-2.0 license
Install
npm i @aws-cdk/aws-codebuild
yarn add @aws-cdk/aws-codebuild
pnpm add @aws-cdk/aws-codebuild
Overview
The CDK Construct Library for AWS::CodeBuild
Index
Functions
Classes
CfnProject
- artifacts
- attrArn
- badgeEnabled
- buildBatchConfig
- cache
- CFN_RESOURCE_TYPE_NAME
- cfnProperties
- concurrentBuildLimit
- description
- encryptionKey
- environment
- fileSystemLocations
- inspect()
- logsConfig
- name
- queuedTimeoutInMinutes
- renderProperties()
- resourceAccessRole
- secondaryArtifacts
- secondarySources
- secondarySourceVersions
- serviceRole
- source
- sourceVersion
- tags
- timeoutInMinutes
- triggers
- visibility
- vpcConfig
LinuxBuildImage
- AMAZON_LINUX_2
- AMAZON_LINUX_2_2
- AMAZON_LINUX_2_3
- AMAZON_LINUX_2_ARM
- AMAZON_LINUX_2_ARM_2
- defaultComputeType
- fromAsset()
- fromCodeBuildImageId()
- fromDockerRegistry()
- fromEcrRepository()
- imageId
- imagePullPrincipalType
- repository
- runScriptBuildspec()
- secretsManagerCredentials
- STANDARD_1_0
- STANDARD_2_0
- STANDARD_3_0
- STANDARD_4_0
- STANDARD_5_0
- type
- UBUNTU_14_04_ANDROID_JAVA8_24_4_1
- UBUNTU_14_04_ANDROID_JAVA8_26_1_1
- UBUNTU_14_04_BASE
- UBUNTU_14_04_DOCKER_17_09_0
- UBUNTU_14_04_DOCKER_18_09_0
- UBUNTU_14_04_DOTNET_CORE_1_1
- UBUNTU_14_04_DOTNET_CORE_2_0
- UBUNTU_14_04_DOTNET_CORE_2_1
- UBUNTU_14_04_GOLANG_1_10
- UBUNTU_14_04_GOLANG_1_11
- UBUNTU_14_04_NODEJS_10_1_0
- UBUNTU_14_04_NODEJS_10_14_1
- UBUNTU_14_04_NODEJS_6_3_1
- UBUNTU_14_04_NODEJS_8_11_0
- UBUNTU_14_04_OPEN_JDK_11
- UBUNTU_14_04_OPEN_JDK_8
- UBUNTU_14_04_OPEN_JDK_9
- UBUNTU_14_04_PHP_5_6
- UBUNTU_14_04_PHP_7_0
- UBUNTU_14_04_PHP_7_1
- UBUNTU_14_04_PYTHON_2_7_12
- UBUNTU_14_04_PYTHON_3_3_6
- UBUNTU_14_04_PYTHON_3_4_5
- UBUNTU_14_04_PYTHON_3_5_2
- UBUNTU_14_04_PYTHON_3_6_5
- UBUNTU_14_04_PYTHON_3_7_1
- UBUNTU_14_04_RUBY_2_2_5
- UBUNTU_14_04_RUBY_2_3_1
- UBUNTU_14_04_RUBY_2_5_1
- UBUNTU_14_04_RUBY_2_5_3
- validate()
LinuxGpuBuildImage
- awsDeepLearningContainersImage()
- bind()
- defaultComputeType
- DLC_MXNET_1_4_1
- DLC_MXNET_1_6_0
- DLC_PYTORCH_1_2_0
- DLC_PYTORCH_1_3_1
- DLC_PYTORCH_1_4_0_INFERENCE
- DLC_PYTORCH_1_4_0_TRAINING
- DLC_PYTORCH_1_5_0_INFERENCE
- DLC_PYTORCH_1_5_0_TRAINING
- DLC_TENSORFLOW_1_14_0
- DLC_TENSORFLOW_1_15_0
- DLC_TENSORFLOW_1_15_2_INFERENCE
- DLC_TENSORFLOW_1_15_2_TRAINING
- DLC_TENSORFLOW_2_0_0
- DLC_TENSORFLOW_2_0_1
- DLC_TENSORFLOW_2_1_0_INFERENCE
- DLC_TENSORFLOW_2_1_0_TRAINING
- DLC_TENSORFLOW_2_2_0_TRAINING
- fromEcrRepository()
- imageId
- imagePullPrincipalType
- runScriptBuildspec()
- type
- validate()
Interfaces
CfnProjectProps
- artifacts
- badgeEnabled
- buildBatchConfig
- cache
- concurrentBuildLimit
- description
- encryptionKey
- environment
- fileSystemLocations
- logsConfig
- name
- queuedTimeoutInMinutes
- resourceAccessRole
- secondaryArtifacts
- secondarySources
- secondarySourceVersions
- serviceRole
- source
- sourceVersion
- tags
- timeoutInMinutes
- triggers
- visibility
- vpcConfig
Enums
Namespaces
CfnProject
- ArtifactsProperty
- BatchRestrictionsProperty
- BuildStatusConfigProperty
- CloudWatchLogsConfigProperty
- EnvironmentProperty
- EnvironmentVariableProperty
- GitSubmodulesConfigProperty
- LogsConfigProperty
- ProjectBuildBatchConfigProperty
- ProjectCacheProperty
- ProjectFileSystemLocationProperty
- ProjectSourceVersionProperty
- ProjectTriggersProperty
- RegistryCredentialProperty
- S3LogsConfigProperty
- SourceAuthProperty
- SourceProperty
- VpcConfigProperty
- WebhookFilterProperty
Functions
function mergeBuildSpecs
mergeBuildSpecs: (lhs: BuildSpec, rhs: BuildSpec) => BuildSpec;
Merge two buildspecs into a new BuildSpec by doing a deep merge
We decided to disallow merging of artifact specs, which is actually impossible since we can't merge two buildspecs with a single primary output into a buildspec with multiple outputs. In case of multiple outputs they must have identifiers but we won't have that information.
In case of test reports we replace the whole object with the RHS (instead of recursively merging)
Classes
class Artifacts
abstract class Artifacts implements IArtifacts {}
Artifacts definition for a CodeBuild Project.
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;
class BitBucketSourceCredentials
class BitBucketSourceCredentials extends Resource {}
The source credentials used when contacting the BitBucket API.
**Note**: CodeBuild only allows a single credential for BitBucket to be saved in a given AWS account in a given region - any attempt to add more than one will result in an error.
AWS::CodeBuild::SourceCredential
constructor
constructor( scope: Construct, id: string, props: BitBucketSourceCredentialsProps);
class BuildSpec
abstract class BuildSpec {}
BuildSpec for CodeBuild projects
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
class Cache
abstract class Cache {}
Cache options for CodeBuild Project. A cache can store reusable pieces of your build environment and use them across multiple builds.
See Also
https://docs.aws.amazon.com/codebuild/latest/userguide/build-caching.html
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;
class CfnProject
class CfnProject extends cdk.CfnResource implements cdk.IInspectable {}
A CloudFormation
AWS::CodeBuild::Project
The
AWS::CodeBuild::Project
resource configures how AWS CodeBuild builds your source code. For example, it tells CodeBuild where to get the source code and which build environment to use.> To unset or remove a project value via CFN, explicitly provide the attribute with value as empty input.
AWS::CodeBuild::Project external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html
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 theSource
property, do not specify theBadgeEnabled
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. AProjectFileSystemLocation
object specifies theidentifier
,location
,mountOptions
,mountPoint
, andtype
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. IfsecondarySourceVersions
is specified at the build level, then they take over thesesecondarySourceVersions
(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 examplepr/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 thissourceVersion
(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;};
class CfnReportGroup
class CfnReportGroup extends cdk.CfnResource implements cdk.IInspectable {}
A CloudFormation
AWS::CodeBuild::ReportGroup
Represents a report group. A report group contains a collection of reports.
AWS::CodeBuild::ReportGroup external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-reportgroup.html
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;};
class CfnSourceCredential
class CfnSourceCredential extends cdk.CfnResource implements cdk.IInspectable {}
A CloudFormation
AWS::CodeBuild::SourceCredential
Information about the credentials for a GitHub, GitHub Enterprise, or Bitbucket repository. We strongly recommend that you use AWS Secrets Manager to store your credentials. If you use Secrets Manager , you must have secrets in your secrets manager. For more information, see [Using Dynamic References to Specify Template Values](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/dynamic-references.html#dynamic-references-secretsmanager) .
> For security purposes, do not use plain text in your AWS CloudFormation template to store your credentials.
AWS::CodeBuild::SourceCredential external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-sourcecredential.html
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;};
class FileSystemLocation
class FileSystemLocation {}
FileSystemLocation provider definition for a CodeBuild Project.
method efs
static efs: (props: EfsFileSystemLocationProps) => IFileSystemLocation;
EFS file system provider.
Parameter props
the EFS File System location property.
class FilterGroup
class FilterGroup {}
An object that represents a group of filter conditions for a webhook. Every condition in a given FilterGroup must be true in order for the whole group to be true. You construct instances of it by calling the static factory method, and then calling various
andXyz
instance methods to create modified instances of it (this class is immutable).You pass instances of this class to the
webhookFilters
property when constructing a source.
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
class GitHubEnterpriseSourceCredentials
class GitHubEnterpriseSourceCredentials extends Resource {}
The source credentials used when contacting the GitHub Enterprise API.
**Note**: CodeBuild only allows a single credential for GitHub Enterprise to be saved in a given AWS account in a given region - any attempt to add more than one will result in an error.
AWS::CodeBuild::SourceCredential
constructor
constructor( scope: Construct, id: string, props: GitHubEnterpriseSourceCredentialsProps);
class GitHubSourceCredentials
class GitHubSourceCredentials extends Resource {}
The source credentials used when contacting the GitHub API.
**Note**: CodeBuild only allows a single credential for GitHub to be saved in a given AWS account in a given region - any attempt to add more than one will result in an error.
AWS::CodeBuild::SourceCredential
constructor
constructor(scope: Construct, id: string, props: GitHubSourceCredentialsProps);
class LinuxArmBuildImage
class LinuxArmBuildImage implements IBuildImage {}
A CodeBuild image running aarch64 Linux.
This class has a bunch of public constants that represent the CodeBuild ARM images.
You can also specify a custom image using the static method:
- LinuxBuildImage.fromEcrRepository(repo[, tag])
See Also
https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-available.html
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
class LinuxBuildImage
class LinuxBuildImage implements IBuildImage {}
A CodeBuild image running x86-64 Linux.
This class has a bunch of public constants that represent the most popular images.
You can also specify a custom image using one of the static methods:
- LinuxBuildImage.fromDockerRegistry(image[, { secretsManagerCredentials }]) - LinuxBuildImage.fromEcrRepository(repo[, tag]) - LinuxBuildImage.fromAsset(parent, id, props)
See Also
https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-available.html
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[];
class LinuxGpuBuildImage
class LinuxGpuBuildImage implements IBindableBuildImage {}
A CodeBuild GPU image running Linux.
This class has public constants that represent the most popular GPU images from AWS Deep Learning Containers.
See Also
https://aws.amazon.com/releasenotes/available-deep-learning-containers-images
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[];
class PhaseChangeEvent
class PhaseChangeEvent {}
Event fields for the CodeBuild "phase change" event
See Also
https://docs.aws.amazon.com/codebuild/latest/userguide/sample-build-notifications.html#sample-build-notifications-ref
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
class PipelineProject
class PipelineProject extends Project {}
A convenience class for CodeBuild Projects that are used in CodePipeline.
constructor
constructor(scope: Construct, id: string, props?: PipelineProjectProps);
class Project
class Project extends ProjectBase {}
A representation of a CodeBuild Project.
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
class ReportGroup
class ReportGroup extends ReportGroupBase {}
The ReportGroup resource class.
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.
class Source
abstract class Source implements ISource {}
Source provider definition for a CodeBuild Project.
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.
method bitBucket
static bitBucket: (props: BitBucketSourceProps) => ISource;
method codeCommit
static codeCommit: (props: CodeCommitSourceProps) => ISource;
method gitHub
static gitHub: (props: GitHubSourceProps) => ISource;
method gitHubEnterprise
static gitHubEnterprise: (props: GitHubEnterpriseSourceProps) => ISource;
method s3
static s3: (props: S3SourceProps) => ISource;
class StateChangeEvent
class StateChangeEvent {}
Event fields for the CodeBuild "state change" event
See Also
https://docs.aws.amazon.com/codebuild/latest/userguide/sample-build-notifications.html#sample-build-notifications-ref
property buildId
static readonly buildId: string;
Return the build id
property buildStatus
static readonly buildStatus: string;
The triggering build's status
property currentPhase
static readonly currentPhase: string;
property projectName
static readonly projectName: string;
The triggering build's project name
class UntrustedCodeBoundaryPolicy
class UntrustedCodeBoundaryPolicy extends iam.ManagedPolicy {}
Permissions Boundary for a CodeBuild Project running untrusted code
This class is a Policy, intended to be used as a Permissions Boundary for a CodeBuild project. It allows most of the actions necessary to run the CodeBuild project, but disallows reading from Parameter Store and Secrets Manager.
Use this when your CodeBuild project is running untrusted code (for example, if you are using one to automatically build Pull Requests that anyone can submit), and you want to prevent your future self from accidentally exposing Secrets to this build.
(The reason you might want to do this is because otherwise anyone who can submit a Pull Request to your project can write a script to email those secrets to themselves).
Example 1
declare const project: codebuild.Project; iam.PermissionsBoundary.of(project).apply(new codebuild.UntrustedCodeBoundaryPolicy(this, 'Boundary'));
constructor
constructor( scope: Construct, id: string, props?: UntrustedCodeBoundaryPolicyProps);
class WindowsBuildImage
class WindowsBuildImage implements IBuildImage {}
A CodeBuild image running Windows.
This class has a bunch of public constants that represent the most popular images.
You can also specify a custom image using one of the static methods:
- WindowsBuildImage.fromDockerRegistry(image[, { secretsManagerCredentials }, imageType]) - WindowsBuildImage.fromEcrRepository(repo[, tag, imageType]) - WindowsBuildImage.fromAsset(parent, id, props, [, imageType])
See Also
https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-available.html
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;
property WIN_SERVER_CORE_2016_BASE
static readonly WIN_SERVER_CORE_2016_BASE: IBuildImage;
Corresponds to the standard CodeBuild image
aws/codebuild/windows-base:1.0
.Deprecated
WindowsBuildImage.WINDOWS_BASE_2_0
should be used instead.
property WIN_SERVER_CORE_2019_BASE
static readonly WIN_SERVER_CORE_2019_BASE: IBuildImage;
The standard CodeBuild image
aws/codebuild/windows-base:2019-1.0
, which is based off Windows Server Core 2019.
property WINDOWS_BASE_2_0
static readonly WINDOWS_BASE_2_0: IBuildImage;
The standard CodeBuild image
aws/codebuild/windows-base:2.0
, which is based off Windows Server Core 2016.
method fromAsset
static fromAsset: ( scope: Construct, id: string, props: DockerImageAssetProps, imageType?: WindowsImageType) => IBuildImage;
Uses an Docker image asset as a Windows build image.
method fromDockerRegistry
static fromDockerRegistry: ( name: string, options?: DockerImageOptions, imageType?: WindowsImageType) => IBuildImage;
Returns
a Windows build image from a Docker Hub image.
method fromEcrRepository
static fromEcrRepository: ( repository: ecr.IRepository, tagOrDigest?: string, imageType?: WindowsImageType) => IBuildImage;
Parameter repository
The ECR repository
Parameter tagOrDigest
Image tag or digest (default "latest", digests must start with
sha256:
)Returns
A Windows 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: BuildEnvironment) => string[];
Interfaces
interface ArtifactsConfig
interface ArtifactsConfig {}
The type returned from IArtifacts#bind.
property artifactsProperty
readonly artifactsProperty: CfnProject.ArtifactsProperty;
The low-level CloudFormation artifacts property.
interface ArtifactsProps
interface ArtifactsProps {}
Properties common to all Artifacts classes.
property identifier
readonly identifier?: string;
The artifact identifier. This property is required on secondary artifacts.
interface BatchBuildConfig
interface BatchBuildConfig {}
The type returned from IProject#enableBatchBuilds.
property role
readonly role: iam.IRole;
The IAM batch service Role of this Project.
interface BindToCodePipelineOptions
interface BindToCodePipelineOptions {}
The extra options passed to the IProject.bindToCodePipeline method.
property artifactBucket
readonly artifactBucket: s3.IBucket;
The artifact bucket that will be used by the action that invokes this project.
interface BitBucketSourceCredentialsProps
interface BitBucketSourceCredentialsProps {}
Construction properties of BitBucketSourceCredentials.
interface BitBucketSourceProps
interface BitBucketSourceProps extends ThirdPartyGitSourceProps {}
Construction properties for BitBucketSource.
property buildStatusName
readonly buildStatusName?: string;
This parameter is used for the
name
parameter in the Bitbucket commit status. Can use built-in CodeBuild variables, like $AWS_REGION.Example 1
"My build #$CODEBUILD_BUILD_NUMBER" "AWS CodeBuild $AWS_REGION ($PROJECT_NAME)"
See Also
https://docs.aws.amazon.com/codebuild/latest/userguide/create-project-cli.html#cli.source.buildstatusconfig.context
https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-env-vars.html
property owner
readonly owner: string;
The BitBucket account/user that owns the repo.
Example 1
'awslabs'
property repo
readonly repo: string;
The name of the repo (without the username).
Example 1
'aws-cdk'
interface BucketCacheOptions
interface BucketCacheOptions {}
property prefix
readonly prefix?: string;
The prefix to use to store the cache in the bucket
interface BuildEnvironment
interface BuildEnvironment {}
property buildImage
readonly buildImage?: IBuildImage;
The image used for the builds.
LinuxBuildImage.STANDARD_1_0
property certificate
readonly certificate?: BuildEnvironmentCertificate;
The location of the PEM-encoded certificate for the build project
- No external certificate is added to the project
property computeType
readonly computeType?: ComputeType;
The type of compute to use for this build. See the ComputeType enum for the possible values.
taken from
property environmentVariables
readonly environmentVariables?: { [name: string]: BuildEnvironmentVariable;};
The environment variables that your builds can use.
property privileged
readonly privileged?: boolean;
Indicates how the project builds Docker images. Specify true to enable running the Docker daemon inside a Docker container. This value must be set to true only if this build project will be used to build Docker images, and the specified build environment image is not one provided by AWS CodeBuild with Docker support. Otherwise, all associated builds that attempt to interact with the Docker daemon will fail.
false
interface BuildEnvironmentCertificate
interface BuildEnvironmentCertificate {}
Location of a PEM certificate on S3
interface BuildEnvironmentVariable
interface BuildEnvironmentVariable {}
property type
readonly type?: BuildEnvironmentVariableType;
The type of environment variable. PlainText
property value
readonly value: any;
The value of the environment variable. For plain-text variables (the default), this is the literal value of variable. For SSM parameter variables, pass the name of the parameter here (
parameterName
property ofIParameter
). For SecretsManager variables secrets, pass either the secret name (secretName
property ofISecret
) or the secret ARN (secretArn
property ofISecret
) here, along with optional SecretsManager qualifiers separated by ':', like the JSON key, or the version or stage (see https://docs.aws.amazon.com/codebuild/latest/userguide/build-spec-ref.html#build-spec.env.secrets-manager for details).
interface BuildImageBindOptions
interface BuildImageBindOptions {}
Optional arguments to IBuildImage.binder - currently empty.
interface BuildImageConfig
interface BuildImageConfig {}
The return type from IBuildImage.binder - currently empty.
interface CfnProjectProps
interface CfnProjectProps {}
Properties for defining a
CfnProject
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html
property artifacts
readonly artifacts: CfnProject.ArtifactsProperty | cdk.IResolvable;
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 badgeEnabled
readonly badgeEnabled?: boolean | cdk.IResolvable;
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 theSource
property, do not specify theBadgeEnabled
property.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-badgeenabled
property buildBatchConfig
readonly buildBatchConfig?: | CfnProject.ProjectBuildBatchConfigProperty | cdk.IResolvable;
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
readonly cache?: CfnProject.ProjectCacheProperty | cdk.IResolvable;
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 concurrentBuildLimit
readonly 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
readonly 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
readonly 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
readonly environment: CfnProject.EnvironmentProperty | cdk.IResolvable;
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
readonly fileSystemLocations?: | Array<CfnProject.ProjectFileSystemLocationProperty | cdk.IResolvable> | cdk.IResolvable;
An array of
ProjectFileSystemLocation
objects for a CodeBuild build project. AProjectFileSystemLocation
object specifies theidentifier
,location
,mountOptions
,mountPoint
, andtype
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
readonly logsConfig?: CfnProject.LogsConfigProperty | cdk.IResolvable;
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
readonly 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
readonly 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
readonly 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
readonly secondaryArtifacts?: | Array<CfnProject.ArtifactsProperty | cdk.IResolvable> | cdk.IResolvable;
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
readonly secondarySources?: | Array<CfnProject.SourceProperty | cdk.IResolvable> | cdk.IResolvable;
An array of
ProjectSource
objects.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-secondarysources
property secondarySourceVersions
readonly secondarySourceVersions?: | Array<CfnProject.ProjectSourceVersionProperty | cdk.IResolvable> | cdk.IResolvable;
An array of
ProjectSourceVersion
objects. IfsecondarySourceVersions
is specified at the build level, then they take over thesesecondarySourceVersions
(at the project level).http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-secondarysourceversions
property serviceRole
readonly 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
readonly source: CfnProject.SourceProperty | cdk.IResolvable;
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
readonly 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 examplepr/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 thissourceVersion
(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.CfnTag[];
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
readonly 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
readonly triggers?: CfnProject.ProjectTriggersProperty | cdk.IResolvable;
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
readonly 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
readonly vpcConfig?: CfnProject.VpcConfigProperty | cdk.IResolvable;
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
interface CfnReportGroupProps
interface CfnReportGroupProps {}
Properties for defining a
CfnReportGroup
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-reportgroup.html
property deleteReports
readonly deleteReports?: boolean | cdk.IResolvable;
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
readonly exportConfig: | CfnReportGroup.ReportExportConfigProperty | cdk.IResolvable;
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
readonly 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.CfnTag[];
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
readonly 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
interface CfnSourceCredentialProps
interface CfnSourceCredentialProps {}
Properties for defining a
CfnSourceCredential
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-sourcecredential.html
property authType
readonly 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 serverType
readonly 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
readonly 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
readonly 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
interface CloudWatchLoggingOptions
interface CloudWatchLoggingOptions {}
Information about logs built to a CloudWatch Log Group for a build project.
property enabled
readonly enabled?: boolean;
The current status of the logs in Amazon CloudWatch Logs for a build project
true
property logGroup
readonly logGroup?: logs.ILogGroup;
The Log Group to send logs to
- no log group specified
property prefix
readonly prefix?: string;
The prefix of the stream name of the Amazon CloudWatch Logs
- no prefix
interface CodeCommitSourceProps
interface CodeCommitSourceProps extends GitSourceProps {}
Construction properties for CodeCommitSource.
property repository
readonly repository: codecommit.IRepository;
interface CommonProjectProps
interface CommonProjectProps {}
property allowAllOutbound
readonly allowAllOutbound?: boolean;
Whether to allow the CodeBuild to send all network traffic
If set to false, you must individually add traffic rules to allow the CodeBuild project to connect to network targets.
Only used if 'vpc' is supplied.
true
property badge
readonly badge?: boolean;
Indicates whether AWS CodeBuild generates a publicly accessible URL for your project's build badge. For more information, see Build Badges Sample in the AWS CodeBuild User Guide.
false
property buildSpec
readonly buildSpec?: BuildSpec;
Filename or contents of buildspec in JSON format.
See Also
https://docs.aws.amazon.com/codebuild/latest/userguide/build-spec-ref.html#build-spec-ref-example
- Empty buildspec.
property cache
readonly cache?: Cache;
Caching strategy to use.
Cache.none
property checkSecretsInPlainTextEnvVariables
readonly checkSecretsInPlainTextEnvVariables?: boolean;
Whether to check for the presence of any secrets in the environment variables of the default type, BuildEnvironmentVariableType.PLAINTEXT. Since using a secret for the value of that kind of variable would result in it being displayed in plain text in the AWS Console, the construct will throw an exception if it detects a secret was passed there. Pass this property as false if you want to skip this validation, and keep using a secret in a plain text environment variable.
true
property concurrentBuildLimit
readonly concurrentBuildLimit?: number;
Maximum number of concurrent builds. Minimum value is 1 and maximum is account build limit.
- no explicit limit is set
property description
readonly description?: string;
A description of the project. Use the description to identify the purpose of the project.
- No description.
property encryptionKey
readonly encryptionKey?: kms.IKey;
Encryption key to use to read and write artifacts.
- The AWS-managed CMK for Amazon Simple Storage Service (Amazon S3) is used.
property environment
readonly environment?: BuildEnvironment;
Build environment to use for the build.
BuildEnvironment.LinuxBuildImage.STANDARD_1_0
property environmentVariables
readonly environmentVariables?: { [name: string]: BuildEnvironmentVariable;};
Additional environment variables to add to the build environment.
- No additional environment variables are specified.
property fileSystemLocations
readonly fileSystemLocations?: IFileSystemLocation[];
An 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.
- no file system locations
property grantReportGroupPermissions
readonly grantReportGroupPermissions?: boolean;
Add permissions to this project's role to create and use test report groups with name starting with the name of this project.
That is the standard report group that gets created when a simple name (in contrast to an ARN) is used in the 'reports' section of the buildspec of this project. This is usually harmless, but you can turn these off if you don't plan on using test reports in this project.
true
See Also
https://docs.aws.amazon.com/codebuild/latest/userguide/test-report-group-naming.html
property logging
readonly logging?: LoggingOptions;
Information about logs for the build project. A project can create logs in Amazon CloudWatch Logs, an S3 bucket, or both.
- no log configuration is set
property projectName
readonly projectName?: string;
The physical, human-readable name of the CodeBuild Project.
- Name is automatically generated.
property queuedTimeout
readonly queuedTimeout?: Duration;
The number of minutes after which AWS CodeBuild stops the build if it's still in queue. For valid values, see the timeoutInMinutes field in the AWS CodeBuild User Guide.
- no queue timeout is set
property role
readonly role?: iam.IRole;
Service Role to assume while running the build.
- A role will be created.
property securityGroups
readonly securityGroups?: ec2.ISecurityGroup[];
What security group to associate with the codebuild project's network interfaces. If no security group is identified, one will be created automatically.
Only used if 'vpc' is supplied.
- Security group will be automatically created.
property subnetSelection
readonly subnetSelection?: ec2.SubnetSelection;
Where to place the network interfaces within the VPC.
Only used if 'vpc' is supplied.
- All private subnets.
property timeout
readonly timeout?: Duration;
The number of minutes after which AWS CodeBuild stops the build if it's not complete. For valid values, see the timeoutInMinutes field in the AWS CodeBuild User Guide.
Duration.hours(1)
property vpc
readonly vpc?: ec2.IVpc;
VPC network to place codebuild network interfaces
Specify this if the codebuild project needs to access resources in a VPC.
- No VPC is specified.
interface DockerImageOptions
interface DockerImageOptions {}
The options when creating a CodeBuild Docker build image using LinuxBuildImage.fromDockerRegistry or WindowsBuildImage.fromDockerRegistry.
property secretsManagerCredentials
readonly secretsManagerCredentials?: secretsmanager.ISecret;
The credentials, stored in Secrets Manager, used for accessing the repository holding the image, if the repository is private.
no credentials will be used (we assume the repository is public)
interface EfsFileSystemLocationProps
interface EfsFileSystemLocationProps {}
Construction properties for EfsFileSystemLocation.
property identifier
readonly identifier: string;
The name used to access a file system created by Amazon EFS.
property location
readonly location: string;
A string that specifies the location of the file system, like Amazon EFS.
This value looks like
fs-abcd1234.efs.us-west-2.amazonaws.com:/my-efs-mount-directory
.
property mountOptions
readonly mountOptions?: string;
The mount options for a file system such as Amazon EFS. 'nfsvers=4.1,rsize=1048576,wsize=1048576,hard,timeo=600,retrans=2'.
property mountPoint
readonly mountPoint: string;
The location in the container where you mount the file system.
interface FileSystemConfig
interface FileSystemConfig {}
The type returned from IFileSystemLocation#bind.
property location
readonly location: CfnProject.ProjectFileSystemLocationProperty;
File system location wrapper property.
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-projectfilesystemlocation.html
interface GitHubEnterpriseSourceCredentialsProps
interface GitHubEnterpriseSourceCredentialsProps {}
Creation properties for GitHubEnterpriseSourceCredentials.
property accessToken
readonly accessToken: SecretValue;
The personal access token to use when contacting the instance of the GitHub Enterprise API.
interface GitHubEnterpriseSourceProps
interface GitHubEnterpriseSourceProps extends CommonGithubSourceProps {}
Construction properties for GitHubEnterpriseSource.
property httpsCloneUrl
readonly httpsCloneUrl: string;
The HTTPS URL of the repository in your GitHub Enterprise installation.
property ignoreSslErrors
readonly ignoreSslErrors?: boolean;
Whether to ignore SSL errors when connecting to the repository.
false
interface GitHubSourceCredentialsProps
interface GitHubSourceCredentialsProps {}
Creation properties for GitHubSourceCredentials.
property accessToken
readonly accessToken: SecretValue;
The personal access token to use when contacting the GitHub API.
interface GitHubSourceProps
interface GitHubSourceProps extends CommonGithubSourceProps {}
Construction properties for GitHubSource and GitHubEnterpriseSource.
interface IArtifacts
interface IArtifacts {}
The abstract interface of a CodeBuild build output. Implemented by Artifacts.
property identifier
readonly identifier?: string;
The artifact identifier. This property is required on secondary artifacts.
property type
readonly type: string;
The CodeBuild type of this artifact.
method bind
bind: (scope: CoreConstruct, project: IProject) => ArtifactsConfig;
Callback when an Artifacts class is used in a CodeBuild Project.
Parameter scope
a root Construct that allows creating new Constructs
Parameter project
the Project this Artifacts is used in
interface IBindableBuildImage
interface IBindableBuildImage extends IBuildImage {}
A variant of IBuildImage that allows binding to the project.
method bind
bind: ( scope: CoreConstruct, project: IProject, options: BuildImageBindOptions) => BuildImageConfig;
Function that allows the build image access to the construct tree.
interface IBuildImage
interface IBuildImage {}
Represents a Docker image used for the CodeBuild Project builds. Use the concrete subclasses, either: LinuxBuildImage or WindowsBuildImage.
property defaultComputeType
readonly defaultComputeType: ComputeType;
The default ComputeType to use with this image, if one was not specified in BuildEnvironment#computeType explicitly.
property imageId
readonly imageId: string;
The Docker image identifier that the build environment uses.
See Also
https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-available.html
property imagePullPrincipalType
readonly imagePullPrincipalType?: ImagePullPrincipalType;
The type of principal that CodeBuild will use to pull this build Docker image.
ImagePullPrincipalType.SERVICE_ROLE
property repository
readonly repository?: ecr.IRepository;
An optional ECR repository that the image is hosted in.
no repository
property secretsManagerCredentials
readonly secretsManagerCredentials?: secretsmanager.ISecret;
The secretsManagerCredentials for access to a private registry.
no credentials will be used
property type
readonly type: string;
The type of build environment.
method runScriptBuildspec
runScriptBuildspec: (entrypoint: string) => BuildSpec;
Make a buildspec to run the indicated script
method validate
validate: (buildEnvironment: BuildEnvironment) => string[];
Allows the image a chance to validate whether the passed configuration is correct.
Parameter buildEnvironment
the current build environment
interface IFileSystemLocation
interface IFileSystemLocation {}
The interface of a CodeBuild FileSystemLocation. Implemented by EfsFileSystemLocation.
method bind
bind: (scope: CoreConstruct, project: IProject) => FileSystemConfig;
Called by the project when a file system is added so it can perform binding operations on this file system location.
interface IProject
interface IProject extends IResource, iam.IGrantable, ec2.IConnectable, notifications.INotificationRuleSource {}
property projectArn
readonly projectArn: string;
The ARN of this Project.
property projectName
readonly projectName: string;
The human-visible name of this Project.
property role
readonly role?: iam.IRole;
The IAM service Role of this Project. Undefined for imported Projects.
method addToRolePolicy
addToRolePolicy: (policyStatement: iam.PolicyStatement) => void;
method enableBatchBuilds
enableBatchBuilds: () => BatchBuildConfig | undefined;
Enable batch builds.
Returns an object contining the batch service role if batch builds could be enabled.
method metric
metric: ( metricName: string, props?: cloudwatch.MetricOptions) => cloudwatch.Metric;
Parameter metricName
The name of the metric
Parameter props
Customization properties
Returns
a CloudWatch metric associated with this build project.
method metricBuilds
metricBuilds: (props?: cloudwatch.MetricOptions) => cloudwatch.Metric;
Measures the number of builds triggered.
Units: Count
Valid CloudWatch statistics: Sum
sum over 5 minutes
method metricDuration
metricDuration: (props?: cloudwatch.MetricOptions) => cloudwatch.Metric;
Measures the duration of all builds over time.
Units: Seconds
Valid CloudWatch statistics: Average (recommended), Maximum, Minimum
average over 5 minutes
method metricFailedBuilds
metricFailedBuilds: (props?: cloudwatch.MetricOptions) => cloudwatch.Metric;
Measures the number of builds that failed because of client error or because of a timeout.
Units: Count
Valid CloudWatch statistics: Sum
sum over 5 minutes
method metricSucceededBuilds
metricSucceededBuilds: (props?: cloudwatch.MetricOptions) => cloudwatch.Metric;
Measures the number of successful builds.
Units: Count
Valid CloudWatch statistics: Sum
sum over 5 minutes
method notifyOn
notifyOn: ( id: string, target: notifications.INotificationRuleTarget, options: ProjectNotifyOnOptions) => notifications.INotificationRule;
Defines a CodeStar Notification rule triggered when the project events emitted by you specified, it very similar to
onEvent
API.You can also use the methods
notifyOnBuildSucceeded
andnotifyOnBuildFailed
to define rules for these specific event emitted.Parameter id
The logical identifier of the CodeStar Notifications rule that will be created
Parameter target
The target to register for the CodeStar Notifications destination.
Parameter options
Customization options for CodeStar Notifications rule
Returns
CodeStar Notifications rule associated with this build project.
method notifyOnBuildFailed
notifyOnBuildFailed: ( id: string, target: notifications.INotificationRuleTarget, options?: notifications.NotificationRuleOptions) => notifications.INotificationRule;
Defines a CodeStar notification rule which triggers when a build fails.
method notifyOnBuildSucceeded
notifyOnBuildSucceeded: ( id: string, target: notifications.INotificationRuleTarget, options?: notifications.NotificationRuleOptions) => notifications.INotificationRule;
Defines a CodeStar notification rule which triggers when a build completes successfully.
method onBuildFailed
onBuildFailed: (id: string, options?: events.OnEventOptions) => events.Rule;
Defines an event rule which triggers when a build fails.
method onBuildStarted
onBuildStarted: (id: string, options?: events.OnEventOptions) => events.Rule;
Defines an event rule which triggers when a build starts.
method onBuildSucceeded
onBuildSucceeded: (id: string, options?: events.OnEventOptions) => events.Rule;
Defines an event rule which triggers when a build completes successfully.
method onEvent
onEvent: (id: string, options?: events.OnEventOptions) => events.Rule;
Defines a CloudWatch event rule triggered when something happens with this project.
See Also
https://docs.aws.amazon.com/codebuild/latest/userguide/sample-build-notifications.html
method onPhaseChange
onPhaseChange: (id: string, options?: events.OnEventOptions) => events.Rule;
Defines a CloudWatch event rule that triggers upon phase change of this build project.
See Also
https://docs.aws.amazon.com/codebuild/latest/userguide/sample-build-notifications.html
method onStateChange
onStateChange: (id: string, options?: events.OnEventOptions) => events.Rule;
Defines a CloudWatch event rule triggered when the build project state changes. You can filter specific build status events using an event pattern filter on the
build-status
detail field:const rule = project.onStateChange('OnBuildStarted', { target }); rule.addEventPattern({ detail: { 'build-status': [ "IN_PROGRESS", "SUCCEEDED", "FAILED", "STOPPED" ] } });
You can also use the methods
onBuildFailed
andonBuildSucceeded
to define rules for these specific state changes.To access fields from the event in the event target input, use the static fields on the
StateChangeEvent
class.See Also
https://docs.aws.amazon.com/codebuild/latest/userguide/sample-build-notifications.html
interface IReportGroup
interface IReportGroup extends cdk.IResource {}
The interface representing the ReportGroup resource - either an existing one, imported using the ReportGroup.fromReportGroupName method, or a new one, created with the ReportGroup class.
property reportGroupArn
readonly reportGroupArn: string;
The ARN of the ReportGroup.
property reportGroupName
readonly reportGroupName: string;
The name of the ReportGroup.
method grantWrite
grantWrite: (identity: iam.IGrantable) => iam.Grant;
Grants the given entity permissions to write (that is, upload reports to) this report group.
interface ISource
interface ISource {}
The abstract interface of a CodeBuild source. Implemented by Source.
property badgeSupported
readonly badgeSupported: boolean;
property identifier
readonly identifier?: string;
property type
readonly type: string;
method bind
bind: (scope: CoreConstruct, project: IProject) => SourceConfig;
interface LoggingOptions
interface LoggingOptions {}
Information about logs for the build project. A project can create logs in Amazon CloudWatch Logs, an S3 bucket, or both.
property cloudWatch
readonly cloudWatch?: CloudWatchLoggingOptions;
Information about Amazon CloudWatch Logs for a build project.
- enabled
property s3
readonly s3?: S3LoggingOptions;
Information about logs built to an S3 bucket for a build project.
- disabled
interface PipelineProjectProps
interface PipelineProjectProps extends CommonProjectProps {}
interface ProjectNotifyOnOptions
interface ProjectNotifyOnOptions extends notifications.NotificationRuleOptions {}
Additional options to pass to the notification rule.
property events
readonly events: ProjectNotificationEvents[];
A list of event types associated with this notification rule for CodeBuild Project. For a complete list of event types and IDs, see Notification concepts in the Developer Tools Console User Guide.
See Also
https://docs.aws.amazon.com/dtconsole/latest/userguide/concepts.html#concepts-api
interface ProjectProps
interface ProjectProps extends CommonProjectProps {}
property artifacts
readonly artifacts?: IArtifacts;
Defines where build artifacts will be stored. Could be: PipelineBuildArtifacts, NoArtifacts and S3Artifacts.
NoArtifacts
property secondaryArtifacts
readonly secondaryArtifacts?: IArtifacts[];
The secondary artifacts for the Project. Can also be added after the Project has been created by using the Project#addSecondaryArtifact method.
- No secondary artifacts.
See Also
https://docs.aws.amazon.com/codebuild/latest/userguide/sample-multi-in-out.html
property secondarySources
readonly secondarySources?: ISource[];
The secondary sources for the Project. Can be also added after the Project has been created by using the Project#addSecondarySource method.
- No secondary sources.
See Also
https://docs.aws.amazon.com/codebuild/latest/userguide/sample-multi-in-out.html
property source
readonly source?: ISource;
The source of the build. *Note*: if NoSource is given as the source, then you need to provide an explicit
buildSpec
.- NoSource
interface ReportGroupProps
interface ReportGroupProps {}
Construction properties for ReportGroup.
property exportBucket
readonly exportBucket?: s3.IBucket;
An optional S3 bucket to export the reports to.
- the reports will not be exported
property removalPolicy
readonly removalPolicy?: cdk.RemovalPolicy;
What to do when this resource is deleted from a stack. As CodeBuild does not allow deleting a ResourceGroup that has reports inside of it, this is set to retain the resource by default.
RemovalPolicy.RETAIN
property reportGroupName
readonly reportGroupName?: string;
The physical name of the report group.
- CloudFormation-generated name
property zipExport
readonly zipExport?: boolean;
Whether to output the report files into the export bucket as-is, or create a ZIP from them before doing the export. Ignored if exportBucket has not been provided.
- false (the files will not be ZIPped)
interface S3ArtifactsProps
interface S3ArtifactsProps extends ArtifactsProps {}
Construction properties for S3Artifacts.
property bucket
readonly bucket: s3.IBucket;
The name of the output bucket.
property encryption
readonly encryption?: boolean;
If this is false, build output will not be encrypted. This is useful if the artifact to publish a static website or sharing content with others
true - output will be encrypted
property includeBuildId
readonly includeBuildId?: boolean;
Indicates if the build ID should be included in the path. If this is set to true, then the build artifact will be stored in "//".
true
property name
readonly name?: string;
The name of the build output ZIP file or folder inside the bucket.
The full S3 object key will be "//" or "/" depending on whether
includeBuildId
is set to true.If not set,
overrideArtifactName
will be set and the name from the buildspec will be used instead.undefined, and use the name from the buildspec
property packageZip
readonly packageZip?: boolean;
If this is true, all build output will be packaged into a single .zip file. Otherwise, all files will be uploaded to /
true - files will be archived
property path
readonly path?: string;
The path inside of the bucket for the build output .zip file or folder. If a value is not specified, then build output will be stored at the root of the bucket (or under the directory if
includeBuildId
is set to true).the root of the bucket
interface S3LoggingOptions
interface S3LoggingOptions {}
Information about logs built to an S3 bucket for a build project.
property bucket
readonly bucket: s3.IBucket;
The S3 Bucket to send logs to
property enabled
readonly enabled?: boolean;
The current status of the logs in Amazon CloudWatch Logs for a build project
true
property encrypted
readonly encrypted?: boolean;
Encrypt the S3 build log output
true
property prefix
readonly prefix?: string;
The path prefix for S3 logs
- no prefix
interface S3SourceProps
interface S3SourceProps extends SourceProps {}
Construction properties for S3Source.
interface SourceConfig
interface SourceConfig {}
The type returned from ISource#bind.
property buildTriggers
readonly buildTriggers?: CfnProject.ProjectTriggersProperty;
property sourceProperty
readonly sourceProperty: CfnProject.SourceProperty;
property sourceVersion
readonly sourceVersion?: string;
AWS::CodeBuild::Project.SourceVersion
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-sourceversion the latest version
interface SourceProps
interface SourceProps {}
Properties common to all Source classes.
property identifier
readonly identifier?: string;
The source identifier. This property is required on secondary sources.
interface UntrustedCodeBoundaryPolicyProps
interface UntrustedCodeBoundaryPolicyProps {}
Construction properties for UntrustedCodeBoundaryPolicy
property additionalStatements
readonly additionalStatements?: iam.PolicyStatement[];
Additional statements to add to the default set of statements
- No additional statements
property managedPolicyName
readonly managedPolicyName?: string;
The name of the managed policy.
- A name is automatically generated.
Enums
enum BuildEnvironmentVariableType
enum BuildEnvironmentVariableType { PLAINTEXT = 'PLAINTEXT', PARAMETER_STORE = 'PARAMETER_STORE', SECRETS_MANAGER = 'SECRETS_MANAGER',}
member PARAMETER_STORE
PARAMETER_STORE = 'PARAMETER_STORE'
An environment variable stored in Systems Manager Parameter Store.
member PLAINTEXT
PLAINTEXT = 'PLAINTEXT'
An environment variable in plaintext format.
member SECRETS_MANAGER
SECRETS_MANAGER = 'SECRETS_MANAGER'
An environment variable stored in AWS Secrets Manager.
enum ComputeType
enum ComputeType { SMALL = 'BUILD_GENERAL1_SMALL', MEDIUM = 'BUILD_GENERAL1_MEDIUM', LARGE = 'BUILD_GENERAL1_LARGE', X2_LARGE = 'BUILD_GENERAL1_2XLARGE',}
Build machine compute type.
enum EventAction
enum EventAction { PUSH = 'PUSH', PULL_REQUEST_CREATED = 'PULL_REQUEST_CREATED', PULL_REQUEST_UPDATED = 'PULL_REQUEST_UPDATED', PULL_REQUEST_MERGED = 'PULL_REQUEST_MERGED', PULL_REQUEST_REOPENED = 'PULL_REQUEST_REOPENED',}
The types of webhook event actions.
member PULL_REQUEST_CREATED
PULL_REQUEST_CREATED = 'PULL_REQUEST_CREATED'
Creating a Pull Request.
member PULL_REQUEST_MERGED
PULL_REQUEST_MERGED = 'PULL_REQUEST_MERGED'
Merging a Pull Request.
member PULL_REQUEST_REOPENED
PULL_REQUEST_REOPENED = 'PULL_REQUEST_REOPENED'
Re-opening a previously closed Pull Request. Note that this event is only supported for GitHub and GitHubEnterprise sources.
member PULL_REQUEST_UPDATED
PULL_REQUEST_UPDATED = 'PULL_REQUEST_UPDATED'
Updating a Pull Request.
member PUSH
PUSH = 'PUSH'
A push (of a branch, or a tag) to the repository.
enum ImagePullPrincipalType
enum ImagePullPrincipalType { CODEBUILD = 'CODEBUILD', SERVICE_ROLE = 'SERVICE_ROLE',}
The type of principal CodeBuild will use to pull your build Docker image.
member CODEBUILD
CODEBUILD = 'CODEBUILD'
CODEBUILD specifies that CodeBuild uses its own identity when pulling the image. This means the resource policy of the ECR repository that hosts the image will be modified to trust CodeBuild's service principal. This is the required principal type when using CodeBuild's pre-defined images.
member SERVICE_ROLE
SERVICE_ROLE = 'SERVICE_ROLE'
SERVICE_ROLE specifies that AWS CodeBuild uses the project's role when pulling the image. The role will be granted pull permissions on the ECR repository hosting the image.
enum LocalCacheMode
enum LocalCacheMode { SOURCE = 'LOCAL_SOURCE_CACHE', DOCKER_LAYER = 'LOCAL_DOCKER_LAYER_CACHE', CUSTOM = 'LOCAL_CUSTOM_CACHE',}
Local cache modes to enable for the CodeBuild Project
member CUSTOM
CUSTOM = 'LOCAL_CUSTOM_CACHE'
Caches directories you specify in the buildspec file
member DOCKER_LAYER
DOCKER_LAYER = 'LOCAL_DOCKER_LAYER_CACHE'
Caches existing Docker layers
member SOURCE
SOURCE = 'LOCAL_SOURCE_CACHE'
Caches Git metadata for primary and secondary sources
enum ProjectNotificationEvents
enum ProjectNotificationEvents { BUILD_FAILED = 'codebuild-project-build-state-failed', BUILD_SUCCEEDED = 'codebuild-project-build-state-succeeded', BUILD_IN_PROGRESS = 'codebuild-project-build-state-in-progress', BUILD_STOPPED = 'codebuild-project-build-state-stopped', BUILD_PHASE_FAILED = 'codebuild-project-build-phase-failure', BUILD_PHASE_SUCCEEDED = 'codebuild-project-build-phase-success',}
The list of event types for AWS Codebuild
See Also
https://docs.aws.amazon.com/dtconsole/latest/userguide/concepts.html#events-ref-buildproject
member BUILD_FAILED
BUILD_FAILED = 'codebuild-project-build-state-failed'
Trigger notification when project build state failed
member BUILD_IN_PROGRESS
BUILD_IN_PROGRESS = 'codebuild-project-build-state-in-progress'
Trigger notification when project build state in progress
member BUILD_PHASE_FAILED
BUILD_PHASE_FAILED = 'codebuild-project-build-phase-failure'
Trigger notification when project build phase failure
member BUILD_PHASE_SUCCEEDED
BUILD_PHASE_SUCCEEDED = 'codebuild-project-build-phase-success'
Trigger notification when project build phase success
member BUILD_STOPPED
BUILD_STOPPED = 'codebuild-project-build-state-stopped'
Trigger notification when project build state stopped
member BUILD_SUCCEEDED
BUILD_SUCCEEDED = 'codebuild-project-build-state-succeeded'
Trigger notification when project build state succeeded
enum WindowsImageType
enum WindowsImageType { STANDARD = 'WINDOWS_CONTAINER', SERVER_2019 = 'WINDOWS_SERVER_2019_CONTAINER',}
Environment type for Windows Docker images
member SERVER_2019
SERVER_2019 = 'WINDOWS_SERVER_2019_CONTAINER'
The WINDOWS_SERVER_2019_CONTAINER environment type
member STANDARD
STANDARD = 'WINDOWS_CONTAINER'
The standard environment type, WINDOWS_CONTAINER
Namespaces
namespace CfnProject
namespace CfnProject {}
interface ArtifactsProperty
interface ArtifactsProperty {}
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.external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-artifacts.html
property artifactIdentifier
readonly artifactIdentifier?: string;
An identifier for this artifact definition.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-artifacts.html#cfn-codebuild-project-artifacts-artifactidentifier
property encryptionDisabled
readonly encryptionDisabled?: boolean | cdk.IResolvable;
Set to true if you do not want your output artifacts encrypted. This option is valid only if your artifacts type is Amazon Simple Storage Service (Amazon S3). If this is set with another artifacts type, an
invalidInputException
is thrown.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-artifacts.html#cfn-codebuild-project-artifacts-encryptiondisabled
property location
readonly location?: string;
Information about the build output artifact location:
- If
type
is set toCODEPIPELINE
, AWS CodePipeline ignores this value if specified. This is because CodePipeline manages its build output locations instead of CodeBuild . - Iftype
is set toNO_ARTIFACTS
, this value is ignored if specified, because no build output is produced. - Iftype
is set toS3
, this is the name of the output bucket.If you specify
CODEPIPELINE
orNO_ARTIFACTS
for theType
property, don't specify this property. For all of the other types, you must specify this property.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-artifacts.html#cfn-codebuild-project-artifacts-location
property name
readonly name?: string;
Along with
path
andnamespaceType
, the pattern that AWS CodeBuild uses to name and store the output artifact:- If
type
is set toCODEPIPELINE
, AWS CodePipeline ignores this value if specified. This is because CodePipeline manages its build output names instead of AWS CodeBuild . - Iftype
is set toNO_ARTIFACTS
, this value is ignored if specified, because no build output is produced. - Iftype
is set toS3
, this is the name of the output artifact object. If you set the name to be a forward slash ("/"), the artifact is stored in the root of the output bucket.For example:
- If
path
is set toMyArtifacts
,namespaceType
is set toBUILD_ID
, andname
is set toMyArtifact.zip
, then the output artifact is stored inMyArtifacts/ *build-ID* /MyArtifact.zip
. - Ifpath
is empty,namespaceType
is set toNONE
, andname
is set to "/
", the output artifact is stored in the root of the output bucket. - Ifpath
is set toMyArtifacts
,namespaceType
is set toBUILD_ID
, andname
is set to "/
", the output artifact is stored inMyArtifacts/ *build-ID*
.If you specify
CODEPIPELINE
orNO_ARTIFACTS
for theType
property, don't specify this property. For all of the other types, you must specify this property.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-artifacts.html#cfn-codebuild-project-artifacts-name
property namespaceType
readonly namespaceType?: string;
Along with
path
andname
, the pattern that AWS CodeBuild uses to determine the name and location to store the output artifact:- If
type
is set toCODEPIPELINE
, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output names instead of AWS CodeBuild . - Iftype
is set toNO_ARTIFACTS
, this value is ignored if specified, because no build output is produced. - Iftype
is set toS3
, valid values include:-
BUILD_ID
: Include the build ID in the location of the build output artifact. -NONE
: Do not include the build ID. This is the default ifnamespaceType
is not specified.For example, if
path
is set toMyArtifacts
,namespaceType
is set toBUILD_ID
, andname
is set toMyArtifact.zip
, the output artifact is stored inMyArtifacts/<build-ID>/MyArtifact.zip
.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-artifacts.html#cfn-codebuild-project-artifacts-namespacetype
property overrideArtifactName
readonly overrideArtifactName?: boolean | cdk.IResolvable;
If set to true a name specified in the buildspec file overrides the artifact name. The name specified in a buildspec file is calculated at build time and uses the Shell command language. For example, you can append a date and time to your artifact name so that it is always unique.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-artifacts.html#cfn-codebuild-project-artifacts-overrideartifactname
property packaging
readonly packaging?: string;
The type of build output artifact to create:
- If
type
is set toCODEPIPELINE
, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output artifacts instead of AWS CodeBuild . - Iftype
is set toNO_ARTIFACTS
, this value is ignored if specified, because no build output is produced. - Iftype
is set toS3
, valid values include:-
NONE
: AWS CodeBuild creates in the output bucket a folder that contains the build output. This is the default ifpackaging
is not specified. -ZIP
: AWS CodeBuild creates in the output bucket a ZIP file that contains the build output.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-artifacts.html#cfn-codebuild-project-artifacts-packaging
property path
readonly path?: string;
Along with
namespaceType
andname
, the pattern that AWS CodeBuild uses to name and store the output artifact:- If
type
is set toCODEPIPELINE
, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output names instead of AWS CodeBuild . - Iftype
is set toNO_ARTIFACTS
, this value is ignored if specified, because no build output is produced. - Iftype
is set toS3
, this is the path to the output artifact. Ifpath
is not specified,path
is not used.For example, if
path
is set toMyArtifacts
,namespaceType
is set toNONE
, andname
is set toMyArtifact.zip
, the output artifact is stored in the output bucket atMyArtifacts/MyArtifact.zip
.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-artifacts.html#cfn-codebuild-project-artifacts-path
property type
readonly type: string;
The type of build output artifact. Valid values include:
-
CODEPIPELINE
: The build project has build output generated through CodePipeline.> The
CODEPIPELINE
type is not supported forsecondaryArtifacts
. -NO_ARTIFACTS
: The build project does not produce any build output. -S3
: The build project stores build output in Amazon S3.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-artifacts.html#cfn-codebuild-project-artifacts-type
interface BatchRestrictionsProperty
interface BatchRestrictionsProperty {}
Specifies restrictions for the batch build.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-batchrestrictions.html
property computeTypesAllowed
readonly computeTypesAllowed?: string[];
An array of strings that specify the compute types that are allowed for the batch build. See [Build environment compute types](https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-compute-types.html) in the *AWS CodeBuild User Guide* for these values.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-batchrestrictions.html#cfn-codebuild-project-batchrestrictions-computetypesallowed
property maximumBuildsAllowed
readonly maximumBuildsAllowed?: number;
Specifies the maximum number of builds allowed.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-batchrestrictions.html#cfn-codebuild-project-batchrestrictions-maximumbuildsallowed
interface BuildStatusConfigProperty
interface BuildStatusConfigProperty {}
Contains information that defines how the AWS CodeBuild build project reports the build status to the source provider.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-buildstatusconfig.html
property context
readonly context?: string;
Specifies the context of the build status CodeBuild sends to the source provider. The usage of this parameter depends on the source provider.
- **Bitbucket** - This parameter is used for the
name
parameter in the Bitbucket commit status. For more information, see [build](https://docs.aws.amazon.com/https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories/%7Bworkspace%7D/%7Brepo_slug%7D/commit/%7Bnode%7D/statuses/build) in the Bitbucket API documentation. - **GitHub/GitHub Enterprise Server** - This parameter is used for thecontext
parameter in the GitHub commit status. For more information, see [Create a commit status](https://docs.aws.amazon.com/https://developer.github.com/v3/repos/statuses/#create-a-commit-status) in the GitHub developer guide.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-buildstatusconfig.html#cfn-codebuild-project-buildstatusconfig-context
property targetUrl
readonly targetUrl?: string;
Specifies the target url of the build status CodeBuild sends to the source provider. The usage of this parameter depends on the source provider.
- **Bitbucket** - This parameter is used for the
url
parameter in the Bitbucket commit status. For more information, see [build](https://docs.aws.amazon.com/https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories/%7Bworkspace%7D/%7Brepo_slug%7D/commit/%7Bnode%7D/statuses/build) in the Bitbucket API documentation. - **GitHub/GitHub Enterprise Server** - This parameter is used for thetarget_url
parameter in the GitHub commit status. For more information, see [Create a commit status](https://docs.aws.amazon.com/https://developer.github.com/v3/repos/statuses/#create-a-commit-status) in the GitHub developer guide.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-buildstatusconfig.html#cfn-codebuild-project-buildstatusconfig-targeturl
interface CloudWatchLogsConfigProperty
interface CloudWatchLogsConfigProperty {}
CloudWatchLogs
is a property of the [AWS CodeBuild Project LogsConfig](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-logsconfig.html) property type that specifies settings for CloudWatch logs generated by an AWS CodeBuild build.external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-cloudwatchlogsconfig.html
property groupName
readonly groupName?: string;
The group name of the logs in CloudWatch Logs. For more information, see [Working with Log Groups and Log Streams](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html) .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-cloudwatchlogsconfig.html#cfn-codebuild-project-cloudwatchlogsconfig-groupname
property status
readonly status: string;
The current status of the logs in CloudWatch Logs for a build project. Valid values are:
-
ENABLED
: CloudWatch Logs are enabled for this build project. -DISABLED
: CloudWatch Logs are not enabled for this build project.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-cloudwatchlogsconfig.html#cfn-codebuild-project-cloudwatchlogsconfig-status
property streamName
readonly streamName?: string;
The prefix of the stream name of the CloudWatch Logs. For more information, see [Working with Log Groups and Log Streams](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html) .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-cloudwatchlogsconfig.html#cfn-codebuild-project-cloudwatchlogsconfig-streamname
interface EnvironmentProperty
interface EnvironmentProperty {}
Environment
is a property of the [AWS::CodeBuild::Project](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html) resource that specifies the environment for an AWS CodeBuild project.external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-environment.html
property certificate
readonly certificate?: string;
The ARN of the Amazon S3 bucket, path prefix, and object key that contains the PEM-encoded certificate for the build project. For more information, see [certificate](https://docs.aws.amazon.com/codebuild/latest/userguide/create-project-cli.html#cli.environment.certificate) in the *AWS CodeBuild User Guide* .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-environment.html#cfn-codebuild-project-environment-certificate
property computeType
readonly computeType: string;
The type of compute environment. This determines the number of CPU cores and memory the build environment uses. Available values include:
-
BUILD_GENERAL1_SMALL
: Use up to 3 GB memory and 2 vCPUs for builds. -BUILD_GENERAL1_MEDIUM
: Use up to 7 GB memory and 4 vCPUs for builds. -BUILD_GENERAL1_LARGE
: Use up to 15 GB memory and 8 vCPUs for builds.For more information, see [Build Environment Compute Types](https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-compute-types.html) in the *AWS CodeBuild User Guide.*
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-environment.html#cfn-codebuild-project-environment-computetype
property environmentVariables
readonly environmentVariables?: | Array<CfnProject.EnvironmentVariableProperty | cdk.IResolvable> | cdk.IResolvable;
A set of environment variables to make available to builds for this build project.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-environment.html#cfn-codebuild-project-environment-environmentvariables
property image
readonly image: string;
The image tag or image digest that identifies the Docker image to use for this build project. Use the following formats:
- For an image tag:
<registry>/<repository>:<tag>
. For example, in the Docker repository that CodeBuild uses to manage its Docker images, this would beaws/codebuild/standard:4.0
. - For an image digest:<registry>/<repository>@<digest>
. For example, to specify an image with the digest "sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf," use<registry>/<repository>@sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf
.For more information, see [Docker images provided by CodeBuild](https://docs.aws.amazon.com//codebuild/latest/userguide/build-env-ref-available.html) in the *AWS CodeBuild user guide* .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-environment.html#cfn-codebuild-project-environment-image
property imagePullCredentialsType
readonly imagePullCredentialsType?: string;
The type of credentials AWS CodeBuild uses to pull images in your build. There are two valid values:
-
CODEBUILD
specifies that AWS CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust AWS CodeBuild service principal. -SERVICE_ROLE
specifies that AWS CodeBuild uses your build project's service role.When you use a cross-account or private registry image, you must use SERVICE_ROLE credentials. When you use an AWS CodeBuild curated image, you must use CODEBUILD credentials.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-environment.html#cfn-codebuild-project-environment-imagepullcredentialstype
property privilegedMode
readonly privilegedMode?: boolean | cdk.IResolvable;
Enables running the Docker daemon inside a Docker container. Set to true only if the build project is used to build Docker images. Otherwise, a build that attempts to interact with the Docker daemon fails. The default setting is
false
.You can initialize the Docker daemon during the install phase of your build by adding one of the following sets of commands to the install phase of your buildspec file:
If the operating system's base image is Ubuntu Linux:
- nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay&
- timeout 15 sh -c "until docker info; do echo .; sleep 1; done"
If the operating system's base image is Alpine Linux and the previous command does not work, add the
-t
argument totimeout
:- nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay&
- timeout -t 15 sh -c "until docker info; do echo .; sleep 1; done"
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-environment.html#cfn-codebuild-project-environment-privilegedmode
property registryCredential
readonly registryCredential?: | CfnProject.RegistryCredentialProperty | cdk.IResolvable;
RegistryCredential
is a property of the [AWS::CodeBuild::Project Environment](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-environment) property that specifies information about credentials that provide access to a private Docker registry. When this is set:-
imagePullCredentialsType
must be set toSERVICE_ROLE
. - images cannot be curated or an Amazon ECR image.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-environment.html#cfn-codebuild-project-environment-registrycredential
property type
readonly type: string;
The type of build environment to use for related builds.
- The environment type
ARM_CONTAINER
is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), Asia Pacific (Mumbai), Asia Pacific (Tokyo), Asia Pacific (Sydney), and EU (Frankfurt). - The environment typeLINUX_CONTAINER
with compute typebuild.general1.2xlarge
is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), Canada (Central), EU (Ireland), EU (London), EU (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Seoul), Asia Pacific (Singapore), Asia Pacific (Sydney), China (Beijing), and China (Ningxia). - The environment typeLINUX_GPU_CONTAINER
is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), Canada (Central), EU (Ireland), EU (London), EU (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Seoul), Asia Pacific (Singapore), Asia Pacific (Sydney) , China (Beijing), and China (Ningxia).- The environment types
WINDOWS_CONTAINER
andWINDOWS_SERVER_2019_CONTAINER
are available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), and EU (Ireland).For more information, see [Build environment compute types](https://docs.aws.amazon.com//codebuild/latest/userguide/build-env-ref-compute-types.html) in the *AWS CodeBuild user guide* .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-environment.html#cfn-codebuild-project-environment-type
interface EnvironmentVariableProperty
interface EnvironmentVariableProperty {}
EnvironmentVariable
is a property of the [AWS CodeBuild Project Environment](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-environment.html) property type that specifies the name and value of an environment variable for an AWS CodeBuild project environment. When you use the environment to run a build, these variables are available for your builds to use.EnvironmentVariable
contains a list ofEnvironmentVariable
property types.external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-environmentvariable.html
property name
readonly name: string;
The name or key of the environment variable.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-environmentvariable.html#cfn-codebuild-project-environmentvariable-name
property type
readonly type?: string;
The type of environment variable. Valid values include:
-
PARAMETER_STORE
: An environment variable stored in Systems Manager Parameter Store. For environment variables of this type, specify the name of the parameter as thevalue
of the EnvironmentVariable. The parameter value will be substituted for the name at runtime. You can also define Parameter Store environment variables in the buildspec. To learn how to do so, see [env/parameter-store](https://docs.aws.amazon.com/codebuild/latest/userguide/build-spec-ref.html#build-spec.env.parameter-store) in the *AWS CodeBuild User Guide* . -PLAINTEXT
: An environment variable in plain text format. This is the default value. -SECRETS_MANAGER
: An environment variable stored in AWS Secrets Manager . For environment variables of this type, specify the name of the secret as thevalue
of the EnvironmentVariable. The secret value will be substituted for the name at runtime. You can also define AWS Secrets Manager environment variables in the buildspec. To learn how to do so, see [env/secrets-manager](https://docs.aws.amazon.com/codebuild/latest/userguide/build-spec-ref.html#build-spec.env.secrets-manager) in the *AWS CodeBuild User Guide* .http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-environmentvariable.html#cfn-codebuild-project-environmentvariable-type
property value
readonly value: string;
The value of the environment variable.
> We strongly discourage the use of
PLAINTEXT
environment variables to store sensitive values, especially AWS secret key IDs and secret access keys.PLAINTEXT
environment variables can be displayed in plain text using the AWS CodeBuild console and the AWS CLI . For sensitive values, we recommend you use an environment variable of typePARAMETER_STORE
orSECRETS_MANAGER
.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-environmentvariable.html#cfn-codebuild-project-environmentvariable-value
interface GitSubmodulesConfigProperty
interface GitSubmodulesConfigProperty {}
GitSubmodulesConfig
is a property of the [AWS CodeBuild Project Source](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-source.html) property type that specifies information about the Git submodules configuration for the build project.external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-gitsubmodulesconfig.html
property fetchSubmodules
readonly fetchSubmodules: boolean | cdk.IResolvable;
Set to true to fetch Git submodules for your AWS CodeBuild build project.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-gitsubmodulesconfig.html#cfn-codebuild-project-gitsubmodulesconfig-fetchsubmodules
interface LogsConfigProperty
interface LogsConfigProperty {}
LogsConfig
is a property of the [AWS CodeBuild Project](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html) resource that specifies information about logs for a build project. These can be logs in Amazon CloudWatch Logs, built in a specified S3 bucket, or both.external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-logsconfig.html
property cloudWatchLogs
readonly cloudWatchLogs?: | CfnProject.CloudWatchLogsConfigProperty | cdk.IResolvable;
Information about CloudWatch Logs for a build project. CloudWatch Logs are enabled by default.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-logsconfig.html#cfn-codebuild-project-logsconfig-cloudwatchlogs
property s3Logs
readonly s3Logs?: CfnProject.S3LogsConfigProperty | cdk.IResolvable;
Information about logs built to an S3 bucket for a build project. S3 logs are not enabled by default.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-logsconfig.html#cfn-codebuild-project-logsconfig-s3logs
interface ProjectBuildBatchConfigProperty
interface ProjectBuildBatchConfigProperty {}
Contains configuration information about a batch build project.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-projectbuildbatchconfig.html
property batchReportMode
readonly batchReportMode?: string;
Specifies how build status reports are sent to the source provider for the batch build. This property is only used when the source provider for your project is Bitbucket, GitHub, or GitHub Enterprise, and your project is configured to report build statuses to the source provider.
- **REPORT_AGGREGATED_BATCH** - (Default) Aggregate all of the build statuses into a single status report. - **REPORT_INDIVIDUAL_BUILDS** - Send a separate status report for each individual build.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-projectbuildbatchconfig.html#cfn-codebuild-project-projectbuildbatchconfig-batchreportmode
property combineArtifacts
readonly combineArtifacts?: boolean | cdk.IResolvable;
Specifies if the build artifacts for the batch build should be combined into a single artifact location.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-projectbuildbatchconfig.html#cfn-codebuild-project-projectbuildbatchconfig-combineartifacts
property restrictions
readonly restrictions?: CfnProject.BatchRestrictionsProperty | cdk.IResolvable;
A
BatchRestrictions
object that specifies the restrictions for the batch build.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-projectbuildbatchconfig.html#cfn-codebuild-project-projectbuildbatchconfig-restrictions
property serviceRole
readonly serviceRole?: string;
Specifies the service role ARN for the batch build project.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-projectbuildbatchconfig.html#cfn-codebuild-project-projectbuildbatchconfig-servicerole
property timeoutInMins
readonly timeoutInMins?: number;
Specifies the maximum amount of time, in minutes, that the batch build must be completed in.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-projectbuildbatchconfig.html#cfn-codebuild-project-projectbuildbatchconfig-timeoutinmins
interface ProjectCacheProperty
interface ProjectCacheProperty {}
ProjectCache
is a property of the [AWS CodeBuild Project](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html) resource that specifies information about the cache for the build project. IfProjectCache
is not specified, then both of its properties default toNO_CACHE
.external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-projectcache.html