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

ibm.getCodeEngineApp

Explore with Pulumi AI

Provides a read-only data source to retrieve information about a code_engine_app. You can then reference the fields of the data source in other resources within the same configuration by using interpolation syntax.

Example Usage

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

const codeEngineApp = ibm.getCodeEngineApp({
    name: ibm_code_engine_app.code_engine_app_instance.name,
    projectId: ibm_code_engine_app.code_engine_app_instance.project_id,
});
Copy
import pulumi
import pulumi_ibm as ibm

code_engine_app = ibm.get_code_engine_app(name=ibm_code_engine_app["code_engine_app_instance"]["name"],
    project_id=ibm_code_engine_app["code_engine_app_instance"]["project_id"])
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.LookupCodeEngineApp(ctx, &ibm.LookupCodeEngineAppArgs{
			Name:      ibm_code_engine_app.Code_engine_app_instance.Name,
			ProjectId: ibm_code_engine_app.Code_engine_app_instance.Project_id,
		}, nil)
		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 codeEngineApp = Ibm.GetCodeEngineApp.Invoke(new()
    {
        Name = ibm_code_engine_app.Code_engine_app_instance.Name,
        ProjectId = ibm_code_engine_app.Code_engine_app_instance.Project_id,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.IbmFunctions;
import com.pulumi.ibm.inputs.GetCodeEngineAppArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

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

    public static void stack(Context ctx) {
        final var codeEngineApp = IbmFunctions.getCodeEngineApp(GetCodeEngineAppArgs.builder()
            .name(ibm_code_engine_app.code_engine_app_instance().name())
            .projectId(ibm_code_engine_app.code_engine_app_instance().project_id())
            .build());

    }
}
Copy
variables:
  codeEngineApp:
    fn::invoke:
      function: ibm:getCodeEngineApp
      arguments:
        name: ${ibm_code_engine_app.code_engine_app_instance.name}
        projectId: ${ibm_code_engine_app.code_engine_app_instance.project_id}
Copy

Using getCodeEngineApp

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

function getCodeEngineApp(args: GetCodeEngineAppArgs, opts?: InvokeOptions): Promise<GetCodeEngineAppResult>
function getCodeEngineAppOutput(args: GetCodeEngineAppOutputArgs, opts?: InvokeOptions): Output<GetCodeEngineAppResult>
Copy
def get_code_engine_app(id: Optional[str] = None,
                        name: Optional[str] = None,
                        project_id: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetCodeEngineAppResult
def get_code_engine_app_output(id: Optional[pulumi.Input[str]] = None,
                        name: Optional[pulumi.Input[str]] = None,
                        project_id: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetCodeEngineAppResult]
Copy
func LookupCodeEngineApp(ctx *Context, args *LookupCodeEngineAppArgs, opts ...InvokeOption) (*LookupCodeEngineAppResult, error)
func LookupCodeEngineAppOutput(ctx *Context, args *LookupCodeEngineAppOutputArgs, opts ...InvokeOption) LookupCodeEngineAppResultOutput
Copy

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

public static class GetCodeEngineApp 
{
    public static Task<GetCodeEngineAppResult> InvokeAsync(GetCodeEngineAppArgs args, InvokeOptions? opts = null)
    public static Output<GetCodeEngineAppResult> Invoke(GetCodeEngineAppInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetCodeEngineAppResult> getCodeEngineApp(GetCodeEngineAppArgs args, InvokeOptions options)
public static Output<GetCodeEngineAppResult> getCodeEngineApp(GetCodeEngineAppArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: ibm:index/getCodeEngineApp:getCodeEngineApp
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Name This property is required. string
The name of your application.

  • Constraints: The maximum length is 63 characters. The minimum length is 1 character. The value must match regular expression /^a-z?$/.
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}$/.
Id string
The unique identifier of the code_engine_app.
Name This property is required. string
The name of your application.

  • Constraints: The maximum length is 63 characters. The minimum length is 1 character. The value must match regular expression /^a-z?$/.
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}$/.
Id string
The unique identifier of the code_engine_app.
name This property is required. String
The name of your application.

  • Constraints: The maximum length is 63 characters. The minimum length is 1 character. The value must match regular expression /^a-z?$/.
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}$/.
id String
The unique identifier of the code_engine_app.
name This property is required. string
The name of your application.

  • Constraints: The maximum length is 63 characters. The minimum length is 1 character. The value must match regular expression /^a-z?$/.
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}$/.
id string
The unique identifier of the code_engine_app.
name This property is required. str
The name of your application.

  • Constraints: The maximum length is 63 characters. The minimum length is 1 character. The value must match regular expression /^a-z?$/.
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}$/.
id str
The unique identifier of the code_engine_app.
name This property is required. String
The name of your application.

  • Constraints: The maximum length is 63 characters. The minimum length is 1 character. The value must match regular expression /^a-z?$/.
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}$/.
id String
The unique identifier of the code_engine_app.

getCodeEngineApp Result

The following output properties are available:

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<GetCodeEngineAppComputedEnvVariable>
(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]+$/.
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 unique identifier of the code_engine_app.
ImagePort double
(Integer) 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
(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
(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
(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
(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?$/.
ProbeLivenesses List<GetCodeEngineAppProbeLiveness>
(List) Response model for probes. Nested schema for probe_liveness:
ProbeReadinesses List<GetCodeEngineAppProbeReadiness>
(List) Response model for probes. Nested schema for probe_readiness:
ProjectId string
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>
(List) 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
(Integer) Optional user ID (UID) to run the app.

  • Constraints: The default value is 0.
RunCommands List<string>
(List) 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<GetCodeEngineAppRunEnvVariable>
(List) 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
(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<GetCodeEngineAppRunVolumeMount>
(List) 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
(Integer) Optional maximum number of requests that can be processed concurrently per instance.

  • Constraints: The default value is 100.
ScaleConcurrencyTarget double
(Integer) 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
(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
(Integer) 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
(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
(Integer) Optional initial number of instances that are created upon app creation or app update.

  • Constraints: The default value is 1.
ScaleMaxInstances double
(Integer) 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
(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
(Integer) 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
(Integer) 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<GetCodeEngineAppStatusDetail>
(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 []GetCodeEngineAppComputedEnvVariable
(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]+$/.
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 unique identifier of the code_engine_app.
ImagePort float64
(Integer) 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
(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
(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
(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
(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?$/.
ProbeLivenesses []GetCodeEngineAppProbeLiveness
(List) Response model for probes. Nested schema for probe_liveness:
ProbeReadinesses []GetCodeEngineAppProbeReadiness
(List) Response model for probes. Nested schema for probe_readiness:
ProjectId string
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
(List) 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
(Integer) Optional user ID (UID) to run the app.

  • Constraints: The default value is 0.
RunCommands []string
(List) 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 []GetCodeEngineAppRunEnvVariable
(List) 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
(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 []GetCodeEngineAppRunVolumeMount
(List) 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
(Integer) Optional maximum number of requests that can be processed concurrently per instance.

  • Constraints: The default value is 100.
ScaleConcurrencyTarget float64
(Integer) 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
(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
(Integer) 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
(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
(Integer) Optional initial number of instances that are created upon app creation or app update.

  • Constraints: The default value is 1.
ScaleMaxInstances float64
(Integer) 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
(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
(Integer) 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
(Integer) 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 []GetCodeEngineAppStatusDetail
(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<GetCodeEngineAppComputedEnvVariable>
(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]+$/.
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 unique identifier of the code_engine_app.
imagePort Double
(Integer) 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
(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
(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
(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
(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?$/.
probeLivenesses List<GetCodeEngineAppProbeLiveness>
(List) Response model for probes. Nested schema for probe_liveness:
probeReadinesses List<GetCodeEngineAppProbeReadiness>
(List) Response model for probes. Nested schema for probe_readiness:
projectId String
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>
(List) 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
(Integer) Optional user ID (UID) to run the app.

  • Constraints: The default value is 0.
runCommands List<String>
(List) 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<GetCodeEngineAppRunEnvVariable>
(List) 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
(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<GetCodeEngineAppRunVolumeMount>
(List) 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
(Integer) Optional maximum number of requests that can be processed concurrently per instance.

  • Constraints: The default value is 100.
scaleConcurrencyTarget Double
(Integer) 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
(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
(Integer) 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
(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
(Integer) Optional initial number of instances that are created upon app creation or app update.

  • Constraints: The default value is 1.
scaleMaxInstances Double
(Integer) 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
(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
(Integer) 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
(Integer) 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<GetCodeEngineAppStatusDetail>
(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 GetCodeEngineAppComputedEnvVariable[]
(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]+$/.
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 unique identifier of the code_engine_app.
imagePort number
(Integer) 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
(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
(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
(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
(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?$/.
probeLivenesses GetCodeEngineAppProbeLiveness[]
(List) Response model for probes. Nested schema for probe_liveness:
probeReadinesses GetCodeEngineAppProbeReadiness[]
(List) Response model for probes. Nested schema for probe_readiness:
projectId string
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[]
(List) 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
(Integer) Optional user ID (UID) to run the app.

  • Constraints: The default value is 0.
runCommands string[]
(List) 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 GetCodeEngineAppRunEnvVariable[]
(List) 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
(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 GetCodeEngineAppRunVolumeMount[]
(List) 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
(Integer) Optional maximum number of requests that can be processed concurrently per instance.

  • Constraints: The default value is 100.
scaleConcurrencyTarget number
(Integer) 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
(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
(Integer) 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
(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
(Integer) Optional initial number of instances that are created upon app creation or app update.

  • Constraints: The default value is 1.
scaleMaxInstances number
(Integer) 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
(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
(Integer) 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
(Integer) 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 GetCodeEngineAppStatusDetail[]
(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[GetCodeEngineAppComputedEnvVariable]
(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]+$/.
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 unique identifier of the code_engine_app.
image_port float
(Integer) 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
(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})?$/.
image_secret str
(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?)*$/.
managed_domain_mappings str
(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 str
(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?$/.
probe_livenesses Sequence[GetCodeEngineAppProbeLiveness]
(List) Response model for probes. Nested schema for probe_liveness:
probe_readinesses Sequence[GetCodeEngineAppProbeReadiness]
(List) Response model for probes. Nested schema for probe_readiness:
project_id str
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]
(List) 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
(Integer) Optional user ID (UID) to run the app.

  • Constraints: The default value is 0.
run_commands Sequence[str]
(List) 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[GetCodeEngineAppRunEnvVariable]
(List) 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
(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)$/.
run_volume_mounts Sequence[GetCodeEngineAppRunVolumeMount]
(List) 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
(Integer) Optional maximum number of requests that can be processed concurrently per instance.

  • Constraints: The default value is 100.
scale_concurrency_target float
(Integer) 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
(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]*)$/.
scale_down_delay float
(Integer) 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
(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]*)$/.
scale_initial_instances float
(Integer) Optional initial number of instances that are created upon app creation or app update.

  • Constraints: The default value is 1.
scale_max_instances float
(Integer) 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
(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]*)$/.
scale_min_instances float
(Integer) 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
(Integer) 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[GetCodeEngineAppStatusDetail]
(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]+$/.
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 unique identifier of the code_engine_app.
imagePort Number
(Integer) 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
(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
(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
(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
(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?$/.
probeLivenesses List<Property Map>
(List) Response model for probes. Nested schema for probe_liveness:
probeReadinesses List<Property Map>
(List) Response model for probes. Nested schema for probe_readiness:
projectId String
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>
(List) 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
(Integer) Optional user ID (UID) to run the app.

  • Constraints: The default value is 0.
runCommands List<String>
(List) 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>
(List) 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
(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>
(List) 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
(Integer) Optional maximum number of requests that can be processed concurrently per instance.

  • Constraints: The default value is 100.
scaleConcurrencyTarget Number
(Integer) 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
(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
(Integer) 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
(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
(Integer) Optional initial number of instances that are created upon app creation or app update.

  • Constraints: The default value is 1.
scaleMaxInstances Number
(Integer) 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
(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
(Integer) 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
(Integer) 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:

Supporting Types

GetCodeEngineAppComputedEnvVariable

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 your application.

  • 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 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
(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)$/.
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 your application.

  • 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 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
(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)$/.
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 your application.

  • 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 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
(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)$/.
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 your application.

  • 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 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
(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)$/.
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 your application.

  • 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 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
(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)$/.
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 your application.

  • 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 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
(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)$/.
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]+$/.

GetCodeEngineAppProbeLiveness

FailureThreshold This property is required. double
(Integer) 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 This property is required. double
(Integer) 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 This property is required. double
(Integer) 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 This property is required. string
(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 This property is required. double
(Integer) The port on which to probe the resource.

  • Constraints: The maximum value is 65535. The minimum value is 1.
Timeout This property is required. double
(Integer) 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 This property is required. string
(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)$/.
FailureThreshold This property is required. float64
(Integer) 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 This property is required. float64
(Integer) 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 This property is required. float64
(Integer) 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 This property is required. string
(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 This property is required. float64
(Integer) The port on which to probe the resource.

  • Constraints: The maximum value is 65535. The minimum value is 1.
Timeout This property is required. float64
(Integer) 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 This property is required. string
(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)$/.
failureThreshold This property is required. Double
(Integer) 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 This property is required. Double
(Integer) 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 This property is required. Double
(Integer) 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 This property is required. String
(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 This property is required. Double
(Integer) The port on which to probe the resource.

  • Constraints: The maximum value is 65535. The minimum value is 1.
timeout This property is required. Double
(Integer) 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 This property is required. String
(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)$/.
failureThreshold This property is required. number
(Integer) 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 This property is required. number
(Integer) 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 This property is required. number
(Integer) 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 This property is required. string
(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 This property is required. number
(Integer) The port on which to probe the resource.

  • Constraints: The maximum value is 65535. The minimum value is 1.
timeout This property is required. number
(Integer) 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 This property is required. string
(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)$/.
failure_threshold This property is required. float
(Integer) 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 This property is required. float
(Integer) 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 This property is required. float
(Integer) 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 This property is required. str
(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 This property is required. float
(Integer) The port on which to probe the resource.

  • Constraints: The maximum value is 65535. The minimum value is 1.
timeout This property is required. float
(Integer) 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 This property is required. str
(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)$/.
failureThreshold This property is required. Number
(Integer) 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 This property is required. Number
(Integer) 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 This property is required. Number
(Integer) 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 This property is required. String
(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 This property is required. Number
(Integer) The port on which to probe the resource.

  • Constraints: The maximum value is 65535. The minimum value is 1.
timeout This property is required. Number
(Integer) 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 This property is required. String
(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)$/.

GetCodeEngineAppProbeReadiness

FailureThreshold This property is required. double
(Integer) 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 This property is required. double
(Integer) 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 This property is required. double
(Integer) 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 This property is required. string
(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 This property is required. double
(Integer) The port on which to probe the resource.

  • Constraints: The maximum value is 65535. The minimum value is 1.
Timeout This property is required. double
(Integer) 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 This property is required. string
(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)$/.
FailureThreshold This property is required. float64
(Integer) 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 This property is required. float64
(Integer) 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 This property is required. float64
(Integer) 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 This property is required. string
(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 This property is required. float64
(Integer) The port on which to probe the resource.

  • Constraints: The maximum value is 65535. The minimum value is 1.
Timeout This property is required. float64
(Integer) 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 This property is required. string
(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)$/.
failureThreshold This property is required. Double
(Integer) 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 This property is required. Double
(Integer) 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 This property is required. Double
(Integer) 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 This property is required. String
(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 This property is required. Double
(Integer) The port on which to probe the resource.

  • Constraints: The maximum value is 65535. The minimum value is 1.
timeout This property is required. Double
(Integer) 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 This property is required. String
(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)$/.
failureThreshold This property is required. number
(Integer) 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 This property is required. number
(Integer) 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 This property is required. number
(Integer) 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 This property is required. string
(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 This property is required. number
(Integer) The port on which to probe the resource.

  • Constraints: The maximum value is 65535. The minimum value is 1.
timeout This property is required. number
(Integer) 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 This property is required. string
(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)$/.
failure_threshold This property is required. float
(Integer) 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 This property is required. float
(Integer) 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 This property is required. float
(Integer) 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 This property is required. str
(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 This property is required. float
(Integer) The port on which to probe the resource.

  • Constraints: The maximum value is 65535. The minimum value is 1.
timeout This property is required. float
(Integer) 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 This property is required. str
(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)$/.
failureThreshold This property is required. Number
(Integer) 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 This property is required. Number
(Integer) 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 This property is required. Number
(Integer) 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 This property is required. String
(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 This property is required. Number
(Integer) The port on which to probe the resource.

  • Constraints: The maximum value is 65535. The minimum value is 1.
timeout This property is required. Number
(Integer) 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 This property is required. String
(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)$/.

GetCodeEngineAppRunEnvVariable

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 your application.

  • 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 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
(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)$/.
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 your application.

  • 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 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
(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)$/.
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 your application.

  • 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 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
(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)$/.
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 your application.

  • 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 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
(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)$/.
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 your application.

  • 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 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
(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)$/.
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 your application.

  • 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 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
(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)$/.
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]+$/.

GetCodeEngineAppRunVolumeMount

MountPath This property is required. string
(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 your application.

  • Constraints: The maximum length is 63 characters. The minimum length is 1 character. The value must match regular expression /^a-z?$/.
Reference This property is required. string
(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
(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
(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 your application.

  • Constraints: The maximum length is 63 characters. The minimum length is 1 character. The value must match regular expression /^a-z?$/.
Reference This property is required. string
(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
(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
(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 your application.

  • Constraints: The maximum length is 63 characters. The minimum length is 1 character. The value must match regular expression /^a-z?$/.
reference This property is required. String
(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
(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
(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 your application.

  • Constraints: The maximum length is 63 characters. The minimum length is 1 character. The value must match regular expression /^a-z?$/.
reference This property is required. string
(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
(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
(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. str
The name of your application.

  • Constraints: The maximum length is 63 characters. The minimum length is 1 character. The value must match regular expression /^a-z?$/.
reference This property is required. str
(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. str
(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
(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 your application.

  • Constraints: The maximum length is 63 characters. The minimum length is 1 character. The value must match regular expression /^a-z?$/.
reference This property is required. String
(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
(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)$/.

GetCodeEngineAppStatusDetail

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.

Package Details

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