Heroku v1.0.4, Apr 8 25

Heroku v1.0.4 published on Tuesday, Apr 8, 2025 by pulumiverse - Marcel Arns

heroku.build.Build

Explore with Pulumi AI

Heroku v1.0.4 published on Tuesday, Apr 8, 2025 by pulumiverse - Marcel Arns

pulumiverse/pulumi-heroku

Import

Existing builds can be imported using the combination of the application name, a colon, and the build ID.

For example:

$ pulumi import heroku:build/build:Build foobar bazbux:4f1db8ef-ed5c-4c42-a3d6-3c28262d5abc

foobar is the heroku_build resource’s name
bazbux is the Heroku app name (or ID) that the build belongs to
: separates the app identifier & the build identifier
4f1db8ef… is the build ID

Create Build Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Build(name: string, args: BuildArgs, opts?: CustomResourceOptions);

@overload
def Build(resource_name: str,
          args: BuildArgs,
          opts: Optional[ResourceOptions] = None)

@overload
def Build(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          app_id: Optional[str] = None,
          source: Optional[BuildSourceArgs] = None,
          buildpacks: Optional[Sequence[str]] = None)

func NewBuild(ctx *Context, name string, args BuildArgs, opts ...ResourceOption) (*Build, error)

public Build(string name, BuildArgs args, CustomResourceOptions? opts = null)

public Build(String name, BuildArgs args)
public Build(String name, BuildArgs args, CustomResourceOptions options)

type: heroku:build:Build
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args BuildArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args BuildArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args BuildArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args BuildArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args BuildArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var buildResource = new Heroku.Build.Build("buildResource", new()
{
    AppId = "string",
    Source = new Heroku.Build.Inputs.BuildSourceArgs
    {
        Checksum = "string",
        Path = "string",
        Url = "string",
        Version = "string",
    },
    Buildpacks = new[]
    {
        "string",
    },
});

example, err := build.NewBuild(ctx, "buildResource", &build.BuildArgs{
	AppId: pulumi.String("string"),
	Source: &build.BuildSourceArgs{
		Checksum: pulumi.String("string"),
		Path:     pulumi.String("string"),
		Url:      pulumi.String("string"),
		Version:  pulumi.String("string"),
	},
	Buildpacks: pulumi.StringArray{
		pulumi.String("string"),
	},
})

var buildResource = new Build("buildResource", BuildArgs.builder()
    .appId("string")
    .source(BuildSourceArgs.builder()
        .checksum("string")
        .path("string")
        .url("string")
        .version("string")
        .build())
    .buildpacks("string")
    .build());

build_resource = heroku.build.Build("buildResource",
    app_id="string",
    source={
        "checksum": "string",
        "path": "string",
        "url": "string",
        "version": "string",
    },
    buildpacks=["string"])

const buildResource = new heroku.build.Build("buildResource", {
    appId: "string",
    source: {
        checksum: "string",
        path: "string",
        url: "string",
        version: "string",
    },
    buildpacks: ["string"],
});

type: heroku:build:Build
properties:
    appId: string
    buildpacks:
        - string
    source:
        checksum: string
        path: string
        url: string
        version: string

Build Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Build resource accepts the following input properties:

AppId string: Heroku app ID (do not use app name)
Source Pulumiverse.Heroku.Build.Inputs.BuildSource: A block that specifies the source code to build & release:
Buildpacks List<string>: List of buildpack GitHub URLs

AppId string: Heroku app ID (do not use app name)
Source BuildSourceArgs: A block that specifies the source code to build & release:
Buildpacks []string: List of buildpack GitHub URLs

appId String: Heroku app ID (do not use app name)
source BuildSource: A block that specifies the source code to build & release:
buildpacks List<String>: List of buildpack GitHub URLs

appId string: Heroku app ID (do not use app name)
source BuildSource: A block that specifies the source code to build & release:
buildpacks string[]: List of buildpack GitHub URLs

app_id str: Heroku app ID (do not use app name)
source BuildSourceArgs: A block that specifies the source code to build & release:
buildpacks Sequence[str]: List of buildpack GitHub URLs

appId String: Heroku app ID (do not use app name)
source Property Map: A block that specifies the source code to build & release:
buildpacks List<String>: List of buildpack GitHub URLs

Outputs

All input properties are implicitly available as output properties. Additionally, the Build resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.
LocalChecksum string
OutputStreamUrl string: URL that streams the log output from the build
ReleaseId string: The Heroku app release created with a build's slug
SlugId string: The Heroku slug created by a build
Stack string: Name or ID of the Heroku stack
Status string: The status of a build. Possible values are pending, successful and failed
Users List<Pulumiverse.Heroku.Build.Outputs.BuildUser>: Heroku account that created a build
Uuid string: The ID of the build

Id string: The provider-assigned unique ID for this managed resource.
LocalChecksum string
OutputStreamUrl string: URL that streams the log output from the build
ReleaseId string: The Heroku app release created with a build's slug
SlugId string: The Heroku slug created by a build
Stack string: Name or ID of the Heroku stack
Status string: The status of a build. Possible values are pending, successful and failed
Users []BuildUser: Heroku account that created a build
Uuid string: The ID of the build

id String: The provider-assigned unique ID for this managed resource.
localChecksum String
outputStreamUrl String: URL that streams the log output from the build
releaseId String: The Heroku app release created with a build's slug
slugId String: The Heroku slug created by a build
stack String: Name or ID of the Heroku stack
status String: The status of a build. Possible values are pending, successful and failed
users List<BuildUser>: Heroku account that created a build
uuid String: The ID of the build

id string: The provider-assigned unique ID for this managed resource.
localChecksum string
outputStreamUrl string: URL that streams the log output from the build
releaseId string: The Heroku app release created with a build's slug
slugId string: The Heroku slug created by a build
stack string: Name or ID of the Heroku stack
status string: The status of a build. Possible values are pending, successful and failed
users BuildUser[]: Heroku account that created a build
uuid string: The ID of the build

id str: The provider-assigned unique ID for this managed resource.
local_checksum str
output_stream_url str: URL that streams the log output from the build
release_id str: The Heroku app release created with a build's slug
slug_id str: The Heroku slug created by a build
stack str: Name or ID of the Heroku stack
status str: The status of a build. Possible values are pending, successful and failed
users Sequence[BuildUser]: Heroku account that created a build
uuid str: The ID of the build

id String: The provider-assigned unique ID for this managed resource.
localChecksum String
outputStreamUrl String: URL that streams the log output from the build
releaseId String: The Heroku app release created with a build's slug
slugId String: The Heroku slug created by a build
stack String: Name or ID of the Heroku stack
status String: The status of a build. Possible values are pending, successful and failed
users List<Property Map>: Heroku account that created a build
uuid String: The ID of the build

Look up Existing Build Resource

Get an existing Build resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: BuildState, opts?: CustomResourceOptions): Build

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        app_id: Optional[str] = None,
        buildpacks: Optional[Sequence[str]] = None,
        local_checksum: Optional[str] = None,
        output_stream_url: Optional[str] = None,
        release_id: Optional[str] = None,
        slug_id: Optional[str] = None,
        source: Optional[BuildSourceArgs] = None,
        stack: Optional[str] = None,
        status: Optional[str] = None,
        users: Optional[Sequence[BuildUserArgs]] = None,
        uuid: Optional[str] = None) -> Build

func GetBuild(ctx *Context, name string, id IDInput, state *BuildState, opts ...ResourceOption) (*Build, error)

public static Build Get(string name, Input<string> id, BuildState? state, CustomResourceOptions? opts = null)

public static Build get(String name, Output<String> id, BuildState state, CustomResourceOptions options)

resources:  _:    type: heroku:build:Build    get:      id: ${id}

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

AppId string: Heroku app ID (do not use app name)
Buildpacks List<string>: List of buildpack GitHub URLs
LocalChecksum string
OutputStreamUrl string: URL that streams the log output from the build
ReleaseId string: The Heroku app release created with a build's slug
SlugId string: The Heroku slug created by a build
Source Pulumiverse.Heroku.Build.Inputs.BuildSource: A block that specifies the source code to build & release:
Stack string: Name or ID of the Heroku stack
Status string: The status of a build. Possible values are pending, successful and failed
Users List<Pulumiverse.Heroku.Build.Inputs.BuildUser>: Heroku account that created a build
Uuid string: The ID of the build

AppId string: Heroku app ID (do not use app name)
Buildpacks []string: List of buildpack GitHub URLs
LocalChecksum string
OutputStreamUrl string: URL that streams the log output from the build
ReleaseId string: The Heroku app release created with a build's slug
SlugId string: The Heroku slug created by a build
Source BuildSourceArgs: A block that specifies the source code to build & release:
Stack string: Name or ID of the Heroku stack
Status string: The status of a build. Possible values are pending, successful and failed
Users []BuildUserArgs: Heroku account that created a build
Uuid string: The ID of the build

appId String: Heroku app ID (do not use app name)
buildpacks List<String>: List of buildpack GitHub URLs
localChecksum String
outputStreamUrl String: URL that streams the log output from the build
releaseId String: The Heroku app release created with a build's slug
slugId String: The Heroku slug created by a build
source BuildSource: A block that specifies the source code to build & release:
stack String: Name or ID of the Heroku stack
status String: The status of a build. Possible values are pending, successful and failed
users List<BuildUser>: Heroku account that created a build
uuid String: The ID of the build

appId string: Heroku app ID (do not use app name)
buildpacks string[]: List of buildpack GitHub URLs
localChecksum string
outputStreamUrl string: URL that streams the log output from the build
releaseId string: The Heroku app release created with a build's slug
slugId string: The Heroku slug created by a build
source BuildSource: A block that specifies the source code to build & release:
stack string: Name or ID of the Heroku stack
status string: The status of a build. Possible values are pending, successful and failed
users BuildUser[]: Heroku account that created a build
uuid string: The ID of the build

app_id str: Heroku app ID (do not use app name)
buildpacks Sequence[str]: List of buildpack GitHub URLs
local_checksum str
output_stream_url str: URL that streams the log output from the build
release_id str: The Heroku app release created with a build's slug
slug_id str: The Heroku slug created by a build
source BuildSourceArgs: A block that specifies the source code to build & release:
stack str: Name or ID of the Heroku stack
status str: The status of a build. Possible values are pending, successful and failed
users Sequence[BuildUserArgs]: Heroku account that created a build
uuid str: The ID of the build

appId String: Heroku app ID (do not use app name)
buildpacks List<String>: List of buildpack GitHub URLs
localChecksum String
outputStreamUrl String: URL that streams the log output from the build
releaseId String: The Heroku app release created with a build's slug
slugId String: The Heroku slug created by a build
source Property Map: A block that specifies the source code to build & release:
stack String: Name or ID of the Heroku stack
status String: The status of a build. Possible values are pending, successful and failed
users List<Property Map>: Heroku account that created a build
uuid String: The ID of the build

Supporting Types

BuildSource, BuildSourceArgs

Checksum string: SHA256 hash of the tarball archive to verify its integrity, example: SHA256:e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855
Path string: Local path to the source directory or tarball archive for the app
Url string: https location of the source archive for the app
Version string: Use to track what version of your source originated this build. If you are creating builds from git-versioned source code, for example, the commit hash, or release tag would be a good value to use for the version parameter.

Checksum string: SHA256 hash of the tarball archive to verify its integrity, example: SHA256:e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855
Path string: Local path to the source directory or tarball archive for the app
Url string: https location of the source archive for the app
Version string: Use to track what version of your source originated this build. If you are creating builds from git-versioned source code, for example, the commit hash, or release tag would be a good value to use for the version parameter.

checksum String: SHA256 hash of the tarball archive to verify its integrity, example: SHA256:e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855
path String: Local path to the source directory or tarball archive for the app
url String: https location of the source archive for the app
version String: Use to track what version of your source originated this build. If you are creating builds from git-versioned source code, for example, the commit hash, or release tag would be a good value to use for the version parameter.

checksum string: SHA256 hash of the tarball archive to verify its integrity, example: SHA256:e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855
path string: Local path to the source directory or tarball archive for the app
url string: https location of the source archive for the app
version string: Use to track what version of your source originated this build. If you are creating builds from git-versioned source code, for example, the commit hash, or release tag would be a good value to use for the version parameter.

checksum str: SHA256 hash of the tarball archive to verify its integrity, example: SHA256:e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855
path str: Local path to the source directory or tarball archive for the app
url str: https location of the source archive for the app
version str: Use to track what version of your source originated this build. If you are creating builds from git-versioned source code, for example, the commit hash, or release tag would be a good value to use for the version parameter.

checksum String: SHA256 hash of the tarball archive to verify its integrity, example: SHA256:e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855
path String: Local path to the source directory or tarball archive for the app
url String: https location of the source archive for the app
version String: Use to track what version of your source originated this build. If you are creating builds from git-versioned source code, for example, the commit hash, or release tag would be a good value to use for the version parameter.

BuildUser, BuildUserArgs

Email string
Id string

Email string
Id string

email String
id String

email string
id string

email str
id str

email String
id String

Package Details

Repository: heroku pulumiverse/pulumi-heroku
License: Apache-2.0
Notes: This Pulumi package is based on the heroku Terraform Provider.

Heroku v1.0.4 published on Tuesday, Apr 8, 2025 by pulumiverse - Marcel Arns

pulumiverse/pulumi-heroku

heroku.build.Build

On this page

On this page

Import

Create Build Resource

Constructor syntax

Parameters

Constructor example

Build Resource Properties

Inputs

Outputs

Look up Existing Build Resource

Supporting Types

BuildSource, BuildSourceArgs

BuildUser, BuildUserArgs

Package Details

On this page

On this page