API.md

API Reference

Constructs

CodePipelineBitbucketBuildResultReporter

A CDK construct for reporting CodePipeline build statuses to a BitBucket server using BitBucket REST API.

You need to configure SSM parameter BITBUCKET_UPDATE_BUILD_STATUS_TOKEN before using the construct.

Initializers

import { CodePipelineBitbucketBuildResultReporter } from 'cdk-codepipeline-bitbucket-build-result-reporter'

new CodePipelineBitbucketBuildResultReporter(scope: Construct, id: string, props: CodePipelineBitbucketBuildResultReporterProps)

scope^Required

• Type: constructs.Construct

---

id^Required

• Type: string

---

props^Required

• Type: cdk-codepipeline-bitbucket-build-result-reporter.CodePipelineBitbucketBuildResultReporterProps

---

Structs

CodePipelineBitbucketBuildResultReporterProps

Common properties.

Initializer

import { CodePipelineBitbucketBuildResultReporterProps } from 'cdk-codepipeline-bitbucket-build-result-reporter'

const codePipelineBitbucketBuildResultReporterProps: CodePipelineBitbucketBuildResultReporterProps = { ... }

bitbucketServerAddress^Required

public readonly bitbucketServerAddress: string;

• Type: string

The BitBucket server address.

---

bitbucketAccessTokenName^Optional

public readonly bitbucketAccessTokenName: string;

• Type: string
• Default: BITBUCKET_UPDATE_BUILD_STATUS_TOKEN

The SSM parameter (SecureString) name that contains the BitBucket access token for reporting build statuses.

---

vpc^Optional

public readonly vpc: VpcAttributes;

• Type: aws-cdk-lib.aws_ec2.VpcAttributes

The VPC in which to run the status reporter.

---