Skip to content
v2.276.0

BuildStatusConfigProperty Struct ​

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

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',
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_codebuild as codebuild

build_status_config_property = codebuild.CfnProject.BuildStatusConfigProperty(
    context="context",
    target_url="targetUrl"
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.codebuild.*;

BuildStatusConfigProperty buildStatusConfigProperty = BuildStatusConfigProperty.builder()
        .context("context")
        .targetUrl("targetUrl")
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.CodeBuild;

var buildStatusConfigProperty = new BuildStatusConfigProperty {
    Context = "context",
    TargetUrl = "targetUrl"
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

buildStatusConfigProperty := &BuildStatusConfigProperty{
	Context: jsii.String("context"),
	TargetUrl: jsii.String("targetUrl"),
}

Properties ​

contextoptionalstringcontextoptionalstrcontextoptionalStringContextoptionalstringContextoptional*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.
targetUrloptionalstringtarget_urloptionalstrtargetUrloptionalStringTargetUrloptionalstringTargetUrloptional*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.