cloudfoundry.App
Explore with Pulumi AI
Provides a Cloud Foundry application resource.
Example Usage
The following example creates an application.
import * as pulumi from "@pulumi/pulumi";
import * as cloudfoundry from "@pulumi/cloudfoundry";
const spring_music = new cloudfoundry.App("spring-music", {path: "/Work/cloudfoundry/apps/spring-music/build/libs/spring-music.war"});
import pulumi
import pulumi_cloudfoundry as cloudfoundry
spring_music = cloudfoundry.App("spring-music", path="/Work/cloudfoundry/apps/spring-music/build/libs/spring-music.war")
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.NewApp(ctx, "spring-music", &cloudfoundry.AppArgs{
Path: pulumi.String("/Work/cloudfoundry/apps/spring-music/build/libs/spring-music.war"),
})
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 spring_music = new Cloudfoundry.App("spring-music", new()
{
Path = "/Work/cloudfoundry/apps/spring-music/build/libs/spring-music.war",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.cloudfoundry.App;
import com.pulumi.cloudfoundry.AppArgs;
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) {
var spring_music = new App("spring-music", AppArgs.builder()
.path("/Work/cloudfoundry/apps/spring-music/build/libs/spring-music.war")
.build());
}
}
resources:
spring-music:
type: cloudfoundry:App
properties:
path: /Work/cloudfoundry/apps/spring-music/build/libs/spring-music.war
Update resource using blue-green app id
This is an example of usage of id_bg
attribute to update your resource on a changing app id by blue-green:
import * as pulumi from "@pulumi/pulumi";
import * as cloudfoundry from "@pulumi/cloudfoundry";
const test_app_bg = new cloudfoundry.App("test-app-bg", {
space: "apaceid",
buildpack: "abuildpack",
path: "myapp.zip",
strategy: "blue-green-v2",
routes: [{
route: "arouteid",
}],
});
const test_app_bg2 = new cloudfoundry.App("test-app-bg2", {
space: "apaceid",
buildpack: "abuildpack",
path: "myapp.zip",
strategy: "blue-green-v2",
routes: [{
route: "arouteid",
}],
});
const my_policy = new cloudfoundry.NetworkPolicy("my-policy", {policies: [{
destinationApp: test_app_bg2.idBg,
port: "8080",
protocol: "tcp",
sourceApp: test_app_bg.idBg,
}]});
import pulumi
import pulumi_cloudfoundry as cloudfoundry
test_app_bg = cloudfoundry.App("test-app-bg",
space="apaceid",
buildpack="abuildpack",
path="myapp.zip",
strategy="blue-green-v2",
routes=[{
"route": "arouteid",
}])
test_app_bg2 = cloudfoundry.App("test-app-bg2",
space="apaceid",
buildpack="abuildpack",
path="myapp.zip",
strategy="blue-green-v2",
routes=[{
"route": "arouteid",
}])
my_policy = cloudfoundry.NetworkPolicy("my-policy", policies=[{
"destination_app": test_app_bg2.id_bg,
"port": "8080",
"protocol": "tcp",
"source_app": test_app_bg.id_bg,
}])
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 {
test_app_bg, err := cloudfoundry.NewApp(ctx, "test-app-bg", &cloudfoundry.AppArgs{
Space: pulumi.String("apaceid"),
Buildpack: pulumi.String("abuildpack"),
Path: pulumi.String("myapp.zip"),
Strategy: pulumi.String("blue-green-v2"),
Routes: cloudfoundry.AppRouteArray{
&cloudfoundry.AppRouteArgs{
Route: pulumi.String("arouteid"),
},
},
})
if err != nil {
return err
}
test_app_bg2, err := cloudfoundry.NewApp(ctx, "test-app-bg2", &cloudfoundry.AppArgs{
Space: pulumi.String("apaceid"),
Buildpack: pulumi.String("abuildpack"),
Path: pulumi.String("myapp.zip"),
Strategy: pulumi.String("blue-green-v2"),
Routes: cloudfoundry.AppRouteArray{
&cloudfoundry.AppRouteArgs{
Route: pulumi.String("arouteid"),
},
},
})
if err != nil {
return err
}
_, err = cloudfoundry.NewNetworkPolicy(ctx, "my-policy", &cloudfoundry.NetworkPolicyArgs{
Policies: cloudfoundry.NetworkPolicyPolicyArray{
&cloudfoundry.NetworkPolicyPolicyArgs{
DestinationApp: test_app_bg2.IdBg,
Port: pulumi.String("8080"),
Protocol: pulumi.String("tcp"),
SourceApp: test_app_bg.IdBg,
},
},
})
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 test_app_bg = new Cloudfoundry.App("test-app-bg", new()
{
Space = "apaceid",
Buildpack = "abuildpack",
Path = "myapp.zip",
Strategy = "blue-green-v2",
Routes = new[]
{
new Cloudfoundry.Inputs.AppRouteArgs
{
Route = "arouteid",
},
},
});
var test_app_bg2 = new Cloudfoundry.App("test-app-bg2", new()
{
Space = "apaceid",
Buildpack = "abuildpack",
Path = "myapp.zip",
Strategy = "blue-green-v2",
Routes = new[]
{
new Cloudfoundry.Inputs.AppRouteArgs
{
Route = "arouteid",
},
},
});
var my_policy = new Cloudfoundry.NetworkPolicy("my-policy", new()
{
Policies = new[]
{
new Cloudfoundry.Inputs.NetworkPolicyPolicyArgs
{
DestinationApp = test_app_bg2.IdBg,
Port = "8080",
Protocol = "tcp",
SourceApp = test_app_bg.IdBg,
},
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.cloudfoundry.App;
import com.pulumi.cloudfoundry.AppArgs;
import com.pulumi.cloudfoundry.inputs.AppRouteArgs;
import com.pulumi.cloudfoundry.NetworkPolicy;
import com.pulumi.cloudfoundry.NetworkPolicyArgs;
import com.pulumi.cloudfoundry.inputs.NetworkPolicyPolicyArgs;
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) {
var test_app_bg = new App("test-app-bg", AppArgs.builder()
.space("apaceid")
.buildpack("abuildpack")
.path("myapp.zip")
.strategy("blue-green-v2")
.routes(AppRouteArgs.builder()
.route("arouteid")
.build())
.build());
var test_app_bg2 = new App("test-app-bg2", AppArgs.builder()
.space("apaceid")
.buildpack("abuildpack")
.path("myapp.zip")
.strategy("blue-green-v2")
.routes(AppRouteArgs.builder()
.route("arouteid")
.build())
.build());
var my_policy = new NetworkPolicy("my-policy", NetworkPolicyArgs.builder()
.policies(NetworkPolicyPolicyArgs.builder()
.destinationApp(test_app_bg2.idBg())
.port("8080")
.protocol("tcp")
.sourceApp(test_app_bg.idBg())
.build())
.build());
}
}
resources:
test-app-bg:
type: cloudfoundry:App
properties:
space: apaceid
buildpack: abuildpack
path: myapp.zip
strategy: blue-green-v2
routes:
- route: arouteid
test-app-bg2:
type: cloudfoundry:App
properties:
space: apaceid
buildpack: abuildpack
path: myapp.zip
strategy: blue-green-v2
routes:
- route: arouteid
my-policy:
type: cloudfoundry:NetworkPolicy
properties:
policies:
- destinationApp: ${["test-app-bg2"].idBg}
port: '8080'
protocol: tcp
sourceApp: ${["test-app-bg"].idBg}
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: Optional[str] = None,
instances: Optional[float] = None,
stopped: Optional[bool] = None,
buildpacks: Optional[Sequence[str]] = None,
command: Optional[str] = None,
disk_quota: Optional[float] = None,
docker_credentials: Optional[Mapping[str, str]] = None,
docker_image: Optional[str] = None,
enable_ssh: Optional[bool] = None,
environment: Optional[Mapping[str, str]] = None,
health_check_http_endpoint: Optional[str] = None,
health_check_invocation_timeout: Optional[float] = None,
labels: Optional[Mapping[str, str]] = None,
buildpack: Optional[str] = None,
health_check_type: Optional[str] = None,
health_check_timeout: Optional[float] = None,
memory: Optional[float] = None,
name: Optional[str] = None,
path: Optional[str] = None,
ports: Optional[Sequence[float]] = None,
routes: Optional[Sequence[AppRouteArgs]] = None,
service_bindings: Optional[Sequence[AppServiceBindingArgs]] = None,
source_code_hash: Optional[str] = None,
app_id: Optional[str] = None,
stack: Optional[str] = None,
annotations: Optional[Mapping[str, str]] = None,
strategy: Optional[str] = None,
timeout: Optional[float] = None)
func NewApp(ctx *Context, name string, args AppArgs, opts ...ResourceOption) (*App, error)
public App(string name, AppArgs args, CustomResourceOptions? opts = null)
type: cloudfoundry: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 Cloudfoundry.App("appResource", new()
{
Space = "string",
Instances = 0,
Stopped = false,
Buildpacks = new[]
{
"string",
},
Command = "string",
DiskQuota = 0,
DockerCredentials =
{
{ "string", "string" },
},
DockerImage = "string",
EnableSsh = false,
Environment =
{
{ "string", "string" },
},
HealthCheckHttpEndpoint = "string",
HealthCheckInvocationTimeout = 0,
Labels =
{
{ "string", "string" },
},
Buildpack = "string",
HealthCheckType = "string",
HealthCheckTimeout = 0,
Memory = 0,
Name = "string",
Path = "string",
Ports = new[]
{
0,
},
Routes = new[]
{
new Cloudfoundry.Inputs.AppRouteArgs
{
Route = "string",
Port = 0,
},
},
ServiceBindings = new[]
{
new Cloudfoundry.Inputs.AppServiceBindingArgs
{
ServiceInstance = "string",
Params =
{
{ "string", "string" },
},
ParamsJson = "string",
},
},
SourceCodeHash = "string",
AppId = "string",
Stack = "string",
Annotations =
{
{ "string", "string" },
},
Strategy = "string",
Timeout = 0,
});
example, err := cloudfoundry.NewApp(ctx, "appResource", &cloudfoundry.AppArgs{
Space: pulumi.String("string"),
Instances: pulumi.Float64(0),
Stopped: pulumi.Bool(false),
Buildpacks: pulumi.StringArray{
pulumi.String("string"),
},
Command: pulumi.String("string"),
DiskQuota: pulumi.Float64(0),
DockerCredentials: pulumi.StringMap{
"string": pulumi.String("string"),
},
DockerImage: pulumi.String("string"),
EnableSsh: pulumi.Bool(false),
Environment: pulumi.StringMap{
"string": pulumi.String("string"),
},
HealthCheckHttpEndpoint: pulumi.String("string"),
HealthCheckInvocationTimeout: pulumi.Float64(0),
Labels: pulumi.StringMap{
"string": pulumi.String("string"),
},
Buildpack: pulumi.String("string"),
HealthCheckType: pulumi.String("string"),
HealthCheckTimeout: pulumi.Float64(0),
Memory: pulumi.Float64(0),
Name: pulumi.String("string"),
Path: pulumi.String("string"),
Ports: pulumi.Float64Array{
pulumi.Float64(0),
},
Routes: cloudfoundry.AppRouteArray{
&cloudfoundry.AppRouteArgs{
Route: pulumi.String("string"),
Port: pulumi.Float64(0),
},
},
ServiceBindings: cloudfoundry.AppServiceBindingArray{
&cloudfoundry.AppServiceBindingArgs{
ServiceInstance: pulumi.String("string"),
Params: pulumi.StringMap{
"string": pulumi.String("string"),
},
ParamsJson: pulumi.String("string"),
},
},
SourceCodeHash: pulumi.String("string"),
AppId: pulumi.String("string"),
Stack: pulumi.String("string"),
Annotations: pulumi.StringMap{
"string": pulumi.String("string"),
},
Strategy: pulumi.String("string"),
Timeout: pulumi.Float64(0),
})
var appResource = new App("appResource", AppArgs.builder()
.space("string")
.instances(0)
.stopped(false)
.buildpacks("string")
.command("string")
.diskQuota(0)
.dockerCredentials(Map.of("string", "string"))
.dockerImage("string")
.enableSsh(false)
.environment(Map.of("string", "string"))
.healthCheckHttpEndpoint("string")
.healthCheckInvocationTimeout(0)
.labels(Map.of("string", "string"))
.buildpack("string")
.healthCheckType("string")
.healthCheckTimeout(0)
.memory(0)
.name("string")
.path("string")
.ports(0)
.routes(AppRouteArgs.builder()
.route("string")
.port(0)
.build())
.serviceBindings(AppServiceBindingArgs.builder()
.serviceInstance("string")
.params(Map.of("string", "string"))
.paramsJson("string")
.build())
.sourceCodeHash("string")
.appId("string")
.stack("string")
.annotations(Map.of("string", "string"))
.strategy("string")
.timeout(0)
.build());
app_resource = cloudfoundry.App("appResource",
space="string",
instances=0,
stopped=False,
buildpacks=["string"],
command="string",
disk_quota=0,
docker_credentials={
"string": "string",
},
docker_image="string",
enable_ssh=False,
environment={
"string": "string",
},
health_check_http_endpoint="string",
health_check_invocation_timeout=0,
labels={
"string": "string",
},
buildpack="string",
health_check_type="string",
health_check_timeout=0,
memory=0,
name="string",
path="string",
ports=[0],
routes=[{
"route": "string",
"port": 0,
}],
service_bindings=[{
"service_instance": "string",
"params": {
"string": "string",
},
"params_json": "string",
}],
source_code_hash="string",
app_id="string",
stack="string",
annotations={
"string": "string",
},
strategy="string",
timeout=0)
const appResource = new cloudfoundry.App("appResource", {
space: "string",
instances: 0,
stopped: false,
buildpacks: ["string"],
command: "string",
diskQuota: 0,
dockerCredentials: {
string: "string",
},
dockerImage: "string",
enableSsh: false,
environment: {
string: "string",
},
healthCheckHttpEndpoint: "string",
healthCheckInvocationTimeout: 0,
labels: {
string: "string",
},
buildpack: "string",
healthCheckType: "string",
healthCheckTimeout: 0,
memory: 0,
name: "string",
path: "string",
ports: [0],
routes: [{
route: "string",
port: 0,
}],
serviceBindings: [{
serviceInstance: "string",
params: {
string: "string",
},
paramsJson: "string",
}],
sourceCodeHash: "string",
appId: "string",
stack: "string",
annotations: {
string: "string",
},
strategy: "string",
timeout: 0,
});
type: cloudfoundry:App
properties:
annotations:
string: string
appId: string
buildpack: string
buildpacks:
- string
command: string
diskQuota: 0
dockerCredentials:
string: string
dockerImage: string
enableSsh: false
environment:
string: string
healthCheckHttpEndpoint: string
healthCheckInvocationTimeout: 0
healthCheckTimeout: 0
healthCheckType: string
instances: 0
labels:
string: string
memory: 0
name: string
path: string
ports:
- 0
routes:
- port: 0
route: string
serviceBindings:
- params:
string: string
paramsJson: string
serviceInstance: string
sourceCodeHash: string
space: string
stack: string
stopped: false
strategy: string
timeout: 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:
- Space string
- The GUID of the associated Cloud Foundry space.
- Annotations Dictionary<string, string>
- Add annotations as described here. Works only on cloud foundry with api >= v3.63.
- App
Id string - The GUID of the application
- Buildpack string
- The buildpack used to stage the application. There are multiple options to choose from:
- a Git URL (e.g. https://github.com/cloudfoundry/java-buildpack.git) or a Git URL with a branch or tag (e.g. https://github.com/cloudfoundry/java-buildpack.git#v3.3.0 for v3.3.0 tag)
- an installed admin buildpack name (e.g. my-buildpack)
- an empty blank string to use built-in buildpacks (i.e. autodetection)
- Buildpacks List<string>
- Multiple
buildpacks
used to stage the application. When bothbuildpack
andbuildpacks
are set,buildpacks
wins. There are multiple options to choose from:- a Git URL (e.g. https://github.com/cloudfoundry/java-buildpack.git) or a Git URL with a branch or tag (e.g. https://github.com/cloudfoundry/java-buildpack.git#v3.3.0 for v3.3.0 tag)
- an installed admin buildpack name (e.g. my-buildpack)
- Command string
- A custom start command for the application. This overrides the start command provided by the buildpack.
- Disk
Quota double - The disk space to be allocated for each application instance in megabytes. If not provided, default disk quota is retrieved from Cloud Foundry and assigned.
- Docker
Credentials Dictionary<string, string> - Docker
Image string - Enable
Ssh bool - Whether to enable or disable SSH access to the container. Default is
true
unless disabled globally. - Environment Dictionary<string, string>
- Health
Check stringHttp Endpoint - Health
Check doubleInvocation Timeout - Health
Check doubleTimeout - Health
Check stringType - Instances double
- The number of app instances that you want to start. Defaults to 1.
- Labels Dictionary<string, string>
- Add labels as described here. Works only on cloud foundry with api >= v3.63.
- Memory double
- The memory limit for each application instance in megabytes. If not provided, value is computed and retreived from Cloud Foundry.
- Name string
- The name of the application.
- Path string
- Path to an app zip in the form of unix path or http url
- Ports List<double>
- Routes
List<App
Route> - Service
Bindings List<AppService Binding> - Source
Code stringHash - Stack string
- The name of the stack the application will be deployed to. Use the
cloudfoundry.getStack
data resource to lookup the available stack names to override Cloud Foundry default. - Stopped bool
- Defines the desired application state. Set to
true
to have the application remain in a stopped state. Default isfalse
, i.e. application will be started. - Strategy string
- Deployment strategy, default to none but accept blue-green strategy
- Timeout double
- Max wait time for app instance startup, in seconds. Defaults to 60 seconds.
- Space string
- The GUID of the associated Cloud Foundry space.
- Annotations map[string]string
- Add annotations as described here. Works only on cloud foundry with api >= v3.63.
- App
Id string - The GUID of the application
- Buildpack string
- The buildpack used to stage the application. There are multiple options to choose from:
- a Git URL (e.g. https://github.com/cloudfoundry/java-buildpack.git) or a Git URL with a branch or tag (e.g. https://github.com/cloudfoundry/java-buildpack.git#v3.3.0 for v3.3.0 tag)
- an installed admin buildpack name (e.g. my-buildpack)
- an empty blank string to use built-in buildpacks (i.e. autodetection)
- Buildpacks []string
- Multiple
buildpacks
used to stage the application. When bothbuildpack
andbuildpacks
are set,buildpacks
wins. There are multiple options to choose from:- a Git URL (e.g. https://github.com/cloudfoundry/java-buildpack.git) or a Git URL with a branch or tag (e.g. https://github.com/cloudfoundry/java-buildpack.git#v3.3.0 for v3.3.0 tag)
- an installed admin buildpack name (e.g. my-buildpack)
- Command string
- A custom start command for the application. This overrides the start command provided by the buildpack.
- Disk
Quota float64 - The disk space to be allocated for each application instance in megabytes. If not provided, default disk quota is retrieved from Cloud Foundry and assigned.
- Docker
Credentials map[string]string - Docker
Image string - Enable
Ssh bool - Whether to enable or disable SSH access to the container. Default is
true
unless disabled globally. - Environment map[string]string
- Health
Check stringHttp Endpoint - Health
Check float64Invocation Timeout - Health
Check float64Timeout - Health
Check stringType - Instances float64
- The number of app instances that you want to start. Defaults to 1.
- Labels map[string]string
- Add labels as described here. Works only on cloud foundry with api >= v3.63.
- Memory float64
- The memory limit for each application instance in megabytes. If not provided, value is computed and retreived from Cloud Foundry.
- Name string
- The name of the application.
- Path string
- Path to an app zip in the form of unix path or http url
- Ports []float64
- Routes
[]App
Route Args - Service
Bindings []AppService Binding Args - Source
Code stringHash - Stack string
- The name of the stack the application will be deployed to. Use the
cloudfoundry.getStack
data resource to lookup the available stack names to override Cloud Foundry default. - Stopped bool
- Defines the desired application state. Set to
true
to have the application remain in a stopped state. Default isfalse
, i.e. application will be started. - Strategy string
- Deployment strategy, default to none but accept blue-green strategy
- Timeout float64
- Max wait time for app instance startup, in seconds. Defaults to 60 seconds.
- space String
- The GUID of the associated Cloud Foundry space.
- annotations Map<String,String>
- Add annotations as described here. Works only on cloud foundry with api >= v3.63.
- app
Id String - The GUID of the application
- buildpack String
- The buildpack used to stage the application. There are multiple options to choose from:
- a Git URL (e.g. https://github.com/cloudfoundry/java-buildpack.git) or a Git URL with a branch or tag (e.g. https://github.com/cloudfoundry/java-buildpack.git#v3.3.0 for v3.3.0 tag)
- an installed admin buildpack name (e.g. my-buildpack)
- an empty blank string to use built-in buildpacks (i.e. autodetection)
- buildpacks List<String>
- Multiple
buildpacks
used to stage the application. When bothbuildpack
andbuildpacks
are set,buildpacks
wins. There are multiple options to choose from:- a Git URL (e.g. https://github.com/cloudfoundry/java-buildpack.git) or a Git URL with a branch or tag (e.g. https://github.com/cloudfoundry/java-buildpack.git#v3.3.0 for v3.3.0 tag)
- an installed admin buildpack name (e.g. my-buildpack)
- command String
- A custom start command for the application. This overrides the start command provided by the buildpack.
- disk
Quota Double - The disk space to be allocated for each application instance in megabytes. If not provided, default disk quota is retrieved from Cloud Foundry and assigned.
- docker
Credentials Map<String,String> - docker
Image String - enable
Ssh Boolean - Whether to enable or disable SSH access to the container. Default is
true
unless disabled globally. - environment Map<String,String>
- health
Check StringHttp Endpoint - health
Check DoubleInvocation Timeout - health
Check DoubleTimeout - health
Check StringType - instances Double
- The number of app instances that you want to start. Defaults to 1.
- labels Map<String,String>
- Add labels as described here. Works only on cloud foundry with api >= v3.63.
- memory Double
- The memory limit for each application instance in megabytes. If not provided, value is computed and retreived from Cloud Foundry.
- name String
- The name of the application.
- path String
- Path to an app zip in the form of unix path or http url
- ports List<Double>
- routes
List<App
Route> - service
Bindings List<AppService Binding> - source
Code StringHash - stack String
- The name of the stack the application will be deployed to. Use the
cloudfoundry.getStack
data resource to lookup the available stack names to override Cloud Foundry default. - stopped Boolean
- Defines the desired application state. Set to
true
to have the application remain in a stopped state. Default isfalse
, i.e. application will be started. - strategy String
- Deployment strategy, default to none but accept blue-green strategy
- timeout Double
- Max wait time for app instance startup, in seconds. Defaults to 60 seconds.
- space string
- The GUID of the associated Cloud Foundry space.
- annotations {[key: string]: string}
- Add annotations as described here. Works only on cloud foundry with api >= v3.63.
- app
Id string - The GUID of the application
- buildpack string
- The buildpack used to stage the application. There are multiple options to choose from:
- a Git URL (e.g. https://github.com/cloudfoundry/java-buildpack.git) or a Git URL with a branch or tag (e.g. https://github.com/cloudfoundry/java-buildpack.git#v3.3.0 for v3.3.0 tag)
- an installed admin buildpack name (e.g. my-buildpack)
- an empty blank string to use built-in buildpacks (i.e. autodetection)
- buildpacks string[]
- Multiple
buildpacks
used to stage the application. When bothbuildpack
andbuildpacks
are set,buildpacks
wins. There are multiple options to choose from:- a Git URL (e.g. https://github.com/cloudfoundry/java-buildpack.git) or a Git URL with a branch or tag (e.g. https://github.com/cloudfoundry/java-buildpack.git#v3.3.0 for v3.3.0 tag)
- an installed admin buildpack name (e.g. my-buildpack)
- command string
- A custom start command for the application. This overrides the start command provided by the buildpack.
- disk
Quota number - The disk space to be allocated for each application instance in megabytes. If not provided, default disk quota is retrieved from Cloud Foundry and assigned.
- docker
Credentials {[key: string]: string} - docker
Image string - enable
Ssh boolean - Whether to enable or disable SSH access to the container. Default is
true
unless disabled globally. - environment {[key: string]: string}
- health
Check stringHttp Endpoint - health
Check numberInvocation Timeout - health
Check numberTimeout - health
Check stringType - instances number
- The number of app instances that you want to start. Defaults to 1.
- labels {[key: string]: string}
- Add labels as described here. Works only on cloud foundry with api >= v3.63.
- memory number
- The memory limit for each application instance in megabytes. If not provided, value is computed and retreived from Cloud Foundry.
- name string
- The name of the application.
- path string
- Path to an app zip in the form of unix path or http url
- ports number[]
- routes
App
Route[] - service
Bindings AppService Binding[] - source
Code stringHash - stack string
- The name of the stack the application will be deployed to. Use the
cloudfoundry.getStack
data resource to lookup the available stack names to override Cloud Foundry default. - stopped boolean
- Defines the desired application state. Set to
true
to have the application remain in a stopped state. Default isfalse
, i.e. application will be started. - strategy string
- Deployment strategy, default to none but accept blue-green strategy
- timeout number
- Max wait time for app instance startup, in seconds. Defaults to 60 seconds.
- space str
- The GUID of the associated Cloud Foundry space.
- annotations Mapping[str, str]
- Add annotations as described here. Works only on cloud foundry with api >= v3.63.
- app_
id str - The GUID of the application
- buildpack str
- The buildpack used to stage the application. There are multiple options to choose from:
- a Git URL (e.g. https://github.com/cloudfoundry/java-buildpack.git) or a Git URL with a branch or tag (e.g. https://github.com/cloudfoundry/java-buildpack.git#v3.3.0 for v3.3.0 tag)
- an installed admin buildpack name (e.g. my-buildpack)
- an empty blank string to use built-in buildpacks (i.e. autodetection)
- buildpacks Sequence[str]
- Multiple
buildpacks
used to stage the application. When bothbuildpack
andbuildpacks
are set,buildpacks
wins. There are multiple options to choose from:- a Git URL (e.g. https://github.com/cloudfoundry/java-buildpack.git) or a Git URL with a branch or tag (e.g. https://github.com/cloudfoundry/java-buildpack.git#v3.3.0 for v3.3.0 tag)
- an installed admin buildpack name (e.g. my-buildpack)
- command str
- A custom start command for the application. This overrides the start command provided by the buildpack.
- disk_
quota float - The disk space to be allocated for each application instance in megabytes. If not provided, default disk quota is retrieved from Cloud Foundry and assigned.
- docker_
credentials Mapping[str, str] - docker_
image str - enable_
ssh bool - Whether to enable or disable SSH access to the container. Default is
true
unless disabled globally. - environment Mapping[str, str]
- health_
check_ strhttp_ endpoint - health_
check_ floatinvocation_ timeout - health_
check_ floattimeout - health_
check_ strtype - instances float
- The number of app instances that you want to start. Defaults to 1.
- labels Mapping[str, str]
- Add labels as described here. Works only on cloud foundry with api >= v3.63.
- memory float
- The memory limit for each application instance in megabytes. If not provided, value is computed and retreived from Cloud Foundry.
- name str
- The name of the application.
- path str
- Path to an app zip in the form of unix path or http url
- ports Sequence[float]
- routes
Sequence[App
Route Args] - service_
bindings Sequence[AppService Binding Args] - source_
code_ strhash - stack str
- The name of the stack the application will be deployed to. Use the
cloudfoundry.getStack
data resource to lookup the available stack names to override Cloud Foundry default. - stopped bool
- Defines the desired application state. Set to
true
to have the application remain in a stopped state. Default isfalse
, i.e. application will be started. - strategy str
- Deployment strategy, default to none but accept blue-green strategy
- timeout float
- Max wait time for app instance startup, in seconds. Defaults to 60 seconds.
- space String
- The GUID of the associated Cloud Foundry space.
- annotations Map<String>
- Add annotations as described here. Works only on cloud foundry with api >= v3.63.
- app
Id String - The GUID of the application
- buildpack String
- The buildpack used to stage the application. There are multiple options to choose from:
- a Git URL (e.g. https://github.com/cloudfoundry/java-buildpack.git) or a Git URL with a branch or tag (e.g. https://github.com/cloudfoundry/java-buildpack.git#v3.3.0 for v3.3.0 tag)
- an installed admin buildpack name (e.g. my-buildpack)
- an empty blank string to use built-in buildpacks (i.e. autodetection)
- buildpacks List<String>
- Multiple
buildpacks
used to stage the application. When bothbuildpack
andbuildpacks
are set,buildpacks
wins. There are multiple options to choose from:- a Git URL (e.g. https://github.com/cloudfoundry/java-buildpack.git) or a Git URL with a branch or tag (e.g. https://github.com/cloudfoundry/java-buildpack.git#v3.3.0 for v3.3.0 tag)
- an installed admin buildpack name (e.g. my-buildpack)
- command String
- A custom start command for the application. This overrides the start command provided by the buildpack.
- disk
Quota Number - The disk space to be allocated for each application instance in megabytes. If not provided, default disk quota is retrieved from Cloud Foundry and assigned.
- docker
Credentials Map<String> - docker
Image String - enable
Ssh Boolean - Whether to enable or disable SSH access to the container. Default is
true
unless disabled globally. - environment Map<String>
- health
Check StringHttp Endpoint - health
Check NumberInvocation Timeout - health
Check NumberTimeout - health
Check StringType - instances Number
- The number of app instances that you want to start. Defaults to 1.
- labels Map<String>
- Add labels as described here. Works only on cloud foundry with api >= v3.63.
- memory Number
- The memory limit for each application instance in megabytes. If not provided, value is computed and retreived from Cloud Foundry.
- name String
- The name of the application.
- path String
- Path to an app zip in the form of unix path or http url
- ports List<Number>
- routes List<Property Map>
- service
Bindings List<Property Map> - source
Code StringHash - stack String
- The name of the stack the application will be deployed to. Use the
cloudfoundry.getStack
data resource to lookup the available stack names to override Cloud Foundry default. - stopped Boolean
- Defines the desired application state. Set to
true
to have the application remain in a stopped state. Default isfalse
, i.e. application will be started. - strategy String
- Deployment strategy, default to none but accept blue-green strategy
- timeout Number
- Max wait time for app instance startup, in seconds. Defaults to 60 seconds.
Outputs
All input properties are implicitly available as output properties. Additionally, the App resource produces the following output properties:
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,
annotations: Optional[Mapping[str, str]] = None,
app_id: Optional[str] = None,
buildpack: Optional[str] = None,
buildpacks: Optional[Sequence[str]] = None,
command: Optional[str] = None,
disk_quota: Optional[float] = None,
docker_credentials: Optional[Mapping[str, str]] = None,
docker_image: Optional[str] = None,
enable_ssh: Optional[bool] = None,
environment: Optional[Mapping[str, str]] = None,
health_check_http_endpoint: Optional[str] = None,
health_check_invocation_timeout: Optional[float] = None,
health_check_timeout: Optional[float] = None,
health_check_type: Optional[str] = None,
id_bg: Optional[str] = None,
instances: Optional[float] = None,
labels: Optional[Mapping[str, str]] = None,
memory: Optional[float] = None,
name: Optional[str] = None,
path: Optional[str] = None,
ports: Optional[Sequence[float]] = None,
routes: Optional[Sequence[AppRouteArgs]] = None,
service_bindings: Optional[Sequence[AppServiceBindingArgs]] = None,
source_code_hash: Optional[str] = None,
space: Optional[str] = None,
stack: Optional[str] = None,
stopped: Optional[bool] = None,
strategy: Optional[str] = None,
timeout: 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: cloudfoundry: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.
- Annotations Dictionary<string, string>
- Add annotations as described here. Works only on cloud foundry with api >= v3.63.
- App
Id string - The GUID of the application
- Buildpack string
- The buildpack used to stage the application. There are multiple options to choose from:
- a Git URL (e.g. https://github.com/cloudfoundry/java-buildpack.git) or a Git URL with a branch or tag (e.g. https://github.com/cloudfoundry/java-buildpack.git#v3.3.0 for v3.3.0 tag)
- an installed admin buildpack name (e.g. my-buildpack)
- an empty blank string to use built-in buildpacks (i.e. autodetection)
- Buildpacks List<string>
- Multiple
buildpacks
used to stage the application. When bothbuildpack
andbuildpacks
are set,buildpacks
wins. There are multiple options to choose from:- a Git URL (e.g. https://github.com/cloudfoundry/java-buildpack.git) or a Git URL with a branch or tag (e.g. https://github.com/cloudfoundry/java-buildpack.git#v3.3.0 for v3.3.0 tag)
- an installed admin buildpack name (e.g. my-buildpack)
- Command string
- A custom start command for the application. This overrides the start command provided by the buildpack.
- Disk
Quota double - The disk space to be allocated for each application instance in megabytes. If not provided, default disk quota is retrieved from Cloud Foundry and assigned.
- Docker
Credentials Dictionary<string, string> - Docker
Image string - Enable
Ssh bool - Whether to enable or disable SSH access to the container. Default is
true
unless disabled globally. - Environment Dictionary<string, string>
- Health
Check stringHttp Endpoint - Health
Check doubleInvocation Timeout - Health
Check doubleTimeout - Health
Check stringType - Id
Bg string - The GUID of the application updated by resource when strategy is blue-green.
- Instances double
- The number of app instances that you want to start. Defaults to 1.
- Labels Dictionary<string, string>
- Add labels as described here. Works only on cloud foundry with api >= v3.63.
- Memory double
- The memory limit for each application instance in megabytes. If not provided, value is computed and retreived from Cloud Foundry.
- Name string
- The name of the application.
- Path string
- Path to an app zip in the form of unix path or http url
- Ports List<double>
- Routes
List<App
Route> - Service
Bindings List<AppService Binding> - Source
Code stringHash - Space string
- The GUID of the associated Cloud Foundry space.
- Stack string
- The name of the stack the application will be deployed to. Use the
cloudfoundry.getStack
data resource to lookup the available stack names to override Cloud Foundry default. - Stopped bool
- Defines the desired application state. Set to
true
to have the application remain in a stopped state. Default isfalse
, i.e. application will be started. - Strategy string
- Deployment strategy, default to none but accept blue-green strategy
- Timeout double
- Max wait time for app instance startup, in seconds. Defaults to 60 seconds.
- Annotations map[string]string
- Add annotations as described here. Works only on cloud foundry with api >= v3.63.
- App
Id string - The GUID of the application
- Buildpack string
- The buildpack used to stage the application. There are multiple options to choose from:
- a Git URL (e.g. https://github.com/cloudfoundry/java-buildpack.git) or a Git URL with a branch or tag (e.g. https://github.com/cloudfoundry/java-buildpack.git#v3.3.0 for v3.3.0 tag)
- an installed admin buildpack name (e.g. my-buildpack)
- an empty blank string to use built-in buildpacks (i.e. autodetection)
- Buildpacks []string
- Multiple
buildpacks
used to stage the application. When bothbuildpack
andbuildpacks
are set,buildpacks
wins. There are multiple options to choose from:- a Git URL (e.g. https://github.com/cloudfoundry/java-buildpack.git) or a Git URL with a branch or tag (e.g. https://github.com/cloudfoundry/java-buildpack.git#v3.3.0 for v3.3.0 tag)
- an installed admin buildpack name (e.g. my-buildpack)
- Command string
- A custom start command for the application. This overrides the start command provided by the buildpack.
- Disk
Quota float64 - The disk space to be allocated for each application instance in megabytes. If not provided, default disk quota is retrieved from Cloud Foundry and assigned.
- Docker
Credentials map[string]string - Docker
Image string - Enable
Ssh bool - Whether to enable or disable SSH access to the container. Default is
true
unless disabled globally. - Environment map[string]string
- Health
Check stringHttp Endpoint - Health
Check float64Invocation Timeout - Health
Check float64Timeout - Health
Check stringType - Id
Bg string - The GUID of the application updated by resource when strategy is blue-green.
- Instances float64
- The number of app instances that you want to start. Defaults to 1.
- Labels map[string]string
- Add labels as described here. Works only on cloud foundry with api >= v3.63.
- Memory float64
- The memory limit for each application instance in megabytes. If not provided, value is computed and retreived from Cloud Foundry.
- Name string
- The name of the application.
- Path string
- Path to an app zip in the form of unix path or http url
- Ports []float64
- Routes
[]App
Route Args - Service
Bindings []AppService Binding Args - Source
Code stringHash - Space string
- The GUID of the associated Cloud Foundry space.
- Stack string
- The name of the stack the application will be deployed to. Use the
cloudfoundry.getStack
data resource to lookup the available stack names to override Cloud Foundry default. - Stopped bool
- Defines the desired application state. Set to
true
to have the application remain in a stopped state. Default isfalse
, i.e. application will be started. - Strategy string
- Deployment strategy, default to none but accept blue-green strategy
- Timeout float64
- Max wait time for app instance startup, in seconds. Defaults to 60 seconds.
- annotations Map<String,String>
- Add annotations as described here. Works only on cloud foundry with api >= v3.63.
- app
Id String - The GUID of the application
- buildpack String
- The buildpack used to stage the application. There are multiple options to choose from:
- a Git URL (e.g. https://github.com/cloudfoundry/java-buildpack.git) or a Git URL with a branch or tag (e.g. https://github.com/cloudfoundry/java-buildpack.git#v3.3.0 for v3.3.0 tag)
- an installed admin buildpack name (e.g. my-buildpack)
- an empty blank string to use built-in buildpacks (i.e. autodetection)
- buildpacks List<String>
- Multiple
buildpacks
used to stage the application. When bothbuildpack
andbuildpacks
are set,buildpacks
wins. There are multiple options to choose from:- a Git URL (e.g. https://github.com/cloudfoundry/java-buildpack.git) or a Git URL with a branch or tag (e.g. https://github.com/cloudfoundry/java-buildpack.git#v3.3.0 for v3.3.0 tag)
- an installed admin buildpack name (e.g. my-buildpack)
- command String
- A custom start command for the application. This overrides the start command provided by the buildpack.
- disk
Quota Double - The disk space to be allocated for each application instance in megabytes. If not provided, default disk quota is retrieved from Cloud Foundry and assigned.
- docker
Credentials Map<String,String> - docker
Image String - enable
Ssh Boolean - Whether to enable or disable SSH access to the container. Default is
true
unless disabled globally. - environment Map<String,String>
- health
Check StringHttp Endpoint - health
Check DoubleInvocation Timeout - health
Check DoubleTimeout - health
Check StringType - id
Bg String - The GUID of the application updated by resource when strategy is blue-green.
- instances Double
- The number of app instances that you want to start. Defaults to 1.
- labels Map<String,String>
- Add labels as described here. Works only on cloud foundry with api >= v3.63.
- memory Double
- The memory limit for each application instance in megabytes. If not provided, value is computed and retreived from Cloud Foundry.
- name String
- The name of the application.
- path String
- Path to an app zip in the form of unix path or http url
- ports List<Double>
- routes
List<App
Route> - service
Bindings List<AppService Binding> - source
Code StringHash - space String
- The GUID of the associated Cloud Foundry space.
- stack String
- The name of the stack the application will be deployed to. Use the
cloudfoundry.getStack
data resource to lookup the available stack names to override Cloud Foundry default. - stopped Boolean
- Defines the desired application state. Set to
true
to have the application remain in a stopped state. Default isfalse
, i.e. application will be started. - strategy String
- Deployment strategy, default to none but accept blue-green strategy
- timeout Double
- Max wait time for app instance startup, in seconds. Defaults to 60 seconds.
- annotations {[key: string]: string}
- Add annotations as described here. Works only on cloud foundry with api >= v3.63.
- app
Id string - The GUID of the application
- buildpack string
- The buildpack used to stage the application. There are multiple options to choose from:
- a Git URL (e.g. https://github.com/cloudfoundry/java-buildpack.git) or a Git URL with a branch or tag (e.g. https://github.com/cloudfoundry/java-buildpack.git#v3.3.0 for v3.3.0 tag)
- an installed admin buildpack name (e.g. my-buildpack)
- an empty blank string to use built-in buildpacks (i.e. autodetection)
- buildpacks string[]
- Multiple
buildpacks
used to stage the application. When bothbuildpack
andbuildpacks
are set,buildpacks
wins. There are multiple options to choose from:- a Git URL (e.g. https://github.com/cloudfoundry/java-buildpack.git) or a Git URL with a branch or tag (e.g. https://github.com/cloudfoundry/java-buildpack.git#v3.3.0 for v3.3.0 tag)
- an installed admin buildpack name (e.g. my-buildpack)
- command string
- A custom start command for the application. This overrides the start command provided by the buildpack.
- disk
Quota number - The disk space to be allocated for each application instance in megabytes. If not provided, default disk quota is retrieved from Cloud Foundry and assigned.
- docker
Credentials {[key: string]: string} - docker
Image string - enable
Ssh boolean - Whether to enable or disable SSH access to the container. Default is
true
unless disabled globally. - environment {[key: string]: string}
- health
Check stringHttp Endpoint - health
Check numberInvocation Timeout - health
Check numberTimeout - health
Check stringType - id
Bg string - The GUID of the application updated by resource when strategy is blue-green.
- instances number
- The number of app instances that you want to start. Defaults to 1.
- labels {[key: string]: string}
- Add labels as described here. Works only on cloud foundry with api >= v3.63.
- memory number
- The memory limit for each application instance in megabytes. If not provided, value is computed and retreived from Cloud Foundry.
- name string
- The name of the application.
- path string
- Path to an app zip in the form of unix path or http url
- ports number[]
- routes
App
Route[] - service
Bindings AppService Binding[] - source
Code stringHash - space string
- The GUID of the associated Cloud Foundry space.
- stack string
- The name of the stack the application will be deployed to. Use the
cloudfoundry.getStack
data resource to lookup the available stack names to override Cloud Foundry default. - stopped boolean
- Defines the desired application state. Set to
true
to have the application remain in a stopped state. Default isfalse
, i.e. application will be started. - strategy string
- Deployment strategy, default to none but accept blue-green strategy
- timeout number
- Max wait time for app instance startup, in seconds. Defaults to 60 seconds.
- annotations Mapping[str, str]
- Add annotations as described here. Works only on cloud foundry with api >= v3.63.
- app_
id str - The GUID of the application
- buildpack str
- The buildpack used to stage the application. There are multiple options to choose from:
- a Git URL (e.g. https://github.com/cloudfoundry/java-buildpack.git) or a Git URL with a branch or tag (e.g. https://github.com/cloudfoundry/java-buildpack.git#v3.3.0 for v3.3.0 tag)
- an installed admin buildpack name (e.g. my-buildpack)
- an empty blank string to use built-in buildpacks (i.e. autodetection)
- buildpacks Sequence[str]
- Multiple
buildpacks
used to stage the application. When bothbuildpack
andbuildpacks
are set,buildpacks
wins. There are multiple options to choose from:- a Git URL (e.g. https://github.com/cloudfoundry/java-buildpack.git) or a Git URL with a branch or tag (e.g. https://github.com/cloudfoundry/java-buildpack.git#v3.3.0 for v3.3.0 tag)
- an installed admin buildpack name (e.g. my-buildpack)
- command str
- A custom start command for the application. This overrides the start command provided by the buildpack.
- disk_
quota float - The disk space to be allocated for each application instance in megabytes. If not provided, default disk quota is retrieved from Cloud Foundry and assigned.
- docker_
credentials Mapping[str, str] - docker_
image str - enable_
ssh bool - Whether to enable or disable SSH access to the container. Default is
true
unless disabled globally. - environment Mapping[str, str]
- health_
check_ strhttp_ endpoint - health_
check_ floatinvocation_ timeout - health_
check_ floattimeout - health_
check_ strtype - id_
bg str - The GUID of the application updated by resource when strategy is blue-green.
- instances float
- The number of app instances that you want to start. Defaults to 1.
- labels Mapping[str, str]
- Add labels as described here. Works only on cloud foundry with api >= v3.63.
- memory float
- The memory limit for each application instance in megabytes. If not provided, value is computed and retreived from Cloud Foundry.
- name str
- The name of the application.
- path str
- Path to an app zip in the form of unix path or http url
- ports Sequence[float]
- routes
Sequence[App
Route Args] - service_
bindings Sequence[AppService Binding Args] - source_
code_ strhash - space str
- The GUID of the associated Cloud Foundry space.
- stack str
- The name of the stack the application will be deployed to. Use the
cloudfoundry.getStack
data resource to lookup the available stack names to override Cloud Foundry default. - stopped bool
- Defines the desired application state. Set to
true
to have the application remain in a stopped state. Default isfalse
, i.e. application will be started. - strategy str
- Deployment strategy, default to none but accept blue-green strategy
- timeout float
- Max wait time for app instance startup, in seconds. Defaults to 60 seconds.
- annotations Map<String>
- Add annotations as described here. Works only on cloud foundry with api >= v3.63.
- app
Id String - The GUID of the application
- buildpack String
- The buildpack used to stage the application. There are multiple options to choose from:
- a Git URL (e.g. https://github.com/cloudfoundry/java-buildpack.git) or a Git URL with a branch or tag (e.g. https://github.com/cloudfoundry/java-buildpack.git#v3.3.0 for v3.3.0 tag)
- an installed admin buildpack name (e.g. my-buildpack)
- an empty blank string to use built-in buildpacks (i.e. autodetection)
- buildpacks List<String>
- Multiple
buildpacks
used to stage the application. When bothbuildpack
andbuildpacks
are set,buildpacks
wins. There are multiple options to choose from:- a Git URL (e.g. https://github.com/cloudfoundry/java-buildpack.git) or a Git URL with a branch or tag (e.g. https://github.com/cloudfoundry/java-buildpack.git#v3.3.0 for v3.3.0 tag)
- an installed admin buildpack name (e.g. my-buildpack)
- command String
- A custom start command for the application. This overrides the start command provided by the buildpack.
- disk
Quota Number - The disk space to be allocated for each application instance in megabytes. If not provided, default disk quota is retrieved from Cloud Foundry and assigned.
- docker
Credentials Map<String> - docker
Image String - enable
Ssh Boolean - Whether to enable or disable SSH access to the container. Default is
true
unless disabled globally. - environment Map<String>
- health
Check StringHttp Endpoint - health
Check NumberInvocation Timeout - health
Check NumberTimeout - health
Check StringType - id
Bg String - The GUID of the application updated by resource when strategy is blue-green.
- instances Number
- The number of app instances that you want to start. Defaults to 1.
- labels Map<String>
- Add labels as described here. Works only on cloud foundry with api >= v3.63.
- memory Number
- The memory limit for each application instance in megabytes. If not provided, value is computed and retreived from Cloud Foundry.
- name String
- The name of the application.
- path String
- Path to an app zip in the form of unix path or http url
- ports List<Number>
- routes List<Property Map>
- service
Bindings List<Property Map> - source
Code StringHash - space String
- The GUID of the associated Cloud Foundry space.
- stack String
- The name of the stack the application will be deployed to. Use the
cloudfoundry.getStack
data resource to lookup the available stack names to override Cloud Foundry default. - stopped Boolean
- Defines the desired application state. Set to
true
to have the application remain in a stopped state. Default isfalse
, i.e. application will be started. - strategy String
- Deployment strategy, default to none but accept blue-green strategy
- timeout Number
- Max wait time for app instance startup, in seconds. Defaults to 60 seconds.
Supporting Types
AppRoute, AppRouteArgs
- Route string
- The route id. Route can be defined using the
cloudfoundry.Route
resource - Port double
The port of the application to map the tcp route to.
NOTE: in the future, the
route
block will support theport
attribute illustrated above to allow mapping of tcp routes, and listening on custom or multiple ports. NOTE: Route mappings can be controlled from either thecloudfoundry_app.routes
or thecloudfoundry_routes.target
attributes. Using both syntaxes will cause conflicts and result in unpredictable behavior. NOTE: A given route can not currently be mapped to more than one application using thecloudfoundry_app.routes
syntax. As an alternative, use thecloudfoundry_route.target
syntax instead in this specific use-case. NOTE: Resource only manages route mapping previously set by resource.
- Route string
- The route id. Route can be defined using the
cloudfoundry.Route
resource - Port float64
The port of the application to map the tcp route to.
NOTE: in the future, the
route
block will support theport
attribute illustrated above to allow mapping of tcp routes, and listening on custom or multiple ports. NOTE: Route mappings can be controlled from either thecloudfoundry_app.routes
or thecloudfoundry_routes.target
attributes. Using both syntaxes will cause conflicts and result in unpredictable behavior. NOTE: A given route can not currently be mapped to more than one application using thecloudfoundry_app.routes
syntax. As an alternative, use thecloudfoundry_route.target
syntax instead in this specific use-case. NOTE: Resource only manages route mapping previously set by resource.
- route String
- The route id. Route can be defined using the
cloudfoundry.Route
resource - port Double
The port of the application to map the tcp route to.
NOTE: in the future, the
route
block will support theport
attribute illustrated above to allow mapping of tcp routes, and listening on custom or multiple ports. NOTE: Route mappings can be controlled from either thecloudfoundry_app.routes
or thecloudfoundry_routes.target
attributes. Using both syntaxes will cause conflicts and result in unpredictable behavior. NOTE: A given route can not currently be mapped to more than one application using thecloudfoundry_app.routes
syntax. As an alternative, use thecloudfoundry_route.target
syntax instead in this specific use-case. NOTE: Resource only manages route mapping previously set by resource.
- route string
- The route id. Route can be defined using the
cloudfoundry.Route
resource - port number
The port of the application to map the tcp route to.
NOTE: in the future, the
route
block will support theport
attribute illustrated above to allow mapping of tcp routes, and listening on custom or multiple ports. NOTE: Route mappings can be controlled from either thecloudfoundry_app.routes
or thecloudfoundry_routes.target
attributes. Using both syntaxes will cause conflicts and result in unpredictable behavior. NOTE: A given route can not currently be mapped to more than one application using thecloudfoundry_app.routes
syntax. As an alternative, use thecloudfoundry_route.target
syntax instead in this specific use-case. NOTE: Resource only manages route mapping previously set by resource.
- route str
- The route id. Route can be defined using the
cloudfoundry.Route
resource - port float
The port of the application to map the tcp route to.
NOTE: in the future, the
route
block will support theport
attribute illustrated above to allow mapping of tcp routes, and listening on custom or multiple ports. NOTE: Route mappings can be controlled from either thecloudfoundry_app.routes
or thecloudfoundry_routes.target
attributes. Using both syntaxes will cause conflicts and result in unpredictable behavior. NOTE: A given route can not currently be mapped to more than one application using thecloudfoundry_app.routes
syntax. As an alternative, use thecloudfoundry_route.target
syntax instead in this specific use-case. NOTE: Resource only manages route mapping previously set by resource.
- route String
- The route id. Route can be defined using the
cloudfoundry.Route
resource - port Number
The port of the application to map the tcp route to.
NOTE: in the future, the
route
block will support theport
attribute illustrated above to allow mapping of tcp routes, and listening on custom or multiple ports. NOTE: Route mappings can be controlled from either thecloudfoundry_app.routes
or thecloudfoundry_routes.target
attributes. Using both syntaxes will cause conflicts and result in unpredictable behavior. NOTE: A given route can not currently be mapped to more than one application using thecloudfoundry_app.routes
syntax. As an alternative, use thecloudfoundry_route.target
syntax instead in this specific use-case. NOTE: Resource only manages route mapping previously set by resource.
AppServiceBinding, AppServiceBindingArgs
- Service
Instance string - The service instance GUID.
- Params Dictionary<string, string>
A list of key/value parameters used by the service broker to create the binding. Defaults to empty map.
NOTE: Modifying this argument will cause the application to be restaged. NOTE: Resource only manages service binding previously set by resource.
- Params
Json string
- Service
Instance string - The service instance GUID.
- Params map[string]string
A list of key/value parameters used by the service broker to create the binding. Defaults to empty map.
NOTE: Modifying this argument will cause the application to be restaged. NOTE: Resource only manages service binding previously set by resource.
- Params
Json string
- service
Instance String - The service instance GUID.
- params Map<String,String>
A list of key/value parameters used by the service broker to create the binding. Defaults to empty map.
NOTE: Modifying this argument will cause the application to be restaged. NOTE: Resource only manages service binding previously set by resource.
- params
Json String
- service
Instance string - The service instance GUID.
- params {[key: string]: string}
A list of key/value parameters used by the service broker to create the binding. Defaults to empty map.
NOTE: Modifying this argument will cause the application to be restaged. NOTE: Resource only manages service binding previously set by resource.
- params
Json string
- service_
instance str - The service instance GUID.
- params Mapping[str, str]
A list of key/value parameters used by the service broker to create the binding. Defaults to empty map.
NOTE: Modifying this argument will cause the application to be restaged. NOTE: Resource only manages service binding previously set by resource.
- params_
json str
- service
Instance String - The service instance GUID.
- params Map<String>
A list of key/value parameters used by the service broker to create the binding. Defaults to empty map.
NOTE: Modifying this argument will cause the application to be restaged. NOTE: Resource only manages service binding previously set by resource.
- params
Json String
Import
The current App can be imported using the app
GUID, e.g.
bash
$ pulumi import cloudfoundry:index/app:App spring-music 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.