Viewing docs for Buildkite v3.4.0
published on Wednesday, May 13, 2026 by Pulumiverse
published on Wednesday, May 13, 2026 by Pulumiverse
Buildkite: Installation & Configuration
I want to use the Pulumi Buildkite package (buildkite) in my project.
## Provider details
- Package: buildkite
- Version: v3.4.0
- Publisher: Pulumiverse
- Source: pulumi
- Repository: https://github.com/pulumiverse/pulumi-buildkite
## Documentation
The Pulumi Cloud Registry API serves canonical, up-to-date docs for this package — including private packages and every published version. Send the "Accept: text/markdown" header for clean readable content, or "application/json" for structured data.
Start at the navigation tree, which cross-links to the readme, installation guide, and per-resource docs URL template:
- https://api.pulumi.com/api/registry/packages/pulumi/pulumiverse/buildkite/versions/latest/nav
Returns a summary by default. The full tree can be hundreds of kB for large providers, so prefer targeted search: append "?q=<query>&depth=full" to filter by resource/function title or token (for example "?q=bucket&depth=full"). Only request the full nav without a query if you actually need to enumerate every resource.
Other endpoints:
- Overview and getting started: https://api.pulumi.com/api/registry/packages/pulumi/pulumiverse/buildkite/versions/latest/readme
- Installation and configuration: https://api.pulumi.com/api/registry/packages/pulumi/pulumiverse/buildkite/versions/latest/installation
- Per-resource/function docs: https://api.pulumi.com/api/registry/packages/pulumi/pulumiverse/buildkite/versions/latest/docs/{token}?lang={lang}
Replace {token} with the percent-encoded token from the nav response (for example aws:s3/bucket:Bucket).
Replace {lang} with typescript, python, go, csharp, java, or yaml.
Fetch the installation endpoint above for the correct setup steps — install instructions vary between native providers, bridged Terraform providers, and component packages.
Help me get started using this provider. Show me a complete Pulumi program that provisions a common resource, including all necessary configuration and imports.
Viewing docs for Buildkite v3.4.0
published on Wednesday, May 13, 2026 by Pulumiverse
published on Wednesday, May 13, 2026 by Pulumiverse
Installation
The Buildkite provider is available as a package in all Pulumi languages:
- JavaScript/TypeScript:
@pulumiverse/buildkite - Python:
pulumiverse-buildkite - Go:
https://pkg.go.dev/github.com/pulumiverse/pulumi-buildkite/sdk/v2/go/buildkite - .NET:
Pulumiverse.Buildkite
Setup
To provision resources with the Pulumi Buildkite provider, you need to have Buildkite credentials.
Configuration Options
Pulumi relies on the Buildkite API to authenticate requests from your computer to Buildkite. Your credentials are never sent to pulumi.com. The Pulumi Buildkite Provider needs to be configured with a Buildkite token before it can be used to create resources.
Use pulumi config set buildkite:<option> or pass options to the constructor of new buildkite.Provider.
| Option | Required/Optional | Description |
|---|---|---|
apiToken | Required | A Buildkite API Access Token. Can be configured from the environment variable BUILDKITE_API_TOKEN. Must have GraphQL access, as well as the write_pipelines and read_pipelines scopes. |
archivePipelineOnDelete | Optional | Enable this to archive pipelines when destroying the resource. This is opposed to completely deleting pipelines. |
organization | Required | The Buildkite organization slug. Can be configured from the environment variable BUILDKITE_ORGANIZATION. |
graphqlUrl | Optional | The Buildkite GraphQL URL. Can be configured from the environment variable BUILDKITE_GRAPHQL_URL. |
restUrl | Optional | The Buildkite REST URL. Can be configured from the environment variable BUILDKITE_REST_URL. |
timeouts | Optional | A Timeout object (see below) |
Timeout Object
| Field | Description |
|---|---|
create | A string that can be parsed as a duration consisting of numbers and unit suffixes, such as “30s” or “2h45m”. Valid time units are “s” (seconds), “m” (minutes), “h” (hours). |
delete | Value as above. Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs. |
read | Value as above. Read operations occur during any refresh or planning operation when refresh is enabled. |
update | Value as above. |
Viewing docs for Buildkite v3.4.0
published on Wednesday, May 13, 2026 by Pulumiverse
published on Wednesday, May 13, 2026 by Pulumiverse
