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

cloudfoundry.getApp

Explore with Pulumi AI

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

    Gets information on a Cloud Foundry application.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as cloudfoundry from "@pulumi/cloudfoundry";

const my_app = cloudfoundry.getApp({
    nameOrId: "my-app",
    space: "space-id",
});

    import pulumi
import pulumi_cloudfoundry as cloudfoundry

my_app = cloudfoundry.get_app(name_or_id="my-app",
    space="space-id")

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/cloudfoundry/cloudfoundry"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := cloudfoundry.LookupApp(ctx, &cloudfoundry.LookupAppArgs{
			NameOrId: "my-app",
			Space:    "space-id",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Cloudfoundry = Pulumi.Cloudfoundry;

return await Deployment.RunAsync(() => 
{
    var my_app = Cloudfoundry.GetApp.Invoke(new()
    {
        NameOrId = "my-app",
        Space = "space-id",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.cloudfoundry.CloudfoundryFunctions;
import com.pulumi.cloudfoundry.inputs.GetAppArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var my-app = CloudfoundryFunctions.getApp(GetAppArgs.builder()
            .nameOrId("my-app")
            .space("space-id")
            .build());

    }
}

    variables:
  my-app:
    fn::invoke:
      function: cloudfoundry:getApp
      arguments:
        nameOrId: my-app
        space: space-id

    Using getApp

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getApp(args: GetAppArgs, opts?: InvokeOptions): Promise<GetAppResult>
function getAppOutput(args: GetAppOutputArgs, opts?: InvokeOptions): Output<GetAppResult>
    def get_app(annotations: Optional[Mapping[str, str]] = None,
            buildpacks: Optional[Sequence[str]] = None,
            id: Optional[str] = None,
            labels: Optional[Mapping[str, str]] = None,
            name_or_id: Optional[str] = None,
            space: Optional[str] = None,
            opts: Optional[InvokeOptions] = None) -> GetAppResult
def get_app_output(annotations: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
            buildpacks: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
            id: Optional[pulumi.Input[str]] = None,
            labels: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
            name_or_id: Optional[pulumi.Input[str]] = None,
            space: Optional[pulumi.Input[str]] = None,
            opts: Optional[InvokeOptions] = None) -> Output[GetAppResult]
    func LookupApp(ctx *Context, args *LookupAppArgs, opts ...InvokeOption) (*LookupAppResult, error)
func LookupAppOutput(ctx *Context, args *LookupAppOutputArgs, opts ...InvokeOption) LookupAppResultOutput

    > Note: This function is named LookupApp in the Go SDK.

    public static class GetApp 
{
    public static Task<GetAppResult> InvokeAsync(GetAppArgs args, InvokeOptions? opts = null)
    public static Output<GetAppResult> Invoke(GetAppInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetAppResult> getApp(GetAppArgs args, InvokeOptions options)
public static Output<GetAppResult> getApp(GetAppArgs args, InvokeOptions options)

    fn::invoke:
  function: cloudfoundry:index/getApp:getApp
  arguments:
    # arguments dictionary

    The following arguments are supported:

    NameOrId string
    The name of the application or its guid.
    Space string
    The space guid of the app.
    Annotations Dictionary<string, string>
    Annotations as described here.
    Buildpacks List<string>
    Id string
    The GUID of the application
    Labels Dictionary<string, string>
    Labels as described here.
    NameOrId string
    The name of the application or its guid.
    Space string
    The space guid of the app.
    Annotations map[string]string
    Annotations as described here.
    Buildpacks []string
    Id string
    The GUID of the application
    Labels map[string]string
    Labels as described here.
    nameOrId String
    The name of the application or its guid.
    space String
    The space guid of the app.
    annotations Map<String,String>
    Annotations as described here.
    buildpacks List<String>
    id String
    The GUID of the application
    labels Map<String,String>
    Labels as described here.
    nameOrId string
    The name of the application or its guid.
    space string
    The space guid of the app.
    annotations {[key: string]: string}
    Annotations as described here.
    buildpacks string[]
    id string
    The GUID of the application
    labels {[key: string]: string}
    Labels as described here.
    name_or_id str
    The name of the application or its guid.
    space str
    The space guid of the app.
    annotations Mapping[str, str]
    Annotations as described here.
    buildpacks Sequence[str]
    id str
    The GUID of the application
    labels Mapping[str, str]
    Labels as described here.
    nameOrId String
    The name of the application or its guid.
    space String
    The space guid of the app.
    annotations Map<String>
    Annotations as described here.
    buildpacks List<String>
    id String
    The GUID of the application
    labels Map<String>
    Labels as described here.

    getApp Result

    The following output properties are available:

    Buildpack string
    The buildpack used to stage the application.
    Command string
    The custom start command for the application.
    DiskQuota double
    The disk space to be allocated for each application instance in megabytes.
    EnableSsh bool
    Whether to enable or disable SSH access to the container.
    Environment Dictionary<string, string>
    Key/value pairs of custom environment variables to set in your app.
    HealthCheckHttpEndpoint string
    The endpoint for the http health check type.
    HealthCheckTimeout double
    The timeout in seconds for the health check.
    HealthCheckType string
    The health check type which can be one of "port", "process", "http" or "none".
    Id string
    The GUID of the application
    Instances double
    The number of app instances that you want to start. Defaults to 1.
    Memory double
    The memory limit for each application instance in megabytes.
    Name string
    The name of the application.
    NameOrId string
    Space string
    Stack string
    The GUID of the stack the application will be deployed to.
    State string
    Current state of the app (stopped or running or started).
    Annotations Dictionary<string, string>
    Annotations as described here.
    Buildpacks List<string>
    Labels Dictionary<string, string>
    Labels as described here.
    Buildpack string
    The buildpack used to stage the application.
    Command string
    The custom start command for the application.
    DiskQuota float64
    The disk space to be allocated for each application instance in megabytes.
    EnableSsh bool
    Whether to enable or disable SSH access to the container.
    Environment map[string]string
    Key/value pairs of custom environment variables to set in your app.
    HealthCheckHttpEndpoint string
    The endpoint for the http health check type.
    HealthCheckTimeout float64
    The timeout in seconds for the health check.
    HealthCheckType string
    The health check type which can be one of "port", "process", "http" or "none".
    Id string
    The GUID of the application
    Instances float64
    The number of app instances that you want to start. Defaults to 1.
    Memory float64
    The memory limit for each application instance in megabytes.
    Name string
    The name of the application.
    NameOrId string
    Space string
    Stack string
    The GUID of the stack the application will be deployed to.
    State string
    Current state of the app (stopped or running or started).
    Annotations map[string]string
    Annotations as described here.
    Buildpacks []string
    Labels map[string]string
    Labels as described here.
    buildpack String
    The buildpack used to stage the application.
    command String
    The custom start command for the application.
    diskQuota Double
    The disk space to be allocated for each application instance in megabytes.
    enableSsh Boolean
    Whether to enable or disable SSH access to the container.
    environment Map<String,String>
    Key/value pairs of custom environment variables to set in your app.
    healthCheckHttpEndpoint String
    The endpoint for the http health check type.
    healthCheckTimeout Double
    The timeout in seconds for the health check.
    healthCheckType String
    The health check type which can be one of "port", "process", "http" or "none".
    id String
    The GUID of the application
    instances Double
    The number of app instances that you want to start. Defaults to 1.
    memory Double
    The memory limit for each application instance in megabytes.
    name String
    The name of the application.
    nameOrId String
    space String
    stack String
    The GUID of the stack the application will be deployed to.
    state String
    Current state of the app (stopped or running or started).
    annotations Map<String,String>
    Annotations as described here.
    buildpacks List<String>
    labels Map<String,String>
    Labels as described here.
    buildpack string
    The buildpack used to stage the application.
    command string
    The custom start command for the application.
    diskQuota number
    The disk space to be allocated for each application instance in megabytes.
    enableSsh boolean
    Whether to enable or disable SSH access to the container.
    environment {[key: string]: string}
    Key/value pairs of custom environment variables to set in your app.
    healthCheckHttpEndpoint string
    The endpoint for the http health check type.
    healthCheckTimeout number
    The timeout in seconds for the health check.
    healthCheckType string
    The health check type which can be one of "port", "process", "http" or "none".
    id string
    The GUID of the application
    instances number
    The number of app instances that you want to start. Defaults to 1.
    memory number
    The memory limit for each application instance in megabytes.
    name string
    The name of the application.
    nameOrId string
    space string
    stack string
    The GUID of the stack the application will be deployed to.
    state string
    Current state of the app (stopped or running or started).
    annotations {[key: string]: string}
    Annotations as described here.
    buildpacks string[]
    labels {[key: string]: string}
    Labels as described here.
    buildpack str
    The buildpack used to stage the application.
    command str
    The custom start command for the application.
    disk_quota float
    The disk space to be allocated for each application instance in megabytes.
    enable_ssh bool
    Whether to enable or disable SSH access to the container.
    environment Mapping[str, str]
    Key/value pairs of custom environment variables to set in your app.
    health_check_http_endpoint str
    The endpoint for the http health check type.
    health_check_timeout float
    The timeout in seconds for the health check.
    health_check_type str
    The health check type which can be one of "port", "process", "http" or "none".
    id str
    The GUID of the application
    instances float
    The number of app instances that you want to start. Defaults to 1.
    memory float
    The memory limit for each application instance in megabytes.
    name str
    The name of the application.
    name_or_id str
    space str
    stack str
    The GUID of the stack the application will be deployed to.
    state str
    Current state of the app (stopped or running or started).
    annotations Mapping[str, str]
    Annotations as described here.
    buildpacks Sequence[str]
    labels Mapping[str, str]
    Labels as described here.
    buildpack String
    The buildpack used to stage the application.
    command String
    The custom start command for the application.
    diskQuota Number
    The disk space to be allocated for each application instance in megabytes.
    enableSsh Boolean
    Whether to enable or disable SSH access to the container.
    environment Map<String>
    Key/value pairs of custom environment variables to set in your app.
    healthCheckHttpEndpoint String
    The endpoint for the http health check type.
    healthCheckTimeout Number
    The timeout in seconds for the health check.
    healthCheckType String
    The health check type which can be one of "port", "process", "http" or "none".
    id String
    The GUID of the application
    instances Number
    The number of app instances that you want to start. Defaults to 1.
    memory Number
    The memory limit for each application instance in megabytes.
    name String
    The name of the application.
    nameOrId String
    space String
    stack String
    The GUID of the stack the application will be deployed to.
    state String
    Current state of the app (stopped or running or started).
    annotations Map<String>
    Annotations as described here.
    buildpacks List<String>
    labels Map<String>
    Labels as described here.

    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