AWS CDK Reference

Appearance

v2.273.0

BuildStatusConfigProperty Struct ​

Contains information that defines how the AWS CodeBuild build project reports the build status to the source provider.

Source
Generated code
Type last changed
v2.93.0 · 23 Aug 2023

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_codebuild as codebuild } from 'aws-cdk-lib';
const buildStatusConfigProperty: codebuild.CfnProject.BuildStatusConfigProperty = {
  context: 'context',
  targetUrl: 'targetUrl',
};

Properties ​

contextstringcontextstrcontextStringContextstringContext*string#
Specifies the context of the build status CodeBuild sends to the source provider.
notes

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 in the Bitbucket API documentation.
  • GitHub/GitHub Enterprise Server - This parameter is used for the context parameter in the GitHub commit status. For more information, see Create a commit status in the GitHub developer guide.
targetUrlstringtarget_urlstrtargetUrlStringTargetUrlstringTargetUrl*string#
Specifies the target url of the build status CodeBuild sends to the source provider.
notes

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 in the Bitbucket API documentation.
  • GitHub/GitHub Enterprise Server - This parameter is used for the target_url parameter in the GitHub commit status. For more information, see Create a commit status in the GitHub developer guide.