Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Ibm Provider
  3. API Docs
  4. App
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

ibm.App

Explore with Pulumi AI

ibm logo
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

    Create App Resource

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

    Constructor syntax

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

@overload
def App(resource_name: str,
        opts: Optional[ResourceOptions] = None,
        space_guid: Optional[str] = None,
        app_path: Optional[str] = None,
        health_check_timeout: Optional[float] = None,
        health_check_type: Optional[str] = None,
        command: Optional[str] = None,
        disk_quota: Optional[float] = None,
        environment_json: Optional[Mapping[str, str]] = None,
        health_check_http_endpoint: Optional[str] = None,
        app_id: Optional[str] = None,
        buildpack: Optional[str] = None,
        instances: Optional[float] = None,
        memory: Optional[float] = None,
        name: Optional[str] = None,
        route_guids: Optional[Sequence[str]] = None,
        service_instance_guids: Optional[Sequence[str]] = None,
        app_version: Optional[str] = None,
        tags: Optional[Sequence[str]] = None,
        wait_time_minutes: Optional[float] = None)
    func NewApp(ctx *Context, name string, args AppArgs, opts ...ResourceOption) (*App, error)
    public App(string name, AppArgs args, CustomResourceOptions? opts = null)
    public App(String name, AppArgs args)
public App(String name, AppArgs args, CustomResourceOptions options)

    type: ibm:App
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 AppArgs
    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 AppArgs
    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 AppArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AppArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AppArgs
    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 appResource = new Ibm.App("appResource", new()
{
    SpaceGuid = "string",
    AppPath = "string",
    HealthCheckTimeout = 0,
    HealthCheckType = "string",
    Command = "string",
    DiskQuota = 0,
    EnvironmentJson = 
    {
        { "string", "string" },
    },
    HealthCheckHttpEndpoint = "string",
    AppId = "string",
    Buildpack = "string",
    Instances = 0,
    Memory = 0,
    Name = "string",
    RouteGuids = new[]
    {
        "string",
    },
    ServiceInstanceGuids = new[]
    {
        "string",
    },
    AppVersion = "string",
    Tags = new[]
    {
        "string",
    },
    WaitTimeMinutes = 0,
});

    example, err := ibm.NewApp(ctx, "appResource", &ibm.AppArgs{
	SpaceGuid:          pulumi.String("string"),
	AppPath:            pulumi.String("string"),
	HealthCheckTimeout: pulumi.Float64(0),
	HealthCheckType:    pulumi.String("string"),
	Command:            pulumi.String("string"),
	DiskQuota:          pulumi.Float64(0),
	EnvironmentJson: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	HealthCheckHttpEndpoint: pulumi.String("string"),
	AppId:                   pulumi.String("string"),
	Buildpack:               pulumi.String("string"),
	Instances:               pulumi.Float64(0),
	Memory:                  pulumi.Float64(0),
	Name:                    pulumi.String("string"),
	RouteGuids: pulumi.StringArray{
		pulumi.String("string"),
	},
	ServiceInstanceGuids: pulumi.StringArray{
		pulumi.String("string"),
	},
	AppVersion: pulumi.String("string"),
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
	WaitTimeMinutes: pulumi.Float64(0),
})

    var appResource = new App("appResource", AppArgs.builder()
    .spaceGuid("string")
    .appPath("string")
    .healthCheckTimeout(0)
    .healthCheckType("string")
    .command("string")
    .diskQuota(0)
    .environmentJson(Map.of("string", "string"))
    .healthCheckHttpEndpoint("string")
    .appId("string")
    .buildpack("string")
    .instances(0)
    .memory(0)
    .name("string")
    .routeGuids("string")
    .serviceInstanceGuids("string")
    .appVersion("string")
    .tags("string")
    .waitTimeMinutes(0)
    .build());

    app_resource = ibm.App("appResource",
    space_guid="string",
    app_path="string",
    health_check_timeout=0,
    health_check_type="string",
    command="string",
    disk_quota=0,
    environment_json={
        "string": "string",
    },
    health_check_http_endpoint="string",
    app_id="string",
    buildpack="string",
    instances=0,
    memory=0,
    name="string",
    route_guids=["string"],
    service_instance_guids=["string"],
    app_version="string",
    tags=["string"],
    wait_time_minutes=0)

    const appResource = new ibm.App("appResource", {
    spaceGuid: "string",
    appPath: "string",
    healthCheckTimeout: 0,
    healthCheckType: "string",
    command: "string",
    diskQuota: 0,
    environmentJson: {
        string: "string",
    },
    healthCheckHttpEndpoint: "string",
    appId: "string",
    buildpack: "string",
    instances: 0,
    memory: 0,
    name: "string",
    routeGuids: ["string"],
    serviceInstanceGuids: ["string"],
    appVersion: "string",
    tags: ["string"],
    waitTimeMinutes: 0,
});

    type: ibm:App
properties:
    appId: string
    appPath: string
    appVersion: string
    buildpack: string
    command: string
    diskQuota: 0
    environmentJson:
        string: string
    healthCheckHttpEndpoint: string
    healthCheckTimeout: 0
    healthCheckType: string
    instances: 0
    memory: 0
    name: string
    routeGuids:
        - string
    serviceInstanceGuids:
        - string
    spaceGuid: string
    tags:
        - string
    waitTimeMinutes: 0

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

    AppPath string
    Define the path of the zip file of the application.
    SpaceGuid string
    Define space guid to which app belongs
    AppId string
    AppVersion string
    Version of the application
    Buildpack string
    Buildpack to build the app. 3 options: a) Blank means autodetection; b) A Git Url pointing to a buildpack; c) Name of an installed buildpack.
    Command string
    The initial command for the app
    DiskQuota double
    The maximum amount of disk available to an instance of an app. In megabytes.
    EnvironmentJson Dictionary<string, string>
    Key/value pairs of all the environment variables to run in your app. Does not include any system or service variables.
    HealthCheckHttpEndpoint string
    Endpoint called to determine if the app is healthy.
    HealthCheckTimeout double
    Timeout in seconds for health checking of an staged app when starting up.
    HealthCheckType string
    Type of health check to perform.
    Instances double
    The number of instances
    Memory double
    The amount of memory each instance should have. In megabytes.
    Name string
    The name for the app
    RouteGuids List<string>
    Define the route guids which should be bound to the application.
    ServiceInstanceGuids List<string>
    Define the service instance guids that should be bound to this application.
    Tags List<string>
    WaitTimeMinutes double
    Define timeout to wait for the app instances to start/update/restage etc.
    AppPath string
    Define the path of the zip file of the application.
    SpaceGuid string
    Define space guid to which app belongs
    AppId string
    AppVersion string
    Version of the application
    Buildpack string
    Buildpack to build the app. 3 options: a) Blank means autodetection; b) A Git Url pointing to a buildpack; c) Name of an installed buildpack.
    Command string
    The initial command for the app
    DiskQuota float64
    The maximum amount of disk available to an instance of an app. In megabytes.
    EnvironmentJson map[string]string
    Key/value pairs of all the environment variables to run in your app. Does not include any system or service variables.
    HealthCheckHttpEndpoint string
    Endpoint called to determine if the app is healthy.
    HealthCheckTimeout float64
    Timeout in seconds for health checking of an staged app when starting up.
    HealthCheckType string
    Type of health check to perform.
    Instances float64
    The number of instances
    Memory float64
    The amount of memory each instance should have. In megabytes.
    Name string
    The name for the app
    RouteGuids []string
    Define the route guids which should be bound to the application.
    ServiceInstanceGuids []string
    Define the service instance guids that should be bound to this application.
    Tags []string
    WaitTimeMinutes float64
    Define timeout to wait for the app instances to start/update/restage etc.
    appPath String
    Define the path of the zip file of the application.
    spaceGuid String
    Define space guid to which app belongs
    appId String
    appVersion String
    Version of the application
    buildpack String
    Buildpack to build the app. 3 options: a) Blank means autodetection; b) A Git Url pointing to a buildpack; c) Name of an installed buildpack.
    command String
    The initial command for the app
    diskQuota Double
    The maximum amount of disk available to an instance of an app. In megabytes.
    environmentJson Map<String,String>
    Key/value pairs of all the environment variables to run in your app. Does not include any system or service variables.
    healthCheckHttpEndpoint String
    Endpoint called to determine if the app is healthy.
    healthCheckTimeout Double
    Timeout in seconds for health checking of an staged app when starting up.
    healthCheckType String
    Type of health check to perform.
    instances Double
    The number of instances
    memory Double
    The amount of memory each instance should have. In megabytes.
    name String
    The name for the app
    routeGuids List<String>
    Define the route guids which should be bound to the application.
    serviceInstanceGuids List<String>
    Define the service instance guids that should be bound to this application.
    tags List<String>
    waitTimeMinutes Double
    Define timeout to wait for the app instances to start/update/restage etc.
    appPath string
    Define the path of the zip file of the application.
    spaceGuid string
    Define space guid to which app belongs
    appId string
    appVersion string
    Version of the application
    buildpack string
    Buildpack to build the app. 3 options: a) Blank means autodetection; b) A Git Url pointing to a buildpack; c) Name of an installed buildpack.
    command string
    The initial command for the app
    diskQuota number
    The maximum amount of disk available to an instance of an app. In megabytes.
    environmentJson {[key: string]: string}
    Key/value pairs of all the environment variables to run in your app. Does not include any system or service variables.
    healthCheckHttpEndpoint string
    Endpoint called to determine if the app is healthy.
    healthCheckTimeout number
    Timeout in seconds for health checking of an staged app when starting up.
    healthCheckType string
    Type of health check to perform.
    instances number
    The number of instances
    memory number
    The amount of memory each instance should have. In megabytes.
    name string
    The name for the app
    routeGuids string[]
    Define the route guids which should be bound to the application.
    serviceInstanceGuids string[]
    Define the service instance guids that should be bound to this application.
    tags string[]
    waitTimeMinutes number
    Define timeout to wait for the app instances to start/update/restage etc.
    app_path str
    Define the path of the zip file of the application.
    space_guid str
    Define space guid to which app belongs
    app_id str
    app_version str
    Version of the application
    buildpack str
    Buildpack to build the app. 3 options: a) Blank means autodetection; b) A Git Url pointing to a buildpack; c) Name of an installed buildpack.
    command str
    The initial command for the app
    disk_quota float
    The maximum amount of disk available to an instance of an app. In megabytes.
    environment_json Mapping[str, str]
    Key/value pairs of all the environment variables to run in your app. Does not include any system or service variables.
    health_check_http_endpoint str
    Endpoint called to determine if the app is healthy.
    health_check_timeout float
    Timeout in seconds for health checking of an staged app when starting up.
    health_check_type str
    Type of health check to perform.
    instances float
    The number of instances
    memory float
    The amount of memory each instance should have. In megabytes.
    name str
    The name for the app
    route_guids Sequence[str]
    Define the route guids which should be bound to the application.
    service_instance_guids Sequence[str]
    Define the service instance guids that should be bound to this application.
    tags Sequence[str]
    wait_time_minutes float
    Define timeout to wait for the app instances to start/update/restage etc.
    appPath String
    Define the path of the zip file of the application.
    spaceGuid String
    Define space guid to which app belongs
    appId String
    appVersion String
    Version of the application
    buildpack String
    Buildpack to build the app. 3 options: a) Blank means autodetection; b) A Git Url pointing to a buildpack; c) Name of an installed buildpack.
    command String
    The initial command for the app
    diskQuota Number
    The maximum amount of disk available to an instance of an app. In megabytes.
    environmentJson Map<String>
    Key/value pairs of all the environment variables to run in your app. Does not include any system or service variables.
    healthCheckHttpEndpoint String
    Endpoint called to determine if the app is healthy.
    healthCheckTimeout Number
    Timeout in seconds for health checking of an staged app when starting up.
    healthCheckType String
    Type of health check to perform.
    instances Number
    The number of instances
    memory Number
    The amount of memory each instance should have. In megabytes.
    name String
    The name for the app
    routeGuids List<String>
    Define the route guids which should be bound to the application.
    serviceInstanceGuids List<String>
    Define the service instance guids that should be bound to this application.
    tags List<String>
    waitTimeMinutes Number
    Define timeout to wait for the app instances to start/update/restage etc.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the App 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 App Resource

    Get an existing App 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?: AppState, opts?: CustomResourceOptions): App
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        app_id: Optional[str] = None,
        app_path: Optional[str] = None,
        app_version: Optional[str] = None,
        buildpack: Optional[str] = None,
        command: Optional[str] = None,
        disk_quota: Optional[float] = None,
        environment_json: Optional[Mapping[str, str]] = None,
        health_check_http_endpoint: Optional[str] = None,
        health_check_timeout: Optional[float] = None,
        health_check_type: Optional[str] = None,
        instances: Optional[float] = None,
        memory: Optional[float] = None,
        name: Optional[str] = None,
        route_guids: Optional[Sequence[str]] = None,
        service_instance_guids: Optional[Sequence[str]] = None,
        space_guid: Optional[str] = None,
        tags: Optional[Sequence[str]] = None,
        wait_time_minutes: Optional[float] = None) -> App
    func GetApp(ctx *Context, name string, id IDInput, state *AppState, opts ...ResourceOption) (*App, error)
    public static App Get(string name, Input<string> id, AppState? state, CustomResourceOptions? opts = null)
    public static App get(String name, Output<String> id, AppState state, CustomResourceOptions options)
    resources:  _:    type: ibm:App    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
    AppPath string
    Define the path of the zip file of the application.
    AppVersion string
    Version of the application
    Buildpack string
    Buildpack to build the app. 3 options: a) Blank means autodetection; b) A Git Url pointing to a buildpack; c) Name of an installed buildpack.
    Command string
    The initial command for the app
    DiskQuota double
    The maximum amount of disk available to an instance of an app. In megabytes.
    EnvironmentJson Dictionary<string, string>
    Key/value pairs of all the environment variables to run in your app. Does not include any system or service variables.
    HealthCheckHttpEndpoint string
    Endpoint called to determine if the app is healthy.
    HealthCheckTimeout double
    Timeout in seconds for health checking of an staged app when starting up.
    HealthCheckType string
    Type of health check to perform.
    Instances double
    The number of instances
    Memory double
    The amount of memory each instance should have. In megabytes.
    Name string
    The name for the app
    RouteGuids List<string>
    Define the route guids which should be bound to the application.
    ServiceInstanceGuids List<string>
    Define the service instance guids that should be bound to this application.
    SpaceGuid string
    Define space guid to which app belongs
    Tags List<string>
    WaitTimeMinutes double
    Define timeout to wait for the app instances to start/update/restage etc.
    AppId string
    AppPath string
    Define the path of the zip file of the application.
    AppVersion string
    Version of the application
    Buildpack string
    Buildpack to build the app. 3 options: a) Blank means autodetection; b) A Git Url pointing to a buildpack; c) Name of an installed buildpack.
    Command string
    The initial command for the app
    DiskQuota float64
    The maximum amount of disk available to an instance of an app. In megabytes.
    EnvironmentJson map[string]string
    Key/value pairs of all the environment variables to run in your app. Does not include any system or service variables.
    HealthCheckHttpEndpoint string
    Endpoint called to determine if the app is healthy.
    HealthCheckTimeout float64
    Timeout in seconds for health checking of an staged app when starting up.
    HealthCheckType string
    Type of health check to perform.
    Instances float64
    The number of instances
    Memory float64
    The amount of memory each instance should have. In megabytes.
    Name string
    The name for the app
    RouteGuids []string
    Define the route guids which should be bound to the application.
    ServiceInstanceGuids []string
    Define the service instance guids that should be bound to this application.
    SpaceGuid string
    Define space guid to which app belongs
    Tags []string
    WaitTimeMinutes float64
    Define timeout to wait for the app instances to start/update/restage etc.
    appId String
    appPath String
    Define the path of the zip file of the application.
    appVersion String
    Version of the application
    buildpack String
    Buildpack to build the app. 3 options: a) Blank means autodetection; b) A Git Url pointing to a buildpack; c) Name of an installed buildpack.
    command String
    The initial command for the app
    diskQuota Double
    The maximum amount of disk available to an instance of an app. In megabytes.
    environmentJson Map<String,String>
    Key/value pairs of all the environment variables to run in your app. Does not include any system or service variables.
    healthCheckHttpEndpoint String
    Endpoint called to determine if the app is healthy.
    healthCheckTimeout Double
    Timeout in seconds for health checking of an staged app when starting up.
    healthCheckType String
    Type of health check to perform.
    instances Double
    The number of instances
    memory Double
    The amount of memory each instance should have. In megabytes.
    name String
    The name for the app
    routeGuids List<String>
    Define the route guids which should be bound to the application.
    serviceInstanceGuids List<String>
    Define the service instance guids that should be bound to this application.
    spaceGuid String
    Define space guid to which app belongs
    tags List<String>
    waitTimeMinutes Double
    Define timeout to wait for the app instances to start/update/restage etc.
    appId string
    appPath string
    Define the path of the zip file of the application.
    appVersion string
    Version of the application
    buildpack string
    Buildpack to build the app. 3 options: a) Blank means autodetection; b) A Git Url pointing to a buildpack; c) Name of an installed buildpack.
    command string
    The initial command for the app
    diskQuota number
    The maximum amount of disk available to an instance of an app. In megabytes.
    environmentJson {[key: string]: string}
    Key/value pairs of all the environment variables to run in your app. Does not include any system or service variables.
    healthCheckHttpEndpoint string
    Endpoint called to determine if the app is healthy.
    healthCheckTimeout number
    Timeout in seconds for health checking of an staged app when starting up.
    healthCheckType string
    Type of health check to perform.
    instances number
    The number of instances
    memory number
    The amount of memory each instance should have. In megabytes.
    name string
    The name for the app
    routeGuids string[]
    Define the route guids which should be bound to the application.
    serviceInstanceGuids string[]
    Define the service instance guids that should be bound to this application.
    spaceGuid string
    Define space guid to which app belongs
    tags string[]
    waitTimeMinutes number
    Define timeout to wait for the app instances to start/update/restage etc.
    app_id str
    app_path str
    Define the path of the zip file of the application.
    app_version str
    Version of the application
    buildpack str
    Buildpack to build the app. 3 options: a) Blank means autodetection; b) A Git Url pointing to a buildpack; c) Name of an installed buildpack.
    command str
    The initial command for the app
    disk_quota float
    The maximum amount of disk available to an instance of an app. In megabytes.
    environment_json Mapping[str, str]
    Key/value pairs of all the environment variables to run in your app. Does not include any system or service variables.
    health_check_http_endpoint str
    Endpoint called to determine if the app is healthy.
    health_check_timeout float
    Timeout in seconds for health checking of an staged app when starting up.
    health_check_type str
    Type of health check to perform.
    instances float
    The number of instances
    memory float
    The amount of memory each instance should have. In megabytes.
    name str
    The name for the app
    route_guids Sequence[str]
    Define the route guids which should be bound to the application.
    service_instance_guids Sequence[str]
    Define the service instance guids that should be bound to this application.
    space_guid str
    Define space guid to which app belongs
    tags Sequence[str]
    wait_time_minutes float
    Define timeout to wait for the app instances to start/update/restage etc.
    appId String
    appPath String
    Define the path of the zip file of the application.
    appVersion String
    Version of the application
    buildpack String
    Buildpack to build the app. 3 options: a) Blank means autodetection; b) A Git Url pointing to a buildpack; c) Name of an installed buildpack.
    command String
    The initial command for the app
    diskQuota Number
    The maximum amount of disk available to an instance of an app. In megabytes.
    environmentJson Map<String>
    Key/value pairs of all the environment variables to run in your app. Does not include any system or service variables.
    healthCheckHttpEndpoint String
    Endpoint called to determine if the app is healthy.
    healthCheckTimeout Number
    Timeout in seconds for health checking of an staged app when starting up.
    healthCheckType String
    Type of health check to perform.
    instances Number
    The number of instances
    memory Number
    The amount of memory each instance should have. In megabytes.
    name String
    The name for the app
    routeGuids List<String>
    Define the route guids which should be bound to the application.
    serviceInstanceGuids List<String>
    Define the service instance guids that should be bound to this application.
    spaceGuid String
    Define space guid to which app belongs
    tags List<String>
    waitTimeMinutes Number
    Define timeout to wait for the app instances to start/update/restage etc.

    Package Details

    Repository
    ibm ibm-cloud/terraform-provider-ibm
    License
    Notes
    This Pulumi package is based on the ibm Terraform Provider.
    ibm logo
    ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
    ibm-cloud/terraform-provider-ibm