Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Cloudfoundry Provider
  3. API Docs
  4. Buildpack
cloudfoundry 0.54.0 published on Monday, Apr 14, 2025 by cloudfoundry-community
cloudfoundry-community/terraform-provider-cloudfoundry

cloudfoundry.Buildpack

Explore with Pulumi AI

cloudfoundry logo
cloudfoundry 0.54.0 published on Monday, Apr 14, 2025 by cloudfoundry-community
cloudfoundry-community/terraform-provider-cloudfoundry

    Provides a Cloud Foundry resource for managing Cloud Foundry admin buildpacks.

    NOTE: This resource requires the provider to be authenticated with an account granted admin permissions.

    Example Usage

    The following example creates a Cloud Foundry buildpack .

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    resources:
  tomee:
    type: cloudfoundry:Buildpack
    properties:
      enable: true
      path: https://github.com/cloudfoundry-community/tomee-buildpack/releases/download/v3.17/tomee-buildpack-v3.17.zip
      position: '12'

    Create Buildpack Resource

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

    Constructor syntax

    new Buildpack(name: string, args: BuildpackArgs, opts?: CustomResourceOptions);
    @overload
def Buildpack(resource_name: str,
              args: BuildpackArgs,
              opts: Optional[ResourceOptions] = None)

@overload
def Buildpack(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              path: Optional[str] = None,
              annotations: Optional[Mapping[str, str]] = None,
              buildpack_id: Optional[str] = None,
              enabled: Optional[bool] = None,
              filename: Optional[str] = None,
              labels: Optional[Mapping[str, str]] = None,
              locked: Optional[bool] = None,
              name: Optional[str] = None,
              position: Optional[float] = None,
              source_code_hash: Optional[str] = None)
    func NewBuildpack(ctx *Context, name string, args BuildpackArgs, opts ...ResourceOption) (*Buildpack, error)
    public Buildpack(string name, BuildpackArgs args, CustomResourceOptions? opts = null)
    public Buildpack(String name, BuildpackArgs args)
public Buildpack(String name, BuildpackArgs args, CustomResourceOptions options)

    type: cloudfoundry:Buildpack
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 BuildpackArgs
    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 BuildpackArgs
    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 BuildpackArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args BuildpackArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args BuildpackArgs
    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 buildpackResource = new Cloudfoundry.Buildpack("buildpackResource", new()
{
    Path = "string",
    Annotations = 
    {
        { "string", "string" },
    },
    BuildpackId = "string",
    Enabled = false,
    Filename = "string",
    Labels = 
    {
        { "string", "string" },
    },
    Locked = false,
    Name = "string",
    Position = 0,
    SourceCodeHash = "string",
});

    example, err := cloudfoundry.NewBuildpack(ctx, "buildpackResource", &cloudfoundry.BuildpackArgs{
	Path: pulumi.String("string"),
	Annotations: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	BuildpackId: pulumi.String("string"),
	Enabled:     pulumi.Bool(false),
	Filename:    pulumi.String("string"),
	Labels: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Locked:         pulumi.Bool(false),
	Name:           pulumi.String("string"),
	Position:       pulumi.Float64(0),
	SourceCodeHash: pulumi.String("string"),
})

    var buildpackResource = new Buildpack("buildpackResource", BuildpackArgs.builder()
    .path("string")
    .annotations(Map.of("string", "string"))
    .buildpackId("string")
    .enabled(false)
    .filename("string")
    .labels(Map.of("string", "string"))
    .locked(false)
    .name("string")
    .position(0)
    .sourceCodeHash("string")
    .build());

    buildpack_resource = cloudfoundry.Buildpack("buildpackResource",
    path="string",
    annotations={
        "string": "string",
    },
    buildpack_id="string",
    enabled=False,
    filename="string",
    labels={
        "string": "string",
    },
    locked=False,
    name="string",
    position=0,
    source_code_hash="string")

    const buildpackResource = new cloudfoundry.Buildpack("buildpackResource", {
    path: "string",
    annotations: {
        string: "string",
    },
    buildpackId: "string",
    enabled: false,
    filename: "string",
    labels: {
        string: "string",
    },
    locked: false,
    name: "string",
    position: 0,
    sourceCodeHash: "string",
});

    type: cloudfoundry:Buildpack
properties:
    annotations:
        string: string
    buildpackId: string
    enabled: false
    filename: string
    labels:
        string: string
    locked: false
    name: string
    path: string
    position: 0
    sourceCodeHash: string

    Buildpack 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 Buildpack resource accepts the following input properties:

    Path string
    Path to a buildpack zip in the form of unix path or http url
    Annotations Dictionary<string, string>
    Add annotations as described here. Works only on cloud foundry with api >= v3.63.
    BuildpackId string
    The GUID of the buildpack
    Enabled bool
    Specifies whether to allow apps to be pushed with the buildpack, and defaults to true.
    Filename string
    Labels Dictionary<string, string>
    Add labels as described here. Works only on cloud foundry with api >= v3.63.
    Locked bool
    Specifies whether buildpack is locked to prevent further updates, and defaults to false.
    Name string
    The name of the Buildpack.
    Position double
    Specifies where to place the buildpack in the detection priority list. For more information, see the Buildpack Detection topic. When not provided, cloudfoundry assigns a default buildpack position.
    SourceCodeHash string
    Path string
    Path to a buildpack zip in the form of unix path or http url
    Annotations map[string]string
    Add annotations as described here. Works only on cloud foundry with api >= v3.63.
    BuildpackId string
    The GUID of the buildpack
    Enabled bool
    Specifies whether to allow apps to be pushed with the buildpack, and defaults to true.
    Filename string
    Labels map[string]string
    Add labels as described here. Works only on cloud foundry with api >= v3.63.
    Locked bool
    Specifies whether buildpack is locked to prevent further updates, and defaults to false.
    Name string
    The name of the Buildpack.
    Position float64
    Specifies where to place the buildpack in the detection priority list. For more information, see the Buildpack Detection topic. When not provided, cloudfoundry assigns a default buildpack position.
    SourceCodeHash string
    path String
    Path to a buildpack zip in the form of unix path or http url
    annotations Map<String,String>
    Add annotations as described here. Works only on cloud foundry with api >= v3.63.
    buildpackId String
    The GUID of the buildpack
    enabled Boolean
    Specifies whether to allow apps to be pushed with the buildpack, and defaults to true.
    filename String
    labels Map<String,String>
    Add labels as described here. Works only on cloud foundry with api >= v3.63.
    locked Boolean
    Specifies whether buildpack is locked to prevent further updates, and defaults to false.
    name String
    The name of the Buildpack.
    position Double
    Specifies where to place the buildpack in the detection priority list. For more information, see the Buildpack Detection topic. When not provided, cloudfoundry assigns a default buildpack position.
    sourceCodeHash String
    path string
    Path to a buildpack zip in the form of unix path or http url
    annotations {[key: string]: string}
    Add annotations as described here. Works only on cloud foundry with api >= v3.63.
    buildpackId string
    The GUID of the buildpack
    enabled boolean
    Specifies whether to allow apps to be pushed with the buildpack, and defaults to true.
    filename string
    labels {[key: string]: string}
    Add labels as described here. Works only on cloud foundry with api >= v3.63.
    locked boolean
    Specifies whether buildpack is locked to prevent further updates, and defaults to false.
    name string
    The name of the Buildpack.
    position number
    Specifies where to place the buildpack in the detection priority list. For more information, see the Buildpack Detection topic. When not provided, cloudfoundry assigns a default buildpack position.
    sourceCodeHash string
    path str
    Path to a buildpack zip in the form of unix path or http url
    annotations Mapping[str, str]
    Add annotations as described here. Works only on cloud foundry with api >= v3.63.
    buildpack_id str
    The GUID of the buildpack
    enabled bool
    Specifies whether to allow apps to be pushed with the buildpack, and defaults to true.
    filename str
    labels Mapping[str, str]
    Add labels as described here. Works only on cloud foundry with api >= v3.63.
    locked bool
    Specifies whether buildpack is locked to prevent further updates, and defaults to false.
    name str
    The name of the Buildpack.
    position float
    Specifies where to place the buildpack in the detection priority list. For more information, see the Buildpack Detection topic. When not provided, cloudfoundry assigns a default buildpack position.
    source_code_hash str
    path String
    Path to a buildpack zip in the form of unix path or http url
    annotations Map<String>
    Add annotations as described here. Works only on cloud foundry with api >= v3.63.
    buildpackId String
    The GUID of the buildpack
    enabled Boolean
    Specifies whether to allow apps to be pushed with the buildpack, and defaults to true.
    filename String
    labels Map<String>
    Add labels as described here. Works only on cloud foundry with api >= v3.63.
    locked Boolean
    Specifies whether buildpack is locked to prevent further updates, and defaults to false.
    name String
    The name of the Buildpack.
    position Number
    Specifies where to place the buildpack in the detection priority list. For more information, see the Buildpack Detection topic. When not provided, cloudfoundry assigns a default buildpack position.
    sourceCodeHash String

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Buildpack Resource

    Get an existing Buildpack 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?: BuildpackState, opts?: CustomResourceOptions): Buildpack
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        annotations: Optional[Mapping[str, str]] = None,
        buildpack_id: Optional[str] = None,
        enabled: Optional[bool] = None,
        filename: Optional[str] = None,
        labels: Optional[Mapping[str, str]] = None,
        locked: Optional[bool] = None,
        name: Optional[str] = None,
        path: Optional[str] = None,
        position: Optional[float] = None,
        source_code_hash: Optional[str] = None) -> Buildpack
    func GetBuildpack(ctx *Context, name string, id IDInput, state *BuildpackState, opts ...ResourceOption) (*Buildpack, error)
    public static Buildpack Get(string name, Input<string> id, BuildpackState? state, CustomResourceOptions? opts = null)
    public static Buildpack get(String name, Output<String> id, BuildpackState state, CustomResourceOptions options)
    resources:  _:    type: cloudfoundry:Buildpack    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:
    Annotations Dictionary<string, string>
    Add annotations as described here. Works only on cloud foundry with api >= v3.63.
    BuildpackId string
    The GUID of the buildpack
    Enabled bool
    Specifies whether to allow apps to be pushed with the buildpack, and defaults to true.
    Filename string
    Labels Dictionary<string, string>
    Add labels as described here. Works only on cloud foundry with api >= v3.63.
    Locked bool
    Specifies whether buildpack is locked to prevent further updates, and defaults to false.
    Name string
    The name of the Buildpack.
    Path string
    Path to a buildpack zip in the form of unix path or http url
    Position double
    Specifies where to place the buildpack in the detection priority list. For more information, see the Buildpack Detection topic. When not provided, cloudfoundry assigns a default buildpack position.
    SourceCodeHash string
    Annotations map[string]string
    Add annotations as described here. Works only on cloud foundry with api >= v3.63.
    BuildpackId string
    The GUID of the buildpack
    Enabled bool
    Specifies whether to allow apps to be pushed with the buildpack, and defaults to true.
    Filename string
    Labels map[string]string
    Add labels as described here. Works only on cloud foundry with api >= v3.63.
    Locked bool
    Specifies whether buildpack is locked to prevent further updates, and defaults to false.
    Name string
    The name of the Buildpack.
    Path string
    Path to a buildpack zip in the form of unix path or http url
    Position float64
    Specifies where to place the buildpack in the detection priority list. For more information, see the Buildpack Detection topic. When not provided, cloudfoundry assigns a default buildpack position.
    SourceCodeHash string
    annotations Map<String,String>
    Add annotations as described here. Works only on cloud foundry with api >= v3.63.
    buildpackId String
    The GUID of the buildpack
    enabled Boolean
    Specifies whether to allow apps to be pushed with the buildpack, and defaults to true.
    filename String
    labels Map<String,String>
    Add labels as described here. Works only on cloud foundry with api >= v3.63.
    locked Boolean
    Specifies whether buildpack is locked to prevent further updates, and defaults to false.
    name String
    The name of the Buildpack.
    path String
    Path to a buildpack zip in the form of unix path or http url
    position Double
    Specifies where to place the buildpack in the detection priority list. For more information, see the Buildpack Detection topic. When not provided, cloudfoundry assigns a default buildpack position.
    sourceCodeHash String
    annotations {[key: string]: string}
    Add annotations as described here. Works only on cloud foundry with api >= v3.63.
    buildpackId string
    The GUID of the buildpack
    enabled boolean
    Specifies whether to allow apps to be pushed with the buildpack, and defaults to true.
    filename string
    labels {[key: string]: string}
    Add labels as described here. Works only on cloud foundry with api >= v3.63.
    locked boolean
    Specifies whether buildpack is locked to prevent further updates, and defaults to false.
    name string
    The name of the Buildpack.
    path string
    Path to a buildpack zip in the form of unix path or http url
    position number
    Specifies where to place the buildpack in the detection priority list. For more information, see the Buildpack Detection topic. When not provided, cloudfoundry assigns a default buildpack position.
    sourceCodeHash string
    annotations Mapping[str, str]
    Add annotations as described here. Works only on cloud foundry with api >= v3.63.
    buildpack_id str
    The GUID of the buildpack
    enabled bool
    Specifies whether to allow apps to be pushed with the buildpack, and defaults to true.
    filename str
    labels Mapping[str, str]
    Add labels as described here. Works only on cloud foundry with api >= v3.63.
    locked bool
    Specifies whether buildpack is locked to prevent further updates, and defaults to false.
    name str
    The name of the Buildpack.
    path str
    Path to a buildpack zip in the form of unix path or http url
    position float
    Specifies where to place the buildpack in the detection priority list. For more information, see the Buildpack Detection topic. When not provided, cloudfoundry assigns a default buildpack position.
    source_code_hash str
    annotations Map<String>
    Add annotations as described here. Works only on cloud foundry with api >= v3.63.
    buildpackId String
    The GUID of the buildpack
    enabled Boolean
    Specifies whether to allow apps to be pushed with the buildpack, and defaults to true.
    filename String
    labels Map<String>
    Add labels as described here. Works only on cloud foundry with api >= v3.63.
    locked Boolean
    Specifies whether buildpack is locked to prevent further updates, and defaults to false.
    name String
    The name of the Buildpack.
    path String
    Path to a buildpack zip in the form of unix path or http url
    position Number
    Specifies where to place the buildpack in the detection priority list. For more information, see the Buildpack Detection topic. When not provided, cloudfoundry assigns a default buildpack position.
    sourceCodeHash String

    Import

    The current buildpack can be imported using the buildpack guid, e.g.

    bash

    $ pulumi import cloudfoundry:index/buildpack:Buildpack tomee a-guid

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    cloudfoundry cloudfoundry-community/terraform-provider-cloudfoundry
    License
    Notes
    This Pulumi package is based on the cloudfoundry Terraform Provider.
    cloudfoundry logo
    cloudfoundry 0.54.0 published on Monday, Apr 14, 2025 by cloudfoundry-community
    cloudfoundry-community/terraform-provider-cloudfoundry