1. Packages
  2. Ibm Provider
  3. API Docs
  4. CodeEngineApp
ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud

ibm.CodeEngineApp

Explore with Pulumi AI

Create, update, and delete code_engine_apps with this resource.

Example Usage

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

const codeEngineAppInstance = new ibm.CodeEngineApp("codeEngineAppInstance", {
    projectId: ibm_code_engine_project.code_engine_project_instance.project_id,
    imageReference: "icr.io/codeengine/helloworld",
    runEnvVariables: [
        {
            type: "literal",
            name: "name",
            value: "value",
        },
        {
            type: "secret_full_reference",
            name: "secret_env_var",
            reference: "secret_name",
        },
    ],
});
Copy
import pulumi
import pulumi_ibm as ibm

code_engine_app_instance = ibm.CodeEngineApp("codeEngineAppInstance",
    project_id=ibm_code_engine_project["code_engine_project_instance"]["project_id"],
    image_reference="icr.io/codeengine/helloworld",
    run_env_variables=[
        {
            "type": "literal",
            "name": "name",
            "value": "value",
        },
        {
            "type": "secret_full_reference",
            "name": "secret_env_var",
            "reference": "secret_name",
        },
    ])
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ibm.NewCodeEngineApp(ctx, "codeEngineAppInstance", &ibm.CodeEngineAppArgs{
			ProjectId:      pulumi.Any(ibm_code_engine_project.Code_engine_project_instance.Project_id),
			ImageReference: pulumi.String("icr.io/codeengine/helloworld"),
			RunEnvVariables: ibm.CodeEngineAppRunEnvVariableArray{
				&ibm.CodeEngineAppRunEnvVariableArgs{
					Type:  pulumi.String("literal"),
					Name:  pulumi.String("name"),
					Value: pulumi.String("value"),
				},
				&ibm.CodeEngineAppRunEnvVariableArgs{
					Type:      pulumi.String("secret_full_reference"),
					Name:      pulumi.String("secret_env_var"),
					Reference: pulumi.String("secret_name"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;

return await Deployment.RunAsync(() => 
{
    var codeEngineAppInstance = new Ibm.CodeEngineApp("codeEngineAppInstance", new()
    {
        ProjectId = ibm_code_engine_project.Code_engine_project_instance.Project_id,
        ImageReference = "icr.io/codeengine/helloworld",
        RunEnvVariables = new[]
        {
            new Ibm.Inputs.CodeEngineAppRunEnvVariableArgs
            {
                Type = "literal",
                Name = "name",
                Value = "value",
            },
            new Ibm.Inputs.CodeEngineAppRunEnvVariableArgs
            {
                Type = "secret_full_reference",
                Name = "secret_env_var",
                Reference = "secret_name",
            },
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.CodeEngineApp;
import com.pulumi.ibm.CodeEngineAppArgs;
import com.pulumi.ibm.inputs.CodeEngineAppRunEnvVariableArgs;
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 codeEngineAppInstance = new CodeEngineApp("codeEngineAppInstance", CodeEngineAppArgs.builder()
            .projectId(ibm_code_engine_project.code_engine_project_instance().project_id())
            .imageReference("icr.io/codeengine/helloworld")
            .runEnvVariables(            
                CodeEngineAppRunEnvVariableArgs.builder()
                    .type("literal")
                    .name("name")
                    .value("value")
                    .build(),
                CodeEngineAppRunEnvVariableArgs.builder()
                    .type("secret_full_reference")
                    .name("secret_env_var")
                    .reference("secret_name")
                    .build())
            .build());

    }
}
Copy
resources:
  codeEngineAppInstance:
    type: ibm:CodeEngineApp
    properties:
      projectId: ${ibm_code_engine_project.code_engine_project_instance.project_id}
      imageReference: icr.io/codeengine/helloworld
      runEnvVariables:
        - type: literal
          name: name
          value: value
        - type: secret_full_reference
          name: secret_env_var
          reference: secret_name
Copy

Create CodeEngineApp Resource

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

Constructor syntax

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

@overload
def CodeEngineApp(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  image_reference: Optional[str] = None,
                  project_id: Optional[str] = None,
                  run_env_variables: Optional[Sequence[CodeEngineAppRunEnvVariableArgs]] = None,
                  image_port: Optional[float] = None,
                  managed_domain_mappings: Optional[str] = None,
                  name: Optional[str] = None,
                  probe_liveness: Optional[CodeEngineAppProbeLivenessArgs] = None,
                  probe_readiness: Optional[CodeEngineAppProbeReadinessArgs] = None,
                  run_service_account: Optional[str] = None,
                  run_arguments: Optional[Sequence[str]] = None,
                  run_as_user: Optional[float] = None,
                  run_commands: Optional[Sequence[str]] = None,
                  image_secret: Optional[str] = None,
                  code_engine_app_id: Optional[str] = None,
                  scale_down_delay: Optional[float] = None,
                  scale_concurrency: Optional[float] = None,
                  scale_concurrency_target: Optional[float] = None,
                  scale_cpu_limit: Optional[str] = None,
                  run_volume_mounts: Optional[Sequence[CodeEngineAppRunVolumeMountArgs]] = None,
                  scale_ephemeral_storage_limit: Optional[str] = None,
                  scale_initial_instances: Optional[float] = None,
                  scale_max_instances: Optional[float] = None,
                  scale_memory_limit: Optional[str] = None,
                  scale_min_instances: Optional[float] = None,
                  scale_request_timeout: Optional[float] = None,
                  timeouts: Optional[CodeEngineAppTimeoutsArgs] = None)
func NewCodeEngineApp(ctx *Context, name string, args CodeEngineAppArgs, opts ...ResourceOption) (*CodeEngineApp, error)
public CodeEngineApp(string name, CodeEngineAppArgs args, CustomResourceOptions? opts = null)
public CodeEngineApp(String name, CodeEngineAppArgs args)
public CodeEngineApp(String name, CodeEngineAppArgs args, CustomResourceOptions options)
type: ibm:CodeEngineApp
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. CodeEngineAppArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. CodeEngineAppArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. CodeEngineAppArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. CodeEngineAppArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. CodeEngineAppArgs
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 codeEngineAppResource = new Ibm.CodeEngineApp("codeEngineAppResource", new()
{
    ImageReference = "string",
    ProjectId = "string",
    RunEnvVariables = new[]
    {
        new Ibm.Inputs.CodeEngineAppRunEnvVariableArgs
        {
            Key = "string",
            Name = "string",
            Prefix = "string",
            Reference = "string",
            Type = "string",
            Value = "string",
        },
    },
    ImagePort = 0,
    ManagedDomainMappings = "string",
    Name = "string",
    ProbeLiveness = new Ibm.Inputs.CodeEngineAppProbeLivenessArgs
    {
        FailureThreshold = 0,
        InitialDelay = 0,
        Interval = 0,
        Path = "string",
        Port = 0,
        Timeout = 0,
        Type = "string",
    },
    ProbeReadiness = new Ibm.Inputs.CodeEngineAppProbeReadinessArgs
    {
        FailureThreshold = 0,
        InitialDelay = 0,
        Interval = 0,
        Path = "string",
        Port = 0,
        Timeout = 0,
        Type = "string",
    },
    RunServiceAccount = "string",
    RunArguments = new[]
    {
        "string",
    },
    RunAsUser = 0,
    RunCommands = new[]
    {
        "string",
    },
    ImageSecret = "string",
    CodeEngineAppId = "string",
    ScaleDownDelay = 0,
    ScaleConcurrency = 0,
    ScaleConcurrencyTarget = 0,
    ScaleCpuLimit = "string",
    RunVolumeMounts = new[]
    {
        new Ibm.Inputs.CodeEngineAppRunVolumeMountArgs
        {
            MountPath = "string",
            Name = "string",
            Reference = "string",
            Type = "string",
        },
    },
    ScaleEphemeralStorageLimit = "string",
    ScaleInitialInstances = 0,
    ScaleMaxInstances = 0,
    ScaleMemoryLimit = "string",
    ScaleMinInstances = 0,
    ScaleRequestTimeout = 0,
    Timeouts = new Ibm.Inputs.CodeEngineAppTimeoutsArgs
    {
        Create = "string",
        Update = "string",
    },
});
Copy
example, err := ibm.NewCodeEngineApp(ctx, "codeEngineAppResource", &ibm.CodeEngineAppArgs{
ImageReference: pulumi.String("string"),
ProjectId: pulumi.String("string"),
RunEnvVariables: .CodeEngineAppRunEnvVariableArray{
&.CodeEngineAppRunEnvVariableArgs{
Key: pulumi.String("string"),
Name: pulumi.String("string"),
Prefix: pulumi.String("string"),
Reference: pulumi.String("string"),
Type: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
ImagePort: pulumi.Float64(0),
ManagedDomainMappings: pulumi.String("string"),
Name: pulumi.String("string"),
ProbeLiveness: &.CodeEngineAppProbeLivenessArgs{
FailureThreshold: pulumi.Float64(0),
InitialDelay: pulumi.Float64(0),
Interval: pulumi.Float64(0),
Path: pulumi.String("string"),
Port: pulumi.Float64(0),
Timeout: pulumi.Float64(0),
Type: pulumi.String("string"),
},
ProbeReadiness: &.CodeEngineAppProbeReadinessArgs{
FailureThreshold: pulumi.Float64(0),
InitialDelay: pulumi.Float64(0),
Interval: pulumi.Float64(0),
Path: pulumi.String("string"),
Port: pulumi.Float64(0),
Timeout: pulumi.Float64(0),
Type: pulumi.String("string"),
},
RunServiceAccount: pulumi.String("string"),
RunArguments: pulumi.StringArray{
pulumi.String("string"),
},
RunAsUser: pulumi.Float64(0),
RunCommands: pulumi.StringArray{
pulumi.String("string"),
},
ImageSecret: pulumi.String("string"),
CodeEngineAppId: pulumi.String("string"),
ScaleDownDelay: pulumi.Float64(0),
ScaleConcurrency: pulumi.Float64(0),
ScaleConcurrencyTarget: pulumi.Float64(0),
ScaleCpuLimit: pulumi.String("string"),
RunVolumeMounts: .CodeEngineAppRunVolumeMountArray{
&.CodeEngineAppRunVolumeMountArgs{
MountPath: pulumi.String("string"),
Name: pulumi.String("string"),
Reference: pulumi.String("string"),
Type: pulumi.String("string"),
},
},
ScaleEphemeralStorageLimit: pulumi.String("string"),
ScaleInitialInstances: pulumi.Float64(0),
ScaleMaxInstances: pulumi.Float64(0),
ScaleMemoryLimit: pulumi.String("string"),
ScaleMinInstances: pulumi.Float64(0),
ScaleRequestTimeout: pulumi.Float64(0),
Timeouts: &.CodeEngineAppTimeoutsArgs{
Create: pulumi.String("string"),
Update: pulumi.String("string"),
},
})
Copy
var codeEngineAppResource = new CodeEngineApp("codeEngineAppResource", CodeEngineAppArgs.builder()
    .imageReference("string")
    .projectId("string")
    .runEnvVariables(CodeEngineAppRunEnvVariableArgs.builder()
        .key("string")
        .name("string")
        .prefix("string")
        .reference("string")
        .type("string")
        .value("string")
        .build())
    .imagePort(0)
    .managedDomainMappings("string")
    .name("string")
    .probeLiveness(CodeEngineAppProbeLivenessArgs.builder()
        .failureThreshold(0)
        .initialDelay(0)
        .interval(0)
        .path("string")
        .port(0)
        .timeout(0)
        .type("string")
        .build())
    .probeReadiness(CodeEngineAppProbeReadinessArgs.builder()
        .failureThreshold(0)
        .initialDelay(0)
        .interval(0)
        .path("string")
        .port(0)
        .timeout(0)
        .type("string")
        .build())
    .runServiceAccount("string")
    .runArguments("string")
    .runAsUser(0)
    .runCommands("string")
    .imageSecret("string")
    .codeEngineAppId("string")
    .scaleDownDelay(0)
    .scaleConcurrency(0)
    .scaleConcurrencyTarget(0)
    .scaleCpuLimit("string")
    .runVolumeMounts(CodeEngineAppRunVolumeMountArgs.builder()
        .mountPath("string")
        .name("string")
        .reference("string")
        .type("string")
        .build())
    .scaleEphemeralStorageLimit("string")
    .scaleInitialInstances(0)
    .scaleMaxInstances(0)
    .scaleMemoryLimit("string")
    .scaleMinInstances(0)
    .scaleRequestTimeout(0)
    .timeouts(CodeEngineAppTimeoutsArgs.builder()
        .create("string")
        .update("string")
        .build())
    .build());
Copy
code_engine_app_resource = ibm.CodeEngineApp("codeEngineAppResource",
    image_reference="string",
    project_id="string",
    run_env_variables=[{
        "key": "string",
        "name": "string",
        "prefix": "string",
        "reference": "string",
        "type": "string",
        "value": "string",
    }],
    image_port=0,
    managed_domain_mappings="string",
    name="string",
    probe_liveness={
        "failure_threshold": 0,
        "initial_delay": 0,
        "interval": 0,
        "path": "string",
        "port": 0,
        "timeout": 0,
        "type": "string",
    },
    probe_readiness={
        "failure_threshold": 0,
        "initial_delay": 0,
        "interval": 0,
        "path": "string",
        "port": 0,
        "timeout": 0,
        "type": "string",
    },
    run_service_account="string",
    run_arguments=["string"],
    run_as_user=0,
    run_commands=["string"],
    image_secret="string",
    code_engine_app_id="string",
    scale_down_delay=0,
    scale_concurrency=0,
    scale_concurrency_target=0,
    scale_cpu_limit="string",
    run_volume_mounts=[{
        "mount_path": "string",
        "name": "string",
        "reference": "string",
        "type": "string",
    }],
    scale_ephemeral_storage_limit="string",
    scale_initial_instances=0,
    scale_max_instances=0,
    scale_memory_limit="string",
    scale_min_instances=0,
    scale_request_timeout=0,
    timeouts={
        "create": "string",
        "update": "string",
    })
Copy
const codeEngineAppResource = new ibm.CodeEngineApp("codeEngineAppResource", {
    imageReference: "string",
    projectId: "string",
    runEnvVariables: [{
        key: "string",
        name: "string",
        prefix: "string",
        reference: "string",
        type: "string",
        value: "string",
    }],
    imagePort: 0,
    managedDomainMappings: "string",
    name: "string",
    probeLiveness: {
        failureThreshold: 0,
        initialDelay: 0,
        interval: 0,
        path: "string",
        port: 0,
        timeout: 0,
        type: "string",
    },
    probeReadiness: {
        failureThreshold: 0,
        initialDelay: 0,
        interval: 0,
        path: "string",
        port: 0,
        timeout: 0,
        type: "string",
    },
    runServiceAccount: "string",
    runArguments: ["string"],
    runAsUser: 0,
    runCommands: ["string"],
    imageSecret: "string",
    codeEngineAppId: "string",
    scaleDownDelay: 0,
    scaleConcurrency: 0,
    scaleConcurrencyTarget: 0,
    scaleCpuLimit: "string",
    runVolumeMounts: [{
        mountPath: "string",
        name: "string",
        reference: "string",
        type: "string",
    }],
    scaleEphemeralStorageLimit: "string",
    scaleInitialInstances: 0,
    scaleMaxInstances: 0,
    scaleMemoryLimit: "string",
    scaleMinInstances: 0,
    scaleRequestTimeout: 0,
    timeouts: {
        create: "string",
        update: "string",
    },
});
Copy
type: ibm:CodeEngineApp
properties:
    codeEngineAppId: string
    imagePort: 0
    imageReference: string
    imageSecret: string
    managedDomainMappings: string
    name: string
    probeLiveness:
        failureThreshold: 0
        initialDelay: 0
        interval: 0
        path: string
        port: 0
        timeout: 0
        type: string
    probeReadiness:
        failureThreshold: 0
        initialDelay: 0
        interval: 0
        path: string
        port: 0
        timeout: 0
        type: string
    projectId: string
    runArguments:
        - string
    runAsUser: 0
    runCommands:
        - string
    runEnvVariables:
        - key: string
          name: string
          prefix: string
          reference: string
          type: string
          value: string
    runServiceAccount: string
    runVolumeMounts:
        - mountPath: string
          name: string
          reference: string
          type: string
    scaleConcurrency: 0
    scaleConcurrencyTarget: 0
    scaleCpuLimit: string
    scaleDownDelay: 0
    scaleEphemeralStorageLimit: string
    scaleInitialInstances: 0
    scaleMaxInstances: 0
    scaleMemoryLimit: string
    scaleMinInstances: 0
    scaleRequestTimeout: 0
    timeouts:
        create: string
        update: string
Copy

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

ImageReference This property is required. string
The name of the image that is used for this app. The format is REGISTRY/NAMESPACE/REPOSITORY:TAG where REGISTRY and TAG are optional. If REGISTRY is not specified, the default is docker.io. If TAG is not specified, the default is latest. If the image reference points to a registry that requires authentication, make sure to also specify the property image_secret.

  • Constraints: The maximum length is 256 characters. The minimum length is 1 character. The value must match regular expression /^([a-z0-9][a-z0-9\\-_.]+[a-z0-9][\/])?([a-z0-9][a-z0-9\\-_]+[a-z0-9][\/])?[a-z0-9][a-z0-9\\-_.\/]+a-z0-9?(@sha256:[a-fA-F0-9]{64})?$/.
ProjectId This property is required. string
The ID of the project.

  • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$/.
CodeEngineAppId string
The unique identifier of the code_engine_app.
ImagePort double
Optional port the app listens on. While the app will always be exposed via port 443 for end users, this port is used to connect to the port that is exposed by the container image.

  • Constraints: The default value is 8080.
ImageSecret string
Optional name of the image registry access secret. The image registry access secret is used to authenticate with a private registry when you download the container image. If the image reference points to a registry that requires authentication, the app will be created but cannot reach the ready status, until this property is provided, too.

  • Constraints: The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /^a-z0-9?(\\.a-z0-9?)*$/.
ManagedDomainMappings string
Optional value controlling which of the system managed domain mappings will be setup for the application. Valid values are 'local_public', 'local_private' and 'local'. Visibility can only be 'local_private' if the project supports application private visibility.

  • Constraints: The default value is local_public. Allowable values are: local, local_private, local_public.
Name string
The name of the app.

  • Constraints: The maximum length is 63 characters. The minimum length is 1 character. The value must match regular expression /^a-z?$/.
ProbeLiveness CodeEngineAppProbeLiveness
Response model for probes. Nested schema for probe_liveness:
ProbeReadiness CodeEngineAppProbeReadiness
Response model for probes. Nested schema for probe_readiness:
RunArguments List<string>
Optional arguments for the app that are passed to start the container. If not specified an empty string array will be applied and the arguments specified by the container image, will be used to start the container.

  • Constraints: The list items must match regular expression /^.*$/. The maximum length is 100 items. The minimum length is 0 items.
RunAsUser double
Optional user ID (UID) to run the app.

  • Constraints: The default value is 0.
RunCommands List<string>
Optional commands for the app that are passed to start the container. If not specified an empty string array will be applied and the command specified by the container image, will be used to start the container.

  • Constraints: The list items must match regular expression /^.*$/. The maximum length is 100 items. The minimum length is 0 items.
RunEnvVariables List<CodeEngineAppRunEnvVariable>
References to config maps, secrets or literal values, which are exposed as environment variables in the application.

  • Constraints: The maximum length is 100 items. The minimum length is 0 items. Nested schema for run_env_variables:
RunServiceAccount string
Optional name of the service account. For built-in service accounts, you can use the shortened names manager , none, reader, and writer.

  • Constraints: The default value is default. Allowable values are: default, manager, reader, writer, none. The minimum length is 0 characters. The value must match regular expression /^(manager|reader|writer|none|default)$/.
RunVolumeMounts List<CodeEngineAppRunVolumeMount>
Mounts of config maps or secrets.

  • Constraints: The maximum length is 100 items. The minimum length is 0 items. Nested schema for run_volume_mounts:
ScaleConcurrency double
Optional maximum number of requests that can be processed concurrently per instance.

  • Constraints: The default value is 100.
ScaleConcurrencyTarget double
Optional threshold of concurrent requests per instance at which one or more additional instances are created. Use this value to scale up instances based on concurrent number of requests. This option defaults to the value of the scale_concurrency option, if not specified.

  • Constraints: The default value is 100. The maximum value is 1000. The minimum value is 1.
ScaleCpuLimit string
Optional number of CPU set for the instance of the app. For valid values see Supported memory and CPU combinations.

  • Constraints: The default value is 1. The maximum length is 10 characters. The minimum length is 0 characters. The value must match regular expression /^([0-9.]+)([eEinumkKMGTPB]*)$/.
ScaleDownDelay double
Optional amount of time in seconds that delays the scale-down behavior for an app instance.

  • Constraints: The default value is 0. The maximum value is 3600. The minimum value is 0.
ScaleEphemeralStorageLimit string
Optional amount of ephemeral storage to set for the instance of the app. The amount specified as ephemeral storage, must not exceed the amount of scale_memory_limit. The units for specifying ephemeral storage are Megabyte (M) or Gigabyte (G), whereas G and M are the shorthand expressions for GB and MB. For more information see Units of measurement.

  • Constraints: The default value is 400M. The maximum length is 10 characters. The minimum length is 0 characters. The value must match regular expression /^([0-9.]+)([eEinumkKMGTPB]*)$/.
ScaleInitialInstances double
Optional initial number of instances that are created upon app creation or app update.

  • Constraints: The default value is 1.
ScaleMaxInstances double
Optional maximum number of instances for this app. If you set this value to 0, this property does not set a upper scaling limit. However, the app scaling is still limited by the project quota for instances. See Limits and quotas for Code Engine.

  • Constraints: The default value is 10.
ScaleMemoryLimit string
Optional amount of memory set for the instance of the app. For valid values see Supported memory and CPU combinations. The units for specifying memory are Megabyte (M) or Gigabyte (G), whereas G and M are the shorthand expressions for GB and MB. For more information see Units of measurement.

  • Constraints: The default value is 4G. The maximum length is 10 characters. The minimum length is 0 characters. The value must match regular expression /^([0-9.]+)([eEinumkKMGTPB]*)$/.
ScaleMinInstances double
Optional minimum number of instances for this app. If you set this value to 0, the app will scale down to zero, if not hit by any request for some time.

  • Constraints: The default value is 0.
ScaleRequestTimeout double
Optional amount of time in seconds that is allowed for a running app to respond to a request.

  • Constraints: The default value is 300.
Timeouts CodeEngineAppTimeouts
ImageReference This property is required. string
The name of the image that is used for this app. The format is REGISTRY/NAMESPACE/REPOSITORY:TAG where REGISTRY and TAG are optional. If REGISTRY is not specified, the default is docker.io. If TAG is not specified, the default is latest. If the image reference points to a registry that requires authentication, make sure to also specify the property image_secret.

  • Constraints: The maximum length is 256 characters. The minimum length is 1 character. The value must match regular expression /^([a-z0-9][a-z0-9\\-_.]+[a-z0-9][\/])?([a-z0-9][a-z0-9\\-_]+[a-z0-9][\/])?[a-z0-9][a-z0-9\\-_.\/]+a-z0-9?(@sha256:[a-fA-F0-9]{64})?$/.
ProjectId This property is required. string
The ID of the project.

  • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$/.
CodeEngineAppId string
The unique identifier of the code_engine_app.
ImagePort float64
Optional port the app listens on. While the app will always be exposed via port 443 for end users, this port is used to connect to the port that is exposed by the container image.

  • Constraints: The default value is 8080.
ImageSecret string
Optional name of the image registry access secret. The image registry access secret is used to authenticate with a private registry when you download the container image. If the image reference points to a registry that requires authentication, the app will be created but cannot reach the ready status, until this property is provided, too.

  • Constraints: The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /^a-z0-9?(\\.a-z0-9?)*$/.
ManagedDomainMappings string
Optional value controlling which of the system managed domain mappings will be setup for the application. Valid values are 'local_public', 'local_private' and 'local'. Visibility can only be 'local_private' if the project supports application private visibility.

  • Constraints: The default value is local_public. Allowable values are: local, local_private, local_public.
Name string
The name of the app.

  • Constraints: The maximum length is 63 characters. The minimum length is 1 character. The value must match regular expression /^a-z?$/.
ProbeLiveness CodeEngineAppProbeLivenessArgs
Response model for probes. Nested schema for probe_liveness:
ProbeReadiness CodeEngineAppProbeReadinessArgs
Response model for probes. Nested schema for probe_readiness:
RunArguments []string
Optional arguments for the app that are passed to start the container. If not specified an empty string array will be applied and the arguments specified by the container image, will be used to start the container.

  • Constraints: The list items must match regular expression /^.*$/. The maximum length is 100 items. The minimum length is 0 items.
RunAsUser float64
Optional user ID (UID) to run the app.

  • Constraints: The default value is 0.
RunCommands []string
Optional commands for the app that are passed to start the container. If not specified an empty string array will be applied and the command specified by the container image, will be used to start the container.

  • Constraints: The list items must match regular expression /^.*$/. The maximum length is 100 items. The minimum length is 0 items.
RunEnvVariables []CodeEngineAppRunEnvVariableArgs
References to config maps, secrets or literal values, which are exposed as environment variables in the application.

  • Constraints: The maximum length is 100 items. The minimum length is 0 items. Nested schema for run_env_variables:
RunServiceAccount string
Optional name of the service account. For built-in service accounts, you can use the shortened names manager , none, reader, and writer.

  • Constraints: The default value is default. Allowable values are: default, manager, reader, writer, none. The minimum length is 0 characters. The value must match regular expression /^(manager|reader|writer|none|default)$/.
RunVolumeMounts []CodeEngineAppRunVolumeMountArgs
Mounts of config maps or secrets.

  • Constraints: The maximum length is 100 items. The minimum length is 0 items. Nested schema for run_volume_mounts:
ScaleConcurrency float64
Optional maximum number of requests that can be processed concurrently per instance.

  • Constraints: The default value is 100.
ScaleConcurrencyTarget float64
Optional threshold of concurrent requests per instance at which one or more additional instances are created. Use this value to scale up instances based on concurrent number of requests. This option defaults to the value of the scale_concurrency option, if not specified.

  • Constraints: The default value is 100. The maximum value is 1000. The minimum value is 1.
ScaleCpuLimit string
Optional number of CPU set for the instance of the app. For valid values see Supported memory and CPU combinations.

  • Constraints: The default value is 1. The maximum length is 10 characters. The minimum length is 0 characters. The value must match regular expression /^([0-9.]+)([eEinumkKMGTPB]*)$/.
ScaleDownDelay float64
Optional amount of time in seconds that delays the scale-down behavior for an app instance.

  • Constraints: The default value is 0. The maximum value is 3600. The minimum value is 0.
ScaleEphemeralStorageLimit string
Optional amount of ephemeral storage to set for the instance of the app. The amount specified as ephemeral storage, must not exceed the amount of scale_memory_limit. The units for specifying ephemeral storage are Megabyte (M) or Gigabyte (G), whereas G and M are the shorthand expressions for GB and MB. For more information see Units of measurement.

  • Constraints: The default value is 400M. The maximum length is 10 characters. The minimum length is 0 characters. The value must match regular expression /^([0-9.]+)([eEinumkKMGTPB]*)$/.
ScaleInitialInstances float64
Optional initial number of instances that are created upon app creation or app update.

  • Constraints: The default value is 1.
ScaleMaxInstances float64
Optional maximum number of instances for this app. If you set this value to 0, this property does not set a upper scaling limit. However, the app scaling is still limited by the project quota for instances. See Limits and quotas for Code Engine.

  • Constraints: The default value is 10.
ScaleMemoryLimit string
Optional amount of memory set for the instance of the app. For valid values see Supported memory and CPU combinations. The units for specifying memory are Megabyte (M) or Gigabyte (G), whereas G and M are the shorthand expressions for GB and MB. For more information see Units of measurement.

  • Constraints: The default value is 4G. The maximum length is 10 characters. The minimum length is 0 characters. The value must match regular expression /^([0-9.]+)([eEinumkKMGTPB]*)$/.
ScaleMinInstances float64
Optional minimum number of instances for this app. If you set this value to 0, the app will scale down to zero, if not hit by any request for some time.

  • Constraints: The default value is 0.
ScaleRequestTimeout float64
Optional amount of time in seconds that is allowed for a running app to respond to a request.

  • Constraints: The default value is 300.
Timeouts CodeEngineAppTimeoutsArgs
imageReference This property is required. String
The name of the image that is used for this app. The format is REGISTRY/NAMESPACE/REPOSITORY:TAG where REGISTRY and TAG are optional. If REGISTRY is not specified, the default is docker.io. If TAG is not specified, the default is latest. If the image reference points to a registry that requires authentication, make sure to also specify the property image_secret.

  • Constraints: The maximum length is 256 characters. The minimum length is 1 character. The value must match regular expression /^([a-z0-9][a-z0-9\\-_.]+[a-z0-9][\/])?([a-z0-9][a-z0-9\\-_]+[a-z0-9][\/])?[a-z0-9][a-z0-9\\-_.\/]+a-z0-9?(@sha256:[a-fA-F0-9]{64})?$/.
projectId This property is required. String
The ID of the project.

  • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$/.
codeEngineAppId String
The unique identifier of the code_engine_app.
imagePort Double
Optional port the app listens on. While the app will always be exposed via port 443 for end users, this port is used to connect to the port that is exposed by the container image.

  • Constraints: The default value is 8080.
imageSecret String
Optional name of the image registry access secret. The image registry access secret is used to authenticate with a private registry when you download the container image. If the image reference points to a registry that requires authentication, the app will be created but cannot reach the ready status, until this property is provided, too.

  • Constraints: The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /^a-z0-9?(\\.a-z0-9?)*$/.
managedDomainMappings String
Optional value controlling which of the system managed domain mappings will be setup for the application. Valid values are 'local_public', 'local_private' and 'local'. Visibility can only be 'local_private' if the project supports application private visibility.

  • Constraints: The default value is local_public. Allowable values are: local, local_private, local_public.
name String
The name of the app.

  • Constraints: The maximum length is 63 characters. The minimum length is 1 character. The value must match regular expression /^a-z?$/.
probeLiveness CodeEngineAppProbeLiveness
Response model for probes. Nested schema for probe_liveness:
probeReadiness CodeEngineAppProbeReadiness
Response model for probes. Nested schema for probe_readiness:
runArguments List<String>
Optional arguments for the app that are passed to start the container. If not specified an empty string array will be applied and the arguments specified by the container image, will be used to start the container.

  • Constraints: The list items must match regular expression /^.*$/. The maximum length is 100 items. The minimum length is 0 items.
runAsUser Double
Optional user ID (UID) to run the app.

  • Constraints: The default value is 0.
runCommands List<String>
Optional commands for the app that are passed to start the container. If not specified an empty string array will be applied and the command specified by the container image, will be used to start the container.

  • Constraints: The list items must match regular expression /^.*$/. The maximum length is 100 items. The minimum length is 0 items.
runEnvVariables List<CodeEngineAppRunEnvVariable>
References to config maps, secrets or literal values, which are exposed as environment variables in the application.

  • Constraints: The maximum length is 100 items. The minimum length is 0 items. Nested schema for run_env_variables:
runServiceAccount String
Optional name of the service account. For built-in service accounts, you can use the shortened names manager , none, reader, and writer.

  • Constraints: The default value is default. Allowable values are: default, manager, reader, writer, none. The minimum length is 0 characters. The value must match regular expression /^(manager|reader|writer|none|default)$/.
runVolumeMounts List<CodeEngineAppRunVolumeMount>
Mounts of config maps or secrets.

  • Constraints: The maximum length is 100 items. The minimum length is 0 items. Nested schema for run_volume_mounts:
scaleConcurrency Double
Optional maximum number of requests that can be processed concurrently per instance.

  • Constraints: The default value is 100.
scaleConcurrencyTarget Double
Optional threshold of concurrent requests per instance at which one or more additional instances are created. Use this value to scale up instances based on concurrent number of requests. This option defaults to the value of the scale_concurrency option, if not specified.

  • Constraints: The default value is 100. The maximum value is 1000. The minimum value is 1.
scaleCpuLimit String
Optional number of CPU set for the instance of the app. For valid values see Supported memory and CPU combinations.

  • Constraints: The default value is 1. The maximum length is 10 characters. The minimum length is 0 characters. The value must match regular expression /^([0-9.]+)([eEinumkKMGTPB]*)$/.
scaleDownDelay Double
Optional amount of time in seconds that delays the scale-down behavior for an app instance.

  • Constraints: The default value is 0. The maximum value is 3600. The minimum value is 0.
scaleEphemeralStorageLimit String
Optional amount of ephemeral storage to set for the instance of the app. The amount specified as ephemeral storage, must not exceed the amount of scale_memory_limit. The units for specifying ephemeral storage are Megabyte (M) or Gigabyte (G), whereas G and M are the shorthand expressions for GB and MB. For more information see Units of measurement.

  • Constraints: The default value is 400M. The maximum length is 10 characters. The minimum length is 0 characters. The value must match regular expression /^([0-9.]+)([eEinumkKMGTPB]*)$/.
scaleInitialInstances Double
Optional initial number of instances that are created upon app creation or app update.

  • Constraints: The default value is 1.
scaleMaxInstances Double
Optional maximum number of instances for this app. If you set this value to 0, this property does not set a upper scaling limit. However, the app scaling is still limited by the project quota for instances. See Limits and quotas for Code Engine.

  • Constraints: The default value is 10.
scaleMemoryLimit String
Optional amount of memory set for the instance of the app. For valid values see Supported memory and CPU combinations. The units for specifying memory are Megabyte (M) or Gigabyte (G), whereas G and M are the shorthand expressions for GB and MB. For more information see Units of measurement.

  • Constraints: The default value is 4G. The maximum length is 10 characters. The minimum length is 0 characters. The value must match regular expression /^([0-9.]+)([eEinumkKMGTPB]*)$/.
scaleMinInstances Double
Optional minimum number of instances for this app. If you set this value to 0, the app will scale down to zero, if not hit by any request for some time.

  • Constraints: The default value is 0.
scaleRequestTimeout Double
Optional amount of time in seconds that is allowed for a running app to respond to a request.

  • Constraints: The default value is 300.
timeouts CodeEngineAppTimeouts
imageReference This property is required. string
The name of the image that is used for this app. The format is REGISTRY/NAMESPACE/REPOSITORY:TAG where REGISTRY and TAG are optional. If REGISTRY is not specified, the default is docker.io. If TAG is not specified, the default is latest. If the image reference points to a registry that requires authentication, make sure to also specify the property image_secret.

  • Constraints: The maximum length is 256 characters. The minimum length is 1 character. The value must match regular expression /^([a-z0-9][a-z0-9\\-_.]+[a-z0-9][\/])?([a-z0-9][a-z0-9\\-_]+[a-z0-9][\/])?[a-z0-9][a-z0-9\\-_.\/]+a-z0-9?(@sha256:[a-fA-F0-9]{64})?$/.
projectId This property is required. string
The ID of the project.

  • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$/.
codeEngineAppId string
The unique identifier of the code_engine_app.
imagePort number
Optional port the app listens on. While the app will always be exposed via port 443 for end users, this port is used to connect to the port that is exposed by the container image.

  • Constraints: The default value is 8080.
imageSecret string
Optional name of the image registry access secret. The image registry access secret is used to authenticate with a private registry when you download the container image. If the image reference points to a registry that requires authentication, the app will be created but cannot reach the ready status, until this property is provided, too.

  • Constraints: The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /^a-z0-9?(\\.a-z0-9?)*$/.
managedDomainMappings string
Optional value controlling which of the system managed domain mappings will be setup for the application. Valid values are 'local_public', 'local_private' and 'local'. Visibility can only be 'local_private' if the project supports application private visibility.

  • Constraints: The default value is local_public. Allowable values are: local, local_private, local_public.
name string
The name of the app.

  • Constraints: The maximum length is 63 characters. The minimum length is 1 character. The value must match regular expression /^a-z?$/.
probeLiveness CodeEngineAppProbeLiveness
Response model for probes. Nested schema for probe_liveness:
probeReadiness CodeEngineAppProbeReadiness
Response model for probes. Nested schema for probe_readiness:
runArguments string[]
Optional arguments for the app that are passed to start the container. If not specified an empty string array will be applied and the arguments specified by the container image, will be used to start the container.

  • Constraints: The list items must match regular expression /^.*$/. The maximum length is 100 items. The minimum length is 0 items.
runAsUser number
Optional user ID (UID) to run the app.

  • Constraints: The default value is 0.
runCommands string[]
Optional commands for the app that are passed to start the container. If not specified an empty string array will be applied and the command specified by the container image, will be used to start the container.

  • Constraints: The list items must match regular expression /^.*$/. The maximum length is 100 items. The minimum length is 0 items.
runEnvVariables CodeEngineAppRunEnvVariable[]
References to config maps, secrets or literal values, which are exposed as environment variables in the application.

  • Constraints: The maximum length is 100 items. The minimum length is 0 items. Nested schema for run_env_variables:
runServiceAccount string
Optional name of the service account. For built-in service accounts, you can use the shortened names manager , none, reader, and writer.

  • Constraints: The default value is default. Allowable values are: default, manager, reader, writer, none. The minimum length is 0 characters. The value must match regular expression /^(manager|reader|writer|none|default)$/.
runVolumeMounts CodeEngineAppRunVolumeMount[]
Mounts of config maps or secrets.

  • Constraints: The maximum length is 100 items. The minimum length is 0 items. Nested schema for run_volume_mounts:
scaleConcurrency number
Optional maximum number of requests that can be processed concurrently per instance.

  • Constraints: The default value is 100.
scaleConcurrencyTarget number
Optional threshold of concurrent requests per instance at which one or more additional instances are created. Use this value to scale up instances based on concurrent number of requests. This option defaults to the value of the scale_concurrency option, if not specified.

  • Constraints: The default value is 100. The maximum value is 1000. The minimum value is 1.
scaleCpuLimit string
Optional number of CPU set for the instance of the app. For valid values see Supported memory and CPU combinations.

  • Constraints: The default value is 1. The maximum length is 10 characters. The minimum length is 0 characters. The value must match regular expression /^([0-9.]+)([eEinumkKMGTPB]*)$/.
scaleDownDelay number
Optional amount of time in seconds that delays the scale-down behavior for an app instance.

  • Constraints: The default value is 0. The maximum value is 3600. The minimum value is 0.
scaleEphemeralStorageLimit string
Optional amount of ephemeral storage to set for the instance of the app. The amount specified as ephemeral storage, must not exceed the amount of scale_memory_limit. The units for specifying ephemeral storage are Megabyte (M) or Gigabyte (G), whereas G and M are the shorthand expressions for GB and MB. For more information see Units of measurement.

  • Constraints: The default value is 400M. The maximum length is 10 characters. The minimum length is 0 characters. The value must match regular expression /^([0-9.]+)([eEinumkKMGTPB]*)$/.
scaleInitialInstances number
Optional initial number of instances that are created upon app creation or app update.

  • Constraints: The default value is 1.
scaleMaxInstances number
Optional maximum number of instances for this app. If you set this value to 0, this property does not set a upper scaling limit. However, the app scaling is still limited by the project quota for instances. See Limits and quotas for Code Engine.

  • Constraints: The default value is 10.
scaleMemoryLimit string
Optional amount of memory set for the instance of the app. For valid values see Supported memory and CPU combinations. The units for specifying memory are Megabyte (M) or Gigabyte (G), whereas G and M are the shorthand expressions for GB and MB. For more information see Units of measurement.

  • Constraints: The default value is 4G. The maximum length is 10 characters. The minimum length is 0 characters. The value must match regular expression /^([0-9.]+)([eEinumkKMGTPB]*)$/.
scaleMinInstances number
Optional minimum number of instances for this app. If you set this value to 0, the app will scale down to zero, if not hit by any request for some time.

  • Constraints: The default value is 0.
scaleRequestTimeout number
Optional amount of time in seconds that is allowed for a running app to respond to a request.

  • Constraints: The default value is 300.
timeouts CodeEngineAppTimeouts
image_reference This property is required. str
The name of the image that is used for this app. The format is REGISTRY/NAMESPACE/REPOSITORY:TAG where REGISTRY and TAG are optional. If REGISTRY is not specified, the default is docker.io. If TAG is not specified, the default is latest. If the image reference points to a registry that requires authentication, make sure to also specify the property image_secret.

  • Constraints: The maximum length is 256 characters. The minimum length is 1 character. The value must match regular expression /^([a-z0-9][a-z0-9\\-_.]+[a-z0-9][\/])?([a-z0-9][a-z0-9\\-_]+[a-z0-9][\/])?[a-z0-9][a-z0-9\\-_.\/]+a-z0-9?(@sha256:[a-fA-F0-9]{64})?$/.
project_id This property is required. str
The ID of the project.

  • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$/.
code_engine_app_id str
The unique identifier of the code_engine_app.
image_port float
Optional port the app listens on. While the app will always be exposed via port 443 for end users, this port is used to connect to the port that is exposed by the container image.

  • Constraints: The default value is 8080.
image_secret str
Optional name of the image registry access secret. The image registry access secret is used to authenticate with a private registry when you download the container image. If the image reference points to a registry that requires authentication, the app will be created but cannot reach the ready status, until this property is provided, too.

  • Constraints: The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /^a-z0-9?(\\.a-z0-9?)*$/.
managed_domain_mappings str
Optional value controlling which of the system managed domain mappings will be setup for the application. Valid values are 'local_public', 'local_private' and 'local'. Visibility can only be 'local_private' if the project supports application private visibility.

  • Constraints: The default value is local_public. Allowable values are: local, local_private, local_public.
name str
The name of the app.

  • Constraints: The maximum length is 63 characters. The minimum length is 1 character. The value must match regular expression /^a-z?$/.
probe_liveness CodeEngineAppProbeLivenessArgs
Response model for probes. Nested schema for probe_liveness:
probe_readiness CodeEngineAppProbeReadinessArgs
Response model for probes. Nested schema for probe_readiness:
run_arguments Sequence[str]
Optional arguments for the app that are passed to start the container. If not specified an empty string array will be applied and the arguments specified by the container image, will be used to start the container.

  • Constraints: The list items must match regular expression /^.*$/. The maximum length is 100 items. The minimum length is 0 items.
run_as_user float
Optional user ID (UID) to run the app.

  • Constraints: The default value is 0.
run_commands Sequence[str]
Optional commands for the app that are passed to start the container. If not specified an empty string array will be applied and the command specified by the container image, will be used to start the container.

  • Constraints: The list items must match regular expression /^.*$/. The maximum length is 100 items. The minimum length is 0 items.
run_env_variables Sequence[CodeEngineAppRunEnvVariableArgs]
References to config maps, secrets or literal values, which are exposed as environment variables in the application.

  • Constraints: The maximum length is 100 items. The minimum length is 0 items. Nested schema for run_env_variables:
run_service_account str
Optional name of the service account. For built-in service accounts, you can use the shortened names manager , none, reader, and writer.

  • Constraints: The default value is default. Allowable values are: default, manager, reader, writer, none. The minimum length is 0 characters. The value must match regular expression /^(manager|reader|writer|none|default)$/.
run_volume_mounts Sequence[CodeEngineAppRunVolumeMountArgs]
Mounts of config maps or secrets.

  • Constraints: The maximum length is 100 items. The minimum length is 0 items. Nested schema for run_volume_mounts:
scale_concurrency float
Optional maximum number of requests that can be processed concurrently per instance.

  • Constraints: The default value is 100.
scale_concurrency_target float
Optional threshold of concurrent requests per instance at which one or more additional instances are created. Use this value to scale up instances based on concurrent number of requests. This option defaults to the value of the scale_concurrency option, if not specified.

  • Constraints: The default value is 100. The maximum value is 1000. The minimum value is 1.
scale_cpu_limit str
Optional number of CPU set for the instance of the app. For valid values see Supported memory and CPU combinations.

  • Constraints: The default value is 1. The maximum length is 10 characters. The minimum length is 0 characters. The value must match regular expression /^([0-9.]+)([eEinumkKMGTPB]*)$/.
scale_down_delay float
Optional amount of time in seconds that delays the scale-down behavior for an app instance.

  • Constraints: The default value is 0. The maximum value is 3600. The minimum value is 0.
scale_ephemeral_storage_limit str
Optional amount of ephemeral storage to set for the instance of the app. The amount specified as ephemeral storage, must not exceed the amount of scale_memory_limit. The units for specifying ephemeral storage are Megabyte (M) or Gigabyte (G), whereas G and M are the shorthand expressions for GB and MB. For more information see Units of measurement.

  • Constraints: The default value is 400M. The maximum length is 10 characters. The minimum length is 0 characters. The value must match regular expression /^([0-9.]+)([eEinumkKMGTPB]*)$/.
scale_initial_instances float
Optional initial number of instances that are created upon app creation or app update.

  • Constraints: The default value is 1.
scale_max_instances float
Optional maximum number of instances for this app. If you set this value to 0, this property does not set a upper scaling limit. However, the app scaling is still limited by the project quota for instances. See Limits and quotas for Code Engine.

  • Constraints: The default value is 10.
scale_memory_limit str
Optional amount of memory set for the instance of the app. For valid values see Supported memory and CPU combinations. The units for specifying memory are Megabyte (M) or Gigabyte (G), whereas G and M are the shorthand expressions for GB and MB. For more information see Units of measurement.

  • Constraints: The default value is 4G. The maximum length is 10 characters. The minimum length is 0 characters. The value must match regular expression /^([0-9.]+)([eEinumkKMGTPB]*)$/.
scale_min_instances float
Optional minimum number of instances for this app. If you set this value to 0, the app will scale down to zero, if not hit by any request for some time.

  • Constraints: The default value is 0.
scale_request_timeout float
Optional amount of time in seconds that is allowed for a running app to respond to a request.

  • Constraints: The default value is 300.
timeouts CodeEngineAppTimeoutsArgs
imageReference This property is required. String
The name of the image that is used for this app. The format is REGISTRY/NAMESPACE/REPOSITORY:TAG where REGISTRY and TAG are optional. If REGISTRY is not specified, the default is docker.io. If TAG is not specified, the default is latest. If the image reference points to a registry that requires authentication, make sure to also specify the property image_secret.

  • Constraints: The maximum length is 256 characters. The minimum length is 1 character. The value must match regular expression /^([a-z0-9][a-z0-9\\-_.]+[a-z0-9][\/])?([a-z0-9][a-z0-9\\-_]+[a-z0-9][\/])?[a-z0-9][a-z0-9\\-_.\/]+a-z0-9?(@sha256:[a-fA-F0-9]{64})?$/.
projectId This property is required. String
The ID of the project.

  • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$/.
codeEngineAppId String
The unique identifier of the code_engine_app.
imagePort Number
Optional port the app listens on. While the app will always be exposed via port 443 for end users, this port is used to connect to the port that is exposed by the container image.

  • Constraints: The default value is 8080.
imageSecret String
Optional name of the image registry access secret. The image registry access secret is used to authenticate with a private registry when you download the container image. If the image reference points to a registry that requires authentication, the app will be created but cannot reach the ready status, until this property is provided, too.

  • Constraints: The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /^a-z0-9?(\\.a-z0-9?)*$/.
managedDomainMappings String
Optional value controlling which of the system managed domain mappings will be setup for the application. Valid values are 'local_public', 'local_private' and 'local'. Visibility can only be 'local_private' if the project supports application private visibility.

  • Constraints: The default value is local_public. Allowable values are: local, local_private, local_public.
name String
The name of the app.

  • Constraints: The maximum length is 63 characters. The minimum length is 1 character. The value must match regular expression /^a-z?$/.
probeLiveness Property Map
Response model for probes. Nested schema for probe_liveness:
probeReadiness Property Map
Response model for probes. Nested schema for probe_readiness:
runArguments List<String>
Optional arguments for the app that are passed to start the container. If not specified an empty string array will be applied and the arguments specified by the container image, will be used to start the container.

  • Constraints: The list items must match regular expression /^.*$/. The maximum length is 100 items. The minimum length is 0 items.
runAsUser Number
Optional user ID (UID) to run the app.

  • Constraints: The default value is 0.
runCommands List<String>
Optional commands for the app that are passed to start the container. If not specified an empty string array will be applied and the command specified by the container image, will be used to start the container.

  • Constraints: The list items must match regular expression /^.*$/. The maximum length is 100 items. The minimum length is 0 items.
runEnvVariables List<Property Map>
References to config maps, secrets or literal values, which are exposed as environment variables in the application.

  • Constraints: The maximum length is 100 items. The minimum length is 0 items. Nested schema for run_env_variables:
runServiceAccount String
Optional name of the service account. For built-in service accounts, you can use the shortened names manager , none, reader, and writer.

  • Constraints: The default value is default. Allowable values are: default, manager, reader, writer, none. The minimum length is 0 characters. The value must match regular expression /^(manager|reader|writer|none|default)$/.
runVolumeMounts List<Property Map>
Mounts of config maps or secrets.

  • Constraints: The maximum length is 100 items. The minimum length is 0 items. Nested schema for run_volume_mounts:
scaleConcurrency Number
Optional maximum number of requests that can be processed concurrently per instance.

  • Constraints: The default value is 100.
scaleConcurrencyTarget Number
Optional threshold of concurrent requests per instance at which one or more additional instances are created. Use this value to scale up instances based on concurrent number of requests. This option defaults to the value of the scale_concurrency option, if not specified.

  • Constraints: The default value is 100. The maximum value is 1000. The minimum value is 1.
scaleCpuLimit String
Optional number of CPU set for the instance of the app. For valid values see Supported memory and CPU combinations.

  • Constraints: The default value is 1. The maximum length is 10 characters. The minimum length is 0 characters. The value must match regular expression /^([0-9.]+)([eEinumkKMGTPB]*)$/.
scaleDownDelay Number
Optional amount of time in seconds that delays the scale-down behavior for an app instance.

  • Constraints: The default value is 0. The maximum value is 3600. The minimum value is 0.
scaleEphemeralStorageLimit String
Optional amount of ephemeral storage to set for the instance of the app. The amount specified as ephemeral storage, must not exceed the amount of scale_memory_limit. The units for specifying ephemeral storage are Megabyte (M) or Gigabyte (G), whereas G and M are the shorthand expressions for GB and MB. For more information see Units of measurement.

  • Constraints: The default value is 400M. The maximum length is 10 characters. The minimum length is 0 characters. The value must match regular expression /^([0-9.]+)([eEinumkKMGTPB]*)$/.
scaleInitialInstances Number
Optional initial number of instances that are created upon app creation or app update.

  • Constraints: The default value is 1.
scaleMaxInstances Number
Optional maximum number of instances for this app. If you set this value to 0, this property does not set a upper scaling limit. However, the app scaling is still limited by the project quota for instances. See Limits and quotas for Code Engine.

  • Constraints: The default value is 10.
scaleMemoryLimit String
Optional amount of memory set for the instance of the app. For valid values see Supported memory and CPU combinations. The units for specifying memory are Megabyte (M) or Gigabyte (G), whereas G and M are the shorthand expressions for GB and MB. For more information see Units of measurement.

  • Constraints: The default value is 4G. The maximum length is 10 characters. The minimum length is 0 characters. The value must match regular expression /^([0-9.]+)([eEinumkKMGTPB]*)$/.
scaleMinInstances Number
Optional minimum number of instances for this app. If you set this value to 0, the app will scale down to zero, if not hit by any request for some time.

  • Constraints: The default value is 0.
scaleRequestTimeout Number
Optional amount of time in seconds that is allowed for a running app to respond to a request.

  • Constraints: The default value is 300.
timeouts Property Map

Outputs

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

AppId string
(String) The identifier of the resource.

  • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$/.
Build string
(String) Reference to a build that is associated with the application.
BuildRun string
(String) Reference to a build run that is associated with the application.
ComputedEnvVariables List<CodeEngineAppComputedEnvVariable>
(List) References to config maps, secrets or literal values, which are defined and set by Code Engine and are exposed as environment variables in the application.

  • Constraints: The maximum length is 100 items. The minimum length is 0 items. Nested schema for computed_env_variables:
CreatedAt string
(String) The timestamp when the resource was created.
Endpoint string
(String) Optional URL to invoke the app. Depending on visibility, this is accessible publicly or in the private network only. Empty in case 'managed_domain_mappings' is set to 'local'.
EndpointInternal string
(String) The URL to the app that is only visible within the project.
EntityTag string
(String) The version of the app instance, which is used to achieve optimistic locking.

  • Constraints: The maximum length is 63 characters. The minimum length is 1 character. The value must match regular expression /^[\\*\\-a-z0-9]+$/.
Etag string
ETag identifier for code_engine_app.
Href string
(String) When you provision a new app, a URL is created identifying the location of the instance.

  • Constraints: The maximum length is 2048 characters. The minimum length is 0 characters. The value must match regular expression /(([^:\/?#]+):)?(\/\/([^\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$/.
Id string
The provider-assigned unique ID for this managed resource.
Region string
(String) The region of the project the resource is located in. Possible values: 'au-syd', 'br-sao', 'ca-tor', 'eu-de', 'eu-gb', 'jp-osa', 'jp-tok', 'us-east', 'us-south'.
ResourceType string
(String) The type of the app.

  • Constraints: Allowable values are: app_v2.
Status string
(String) The current status of the app.

  • Constraints: Allowable values are: ready, deploying, failed, warning.
StatusDetails List<CodeEngineAppStatusDetail>
(List) The detailed status of the application. Nested schema for status_details:
AppId string
(String) The identifier of the resource.

  • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$/.
Build string
(String) Reference to a build that is associated with the application.
BuildRun string
(String) Reference to a build run that is associated with the application.
ComputedEnvVariables []CodeEngineAppComputedEnvVariable
(List) References to config maps, secrets or literal values, which are defined and set by Code Engine and are exposed as environment variables in the application.

  • Constraints: The maximum length is 100 items. The minimum length is 0 items. Nested schema for computed_env_variables:
CreatedAt string
(String) The timestamp when the resource was created.
Endpoint string
(String) Optional URL to invoke the app. Depending on visibility, this is accessible publicly or in the private network only. Empty in case 'managed_domain_mappings' is set to 'local'.
EndpointInternal string
(String) The URL to the app that is only visible within the project.
EntityTag string
(String) The version of the app instance, which is used to achieve optimistic locking.

  • Constraints: The maximum length is 63 characters. The minimum length is 1 character. The value must match regular expression /^[\\*\\-a-z0-9]+$/.
Etag string
ETag identifier for code_engine_app.
Href string
(String) When you provision a new app, a URL is created identifying the location of the instance.

  • Constraints: The maximum length is 2048 characters. The minimum length is 0 characters. The value must match regular expression /(([^:\/?#]+):)?(\/\/([^\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$/.
Id string
The provider-assigned unique ID for this managed resource.
Region string
(String) The region of the project the resource is located in. Possible values: 'au-syd', 'br-sao', 'ca-tor', 'eu-de', 'eu-gb', 'jp-osa', 'jp-tok', 'us-east', 'us-south'.
ResourceType string
(String) The type of the app.

  • Constraints: Allowable values are: app_v2.
Status string
(String) The current status of the app.

  • Constraints: Allowable values are: ready, deploying, failed, warning.
StatusDetails []CodeEngineAppStatusDetail
(List) The detailed status of the application. Nested schema for status_details:
appId String
(String) The identifier of the resource.

  • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$/.
build String
(String) Reference to a build that is associated with the application.
buildRun String
(String) Reference to a build run that is associated with the application.
computedEnvVariables List<CodeEngineAppComputedEnvVariable>
(List) References to config maps, secrets or literal values, which are defined and set by Code Engine and are exposed as environment variables in the application.

  • Constraints: The maximum length is 100 items. The minimum length is 0 items. Nested schema for computed_env_variables:
createdAt String
(String) The timestamp when the resource was created.
endpoint String
(String) Optional URL to invoke the app. Depending on visibility, this is accessible publicly or in the private network only. Empty in case 'managed_domain_mappings' is set to 'local'.
endpointInternal String
(String) The URL to the app that is only visible within the project.
entityTag String
(String) The version of the app instance, which is used to achieve optimistic locking.

  • Constraints: The maximum length is 63 characters. The minimum length is 1 character. The value must match regular expression /^[\\*\\-a-z0-9]+$/.
etag String
ETag identifier for code_engine_app.
href String
(String) When you provision a new app, a URL is created identifying the location of the instance.

  • Constraints: The maximum length is 2048 characters. The minimum length is 0 characters. The value must match regular expression /(([^:\/?#]+):)?(\/\/([^\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$/.
id String
The provider-assigned unique ID for this managed resource.
region String
(String) The region of the project the resource is located in. Possible values: 'au-syd', 'br-sao', 'ca-tor', 'eu-de', 'eu-gb', 'jp-osa', 'jp-tok', 'us-east', 'us-south'.
resourceType String
(String) The type of the app.

  • Constraints: Allowable values are: app_v2.
status String
(String) The current status of the app.

  • Constraints: Allowable values are: ready, deploying, failed, warning.
statusDetails List<CodeEngineAppStatusDetail>
(List) The detailed status of the application. Nested schema for status_details:
appId string
(String) The identifier of the resource.

  • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$/.
build string
(String) Reference to a build that is associated with the application.
buildRun string
(String) Reference to a build run that is associated with the application.
computedEnvVariables CodeEngineAppComputedEnvVariable[]
(List) References to config maps, secrets or literal values, which are defined and set by Code Engine and are exposed as environment variables in the application.

  • Constraints: The maximum length is 100 items. The minimum length is 0 items. Nested schema for computed_env_variables:
createdAt string
(String) The timestamp when the resource was created.
endpoint string
(String) Optional URL to invoke the app. Depending on visibility, this is accessible publicly or in the private network only. Empty in case 'managed_domain_mappings' is set to 'local'.
endpointInternal string
(String) The URL to the app that is only visible within the project.
entityTag string
(String) The version of the app instance, which is used to achieve optimistic locking.

  • Constraints: The maximum length is 63 characters. The minimum length is 1 character. The value must match regular expression /^[\\*\\-a-z0-9]+$/.
etag string
ETag identifier for code_engine_app.
href string
(String) When you provision a new app, a URL is created identifying the location of the instance.

  • Constraints: The maximum length is 2048 characters. The minimum length is 0 characters. The value must match regular expression /(([^:\/?#]+):)?(\/\/([^\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$/.
id string
The provider-assigned unique ID for this managed resource.
region string
(String) The region of the project the resource is located in. Possible values: 'au-syd', 'br-sao', 'ca-tor', 'eu-de', 'eu-gb', 'jp-osa', 'jp-tok', 'us-east', 'us-south'.
resourceType string
(String) The type of the app.

  • Constraints: Allowable values are: app_v2.
status string
(String) The current status of the app.

  • Constraints: Allowable values are: ready, deploying, failed, warning.
statusDetails CodeEngineAppStatusDetail[]
(List) The detailed status of the application. Nested schema for status_details:
app_id str
(String) The identifier of the resource.

  • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$/.
build str
(String) Reference to a build that is associated with the application.
build_run str
(String) Reference to a build run that is associated with the application.
computed_env_variables Sequence[CodeEngineAppComputedEnvVariable]
(List) References to config maps, secrets or literal values, which are defined and set by Code Engine and are exposed as environment variables in the application.

  • Constraints: The maximum length is 100 items. The minimum length is 0 items. Nested schema for computed_env_variables:
created_at str
(String) The timestamp when the resource was created.
endpoint str
(String) Optional URL to invoke the app. Depending on visibility, this is accessible publicly or in the private network only. Empty in case 'managed_domain_mappings' is set to 'local'.
endpoint_internal str
(String) The URL to the app that is only visible within the project.
entity_tag str
(String) The version of the app instance, which is used to achieve optimistic locking.

  • Constraints: The maximum length is 63 characters. The minimum length is 1 character. The value must match regular expression /^[\\*\\-a-z0-9]+$/.
etag str
ETag identifier for code_engine_app.
href str
(String) When you provision a new app, a URL is created identifying the location of the instance.

  • Constraints: The maximum length is 2048 characters. The minimum length is 0 characters. The value must match regular expression /(([^:\/?#]+):)?(\/\/([^\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$/.
id str
The provider-assigned unique ID for this managed resource.
region str
(String) The region of the project the resource is located in. Possible values: 'au-syd', 'br-sao', 'ca-tor', 'eu-de', 'eu-gb', 'jp-osa', 'jp-tok', 'us-east', 'us-south'.
resource_type str
(String) The type of the app.

  • Constraints: Allowable values are: app_v2.
status str
(String) The current status of the app.

  • Constraints: Allowable values are: ready, deploying, failed, warning.
status_details Sequence[CodeEngineAppStatusDetail]
(List) The detailed status of the application. Nested schema for status_details:
appId String
(String) The identifier of the resource.

  • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$/.
build String
(String) Reference to a build that is associated with the application.
buildRun String
(String) Reference to a build run that is associated with the application.
computedEnvVariables List<Property Map>
(List) References to config maps, secrets or literal values, which are defined and set by Code Engine and are exposed as environment variables in the application.

  • Constraints: The maximum length is 100 items. The minimum length is 0 items. Nested schema for computed_env_variables:
createdAt String
(String) The timestamp when the resource was created.
endpoint String
(String) Optional URL to invoke the app. Depending on visibility, this is accessible publicly or in the private network only. Empty in case 'managed_domain_mappings' is set to 'local'.
endpointInternal String
(String) The URL to the app that is only visible within the project.
entityTag String
(String) The version of the app instance, which is used to achieve optimistic locking.

  • Constraints: The maximum length is 63 characters. The minimum length is 1 character. The value must match regular expression /^[\\*\\-a-z0-9]+$/.
etag String
ETag identifier for code_engine_app.
href String
(String) When you provision a new app, a URL is created identifying the location of the instance.

  • Constraints: The maximum length is 2048 characters. The minimum length is 0 characters. The value must match regular expression /(([^:\/?#]+):)?(\/\/([^\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$/.
id String
The provider-assigned unique ID for this managed resource.
region String
(String) The region of the project the resource is located in. Possible values: 'au-syd', 'br-sao', 'ca-tor', 'eu-de', 'eu-gb', 'jp-osa', 'jp-tok', 'us-east', 'us-south'.
resourceType String
(String) The type of the app.

  • Constraints: Allowable values are: app_v2.
status String
(String) The current status of the app.

  • Constraints: Allowable values are: ready, deploying, failed, warning.
statusDetails List<Property Map>
(List) The detailed status of the application. Nested schema for status_details:

Look up Existing CodeEngineApp Resource

Get an existing CodeEngineApp 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?: CodeEngineAppState, opts?: CustomResourceOptions): CodeEngineApp
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        app_id: Optional[str] = None,
        build: Optional[str] = None,
        build_run: Optional[str] = None,
        code_engine_app_id: Optional[str] = None,
        computed_env_variables: Optional[Sequence[CodeEngineAppComputedEnvVariableArgs]] = None,
        created_at: Optional[str] = None,
        endpoint: Optional[str] = None,
        endpoint_internal: Optional[str] = None,
        entity_tag: Optional[str] = None,
        etag: Optional[str] = None,
        href: Optional[str] = None,
        image_port: Optional[float] = None,
        image_reference: Optional[str] = None,
        image_secret: Optional[str] = None,
        managed_domain_mappings: Optional[str] = None,
        name: Optional[str] = None,
        probe_liveness: Optional[CodeEngineAppProbeLivenessArgs] = None,
        probe_readiness: Optional[CodeEngineAppProbeReadinessArgs] = None,
        project_id: Optional[str] = None,
        region: Optional[str] = None,
        resource_type: Optional[str] = None,
        run_arguments: Optional[Sequence[str]] = None,
        run_as_user: Optional[float] = None,
        run_commands: Optional[Sequence[str]] = None,
        run_env_variables: Optional[Sequence[CodeEngineAppRunEnvVariableArgs]] = None,
        run_service_account: Optional[str] = None,
        run_volume_mounts: Optional[Sequence[CodeEngineAppRunVolumeMountArgs]] = None,
        scale_concurrency: Optional[float] = None,
        scale_concurrency_target: Optional[float] = None,
        scale_cpu_limit: Optional[str] = None,
        scale_down_delay: Optional[float] = None,
        scale_ephemeral_storage_limit: Optional[str] = None,
        scale_initial_instances: Optional[float] = None,
        scale_max_instances: Optional[float] = None,
        scale_memory_limit: Optional[str] = None,
        scale_min_instances: Optional[float] = None,
        scale_request_timeout: Optional[float] = None,
        status: Optional[str] = None,
        status_details: Optional[Sequence[CodeEngineAppStatusDetailArgs]] = None,
        timeouts: Optional[CodeEngineAppTimeoutsArgs] = None) -> CodeEngineApp
func GetCodeEngineApp(ctx *Context, name string, id IDInput, state *CodeEngineAppState, opts ...ResourceOption) (*CodeEngineApp, error)
public static CodeEngineApp Get(string name, Input<string> id, CodeEngineAppState? state, CustomResourceOptions? opts = null)
public static CodeEngineApp get(String name, Output<String> id, CodeEngineAppState state, CustomResourceOptions options)
resources:  _:    type: ibm:CodeEngineApp    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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
(String) The identifier of the resource.

  • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$/.
Build string
(String) Reference to a build that is associated with the application.
BuildRun string
(String) Reference to a build run that is associated with the application.
CodeEngineAppId string
The unique identifier of the code_engine_app.
ComputedEnvVariables List<CodeEngineAppComputedEnvVariable>
(List) References to config maps, secrets or literal values, which are defined and set by Code Engine and are exposed as environment variables in the application.

  • Constraints: The maximum length is 100 items. The minimum length is 0 items. Nested schema for computed_env_variables:
CreatedAt string
(String) The timestamp when the resource was created.
Endpoint string
(String) Optional URL to invoke the app. Depending on visibility, this is accessible publicly or in the private network only. Empty in case 'managed_domain_mappings' is set to 'local'.
EndpointInternal string
(String) The URL to the app that is only visible within the project.
EntityTag string
(String) The version of the app instance, which is used to achieve optimistic locking.

  • Constraints: The maximum length is 63 characters. The minimum length is 1 character. The value must match regular expression /^[\\*\\-a-z0-9]+$/.
Etag string
ETag identifier for code_engine_app.
Href string
(String) When you provision a new app, a URL is created identifying the location of the instance.

  • Constraints: The maximum length is 2048 characters. The minimum length is 0 characters. The value must match regular expression /(([^:\/?#]+):)?(\/\/([^\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$/.
ImagePort double
Optional port the app listens on. While the app will always be exposed via port 443 for end users, this port is used to connect to the port that is exposed by the container image.

  • Constraints: The default value is 8080.
ImageReference string
The name of the image that is used for this app. The format is REGISTRY/NAMESPACE/REPOSITORY:TAG where REGISTRY and TAG are optional. If REGISTRY is not specified, the default is docker.io. If TAG is not specified, the default is latest. If the image reference points to a registry that requires authentication, make sure to also specify the property image_secret.

  • Constraints: The maximum length is 256 characters. The minimum length is 1 character. The value must match regular expression /^([a-z0-9][a-z0-9\\-_.]+[a-z0-9][\/])?([a-z0-9][a-z0-9\\-_]+[a-z0-9][\/])?[a-z0-9][a-z0-9\\-_.\/]+a-z0-9?(@sha256:[a-fA-F0-9]{64})?$/.
ImageSecret string
Optional name of the image registry access secret. The image registry access secret is used to authenticate with a private registry when you download the container image. If the image reference points to a registry that requires authentication, the app will be created but cannot reach the ready status, until this property is provided, too.

  • Constraints: The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /^a-z0-9?(\\.a-z0-9?)*$/.
ManagedDomainMappings string
Optional value controlling which of the system managed domain mappings will be setup for the application. Valid values are 'local_public', 'local_private' and 'local'. Visibility can only be 'local_private' if the project supports application private visibility.

  • Constraints: The default value is local_public. Allowable values are: local, local_private, local_public.
Name string
The name of the app.

  • Constraints: The maximum length is 63 characters. The minimum length is 1 character. The value must match regular expression /^a-z?$/.
ProbeLiveness CodeEngineAppProbeLiveness
Response model for probes. Nested schema for probe_liveness:
ProbeReadiness CodeEngineAppProbeReadiness
Response model for probes. Nested schema for probe_readiness:
ProjectId string
The ID of the project.

  • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$/.
Region string
(String) The region of the project the resource is located in. Possible values: 'au-syd', 'br-sao', 'ca-tor', 'eu-de', 'eu-gb', 'jp-osa', 'jp-tok', 'us-east', 'us-south'.
ResourceType string
(String) The type of the app.

  • Constraints: Allowable values are: app_v2.
RunArguments List<string>
Optional arguments for the app that are passed to start the container. If not specified an empty string array will be applied and the arguments specified by the container image, will be used to start the container.

  • Constraints: The list items must match regular expression /^.*$/. The maximum length is 100 items. The minimum length is 0 items.
RunAsUser double
Optional user ID (UID) to run the app.

  • Constraints: The default value is 0.
RunCommands List<string>
Optional commands for the app that are passed to start the container. If not specified an empty string array will be applied and the command specified by the container image, will be used to start the container.

  • Constraints: The list items must match regular expression /^.*$/. The maximum length is 100 items. The minimum length is 0 items.
RunEnvVariables List<CodeEngineAppRunEnvVariable>
References to config maps, secrets or literal values, which are exposed as environment variables in the application.

  • Constraints: The maximum length is 100 items. The minimum length is 0 items. Nested schema for run_env_variables:
RunServiceAccount string
Optional name of the service account. For built-in service accounts, you can use the shortened names manager , none, reader, and writer.

  • Constraints: The default value is default. Allowable values are: default, manager, reader, writer, none. The minimum length is 0 characters. The value must match regular expression /^(manager|reader|writer|none|default)$/.
RunVolumeMounts List<CodeEngineAppRunVolumeMount>
Mounts of config maps or secrets.

  • Constraints: The maximum length is 100 items. The minimum length is 0 items. Nested schema for run_volume_mounts:
ScaleConcurrency double
Optional maximum number of requests that can be processed concurrently per instance.

  • Constraints: The default value is 100.
ScaleConcurrencyTarget double
Optional threshold of concurrent requests per instance at which one or more additional instances are created. Use this value to scale up instances based on concurrent number of requests. This option defaults to the value of the scale_concurrency option, if not specified.

  • Constraints: The default value is 100. The maximum value is 1000. The minimum value is 1.
ScaleCpuLimit string
Optional number of CPU set for the instance of the app. For valid values see Supported memory and CPU combinations.

  • Constraints: The default value is 1. The maximum length is 10 characters. The minimum length is 0 characters. The value must match regular expression /^([0-9.]+)([eEinumkKMGTPB]*)$/.
ScaleDownDelay double
Optional amount of time in seconds that delays the scale-down behavior for an app instance.

  • Constraints: The default value is 0. The maximum value is 3600. The minimum value is 0.
ScaleEphemeralStorageLimit string
Optional amount of ephemeral storage to set for the instance of the app. The amount specified as ephemeral storage, must not exceed the amount of scale_memory_limit. The units for specifying ephemeral storage are Megabyte (M) or Gigabyte (G), whereas G and M are the shorthand expressions for GB and MB. For more information see Units of measurement.

  • Constraints: The default value is 400M. The maximum length is 10 characters. The minimum length is 0 characters. The value must match regular expression /^([0-9.]+)([eEinumkKMGTPB]*)$/.
ScaleInitialInstances double
Optional initial number of instances that are created upon app creation or app update.

  • Constraints: The default value is 1.
ScaleMaxInstances double
Optional maximum number of instances for this app. If you set this value to 0, this property does not set a upper scaling limit. However, the app scaling is still limited by the project quota for instances. See Limits and quotas for Code Engine.

  • Constraints: The default value is 10.
ScaleMemoryLimit string
Optional amount of memory set for the instance of the app. For valid values see Supported memory and CPU combinations. The units for specifying memory are Megabyte (M) or Gigabyte (G), whereas G and M are the shorthand expressions for GB and MB. For more information see Units of measurement.

  • Constraints: The default value is 4G. The maximum length is 10 characters. The minimum length is 0 characters. The value must match regular expression /^([0-9.]+)([eEinumkKMGTPB]*)$/.
ScaleMinInstances double
Optional minimum number of instances for this app. If you set this value to 0, the app will scale down to zero, if not hit by any request for some time.

  • Constraints: The default value is 0.
ScaleRequestTimeout double
Optional amount of time in seconds that is allowed for a running app to respond to a request.

  • Constraints: The default value is 300.
Status string
(String) The current status of the app.

  • Constraints: Allowable values are: ready, deploying, failed, warning.
StatusDetails List<CodeEngineAppStatusDetail>
(List) The detailed status of the application. Nested schema for status_details:
Timeouts CodeEngineAppTimeouts
AppId string
(String) The identifier of the resource.

  • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$/.
Build string
(String) Reference to a build that is associated with the application.
BuildRun string
(String) Reference to a build run that is associated with the application.
CodeEngineAppId string
The unique identifier of the code_engine_app.
ComputedEnvVariables []CodeEngineAppComputedEnvVariableArgs
(List) References to config maps, secrets or literal values, which are defined and set by Code Engine and are exposed as environment variables in the application.

  • Constraints: The maximum length is 100 items. The minimum length is 0 items. Nested schema for computed_env_variables:
CreatedAt string
(String) The timestamp when the resource was created.
Endpoint string
(String) Optional URL to invoke the app. Depending on visibility, this is accessible publicly or in the private network only. Empty in case 'managed_domain_mappings' is set to 'local'.
EndpointInternal string
(String) The URL to the app that is only visible within the project.
EntityTag string
(String) The version of the app instance, which is used to achieve optimistic locking.

  • Constraints: The maximum length is 63 characters. The minimum length is 1 character. The value must match regular expression /^[\\*\\-a-z0-9]+$/.
Etag string
ETag identifier for code_engine_app.
Href string
(String) When you provision a new app, a URL is created identifying the location of the instance.

  • Constraints: The maximum length is 2048 characters. The minimum length is 0 characters. The value must match regular expression /(([^:\/?#]+):)?(\/\/([^\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$/.
ImagePort float64
Optional port the app listens on. While the app will always be exposed via port 443 for end users, this port is used to connect to the port that is exposed by the container image.

  • Constraints: The default value is 8080.
ImageReference string
The name of the image that is used for this app. The format is REGISTRY/NAMESPACE/REPOSITORY:TAG where REGISTRY and TAG are optional. If REGISTRY is not specified, the default is docker.io. If TAG is not specified, the default is latest. If the image reference points to a registry that requires authentication, make sure to also specify the property image_secret.

  • Constraints: The maximum length is 256 characters. The minimum length is 1 character. The value must match regular expression /^([a-z0-9][a-z0-9\\-_.]+[a-z0-9][\/])?([a-z0-9][a-z0-9\\-_]+[a-z0-9][\/])?[a-z0-9][a-z0-9\\-_.\/]+a-z0-9?(@sha256:[a-fA-F0-9]{64})?$/.
ImageSecret string
Optional name of the image registry access secret. The image registry access secret is used to authenticate with a private registry when you download the container image. If the image reference points to a registry that requires authentication, the app will be created but cannot reach the ready status, until this property is provided, too.

  • Constraints: The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /^a-z0-9?(\\.a-z0-9?)*$/.
ManagedDomainMappings string
Optional value controlling which of the system managed domain mappings will be setup for the application. Valid values are 'local_public', 'local_private' and 'local'. Visibility can only be 'local_private' if the project supports application private visibility.

  • Constraints: The default value is local_public. Allowable values are: local, local_private, local_public.
Name string
The name of the app.

  • Constraints: The maximum length is 63 characters. The minimum length is 1 character. The value must match regular expression /^a-z?$/.
ProbeLiveness CodeEngineAppProbeLivenessArgs
Response model for probes. Nested schema for probe_liveness:
ProbeReadiness CodeEngineAppProbeReadinessArgs
Response model for probes. Nested schema for probe_readiness:
ProjectId string
The ID of the project.

  • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$/.
Region string
(String) The region of the project the resource is located in. Possible values: 'au-syd', 'br-sao', 'ca-tor', 'eu-de', 'eu-gb', 'jp-osa', 'jp-tok', 'us-east', 'us-south'.
ResourceType string
(String) The type of the app.

  • Constraints: Allowable values are: app_v2.
RunArguments []string
Optional arguments for the app that are passed to start the container. If not specified an empty string array will be applied and the arguments specified by the container image, will be used to start the container.

  • Constraints: The list items must match regular expression /^.*$/. The maximum length is 100 items. The minimum length is 0 items.
RunAsUser float64
Optional user ID (UID) to run the app.

  • Constraints: The default value is 0.
RunCommands []string
Optional commands for the app that are passed to start the container. If not specified an empty string array will be applied and the command specified by the container image, will be used to start the container.

  • Constraints: The list items must match regular expression /^.*$/. The maximum length is 100 items. The minimum length is 0 items.
RunEnvVariables []CodeEngineAppRunEnvVariableArgs
References to config maps, secrets or literal values, which are exposed as environment variables in the application.

  • Constraints: The maximum length is 100 items. The minimum length is 0 items. Nested schema for run_env_variables:
RunServiceAccount string
Optional name of the service account. For built-in service accounts, you can use the shortened names manager , none, reader, and writer.

  • Constraints: The default value is default. Allowable values are: default, manager, reader, writer, none. The minimum length is 0 characters. The value must match regular expression /^(manager|reader|writer|none|default)$/.
RunVolumeMounts []CodeEngineAppRunVolumeMountArgs
Mounts of config maps or secrets.

  • Constraints: The maximum length is 100 items. The minimum length is 0 items. Nested schema for run_volume_mounts:
ScaleConcurrency float64
Optional maximum number of requests that can be processed concurrently per instance.

  • Constraints: The default value is 100.
ScaleConcurrencyTarget float64
Optional threshold of concurrent requests per instance at which one or more additional instances are created. Use this value to scale up instances based on concurrent number of requests. This option defaults to the value of the scale_concurrency option, if not specified.

  • Constraints: The default value is 100. The maximum value is 1000. The minimum value is 1.
ScaleCpuLimit string
Optional number of CPU set for the instance of the app. For valid values see Supported memory and CPU combinations.

  • Constraints: The default value is 1. The maximum length is 10 characters. The minimum length is 0 characters. The value must match regular expression /^([0-9.]+)([eEinumkKMGTPB]*)$/.
ScaleDownDelay float64
Optional amount of time in seconds that delays the scale-down behavior for an app instance.

  • Constraints: The default value is 0. The maximum value is 3600. The minimum value is 0.
ScaleEphemeralStorageLimit string
Optional amount of ephemeral storage to set for the instance of the app. The amount specified as ephemeral storage, must not exceed the amount of scale_memory_limit. The units for specifying ephemeral storage are Megabyte (M) or Gigabyte (G), whereas G and M are the shorthand expressions for GB and MB. For more information see Units of measurement.

  • Constraints: The default value is 400M. The maximum length is 10 characters. The minimum length is 0 characters. The value must match regular expression /^([0-9.]+)([eEinumkKMGTPB]*)$/.
ScaleInitialInstances float64
Optional initial number of instances that are created upon app creation or app update.

  • Constraints: The default value is 1.
ScaleMaxInstances float64
Optional maximum number of instances for this app. If you set this value to 0, this property does not set a upper scaling limit. However, the app scaling is still limited by the project quota for instances. See Limits and quotas for Code Engine.

  • Constraints: The default value is 10.
ScaleMemoryLimit string
Optional amount of memory set for the instance of the app. For valid values see Supported memory and CPU combinations. The units for specifying memory are Megabyte (M) or Gigabyte (G), whereas G and M are the shorthand expressions for GB and MB. For more information see Units of measurement.

  • Constraints: The default value is 4G. The maximum length is 10 characters. The minimum length is 0 characters. The value must match regular expression /^([0-9.]+)([eEinumkKMGTPB]*)$/.
ScaleMinInstances float64
Optional minimum number of instances for this app. If you set this value to 0, the app will scale down to zero, if not hit by any request for some time.

  • Constraints: The default value is 0.
ScaleRequestTimeout float64
Optional amount of time in seconds that is allowed for a running app to respond to a request.

  • Constraints: The default value is 300.
Status string
(String) The current status of the app.

  • Constraints: Allowable values are: ready, deploying, failed, warning.
StatusDetails []CodeEngineAppStatusDetailArgs
(List) The detailed status of the application. Nested schema for status_details:
Timeouts CodeEngineAppTimeoutsArgs
appId String
(String) The identifier of the resource.

  • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$/.
build String
(String) Reference to a build that is associated with the application.
buildRun String
(String) Reference to a build run that is associated with the application.
codeEngineAppId String
The unique identifier of the code_engine_app.
computedEnvVariables List<CodeEngineAppComputedEnvVariable>
(List) References to config maps, secrets or literal values, which are defined and set by Code Engine and are exposed as environment variables in the application.

  • Constraints: The maximum length is 100 items. The minimum length is 0 items. Nested schema for computed_env_variables:
createdAt String
(String) The timestamp when the resource was created.
endpoint String
(String) Optional URL to invoke the app. Depending on visibility, this is accessible publicly or in the private network only. Empty in case 'managed_domain_mappings' is set to 'local'.
endpointInternal String
(String) The URL to the app that is only visible within the project.
entityTag String
(String) The version of the app instance, which is used to achieve optimistic locking.

  • Constraints: The maximum length is 63 characters. The minimum length is 1 character. The value must match regular expression /^[\\*\\-a-z0-9]+$/.
etag String
ETag identifier for code_engine_app.
href String
(String) When you provision a new app, a URL is created identifying the location of the instance.

  • Constraints: The maximum length is 2048 characters. The minimum length is 0 characters. The value must match regular expression /(([^:\/?#]+):)?(\/\/([^\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$/.
imagePort Double
Optional port the app listens on. While the app will always be exposed via port 443 for end users, this port is used to connect to the port that is exposed by the container image.

  • Constraints: The default value is 8080.
imageReference String
The name of the image that is used for this app. The format is REGISTRY/NAMESPACE/REPOSITORY:TAG where REGISTRY and TAG are optional. If REGISTRY is not specified, the default is docker.io. If TAG is not specified, the default is latest. If the image reference points to a registry that requires authentication, make sure to also specify the property image_secret.

  • Constraints: The maximum length is 256 characters. The minimum length is 1 character. The value must match regular expression /^([a-z0-9][a-z0-9\\-_.]+[a-z0-9][\/])?([a-z0-9][a-z0-9\\-_]+[a-z0-9][\/])?[a-z0-9][a-z0-9\\-_.\/]+a-z0-9?(@sha256:[a-fA-F0-9]{64})?$/.
imageSecret String
Optional name of the image registry access secret. The image registry access secret is used to authenticate with a private registry when you download the container image. If the image reference points to a registry that requires authentication, the app will be created but cannot reach the ready status, until this property is provided, too.

  • Constraints: The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /^a-z0-9?(\\.a-z0-9?)*$/.
managedDomainMappings String
Optional value controlling which of the system managed domain mappings will be setup for the application. Valid values are 'local_public', 'local_private' and 'local'. Visibility can only be 'local_private' if the project supports application private visibility.

  • Constraints: The default value is local_public. Allowable values are: local, local_private, local_public.
name String
The name of the app.

  • Constraints: The maximum length is 63 characters. The minimum length is 1 character. The value must match regular expression /^a-z?$/.
probeLiveness CodeEngineAppProbeLiveness
Response model for probes. Nested schema for probe_liveness:
probeReadiness CodeEngineAppProbeReadiness
Response model for probes. Nested schema for probe_readiness:
projectId String
The ID of the project.

  • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$/.
region String
(String) The region of the project the resource is located in. Possible values: 'au-syd', 'br-sao', 'ca-tor', 'eu-de', 'eu-gb', 'jp-osa', 'jp-tok', 'us-east', 'us-south'.
resourceType String
(String) The type of the app.

  • Constraints: Allowable values are: app_v2.
runArguments List<String>
Optional arguments for the app that are passed to start the container. If not specified an empty string array will be applied and the arguments specified by the container image, will be used to start the container.

  • Constraints: The list items must match regular expression /^.*$/. The maximum length is 100 items. The minimum length is 0 items.
runAsUser Double
Optional user ID (UID) to run the app.

  • Constraints: The default value is 0.
runCommands List<String>
Optional commands for the app that are passed to start the container. If not specified an empty string array will be applied and the command specified by the container image, will be used to start the container.

  • Constraints: The list items must match regular expression /^.*$/. The maximum length is 100 items. The minimum length is 0 items.
runEnvVariables List<CodeEngineAppRunEnvVariable>
References to config maps, secrets or literal values, which are exposed as environment variables in the application.

  • Constraints: The maximum length is 100 items. The minimum length is 0 items. Nested schema for run_env_variables:
runServiceAccount String
Optional name of the service account. For built-in service accounts, you can use the shortened names manager , none, reader, and writer.

  • Constraints: The default value is default. Allowable values are: default, manager, reader, writer, none. The minimum length is 0 characters. The value must match regular expression /^(manager|reader|writer|none|default)$/.
runVolumeMounts List<CodeEngineAppRunVolumeMount>
Mounts of config maps or secrets.

  • Constraints: The maximum length is 100 items. The minimum length is 0 items. Nested schema for run_volume_mounts:
scaleConcurrency Double
Optional maximum number of requests that can be processed concurrently per instance.

  • Constraints: The default value is 100.
scaleConcurrencyTarget Double
Optional threshold of concurrent requests per instance at which one or more additional instances are created. Use this value to scale up instances based on concurrent number of requests. This option defaults to the value of the scale_concurrency option, if not specified.

  • Constraints: The default value is 100. The maximum value is 1000. The minimum value is 1.
scaleCpuLimit String
Optional number of CPU set for the instance of the app. For valid values see Supported memory and CPU combinations.

  • Constraints: The default value is 1. The maximum length is 10 characters. The minimum length is 0 characters. The value must match regular expression /^([0-9.]+)([eEinumkKMGTPB]*)$/.
scaleDownDelay Double
Optional amount of time in seconds that delays the scale-down behavior for an app instance.

  • Constraints: The default value is 0. The maximum value is 3600. The minimum value is 0.
scaleEphemeralStorageLimit String
Optional amount of ephemeral storage to set for the instance of the app. The amount specified as ephemeral storage, must not exceed the amount of scale_memory_limit. The units for specifying ephemeral storage are Megabyte (M) or Gigabyte (G), whereas G and M are the shorthand expressions for GB and MB. For more information see Units of measurement.

  • Constraints: The default value is 400M. The maximum length is 10 characters. The minimum length is 0 characters. The value must match regular expression /^([0-9.]+)([eEinumkKMGTPB]*)$/.
scaleInitialInstances Double
Optional initial number of instances that are created upon app creation or app update.

  • Constraints: The default value is 1.
scaleMaxInstances Double
Optional maximum number of instances for this app. If you set this value to 0, this property does not set a upper scaling limit. However, the app scaling is still limited by the project quota for instances. See Limits and quotas for Code Engine.

  • Constraints: The default value is 10.
scaleMemoryLimit String
Optional amount of memory set for the instance of the app. For valid values see Supported memory and CPU combinations. The units for specifying memory are Megabyte (M) or Gigabyte (G), whereas G and M are the shorthand expressions for GB and MB. For more information see Units of measurement.

  • Constraints: The default value is 4G. The maximum length is 10 characters. The minimum length is 0 characters. The value must match regular expression /^([0-9.]+)([eEinumkKMGTPB]*)$/.
scaleMinInstances Double
Optional minimum number of instances for this app. If you set this value to 0, the app will scale down to zero, if not hit by any request for some time.

  • Constraints: The default value is 0.
scaleRequestTimeout Double
Optional amount of time in seconds that is allowed for a running app to respond to a request.

  • Constraints: The default value is 300.
status String
(String) The current status of the app.

  • Constraints: Allowable values are: ready, deploying, failed, warning.
statusDetails List<CodeEngineAppStatusDetail>
(List) The detailed status of the application. Nested schema for status_details:
timeouts CodeEngineAppTimeouts
appId string
(String) The identifier of the resource.

  • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$/.
build string
(String) Reference to a build that is associated with the application.
buildRun string
(String) Reference to a build run that is associated with the application.
codeEngineAppId string
The unique identifier of the code_engine_app.
computedEnvVariables CodeEngineAppComputedEnvVariable[]
(List) References to config maps, secrets or literal values, which are defined and set by Code Engine and are exposed as environment variables in the application.

  • Constraints: The maximum length is 100 items. The minimum length is 0 items. Nested schema for computed_env_variables:
createdAt string
(String) The timestamp when the resource was created.
endpoint string
(String) Optional URL to invoke the app. Depending on visibility, this is accessible publicly or in the private network only. Empty in case 'managed_domain_mappings' is set to 'local'.
endpointInternal string
(String) The URL to the app that is only visible within the project.
entityTag string
(String) The version of the app instance, which is used to achieve optimistic locking.

  • Constraints: The maximum length is 63 characters. The minimum length is 1 character. The value must match regular expression /^[\\*\\-a-z0-9]+$/.
etag string
ETag identifier for code_engine_app.
href string
(String) When you provision a new app, a URL is created identifying the location of the instance.

  • Constraints: The maximum length is 2048 characters. The minimum length is 0 characters. The value must match regular expression /(([^:\/?#]+):)?(\/\/([^\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$/.
imagePort number
Optional port the app listens on. While the app will always be exposed via port 443 for end users, this port is used to connect to the port that is exposed by the container image.

  • Constraints: The default value is 8080.
imageReference string
The name of the image that is used for this app. The format is REGISTRY/NAMESPACE/REPOSITORY:TAG where REGISTRY and TAG are optional. If REGISTRY is not specified, the default is docker.io. If TAG is not specified, the default is latest. If the image reference points to a registry that requires authentication, make sure to also specify the property image_secret.

  • Constraints: The maximum length is 256 characters. The minimum length is 1 character. The value must match regular expression /^([a-z0-9][a-z0-9\\-_.]+[a-z0-9][\/])?([a-z0-9][a-z0-9\\-_]+[a-z0-9][\/])?[a-z0-9][a-z0-9\\-_.\/]+a-z0-9?(@sha256:[a-fA-F0-9]{64})?$/.
imageSecret string
Optional name of the image registry access secret. The image registry access secret is used to authenticate with a private registry when you download the container image. If the image reference points to a registry that requires authentication, the app will be created but cannot reach the ready status, until this property is provided, too.

  • Constraints: The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /^a-z0-9?(\\.a-z0-9?)*$/.
managedDomainMappings string
Optional value controlling which of the system managed domain mappings will be setup for the application. Valid values are 'local_public', 'local_private' and 'local'. Visibility can only be 'local_private' if the project supports application private visibility.

  • Constraints: The default value is local_public. Allowable values are: local, local_private, local_public.
name string
The name of the app.

  • Constraints: The maximum length is 63 characters. The minimum length is 1 character. The value must match regular expression /^a-z?$/.
probeLiveness CodeEngineAppProbeLiveness
Response model for probes. Nested schema for probe_liveness:
probeReadiness CodeEngineAppProbeReadiness
Response model for probes. Nested schema for probe_readiness:
projectId string
The ID of the project.

  • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$/.
region string
(String) The region of the project the resource is located in. Possible values: 'au-syd', 'br-sao', 'ca-tor', 'eu-de', 'eu-gb', 'jp-osa', 'jp-tok', 'us-east', 'us-south'.
resourceType string
(String) The type of the app.

  • Constraints: Allowable values are: app_v2.
runArguments string[]
Optional arguments for the app that are passed to start the container. If not specified an empty string array will be applied and the arguments specified by the container image, will be used to start the container.

  • Constraints: The list items must match regular expression /^.*$/. The maximum length is 100 items. The minimum length is 0 items.
runAsUser number
Optional user ID (UID) to run the app.

  • Constraints: The default value is 0.
runCommands string[]
Optional commands for the app that are passed to start the container. If not specified an empty string array will be applied and the command specified by the container image, will be used to start the container.

  • Constraints: The list items must match regular expression /^.*$/. The maximum length is 100 items. The minimum length is 0 items.
runEnvVariables CodeEngineAppRunEnvVariable[]
References to config maps, secrets or literal values, which are exposed as environment variables in the application.

  • Constraints: The maximum length is 100 items. The minimum length is 0 items. Nested schema for run_env_variables:
runServiceAccount string
Optional name of the service account. For built-in service accounts, you can use the shortened names manager , none, reader, and writer.

  • Constraints: The default value is default. Allowable values are: default, manager, reader, writer, none. The minimum length is 0 characters. The value must match regular expression /^(manager|reader|writer|none|default)$/.
runVolumeMounts CodeEngineAppRunVolumeMount[]
Mounts of config maps or secrets.

  • Constraints: The maximum length is 100 items. The minimum length is 0 items. Nested schema for run_volume_mounts:
scaleConcurrency number
Optional maximum number of requests that can be processed concurrently per instance.

  • Constraints: The default value is 100.
scaleConcurrencyTarget number
Optional threshold of concurrent requests per instance at which one or more additional instances are created. Use this value to scale up instances based on concurrent number of requests. This option defaults to the value of the scale_concurrency option, if not specified.

  • Constraints: The default value is 100. The maximum value is 1000. The minimum value is 1.
scaleCpuLimit string
Optional number of CPU set for the instance of the app. For valid values see Supported memory and CPU combinations.

  • Constraints: The default value is 1. The maximum length is 10 characters. The minimum length is 0 characters. The value must match regular expression /^([0-9.]+)([eEinumkKMGTPB]*)$/.
scaleDownDelay number
Optional amount of time in seconds that delays the scale-down behavior for an app instance.

  • Constraints: The default value is 0. The maximum value is 3600. The minimum value is 0.
scaleEphemeralStorageLimit string
Optional amount of ephemeral storage to set for the instance of the app. The amount specified as ephemeral storage, must not exceed the amount of scale_memory_limit. The units for specifying ephemeral storage are Megabyte (M) or Gigabyte (G), whereas G and M are the shorthand expressions for GB and MB. For more information see Units of measurement.

  • Constraints: The default value is 400M. The maximum length is 10 characters. The minimum length is 0 characters. The value must match regular expression /^([0-9.]+)([eEinumkKMGTPB]*)$/.
scaleInitialInstances number
Optional initial number of instances that are created upon app creation or app update.

  • Constraints: The default value is 1.
scaleMaxInstances number
Optional maximum number of instances for this app. If you set this value to 0, this property does not set a upper scaling limit. However, the app scaling is still limited by the project quota for instances. See Limits and quotas for Code Engine.

  • Constraints: The default value is 10.
scaleMemoryLimit string
Optional amount of memory set for the instance of the app. For valid values see Supported memory and CPU combinations. The units for specifying memory are Megabyte (M) or Gigabyte (G), whereas G and M are the shorthand expressions for GB and MB. For more information see Units of measurement.

  • Constraints: The default value is 4G. The maximum length is 10 characters. The minimum length is 0 characters. The value must match regular expression /^([0-9.]+)([eEinumkKMGTPB]*)$/.
scaleMinInstances number
Optional minimum number of instances for this app. If you set this value to 0, the app will scale down to zero, if not hit by any request for some time.

  • Constraints: The default value is 0.
scaleRequestTimeout number
Optional amount of time in seconds that is allowed for a running app to respond to a request.

  • Constraints: The default value is 300.
status string
(String) The current status of the app.

  • Constraints: Allowable values are: ready, deploying, failed, warning.
statusDetails CodeEngineAppStatusDetail[]
(List) The detailed status of the application. Nested schema for status_details:
timeouts CodeEngineAppTimeouts
app_id str
(String) The identifier of the resource.

  • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$/.
build str
(String) Reference to a build that is associated with the application.
build_run str
(String) Reference to a build run that is associated with the application.
code_engine_app_id str
The unique identifier of the code_engine_app.
computed_env_variables Sequence[CodeEngineAppComputedEnvVariableArgs]
(List) References to config maps, secrets or literal values, which are defined and set by Code Engine and are exposed as environment variables in the application.

  • Constraints: The maximum length is 100 items. The minimum length is 0 items. Nested schema for computed_env_variables:
created_at str
(String) The timestamp when the resource was created.
endpoint str
(String) Optional URL to invoke the app. Depending on visibility, this is accessible publicly or in the private network only. Empty in case 'managed_domain_mappings' is set to 'local'.
endpoint_internal str
(String) The URL to the app that is only visible within the project.
entity_tag str
(String) The version of the app instance, which is used to achieve optimistic locking.

  • Constraints: The maximum length is 63 characters. The minimum length is 1 character. The value must match regular expression /^[\\*\\-a-z0-9]+$/.
etag str
ETag identifier for code_engine_app.
href str
(String) When you provision a new app, a URL is created identifying the location of the instance.

  • Constraints: The maximum length is 2048 characters. The minimum length is 0 characters. The value must match regular expression /(([^:\/?#]+):)?(\/\/([^\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$/.
image_port float
Optional port the app listens on. While the app will always be exposed via port 443 for end users, this port is used to connect to the port that is exposed by the container image.

  • Constraints: The default value is 8080.
image_reference str
The name of the image that is used for this app. The format is REGISTRY/NAMESPACE/REPOSITORY:TAG where REGISTRY and TAG are optional. If REGISTRY is not specified, the default is docker.io. If TAG is not specified, the default is latest. If the image reference points to a registry that requires authentication, make sure to also specify the property image_secret.

  • Constraints: The maximum length is 256 characters. The minimum length is 1 character. The value must match regular expression /^([a-z0-9][a-z0-9\\-_.]+[a-z0-9][\/])?([a-z0-9][a-z0-9\\-_]+[a-z0-9][\/])?[a-z0-9][a-z0-9\\-_.\/]+a-z0-9?(@sha256:[a-fA-F0-9]{64})?$/.
image_secret str
Optional name of the image registry access secret. The image registry access secret is used to authenticate with a private registry when you download the container image. If the image reference points to a registry that requires authentication, the app will be created but cannot reach the ready status, until this property is provided, too.

  • Constraints: The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /^a-z0-9?(\\.a-z0-9?)*$/.
managed_domain_mappings str
Optional value controlling which of the system managed domain mappings will be setup for the application. Valid values are 'local_public', 'local_private' and 'local'. Visibility can only be 'local_private' if the project supports application private visibility.

  • Constraints: The default value is local_public. Allowable values are: local, local_private, local_public.
name str
The name of the app.

  • Constraints: The maximum length is 63 characters. The minimum length is 1 character. The value must match regular expression /^a-z?$/.
probe_liveness CodeEngineAppProbeLivenessArgs
Response model for probes. Nested schema for probe_liveness:
probe_readiness CodeEngineAppProbeReadinessArgs
Response model for probes. Nested schema for probe_readiness:
project_id str
The ID of the project.

  • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$/.
region str
(String) The region of the project the resource is located in. Possible values: 'au-syd', 'br-sao', 'ca-tor', 'eu-de', 'eu-gb', 'jp-osa', 'jp-tok', 'us-east', 'us-south'.
resource_type str
(String) The type of the app.

  • Constraints: Allowable values are: app_v2.
run_arguments Sequence[str]
Optional arguments for the app that are passed to start the container. If not specified an empty string array will be applied and the arguments specified by the container image, will be used to start the container.

  • Constraints: The list items must match regular expression /^.*$/. The maximum length is 100 items. The minimum length is 0 items.
run_as_user float
Optional user ID (UID) to run the app.

  • Constraints: The default value is 0.
run_commands Sequence[str]
Optional commands for the app that are passed to start the container. If not specified an empty string array will be applied and the command specified by the container image, will be used to start the container.

  • Constraints: The list items must match regular expression /^.*$/. The maximum length is 100 items. The minimum length is 0 items.
run_env_variables Sequence[CodeEngineAppRunEnvVariableArgs]
References to config maps, secrets or literal values, which are exposed as environment variables in the application.

  • Constraints: The maximum length is 100 items. The minimum length is 0 items. Nested schema for run_env_variables:
run_service_account str
Optional name of the service account. For built-in service accounts, you can use the shortened names manager , none, reader, and writer.

  • Constraints: The default value is default. Allowable values are: default, manager, reader, writer, none. The minimum length is 0 characters. The value must match regular expression /^(manager|reader|writer|none|default)$/.
run_volume_mounts Sequence[CodeEngineAppRunVolumeMountArgs]
Mounts of config maps or secrets.

  • Constraints: The maximum length is 100 items. The minimum length is 0 items. Nested schema for run_volume_mounts:
scale_concurrency float
Optional maximum number of requests that can be processed concurrently per instance.

  • Constraints: The default value is 100.
scale_concurrency_target float
Optional threshold of concurrent requests per instance at which one or more additional instances are created. Use this value to scale up instances based on concurrent number of requests. This option defaults to the value of the scale_concurrency option, if not specified.

  • Constraints: The default value is 100. The maximum value is 1000. The minimum value is 1.
scale_cpu_limit str
Optional number of CPU set for the instance of the app. For valid values see Supported memory and CPU combinations.

  • Constraints: The default value is 1. The maximum length is 10 characters. The minimum length is 0 characters. The value must match regular expression /^([0-9.]+)([eEinumkKMGTPB]*)$/.
scale_down_delay float
Optional amount of time in seconds that delays the scale-down behavior for an app instance.

  • Constraints: The default value is 0. The maximum value is 3600. The minimum value is 0.
scale_ephemeral_storage_limit str
Optional amount of ephemeral storage to set for the instance of the app. The amount specified as ephemeral storage, must not exceed the amount of scale_memory_limit. The units for specifying ephemeral storage are Megabyte (M) or Gigabyte (G), whereas G and M are the shorthand expressions for GB and MB. For more information see Units of measurement.

  • Constraints: The default value is 400M. The maximum length is 10 characters. The minimum length is 0 characters. The value must match regular expression /^([0-9.]+)([eEinumkKMGTPB]*)$/.
scale_initial_instances float
Optional initial number of instances that are created upon app creation or app update.

  • Constraints: The default value is 1.
scale_max_instances float
Optional maximum number of instances for this app. If you set this value to 0, this property does not set a upper scaling limit. However, the app scaling is still limited by the project quota for instances. See Limits and quotas for Code Engine.

  • Constraints: The default value is 10.
scale_memory_limit str
Optional amount of memory set for the instance of the app. For valid values see Supported memory and CPU combinations. The units for specifying memory are Megabyte (M) or Gigabyte (G), whereas G and M are the shorthand expressions for GB and MB. For more information see Units of measurement.

  • Constraints: The default value is 4G. The maximum length is 10 characters. The minimum length is 0 characters. The value must match regular expression /^([0-9.]+)([eEinumkKMGTPB]*)$/.
scale_min_instances float
Optional minimum number of instances for this app. If you set this value to 0, the app will scale down to zero, if not hit by any request for some time.

  • Constraints: The default value is 0.
scale_request_timeout float
Optional amount of time in seconds that is allowed for a running app to respond to a request.

  • Constraints: The default value is 300.
status str
(String) The current status of the app.

  • Constraints: Allowable values are: ready, deploying, failed, warning.
status_details Sequence[CodeEngineAppStatusDetailArgs]
(List) The detailed status of the application. Nested schema for status_details:
timeouts CodeEngineAppTimeoutsArgs
appId String
(String) The identifier of the resource.

  • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$/.
build String
(String) Reference to a build that is associated with the application.
buildRun String
(String) Reference to a build run that is associated with the application.
codeEngineAppId String
The unique identifier of the code_engine_app.
computedEnvVariables List<Property Map>
(List) References to config maps, secrets or literal values, which are defined and set by Code Engine and are exposed as environment variables in the application.

  • Constraints: The maximum length is 100 items. The minimum length is 0 items. Nested schema for computed_env_variables:
createdAt String
(String) The timestamp when the resource was created.
endpoint String
(String) Optional URL to invoke the app. Depending on visibility, this is accessible publicly or in the private network only. Empty in case 'managed_domain_mappings' is set to 'local'.
endpointInternal String
(String) The URL to the app that is only visible within the project.
entityTag String
(String) The version of the app instance, which is used to achieve optimistic locking.

  • Constraints: The maximum length is 63 characters. The minimum length is 1 character. The value must match regular expression /^[\\*\\-a-z0-9]+$/.
etag String
ETag identifier for code_engine_app.
href String
(String) When you provision a new app, a URL is created identifying the location of the instance.

  • Constraints: The maximum length is 2048 characters. The minimum length is 0 characters. The value must match regular expression /(([^:\/?#]+):)?(\/\/([^\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$/.
imagePort Number
Optional port the app listens on. While the app will always be exposed via port 443 for end users, this port is used to connect to the port that is exposed by the container image.

  • Constraints: The default value is 8080.
imageReference String
The name of the image that is used for this app. The format is REGISTRY/NAMESPACE/REPOSITORY:TAG where REGISTRY and TAG are optional. If REGISTRY is not specified, the default is docker.io. If TAG is not specified, the default is latest. If the image reference points to a registry that requires authentication, make sure to also specify the property image_secret.

  • Constraints: The maximum length is 256 characters. The minimum length is 1 character. The value must match regular expression /^([a-z0-9][a-z0-9\\-_.]+[a-z0-9][\/])?([a-z0-9][a-z0-9\\-_]+[a-z0-9][\/])?[a-z0-9][a-z0-9\\-_.\/]+a-z0-9?(@sha256:[a-fA-F0-9]{64})?$/.
imageSecret String
Optional name of the image registry access secret. The image registry access secret is used to authenticate with a private registry when you download the container image. If the image reference points to a registry that requires authentication, the app will be created but cannot reach the ready status, until this property is provided, too.

  • Constraints: The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /^a-z0-9?(\\.a-z0-9?)*$/.
managedDomainMappings String
Optional value controlling which of the system managed domain mappings will be setup for the application. Valid values are 'local_public', 'local_private' and 'local'. Visibility can only be 'local_private' if the project supports application private visibility.

  • Constraints: The default value is local_public. Allowable values are: local, local_private, local_public.
name String
The name of the app.

  • Constraints: The maximum length is 63 characters. The minimum length is 1 character. The value must match regular expression /^a-z?$/.
probeLiveness Property Map
Response model for probes. Nested schema for probe_liveness:
probeReadiness Property Map
Response model for probes. Nested schema for probe_readiness:
projectId String
The ID of the project.

  • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$/.
region String
(String) The region of the project the resource is located in. Possible values: 'au-syd', 'br-sao', 'ca-tor', 'eu-de', 'eu-gb', 'jp-osa', 'jp-tok', 'us-east', 'us-south'.
resourceType String
(String) The type of the app.

  • Constraints: Allowable values are: app_v2.
runArguments List<String>
Optional arguments for the app that are passed to start the container. If not specified an empty string array will be applied and the arguments specified by the container image, will be used to start the container.

  • Constraints: The list items must match regular expression /^.*$/. The maximum length is 100 items. The minimum length is 0 items.
runAsUser Number
Optional user ID (UID) to run the app.

  • Constraints: The default value is 0.
runCommands List<String>
Optional commands for the app that are passed to start the container. If not specified an empty string array will be applied and the command specified by the container image, will be used to start the container.

  • Constraints: The list items must match regular expression /^.*$/. The maximum length is 100 items. The minimum length is 0 items.
runEnvVariables List<Property Map>
References to config maps, secrets or literal values, which are exposed as environment variables in the application.

  • Constraints: The maximum length is 100 items. The minimum length is 0 items. Nested schema for run_env_variables:
runServiceAccount String
Optional name of the service account. For built-in service accounts, you can use the shortened names manager , none, reader, and writer.

  • Constraints: The default value is default. Allowable values are: default, manager, reader, writer, none. The minimum length is 0 characters. The value must match regular expression /^(manager|reader|writer|none|default)$/.
runVolumeMounts List<Property Map>
Mounts of config maps or secrets.

  • Constraints: The maximum length is 100 items. The minimum length is 0 items. Nested schema for run_volume_mounts:
scaleConcurrency Number
Optional maximum number of requests that can be processed concurrently per instance.

  • Constraints: The default value is 100.
scaleConcurrencyTarget Number
Optional threshold of concurrent requests per instance at which one or more additional instances are created. Use this value to scale up instances based on concurrent number of requests. This option defaults to the value of the scale_concurrency option, if not specified.

  • Constraints: The default value is 100. The maximum value is 1000. The minimum value is 1.
scaleCpuLimit String
Optional number of CPU set for the instance of the app. For valid values see Supported memory and CPU combinations.

  • Constraints: The default value is 1. The maximum length is 10 characters. The minimum length is 0 characters. The value must match regular expression /^([0-9.]+)([eEinumkKMGTPB]*)$/.
scaleDownDelay Number
Optional amount of time in seconds that delays the scale-down behavior for an app instance.

  • Constraints: The default value is 0. The maximum value is 3600. The minimum value is 0.
scaleEphemeralStorageLimit String
Optional amount of ephemeral storage to set for the instance of the app. The amount specified as ephemeral storage, must not exceed the amount of scale_memory_limit. The units for specifying ephemeral storage are Megabyte (M) or Gigabyte (G), whereas G and M are the shorthand expressions for GB and MB. For more information see Units of measurement.

  • Constraints: The default value is 400M. The maximum length is 10 characters. The minimum length is 0 characters. The value must match regular expression /^([0-9.]+)([eEinumkKMGTPB]*)$/.
scaleInitialInstances Number
Optional initial number of instances that are created upon app creation or app update.

  • Constraints: The default value is 1.
scaleMaxInstances Number
Optional maximum number of instances for this app. If you set this value to 0, this property does not set a upper scaling limit. However, the app scaling is still limited by the project quota for instances. See Limits and quotas for Code Engine.

  • Constraints: The default value is 10.
scaleMemoryLimit String
Optional amount of memory set for the instance of the app. For valid values see Supported memory and CPU combinations. The units for specifying memory are Megabyte (M) or Gigabyte (G), whereas G and M are the shorthand expressions for GB and MB. For more information see Units of measurement.

  • Constraints: The default value is 4G. The maximum length is 10 characters. The minimum length is 0 characters. The value must match regular expression /^([0-9.]+)([eEinumkKMGTPB]*)$/.
scaleMinInstances Number
Optional minimum number of instances for this app. If you set this value to 0, the app will scale down to zero, if not hit by any request for some time.

  • Constraints: The default value is 0.
scaleRequestTimeout Number
Optional amount of time in seconds that is allowed for a running app to respond to a request.

  • Constraints: The default value is 300.
status String
(String) The current status of the app.

  • Constraints: Allowable values are: ready, deploying, failed, warning.
statusDetails List<Property Map>
(List) The detailed status of the application. Nested schema for status_details:
timeouts Property Map

Supporting Types

CodeEngineAppComputedEnvVariable
, CodeEngineAppComputedEnvVariableArgs

Key This property is required. string
(String) The key to reference as environment variable.

  • Constraints: The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /^[\\-._a-zA-Z0-9]+$/.
Name This property is required. string
The name of the app.

  • Constraints: The maximum length is 63 characters. The minimum length is 1 character. The value must match regular expression /^a-z?$/.
Prefix This property is required. string
(String) A prefix that can be added to all keys of a full secret or config map reference.

  • Constraints: The maximum length is 253 characters. The minimum length is 0 characters. The value must match regular expression /^[a-zA-Z_][a-zA-Z0-9_]*$/.
Reference This property is required. string
(String) The name of the secret or config map.

  • Constraints: The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /^a-z0-9?(\\.a-z0-9?)*$/.
Type This property is required. string
(String) Specify the type of the environment variable.

  • Constraints: The default value is literal. Allowable values are: literal, config_map_full_reference, secret_full_reference, config_map_key_reference, secret_key_reference. The value must match regular expression /^(literal|config_map_full_reference|secret_full_reference|config_map_key_reference|secret_key_reference)$/.
Value This property is required. string
(String) The literal value of the environment variable.

  • Constraints: The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /^[\\-._a-zA-Z0-9]+$/.
Key This property is required. string
(String) The key to reference as environment variable.

  • Constraints: The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /^[\\-._a-zA-Z0-9]+$/.
Name This property is required. string
The name of the app.

  • Constraints: The maximum length is 63 characters. The minimum length is 1 character. The value must match regular expression /^a-z?$/.
Prefix This property is required. string
(String) A prefix that can be added to all keys of a full secret or config map reference.

  • Constraints: The maximum length is 253 characters. The minimum length is 0 characters. The value must match regular expression /^[a-zA-Z_][a-zA-Z0-9_]*$/.
Reference This property is required. string
(String) The name of the secret or config map.

  • Constraints: The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /^a-z0-9?(\\.a-z0-9?)*$/.
Type This property is required. string
(String) Specify the type of the environment variable.

  • Constraints: The default value is literal. Allowable values are: literal, config_map_full_reference, secret_full_reference, config_map_key_reference, secret_key_reference. The value must match regular expression /^(literal|config_map_full_reference|secret_full_reference|config_map_key_reference|secret_key_reference)$/.
Value This property is required. string
(String) The literal value of the environment variable.

  • Constraints: The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /^[\\-._a-zA-Z0-9]+$/.
key This property is required. String
(String) The key to reference as environment variable.

  • Constraints: The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /^[\\-._a-zA-Z0-9]+$/.
name This property is required. String
The name of the app.

  • Constraints: The maximum length is 63 characters. The minimum length is 1 character. The value must match regular expression /^a-z?$/.
prefix This property is required. String
(String) A prefix that can be added to all keys of a full secret or config map reference.

  • Constraints: The maximum length is 253 characters. The minimum length is 0 characters. The value must match regular expression /^[a-zA-Z_][a-zA-Z0-9_]*$/.
reference This property is required. String
(String) The name of the secret or config map.

  • Constraints: The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /^a-z0-9?(\\.a-z0-9?)*$/.
type This property is required. String
(String) Specify the type of the environment variable.

  • Constraints: The default value is literal. Allowable values are: literal, config_map_full_reference, secret_full_reference, config_map_key_reference, secret_key_reference. The value must match regular expression /^(literal|config_map_full_reference|secret_full_reference|config_map_key_reference|secret_key_reference)$/.
value This property is required. String
(String) The literal value of the environment variable.

  • Constraints: The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /^[\\-._a-zA-Z0-9]+$/.
key This property is required. string
(String) The key to reference as environment variable.

  • Constraints: The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /^[\\-._a-zA-Z0-9]+$/.
name This property is required. string
The name of the app.

  • Constraints: The maximum length is 63 characters. The minimum length is 1 character. The value must match regular expression /^a-z?$/.
prefix This property is required. string
(String) A prefix that can be added to all keys of a full secret or config map reference.

  • Constraints: The maximum length is 253 characters. The minimum length is 0 characters. The value must match regular expression /^[a-zA-Z_][a-zA-Z0-9_]*$/.
reference This property is required. string
(String) The name of the secret or config map.

  • Constraints: The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /^a-z0-9?(\\.a-z0-9?)*$/.
type This property is required. string
(String) Specify the type of the environment variable.

  • Constraints: The default value is literal. Allowable values are: literal, config_map_full_reference, secret_full_reference, config_map_key_reference, secret_key_reference. The value must match regular expression /^(literal|config_map_full_reference|secret_full_reference|config_map_key_reference|secret_key_reference)$/.
value This property is required. string
(String) The literal value of the environment variable.

  • Constraints: The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /^[\\-._a-zA-Z0-9]+$/.
key This property is required. str
(String) The key to reference as environment variable.

  • Constraints: The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /^[\\-._a-zA-Z0-9]+$/.
name This property is required. str
The name of the app.

  • Constraints: The maximum length is 63 characters. The minimum length is 1 character. The value must match regular expression /^a-z?$/.
prefix This property is required. str
(String) A prefix that can be added to all keys of a full secret or config map reference.

  • Constraints: The maximum length is 253 characters. The minimum length is 0 characters. The value must match regular expression /^[a-zA-Z_][a-zA-Z0-9_]*$/.
reference This property is required. str
(String) The name of the secret or config map.

  • Constraints: The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /^a-z0-9?(\\.a-z0-9?)*$/.
type This property is required. str
(String) Specify the type of the environment variable.

  • Constraints: The default value is literal. Allowable values are: literal, config_map_full_reference, secret_full_reference, config_map_key_reference, secret_key_reference. The value must match regular expression /^(literal|config_map_full_reference|secret_full_reference|config_map_key_reference|secret_key_reference)$/.
value This property is required. str
(String) The literal value of the environment variable.

  • Constraints: The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /^[\\-._a-zA-Z0-9]+$/.
key This property is required. String
(String) The key to reference as environment variable.

  • Constraints: The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /^[\\-._a-zA-Z0-9]+$/.
name This property is required. String
The name of the app.

  • Constraints: The maximum length is 63 characters. The minimum length is 1 character. The value must match regular expression /^a-z?$/.
prefix This property is required. String
(String) A prefix that can be added to all keys of a full secret or config map reference.

  • Constraints: The maximum length is 253 characters. The minimum length is 0 characters. The value must match regular expression /^[a-zA-Z_][a-zA-Z0-9_]*$/.
reference This property is required. String
(String) The name of the secret or config map.

  • Constraints: The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /^a-z0-9?(\\.a-z0-9?)*$/.
type This property is required. String
(String) Specify the type of the environment variable.

  • Constraints: The default value is literal. Allowable values are: literal, config_map_full_reference, secret_full_reference, config_map_key_reference, secret_key_reference. The value must match regular expression /^(literal|config_map_full_reference|secret_full_reference|config_map_key_reference|secret_key_reference)$/.
value This property is required. String
(String) The literal value of the environment variable.

  • Constraints: The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /^[\\-._a-zA-Z0-9]+$/.

CodeEngineAppProbeLiveness
, CodeEngineAppProbeLivenessArgs

FailureThreshold double
The number of consecutive, unsuccessful checks for the probe to be considered failed.

  • Constraints: The default value is 1. The maximum value is 10. The minimum value is 1.
InitialDelay double
The amount of time in seconds to wait before the first probe check is performed.

  • Constraints: The maximum value is 10. The minimum value is 1.
Interval double
The amount of time in seconds between probe checks.

  • Constraints: The default value is 10. The maximum value is 60. The minimum value is 1.
Path string
The path of the HTTP request to the resource. A path is only supported for a probe with a type of http.

  • Constraints: The maximum length is 2048 characters. The minimum length is 0 characters. The value must match regular expression /^\/(([a-zA-Z0-9-._~!$&'()*+,;=:@]|%[a-fA-F0-9]{2})+(\/([a-zA-Z0-9-._~!$&'()*+,;=:@]|%[a-fA-F0-9]{2})*)*)?(\\?([a-zA-Z0-9-._~!$&'()*+,;=:@\/?]|%[a-fA-F0-9]{2})*)?$/.
Port double
The port on which to probe the resource.

  • Constraints: The maximum value is 65535. The minimum value is 1.
Timeout double
The amount of time in seconds that the probe waits for a response from the application before it times out and fails.

  • Constraints: The default value is 1. The maximum value is 3600. The minimum value is 1.
Type string
Specifies whether to use HTTP or TCP for the probe checks. The default is TCP.

  • Constraints: Allowable values are: tcp, http.
FailureThreshold float64
The number of consecutive, unsuccessful checks for the probe to be considered failed.

  • Constraints: The default value is 1. The maximum value is 10. The minimum value is 1.
InitialDelay float64
The amount of time in seconds to wait before the first probe check is performed.

  • Constraints: The maximum value is 10. The minimum value is 1.
Interval float64
The amount of time in seconds between probe checks.

  • Constraints: The default value is 10. The maximum value is 60. The minimum value is 1.
Path string
The path of the HTTP request to the resource. A path is only supported for a probe with a type of http.

  • Constraints: The maximum length is 2048 characters. The minimum length is 0 characters. The value must match regular expression /^\/(([a-zA-Z0-9-._~!$&'()*+,;=:@]|%[a-fA-F0-9]{2})+(\/([a-zA-Z0-9-._~!$&'()*+,;=:@]|%[a-fA-F0-9]{2})*)*)?(\\?([a-zA-Z0-9-._~!$&'()*+,;=:@\/?]|%[a-fA-F0-9]{2})*)?$/.
Port float64
The port on which to probe the resource.

  • Constraints: The maximum value is 65535. The minimum value is 1.
Timeout float64
The amount of time in seconds that the probe waits for a response from the application before it times out and fails.

  • Constraints: The default value is 1. The maximum value is 3600. The minimum value is 1.
Type string
Specifies whether to use HTTP or TCP for the probe checks. The default is TCP.

  • Constraints: Allowable values are: tcp, http.
failureThreshold Double
The number of consecutive, unsuccessful checks for the probe to be considered failed.

  • Constraints: The default value is 1. The maximum value is 10. The minimum value is 1.
initialDelay Double
The amount of time in seconds to wait before the first probe check is performed.

  • Constraints: The maximum value is 10. The minimum value is 1.
interval Double
The amount of time in seconds between probe checks.

  • Constraints: The default value is 10. The maximum value is 60. The minimum value is 1.
path String
The path of the HTTP request to the resource. A path is only supported for a probe with a type of http.

  • Constraints: The maximum length is 2048 characters. The minimum length is 0 characters. The value must match regular expression /^\/(([a-zA-Z0-9-._~!$&'()*+,;=:@]|%[a-fA-F0-9]{2})+(\/([a-zA-Z0-9-._~!$&'()*+,;=:@]|%[a-fA-F0-9]{2})*)*)?(\\?([a-zA-Z0-9-._~!$&'()*+,;=:@\/?]|%[a-fA-F0-9]{2})*)?$/.
port Double
The port on which to probe the resource.

  • Constraints: The maximum value is 65535. The minimum value is 1.
timeout Double
The amount of time in seconds that the probe waits for a response from the application before it times out and fails.

  • Constraints: The default value is 1. The maximum value is 3600. The minimum value is 1.
type String
Specifies whether to use HTTP or TCP for the probe checks. The default is TCP.

  • Constraints: Allowable values are: tcp, http.
failureThreshold number
The number of consecutive, unsuccessful checks for the probe to be considered failed.

  • Constraints: The default value is 1. The maximum value is 10. The minimum value is 1.
initialDelay number
The amount of time in seconds to wait before the first probe check is performed.

  • Constraints: The maximum value is 10. The minimum value is 1.
interval number
The amount of time in seconds between probe checks.

  • Constraints: The default value is 10. The maximum value is 60. The minimum value is 1.
path string
The path of the HTTP request to the resource. A path is only supported for a probe with a type of http.

  • Constraints: The maximum length is 2048 characters. The minimum length is 0 characters. The value must match regular expression /^\/(([a-zA-Z0-9-._~!$&'()*+,;=:@]|%[a-fA-F0-9]{2})+(\/([a-zA-Z0-9-._~!$&'()*+,;=:@]|%[a-fA-F0-9]{2})*)*)?(\\?([a-zA-Z0-9-._~!$&'()*+,;=:@\/?]|%[a-fA-F0-9]{2})*)?$/.
port number
The port on which to probe the resource.

  • Constraints: The maximum value is 65535. The minimum value is 1.
timeout number
The amount of time in seconds that the probe waits for a response from the application before it times out and fails.

  • Constraints: The default value is 1. The maximum value is 3600. The minimum value is 1.
type string
Specifies whether to use HTTP or TCP for the probe checks. The default is TCP.

  • Constraints: Allowable values are: tcp, http.
failure_threshold float
The number of consecutive, unsuccessful checks for the probe to be considered failed.

  • Constraints: The default value is 1. The maximum value is 10. The minimum value is 1.
initial_delay float
The amount of time in seconds to wait before the first probe check is performed.

  • Constraints: The maximum value is 10. The minimum value is 1.
interval float
The amount of time in seconds between probe checks.

  • Constraints: The default value is 10. The maximum value is 60. The minimum value is 1.
path str
The path of the HTTP request to the resource. A path is only supported for a probe with a type of http.

  • Constraints: The maximum length is 2048 characters. The minimum length is 0 characters. The value must match regular expression /^\/(([a-zA-Z0-9-._~!$&'()*+,;=:@]|%[a-fA-F0-9]{2})+(\/([a-zA-Z0-9-._~!$&'()*+,;=:@]|%[a-fA-F0-9]{2})*)*)?(\\?([a-zA-Z0-9-._~!$&'()*+,;=:@\/?]|%[a-fA-F0-9]{2})*)?$/.
port float
The port on which to probe the resource.

  • Constraints: The maximum value is 65535. The minimum value is 1.
timeout float
The amount of time in seconds that the probe waits for a response from the application before it times out and fails.

  • Constraints: The default value is 1. The maximum value is 3600. The minimum value is 1.
type str
Specifies whether to use HTTP or TCP for the probe checks. The default is TCP.

  • Constraints: Allowable values are: tcp, http.
failureThreshold Number
The number of consecutive, unsuccessful checks for the probe to be considered failed.

  • Constraints: The default value is 1. The maximum value is 10. The minimum value is 1.
initialDelay Number
The amount of time in seconds to wait before the first probe check is performed.

  • Constraints: The maximum value is 10. The minimum value is 1.
interval Number
The amount of time in seconds between probe checks.

  • Constraints: The default value is 10. The maximum value is 60. The minimum value is 1.
path String
The path of the HTTP request to the resource. A path is only supported for a probe with a type of http.

  • Constraints: The maximum length is 2048 characters. The minimum length is 0 characters. The value must match regular expression /^\/(([a-zA-Z0-9-._~!$&'()*+,;=:@]|%[a-fA-F0-9]{2})+(\/([a-zA-Z0-9-._~!$&'()*+,;=:@]|%[a-fA-F0-9]{2})*)*)?(\\?([a-zA-Z0-9-._~!$&'()*+,;=:@\/?]|%[a-fA-F0-9]{2})*)?$/.
port Number
The port on which to probe the resource.

  • Constraints: The maximum value is 65535. The minimum value is 1.
timeout Number
The amount of time in seconds that the probe waits for a response from the application before it times out and fails.

  • Constraints: The default value is 1. The maximum value is 3600. The minimum value is 1.
type String
Specifies whether to use HTTP or TCP for the probe checks. The default is TCP.

  • Constraints: Allowable values are: tcp, http.

CodeEngineAppProbeReadiness
, CodeEngineAppProbeReadinessArgs

FailureThreshold double
The number of consecutive, unsuccessful checks for the probe to be considered failed.

  • Constraints: The default value is 1. The maximum value is 10. The minimum value is 1.
InitialDelay double
The amount of time in seconds to wait before the first probe check is performed.

  • Constraints: The maximum value is 10. The minimum value is 1.
Interval double
The amount of time in seconds between probe checks.

  • Constraints: The default value is 10. The maximum value is 60. The minimum value is 1.
Path string
The path of the HTTP request to the resource. A path is only supported for a probe with a type of http.

  • Constraints: The maximum length is 2048 characters. The minimum length is 0 characters. The value must match regular expression /^\/(([a-zA-Z0-9-._~!$&'()*+,;=:@]|%[a-fA-F0-9]{2})+(\/([a-zA-Z0-9-._~!$&'()*+,;=:@]|%[a-fA-F0-9]{2})*)*)?(\\?([a-zA-Z0-9-._~!$&'()*+,;=:@\/?]|%[a-fA-F0-9]{2})*)?$/.
Port double
The port on which to probe the resource.

  • Constraints: The maximum value is 65535. The minimum value is 1.
Timeout double
The amount of time in seconds that the probe waits for a response from the application before it times out and fails.

  • Constraints: The default value is 1. The maximum value is 3600. The minimum value is 1.
Type string
Specifies whether to use HTTP or TCP for the probe checks. The default is TCP.

  • Constraints: Allowable values are: tcp, http.
FailureThreshold float64
The number of consecutive, unsuccessful checks for the probe to be considered failed.

  • Constraints: The default value is 1. The maximum value is 10. The minimum value is 1.
InitialDelay float64
The amount of time in seconds to wait before the first probe check is performed.

  • Constraints: The maximum value is 10. The minimum value is 1.
Interval float64
The amount of time in seconds between probe checks.

  • Constraints: The default value is 10. The maximum value is 60. The minimum value is 1.
Path string
The path of the HTTP request to the resource. A path is only supported for a probe with a type of http.

  • Constraints: The maximum length is 2048 characters. The minimum length is 0 characters. The value must match regular expression /^\/(([a-zA-Z0-9-._~!$&'()*+,;=:@]|%[a-fA-F0-9]{2})+(\/([a-zA-Z0-9-._~!$&'()*+,;=:@]|%[a-fA-F0-9]{2})*)*)?(\\?([a-zA-Z0-9-._~!$&'()*+,;=:@\/?]|%[a-fA-F0-9]{2})*)?$/.
Port float64
The port on which to probe the resource.

  • Constraints: The maximum value is 65535. The minimum value is 1.
Timeout float64
The amount of time in seconds that the probe waits for a response from the application before it times out and fails.

  • Constraints: The default value is 1. The maximum value is 3600. The minimum value is 1.
Type string
Specifies whether to use HTTP or TCP for the probe checks. The default is TCP.

  • Constraints: Allowable values are: tcp, http.
failureThreshold Double
The number of consecutive, unsuccessful checks for the probe to be considered failed.

  • Constraints: The default value is 1. The maximum value is 10. The minimum value is 1.
initialDelay Double
The amount of time in seconds to wait before the first probe check is performed.

  • Constraints: The maximum value is 10. The minimum value is 1.
interval Double
The amount of time in seconds between probe checks.

  • Constraints: The default value is 10. The maximum value is 60. The minimum value is 1.
path String
The path of the HTTP request to the resource. A path is only supported for a probe with a type of http.

  • Constraints: The maximum length is 2048 characters. The minimum length is 0 characters. The value must match regular expression /^\/(([a-zA-Z0-9-._~!$&'()*+,;=:@]|%[a-fA-F0-9]{2})+(\/([a-zA-Z0-9-._~!$&'()*+,;=:@]|%[a-fA-F0-9]{2})*)*)?(\\?([a-zA-Z0-9-._~!$&'()*+,;=:@\/?]|%[a-fA-F0-9]{2})*)?$/.
port Double
The port on which to probe the resource.

  • Constraints: The maximum value is 65535. The minimum value is 1.
timeout Double
The amount of time in seconds that the probe waits for a response from the application before it times out and fails.

  • Constraints: The default value is 1. The maximum value is 3600. The minimum value is 1.
type String
Specifies whether to use HTTP or TCP for the probe checks. The default is TCP.

  • Constraints: Allowable values are: tcp, http.
failureThreshold number
The number of consecutive, unsuccessful checks for the probe to be considered failed.

  • Constraints: The default value is 1. The maximum value is 10. The minimum value is 1.
initialDelay number
The amount of time in seconds to wait before the first probe check is performed.

  • Constraints: The maximum value is 10. The minimum value is 1.
interval number
The amount of time in seconds between probe checks.

  • Constraints: The default value is 10. The maximum value is 60. The minimum value is 1.
path string
The path of the HTTP request to the resource. A path is only supported for a probe with a type of http.

  • Constraints: The maximum length is 2048 characters. The minimum length is 0 characters. The value must match regular expression /^\/(([a-zA-Z0-9-._~!$&'()*+,;=:@]|%[a-fA-F0-9]{2})+(\/([a-zA-Z0-9-._~!$&'()*+,;=:@]|%[a-fA-F0-9]{2})*)*)?(\\?([a-zA-Z0-9-._~!$&'()*+,;=:@\/?]|%[a-fA-F0-9]{2})*)?$/.
port number
The port on which to probe the resource.

  • Constraints: The maximum value is 65535. The minimum value is 1.
timeout number
The amount of time in seconds that the probe waits for a response from the application before it times out and fails.

  • Constraints: The default value is 1. The maximum value is 3600. The minimum value is 1.
type string
Specifies whether to use HTTP or TCP for the probe checks. The default is TCP.

  • Constraints: Allowable values are: tcp, http.
failure_threshold float
The number of consecutive, unsuccessful checks for the probe to be considered failed.

  • Constraints: The default value is 1. The maximum value is 10. The minimum value is 1.
initial_delay float
The amount of time in seconds to wait before the first probe check is performed.

  • Constraints: The maximum value is 10. The minimum value is 1.
interval float
The amount of time in seconds between probe checks.

  • Constraints: The default value is 10. The maximum value is 60. The minimum value is 1.
path str
The path of the HTTP request to the resource. A path is only supported for a probe with a type of http.

  • Constraints: The maximum length is 2048 characters. The minimum length is 0 characters. The value must match regular expression /^\/(([a-zA-Z0-9-._~!$&'()*+,;=:@]|%[a-fA-F0-9]{2})+(\/([a-zA-Z0-9-._~!$&'()*+,;=:@]|%[a-fA-F0-9]{2})*)*)?(\\?([a-zA-Z0-9-._~!$&'()*+,;=:@\/?]|%[a-fA-F0-9]{2})*)?$/.
port float
The port on which to probe the resource.

  • Constraints: The maximum value is 65535. The minimum value is 1.
timeout float
The amount of time in seconds that the probe waits for a response from the application before it times out and fails.

  • Constraints: The default value is 1. The maximum value is 3600. The minimum value is 1.
type str
Specifies whether to use HTTP or TCP for the probe checks. The default is TCP.

  • Constraints: Allowable values are: tcp, http.
failureThreshold Number
The number of consecutive, unsuccessful checks for the probe to be considered failed.

  • Constraints: The default value is 1. The maximum value is 10. The minimum value is 1.
initialDelay Number
The amount of time in seconds to wait before the first probe check is performed.

  • Constraints: The maximum value is 10. The minimum value is 1.
interval Number
The amount of time in seconds between probe checks.

  • Constraints: The default value is 10. The maximum value is 60. The minimum value is 1.
path String
The path of the HTTP request to the resource. A path is only supported for a probe with a type of http.

  • Constraints: The maximum length is 2048 characters. The minimum length is 0 characters. The value must match regular expression /^\/(([a-zA-Z0-9-._~!$&'()*+,;=:@]|%[a-fA-F0-9]{2})+(\/([a-zA-Z0-9-._~!$&'()*+,;=:@]|%[a-fA-F0-9]{2})*)*)?(\\?([a-zA-Z0-9-._~!$&'()*+,;=:@\/?]|%[a-fA-F0-9]{2})*)?$/.
port Number
The port on which to probe the resource.

  • Constraints: The maximum value is 65535. The minimum value is 1.
timeout Number
The amount of time in seconds that the probe waits for a response from the application before it times out and fails.

  • Constraints: The default value is 1. The maximum value is 3600. The minimum value is 1.
type String
Specifies whether to use HTTP or TCP for the probe checks. The default is TCP.

  • Constraints: Allowable values are: tcp, http.

CodeEngineAppRunEnvVariable
, CodeEngineAppRunEnvVariableArgs

Key string
The key to reference as environment variable.

  • Constraints: The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /^[\\-._a-zA-Z0-9]+$/.
Name string
The name of the environment variable.

  • Constraints: The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /^[\\-._a-zA-Z0-9]+$/.
Prefix string
A prefix that can be added to all keys of a full secret or config map reference.

  • Constraints: The maximum length is 253 characters. The minimum length is 0 characters. The value must match regular expression /^[a-zA-Z_][a-zA-Z0-9_]*$/.
Reference string
The name of the secret or config map.

  • Constraints: The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /^a-z0-9?(\\.a-z0-9?)*$/.
Type string
Specify the type of the environment variable.

  • Constraints: The default value is literal. Allowable values are: literal, config_map_full_reference, secret_full_reference, config_map_key_reference, secret_key_reference. The value must match regular expression /^(literal|config_map_full_reference|secret_full_reference|config_map_key_reference|secret_key_reference)$/. When referencing a secret or configmap, the reference must be specified. When referencing a secret or configmap key, a key must also be specified.
Value string
The literal value of the environment variable.

  • Constraints: The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /^[\\-._a-zA-Z0-9]+$/.
Key string
The key to reference as environment variable.

  • Constraints: The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /^[\\-._a-zA-Z0-9]+$/.
Name string
The name of the environment variable.

  • Constraints: The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /^[\\-._a-zA-Z0-9]+$/.
Prefix string
A prefix that can be added to all keys of a full secret or config map reference.

  • Constraints: The maximum length is 253 characters. The minimum length is 0 characters. The value must match regular expression /^[a-zA-Z_][a-zA-Z0-9_]*$/.
Reference string
The name of the secret or config map.

  • Constraints: The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /^a-z0-9?(\\.a-z0-9?)*$/.
Type string
Specify the type of the environment variable.

  • Constraints: The default value is literal. Allowable values are: literal, config_map_full_reference, secret_full_reference, config_map_key_reference, secret_key_reference. The value must match regular expression /^(literal|config_map_full_reference|secret_full_reference|config_map_key_reference|secret_key_reference)$/. When referencing a secret or configmap, the reference must be specified. When referencing a secret or configmap key, a key must also be specified.
Value string
The literal value of the environment variable.

  • Constraints: The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /^[\\-._a-zA-Z0-9]+$/.
key String
The key to reference as environment variable.

  • Constraints: The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /^[\\-._a-zA-Z0-9]+$/.
name String
The name of the environment variable.

  • Constraints: The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /^[\\-._a-zA-Z0-9]+$/.
prefix String
A prefix that can be added to all keys of a full secret or config map reference.

  • Constraints: The maximum length is 253 characters. The minimum length is 0 characters. The value must match regular expression /^[a-zA-Z_][a-zA-Z0-9_]*$/.
reference String
The name of the secret or config map.

  • Constraints: The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /^a-z0-9?(\\.a-z0-9?)*$/.
type String
Specify the type of the environment variable.

  • Constraints: The default value is literal. Allowable values are: literal, config_map_full_reference, secret_full_reference, config_map_key_reference, secret_key_reference. The value must match regular expression /^(literal|config_map_full_reference|secret_full_reference|config_map_key_reference|secret_key_reference)$/. When referencing a secret or configmap, the reference must be specified. When referencing a secret or configmap key, a key must also be specified.
value String
The literal value of the environment variable.

  • Constraints: The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /^[\\-._a-zA-Z0-9]+$/.
key string
The key to reference as environment variable.

  • Constraints: The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /^[\\-._a-zA-Z0-9]+$/.
name string
The name of the environment variable.

  • Constraints: The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /^[\\-._a-zA-Z0-9]+$/.
prefix string
A prefix that can be added to all keys of a full secret or config map reference.

  • Constraints: The maximum length is 253 characters. The minimum length is 0 characters. The value must match regular expression /^[a-zA-Z_][a-zA-Z0-9_]*$/.
reference string
The name of the secret or config map.

  • Constraints: The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /^a-z0-9?(\\.a-z0-9?)*$/.
type string
Specify the type of the environment variable.

  • Constraints: The default value is literal. Allowable values are: literal, config_map_full_reference, secret_full_reference, config_map_key_reference, secret_key_reference. The value must match regular expression /^(literal|config_map_full_reference|secret_full_reference|config_map_key_reference|secret_key_reference)$/. When referencing a secret or configmap, the reference must be specified. When referencing a secret or configmap key, a key must also be specified.
value string
The literal value of the environment variable.

  • Constraints: The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /^[\\-._a-zA-Z0-9]+$/.
key str
The key to reference as environment variable.

  • Constraints: The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /^[\\-._a-zA-Z0-9]+$/.
name str
The name of the environment variable.

  • Constraints: The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /^[\\-._a-zA-Z0-9]+$/.
prefix str
A prefix that can be added to all keys of a full secret or config map reference.

  • Constraints: The maximum length is 253 characters. The minimum length is 0 characters. The value must match regular expression /^[a-zA-Z_][a-zA-Z0-9_]*$/.
reference str
The name of the secret or config map.

  • Constraints: The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /^a-z0-9?(\\.a-z0-9?)*$/.
type str
Specify the type of the environment variable.

  • Constraints: The default value is literal. Allowable values are: literal, config_map_full_reference, secret_full_reference, config_map_key_reference, secret_key_reference. The value must match regular expression /^(literal|config_map_full_reference|secret_full_reference|config_map_key_reference|secret_key_reference)$/. When referencing a secret or configmap, the reference must be specified. When referencing a secret or configmap key, a key must also be specified.
value str
The literal value of the environment variable.

  • Constraints: The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /^[\\-._a-zA-Z0-9]+$/.
key String
The key to reference as environment variable.

  • Constraints: The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /^[\\-._a-zA-Z0-9]+$/.
name String
The name of the environment variable.

  • Constraints: The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /^[\\-._a-zA-Z0-9]+$/.
prefix String
A prefix that can be added to all keys of a full secret or config map reference.

  • Constraints: The maximum length is 253 characters. The minimum length is 0 characters. The value must match regular expression /^[a-zA-Z_][a-zA-Z0-9_]*$/.
reference String
The name of the secret or config map.

  • Constraints: The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /^a-z0-9?(\\.a-z0-9?)*$/.
type String
Specify the type of the environment variable.

  • Constraints: The default value is literal. Allowable values are: literal, config_map_full_reference, secret_full_reference, config_map_key_reference, secret_key_reference. The value must match regular expression /^(literal|config_map_full_reference|secret_full_reference|config_map_key_reference|secret_key_reference)$/. When referencing a secret or configmap, the reference must be specified. When referencing a secret or configmap key, a key must also be specified.
value String
The literal value of the environment variable.

  • Constraints: The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /^[\\-._a-zA-Z0-9]+$/.

CodeEngineAppRunVolumeMount
, CodeEngineAppRunVolumeMountArgs

MountPath This property is required. string
The path that should be mounted.

  • Constraints: The maximum length is 256 characters. The minimum length is 1 character. The value must match regular expression /^\/([^\/\\0]+\/?)+$/.
Name This property is required. string
The name of the mount.

  • Constraints: The maximum length is 63 characters. The minimum length is 0 characters. The value must match regular expression /^a-z?$/.
Reference This property is required. string
The name of the referenced secret or config map.

  • Constraints: The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /^a-z0-9?(\\.a-z0-9?)*$/.
Type This property is required. string
Specify the type of the volume mount. Allowed types are: 'config_map', 'secret'.

  • Constraints: The default value is secret. Allowable values are: config_map, secret. The value must match regular expression /^(config_map|secret)$/.
MountPath This property is required. string
The path that should be mounted.

  • Constraints: The maximum length is 256 characters. The minimum length is 1 character. The value must match regular expression /^\/([^\/\\0]+\/?)+$/.
Name This property is required. string
The name of the mount.

  • Constraints: The maximum length is 63 characters. The minimum length is 0 characters. The value must match regular expression /^a-z?$/.
Reference This property is required. string
The name of the referenced secret or config map.

  • Constraints: The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /^a-z0-9?(\\.a-z0-9?)*$/.
Type This property is required. string
Specify the type of the volume mount. Allowed types are: 'config_map', 'secret'.

  • Constraints: The default value is secret. Allowable values are: config_map, secret. The value must match regular expression /^(config_map|secret)$/.
mountPath This property is required. String
The path that should be mounted.

  • Constraints: The maximum length is 256 characters. The minimum length is 1 character. The value must match regular expression /^\/([^\/\\0]+\/?)+$/.
name This property is required. String
The name of the mount.

  • Constraints: The maximum length is 63 characters. The minimum length is 0 characters. The value must match regular expression /^a-z?$/.
reference This property is required. String
The name of the referenced secret or config map.

  • Constraints: The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /^a-z0-9?(\\.a-z0-9?)*$/.
type This property is required. String
Specify the type of the volume mount. Allowed types are: 'config_map', 'secret'.

  • Constraints: The default value is secret. Allowable values are: config_map, secret. The value must match regular expression /^(config_map|secret)$/.
mountPath This property is required. string
The path that should be mounted.

  • Constraints: The maximum length is 256 characters. The minimum length is 1 character. The value must match regular expression /^\/([^\/\\0]+\/?)+$/.
name This property is required. string
The name of the mount.

  • Constraints: The maximum length is 63 characters. The minimum length is 0 characters. The value must match regular expression /^a-z?$/.
reference This property is required. string
The name of the referenced secret or config map.

  • Constraints: The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /^a-z0-9?(\\.a-z0-9?)*$/.
type This property is required. string
Specify the type of the volume mount. Allowed types are: 'config_map', 'secret'.

  • Constraints: The default value is secret. Allowable values are: config_map, secret. The value must match regular expression /^(config_map|secret)$/.
mount_path This property is required. str
The path that should be mounted.

  • Constraints: The maximum length is 256 characters. The minimum length is 1 character. The value must match regular expression /^\/([^\/\\0]+\/?)+$/.
name This property is required. str
The name of the mount.

  • Constraints: The maximum length is 63 characters. The minimum length is 0 characters. The value must match regular expression /^a-z?$/.
reference This property is required. str
The name of the referenced secret or config map.

  • Constraints: The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /^a-z0-9?(\\.a-z0-9?)*$/.
type This property is required. str
Specify the type of the volume mount. Allowed types are: 'config_map', 'secret'.

  • Constraints: The default value is secret. Allowable values are: config_map, secret. The value must match regular expression /^(config_map|secret)$/.
mountPath This property is required. String
The path that should be mounted.

  • Constraints: The maximum length is 256 characters. The minimum length is 1 character. The value must match regular expression /^\/([^\/\\0]+\/?)+$/.
name This property is required. String
The name of the mount.

  • Constraints: The maximum length is 63 characters. The minimum length is 0 characters. The value must match regular expression /^a-z?$/.
reference This property is required. String
The name of the referenced secret or config map.

  • Constraints: The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /^a-z0-9?(\\.a-z0-9?)*$/.
type This property is required. String
Specify the type of the volume mount. Allowed types are: 'config_map', 'secret'.

  • Constraints: The default value is secret. Allowable values are: config_map, secret. The value must match regular expression /^(config_map|secret)$/.

CodeEngineAppStatusDetail
, CodeEngineAppStatusDetailArgs

LatestCreatedRevision This property is required. string
(String) Latest app revision that has been created.
LatestReadyRevision This property is required. string
(String) Latest app revision that reached a ready state.
Reason This property is required. string
(String) Optional information to provide more context in case of a 'failed' or 'warning' status.

  • Constraints: Allowable values are: ready, deploying, waiting_for_resources, no_revision_ready, ready_but_latest_revision_failed.
LatestCreatedRevision This property is required. string
(String) Latest app revision that has been created.
LatestReadyRevision This property is required. string
(String) Latest app revision that reached a ready state.
Reason This property is required. string
(String) Optional information to provide more context in case of a 'failed' or 'warning' status.

  • Constraints: Allowable values are: ready, deploying, waiting_for_resources, no_revision_ready, ready_but_latest_revision_failed.
latestCreatedRevision This property is required. String
(String) Latest app revision that has been created.
latestReadyRevision This property is required. String
(String) Latest app revision that reached a ready state.
reason This property is required. String
(String) Optional information to provide more context in case of a 'failed' or 'warning' status.

  • Constraints: Allowable values are: ready, deploying, waiting_for_resources, no_revision_ready, ready_but_latest_revision_failed.
latestCreatedRevision This property is required. string
(String) Latest app revision that has been created.
latestReadyRevision This property is required. string
(String) Latest app revision that reached a ready state.
reason This property is required. string
(String) Optional information to provide more context in case of a 'failed' or 'warning' status.

  • Constraints: Allowable values are: ready, deploying, waiting_for_resources, no_revision_ready, ready_but_latest_revision_failed.
latest_created_revision This property is required. str
(String) Latest app revision that has been created.
latest_ready_revision This property is required. str
(String) Latest app revision that reached a ready state.
reason This property is required. str
(String) Optional information to provide more context in case of a 'failed' or 'warning' status.

  • Constraints: Allowable values are: ready, deploying, waiting_for_resources, no_revision_ready, ready_but_latest_revision_failed.
latestCreatedRevision This property is required. String
(String) Latest app revision that has been created.
latestReadyRevision This property is required. String
(String) Latest app revision that reached a ready state.
reason This property is required. String
(String) Optional information to provide more context in case of a 'failed' or 'warning' status.

  • Constraints: Allowable values are: ready, deploying, waiting_for_resources, no_revision_ready, ready_but_latest_revision_failed.

CodeEngineAppTimeouts
, CodeEngineAppTimeoutsArgs

Create string
Update string
Create string
Update string
create String
update String
create string
update string
create str
update str
create String
update String

Import

You can import the ibm_code_engine_app resource by using name.

The name property can be formed from project_id, and name in the following format:

<project_id>/<name>

  • project_id: A string in the format 15314cc3-85b4-4338-903f-c28cdee6d005. The ID of the project.

  • name: A string in the format my-app. The name of the app.

Syntax

```sh
$ pulumi import ibm:index/codeEngineApp:CodeEngineApp code_engine_app <project_id>/<name>
```

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

Package Details

Repository
ibm ibm-cloud/terraform-provider-ibm
License
Notes
This Pulumi package is based on the ibm Terraform Provider.