ibm.CodeEngineApp
Explore with Pulumi AI
Create, update, and delete code_engine_apps with this resource.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as ibm from "@pulumi/ibm";
const codeEngineAppInstance = new ibm.CodeEngineApp("codeEngineAppInstance", {
projectId: ibm_code_engine_project.code_engine_project_instance.project_id,
imageReference: "icr.io/codeengine/helloworld",
runEnvVariables: [
{
type: "literal",
name: "name",
value: "value",
},
{
type: "secret_full_reference",
name: "secret_env_var",
reference: "secret_name",
},
],
});
import pulumi
import pulumi_ibm as ibm
code_engine_app_instance = ibm.CodeEngineApp("codeEngineAppInstance",
project_id=ibm_code_engine_project["code_engine_project_instance"]["project_id"],
image_reference="icr.io/codeengine/helloworld",
run_env_variables=[
{
"type": "literal",
"name": "name",
"value": "value",
},
{
"type": "secret_full_reference",
"name": "secret_env_var",
"reference": "secret_name",
},
])
package main
import (
"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/ibm"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := ibm.NewCodeEngineApp(ctx, "codeEngineAppInstance", &ibm.CodeEngineAppArgs{
ProjectId: pulumi.Any(ibm_code_engine_project.Code_engine_project_instance.Project_id),
ImageReference: pulumi.String("icr.io/codeengine/helloworld"),
RunEnvVariables: ibm.CodeEngineAppRunEnvVariableArray{
&ibm.CodeEngineAppRunEnvVariableArgs{
Type: pulumi.String("literal"),
Name: pulumi.String("name"),
Value: pulumi.String("value"),
},
&ibm.CodeEngineAppRunEnvVariableArgs{
Type: pulumi.String("secret_full_reference"),
Name: pulumi.String("secret_env_var"),
Reference: pulumi.String("secret_name"),
},
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;
return await Deployment.RunAsync(() =>
{
var codeEngineAppInstance = new Ibm.CodeEngineApp("codeEngineAppInstance", new()
{
ProjectId = ibm_code_engine_project.Code_engine_project_instance.Project_id,
ImageReference = "icr.io/codeengine/helloworld",
RunEnvVariables = new[]
{
new Ibm.Inputs.CodeEngineAppRunEnvVariableArgs
{
Type = "literal",
Name = "name",
Value = "value",
},
new Ibm.Inputs.CodeEngineAppRunEnvVariableArgs
{
Type = "secret_full_reference",
Name = "secret_env_var",
Reference = "secret_name",
},
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.CodeEngineApp;
import com.pulumi.ibm.CodeEngineAppArgs;
import com.pulumi.ibm.inputs.CodeEngineAppRunEnvVariableArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var codeEngineAppInstance = new CodeEngineApp("codeEngineAppInstance", CodeEngineAppArgs.builder()
.projectId(ibm_code_engine_project.code_engine_project_instance().project_id())
.imageReference("icr.io/codeengine/helloworld")
.runEnvVariables(
CodeEngineAppRunEnvVariableArgs.builder()
.type("literal")
.name("name")
.value("value")
.build(),
CodeEngineAppRunEnvVariableArgs.builder()
.type("secret_full_reference")
.name("secret_env_var")
.reference("secret_name")
.build())
.build());
}
}
resources:
codeEngineAppInstance:
type: ibm:CodeEngineApp
properties:
projectId: ${ibm_code_engine_project.code_engine_project_instance.project_id}
imageReference: icr.io/codeengine/helloworld
runEnvVariables:
- type: literal
name: name
value: value
- type: secret_full_reference
name: secret_env_var
reference: secret_name
Create CodeEngineApp Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new CodeEngineApp(name: string, args: CodeEngineAppArgs, opts?: CustomResourceOptions);
@overload
def CodeEngineApp(resource_name: str,
args: CodeEngineAppArgs,
opts: Optional[ResourceOptions] = None)
@overload
def CodeEngineApp(resource_name: str,
opts: Optional[ResourceOptions] = None,
image_reference: Optional[str] = None,
project_id: Optional[str] = None,
run_env_variables: Optional[Sequence[CodeEngineAppRunEnvVariableArgs]] = None,
image_port: Optional[float] = None,
managed_domain_mappings: Optional[str] = None,
name: Optional[str] = None,
probe_liveness: Optional[CodeEngineAppProbeLivenessArgs] = None,
probe_readiness: Optional[CodeEngineAppProbeReadinessArgs] = None,
run_service_account: Optional[str] = None,
run_arguments: Optional[Sequence[str]] = None,
run_as_user: Optional[float] = None,
run_commands: Optional[Sequence[str]] = None,
image_secret: Optional[str] = None,
code_engine_app_id: Optional[str] = None,
scale_down_delay: Optional[float] = None,
scale_concurrency: Optional[float] = None,
scale_concurrency_target: Optional[float] = None,
scale_cpu_limit: Optional[str] = None,
run_volume_mounts: Optional[Sequence[CodeEngineAppRunVolumeMountArgs]] = None,
scale_ephemeral_storage_limit: Optional[str] = None,
scale_initial_instances: Optional[float] = None,
scale_max_instances: Optional[float] = None,
scale_memory_limit: Optional[str] = None,
scale_min_instances: Optional[float] = None,
scale_request_timeout: Optional[float] = None,
timeouts: Optional[CodeEngineAppTimeoutsArgs] = None)
func NewCodeEngineApp(ctx *Context, name string, args CodeEngineAppArgs, opts ...ResourceOption) (*CodeEngineApp, error)
public CodeEngineApp(string name, CodeEngineAppArgs args, CustomResourceOptions? opts = null)
public CodeEngineApp(String name, CodeEngineAppArgs args)
public CodeEngineApp(String name, CodeEngineAppArgs args, CustomResourceOptions options)
type: ibm:CodeEngineApp
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args CodeEngineAppArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args CodeEngineAppArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args CodeEngineAppArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args CodeEngineAppArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args CodeEngineAppArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var codeEngineAppResource = new Ibm.CodeEngineApp("codeEngineAppResource", new()
{
ImageReference = "string",
ProjectId = "string",
RunEnvVariables = new[]
{
new Ibm.Inputs.CodeEngineAppRunEnvVariableArgs
{
Key = "string",
Name = "string",
Prefix = "string",
Reference = "string",
Type = "string",
Value = "string",
},
},
ImagePort = 0,
ManagedDomainMappings = "string",
Name = "string",
ProbeLiveness = new Ibm.Inputs.CodeEngineAppProbeLivenessArgs
{
FailureThreshold = 0,
InitialDelay = 0,
Interval = 0,
Path = "string",
Port = 0,
Timeout = 0,
Type = "string",
},
ProbeReadiness = new Ibm.Inputs.CodeEngineAppProbeReadinessArgs
{
FailureThreshold = 0,
InitialDelay = 0,
Interval = 0,
Path = "string",
Port = 0,
Timeout = 0,
Type = "string",
},
RunServiceAccount = "string",
RunArguments = new[]
{
"string",
},
RunAsUser = 0,
RunCommands = new[]
{
"string",
},
ImageSecret = "string",
CodeEngineAppId = "string",
ScaleDownDelay = 0,
ScaleConcurrency = 0,
ScaleConcurrencyTarget = 0,
ScaleCpuLimit = "string",
RunVolumeMounts = new[]
{
new Ibm.Inputs.CodeEngineAppRunVolumeMountArgs
{
MountPath = "string",
Name = "string",
Reference = "string",
Type = "string",
},
},
ScaleEphemeralStorageLimit = "string",
ScaleInitialInstances = 0,
ScaleMaxInstances = 0,
ScaleMemoryLimit = "string",
ScaleMinInstances = 0,
ScaleRequestTimeout = 0,
Timeouts = new Ibm.Inputs.CodeEngineAppTimeoutsArgs
{
Create = "string",
Update = "string",
},
});
example, err := ibm.NewCodeEngineApp(ctx, "codeEngineAppResource", &ibm.CodeEngineAppArgs{
ImageReference: pulumi.String("string"),
ProjectId: pulumi.String("string"),
RunEnvVariables: ibm.CodeEngineAppRunEnvVariableArray{
&ibm.CodeEngineAppRunEnvVariableArgs{
Key: pulumi.String("string"),
Name: pulumi.String("string"),
Prefix: pulumi.String("string"),
Reference: pulumi.String("string"),
Type: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
ImagePort: pulumi.Float64(0),
ManagedDomainMappings: pulumi.String("string"),
Name: pulumi.String("string"),
ProbeLiveness: &ibm.CodeEngineAppProbeLivenessArgs{
FailureThreshold: pulumi.Float64(0),
InitialDelay: pulumi.Float64(0),
Interval: pulumi.Float64(0),
Path: pulumi.String("string"),
Port: pulumi.Float64(0),
Timeout: pulumi.Float64(0),
Type: pulumi.String("string"),
},
ProbeReadiness: &ibm.CodeEngineAppProbeReadinessArgs{
FailureThreshold: pulumi.Float64(0),
InitialDelay: pulumi.Float64(0),
Interval: pulumi.Float64(0),
Path: pulumi.String("string"),
Port: pulumi.Float64(0),
Timeout: pulumi.Float64(0),
Type: pulumi.String("string"),
},
RunServiceAccount: pulumi.String("string"),
RunArguments: pulumi.StringArray{
pulumi.String("string"),
},
RunAsUser: pulumi.Float64(0),
RunCommands: pulumi.StringArray{
pulumi.String("string"),
},
ImageSecret: pulumi.String("string"),
CodeEngineAppId: pulumi.String("string"),
ScaleDownDelay: pulumi.Float64(0),
ScaleConcurrency: pulumi.Float64(0),
ScaleConcurrencyTarget: pulumi.Float64(0),
ScaleCpuLimit: pulumi.String("string"),
RunVolumeMounts: ibm.CodeEngineAppRunVolumeMountArray{
&ibm.CodeEngineAppRunVolumeMountArgs{
MountPath: pulumi.String("string"),
Name: pulumi.String("string"),
Reference: pulumi.String("string"),
Type: pulumi.String("string"),
},
},
ScaleEphemeralStorageLimit: pulumi.String("string"),
ScaleInitialInstances: pulumi.Float64(0),
ScaleMaxInstances: pulumi.Float64(0),
ScaleMemoryLimit: pulumi.String("string"),
ScaleMinInstances: pulumi.Float64(0),
ScaleRequestTimeout: pulumi.Float64(0),
Timeouts: &ibm.CodeEngineAppTimeoutsArgs{
Create: pulumi.String("string"),
Update: pulumi.String("string"),
},
})
var codeEngineAppResource = new CodeEngineApp("codeEngineAppResource", CodeEngineAppArgs.builder()
.imageReference("string")
.projectId("string")
.runEnvVariables(CodeEngineAppRunEnvVariableArgs.builder()
.key("string")
.name("string")
.prefix("string")
.reference("string")
.type("string")
.value("string")
.build())
.imagePort(0)
.managedDomainMappings("string")
.name("string")
.probeLiveness(CodeEngineAppProbeLivenessArgs.builder()
.failureThreshold(0)
.initialDelay(0)
.interval(0)
.path("string")
.port(0)
.timeout(0)
.type("string")
.build())
.probeReadiness(CodeEngineAppProbeReadinessArgs.builder()
.failureThreshold(0)
.initialDelay(0)
.interval(0)
.path("string")
.port(0)
.timeout(0)
.type("string")
.build())
.runServiceAccount("string")
.runArguments("string")
.runAsUser(0)
.runCommands("string")
.imageSecret("string")
.codeEngineAppId("string")
.scaleDownDelay(0)
.scaleConcurrency(0)
.scaleConcurrencyTarget(0)
.scaleCpuLimit("string")
.runVolumeMounts(CodeEngineAppRunVolumeMountArgs.builder()
.mountPath("string")
.name("string")
.reference("string")
.type("string")
.build())
.scaleEphemeralStorageLimit("string")
.scaleInitialInstances(0)
.scaleMaxInstances(0)
.scaleMemoryLimit("string")
.scaleMinInstances(0)
.scaleRequestTimeout(0)
.timeouts(CodeEngineAppTimeoutsArgs.builder()
.create("string")
.update("string")
.build())
.build());
code_engine_app_resource = ibm.CodeEngineApp("codeEngineAppResource",
image_reference="string",
project_id="string",
run_env_variables=[{
"key": "string",
"name": "string",
"prefix": "string",
"reference": "string",
"type": "string",
"value": "string",
}],
image_port=0,
managed_domain_mappings="string",
name="string",
probe_liveness={
"failure_threshold": 0,
"initial_delay": 0,
"interval": 0,
"path": "string",
"port": 0,
"timeout": 0,
"type": "string",
},
probe_readiness={
"failure_threshold": 0,
"initial_delay": 0,
"interval": 0,
"path": "string",
"port": 0,
"timeout": 0,
"type": "string",
},
run_service_account="string",
run_arguments=["string"],
run_as_user=0,
run_commands=["string"],
image_secret="string",
code_engine_app_id="string",
scale_down_delay=0,
scale_concurrency=0,
scale_concurrency_target=0,
scale_cpu_limit="string",
run_volume_mounts=[{
"mount_path": "string",
"name": "string",
"reference": "string",
"type": "string",
}],
scale_ephemeral_storage_limit="string",
scale_initial_instances=0,
scale_max_instances=0,
scale_memory_limit="string",
scale_min_instances=0,
scale_request_timeout=0,
timeouts={
"create": "string",
"update": "string",
})
const codeEngineAppResource = new ibm.CodeEngineApp("codeEngineAppResource", {
imageReference: "string",
projectId: "string",
runEnvVariables: [{
key: "string",
name: "string",
prefix: "string",
reference: "string",
type: "string",
value: "string",
}],
imagePort: 0,
managedDomainMappings: "string",
name: "string",
probeLiveness: {
failureThreshold: 0,
initialDelay: 0,
interval: 0,
path: "string",
port: 0,
timeout: 0,
type: "string",
},
probeReadiness: {
failureThreshold: 0,
initialDelay: 0,
interval: 0,
path: "string",
port: 0,
timeout: 0,
type: "string",
},
runServiceAccount: "string",
runArguments: ["string"],
runAsUser: 0,
runCommands: ["string"],
imageSecret: "string",
codeEngineAppId: "string",
scaleDownDelay: 0,
scaleConcurrency: 0,
scaleConcurrencyTarget: 0,
scaleCpuLimit: "string",
runVolumeMounts: [{
mountPath: "string",
name: "string",
reference: "string",
type: "string",
}],
scaleEphemeralStorageLimit: "string",
scaleInitialInstances: 0,
scaleMaxInstances: 0,
scaleMemoryLimit: "string",
scaleMinInstances: 0,
scaleRequestTimeout: 0,
timeouts: {
create: "string",
update: "string",
},
});
type: ibm:CodeEngineApp
properties:
codeEngineAppId: string
imagePort: 0
imageReference: string
imageSecret: string
managedDomainMappings: string
name: string
probeLiveness:
failureThreshold: 0
initialDelay: 0
interval: 0
path: string
port: 0
timeout: 0
type: string
probeReadiness:
failureThreshold: 0
initialDelay: 0
interval: 0
path: string
port: 0
timeout: 0
type: string
projectId: string
runArguments:
- string
runAsUser: 0
runCommands:
- string
runEnvVariables:
- key: string
name: string
prefix: string
reference: string
type: string
value: string
runServiceAccount: string
runVolumeMounts:
- mountPath: string
name: string
reference: string
type: string
scaleConcurrency: 0
scaleConcurrencyTarget: 0
scaleCpuLimit: string
scaleDownDelay: 0
scaleEphemeralStorageLimit: string
scaleInitialInstances: 0
scaleMaxInstances: 0
scaleMemoryLimit: string
scaleMinInstances: 0
scaleRequestTimeout: 0
timeouts:
create: string
update: string
CodeEngineApp Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The CodeEngineApp resource accepts the following input properties:
- Image
Reference string - The name of the image that is used for this app. The format is
REGISTRY/NAMESPACE/REPOSITORY:TAG
whereREGISTRY
andTAG
are optional. IfREGISTRY
is not specified, the default isdocker.io
. IfTAG
is not specified, the default islatest
. If the image reference points to a registry that requires authentication, make sure to also specify the propertyimage_secret
.- Constraints: The maximum length is
256
characters. The minimum length is1
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})?$/
.
- Constraints: The maximum length is
- Project
Id string - The ID of the project.
- Constraints: The maximum length is
36
characters. The minimum length is36
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}$/
.
- Constraints: The maximum length is
- Code
Engine stringApp Id - The unique identifier of the code_engine_app.
- Image
Port double - Optional port the app listens on. While the app will always be exposed via port
443
for end users, this port is used to connect to the port that is exposed by the container image.- Constraints: The default value is
8080
.
- Constraints: The default value is
- Image
Secret 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 is1
character. The value must match regular expression/^a-z0-9?(\\.a-z0-9?)*$/
.
- Constraints: The maximum length is
- Managed
Domain stringMappings - 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
.
- Constraints: The default value is
- Name string
- The name of the app.
- Constraints: The maximum length is
63
characters. The minimum length is1
character. The value must match regular expression/^a-z?$/
.
- Constraints: The maximum length is
- Probe
Liveness CodeEngine App Probe Liveness - Response model for probes. Nested schema for probe_liveness:
- Probe
Readiness CodeEngine App Probe Readiness - Response model for probes. Nested schema for probe_readiness:
- Run
Arguments List<string> - Optional arguments for the app that are passed to start the container. If not specified an empty string array will be applied and the arguments specified by the container image, will be used to start the container.
- Constraints: The list items must match regular expression
/^.*$/
. The maximum length is100
items. The minimum length is0
items.
- Constraints: The list items must match regular expression
- Run
As doubleUser - Optional user ID (UID) to run the app.
- Constraints: The default value is
0
.
- Constraints: The default value is
- Run
Commands List<string> - Optional commands for the app that are passed to start the container. If not specified an empty string array will be applied and the command specified by the container image, will be used to start the container.
- Constraints: The list items must match regular expression
/^.*$/
. The maximum length is100
items. The minimum length is0
items.
- Constraints: The list items must match regular expression
- Run
Env List<CodeVariables Engine App Run Env Variable> - 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 is0
items. Nested schema for run_env_variables:
- Constraints: The maximum length is
- Run
Service stringAccount - Optional name of the service account. For built-in service accounts, you can use the shortened names
manager
,none
,reader
, andwriter
.- Constraints: The default value is
default
. Allowable values are:default
,manager
,reader
,writer
,none
. The minimum length is0
characters. The value must match regular expression/^(manager|reader|writer|none|default)$/
.
- Constraints: The default value is
- Run
Volume List<CodeMounts Engine App Run Volume Mount> - Mounts of config maps or secrets.
- Constraints: The maximum length is
100
items. The minimum length is0
items. Nested schema for run_volume_mounts:
- Constraints: The maximum length is
- Scale
Concurrency double - Optional maximum number of requests that can be processed concurrently per instance.
- Constraints: The default value is
100
.
- Constraints: The default value is
- Scale
Concurrency doubleTarget - 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 is1000
. The minimum value is1
.
- Constraints: The default value is
- Scale
Cpu stringLimit - 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 is10
characters. The minimum length is0
characters. The value must match regular expression/^([0-9.]+)([eEinumkKMGTPB]*)$/
.
- Constraints: The default value is
- Scale
Down doubleDelay - 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 is3600
. The minimum value is0
.
- Constraints: The default value is
- Scale
Ephemeral stringStorage Limit - 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 is10
characters. The minimum length is0
characters. The value must match regular expression/^([0-9.]+)([eEinumkKMGTPB]*)$/
.
- Constraints: The default value is
- Scale
Initial doubleInstances - Optional initial number of instances that are created upon app creation or app update.
- Constraints: The default value is
1
.
- Constraints: The default value is
- Scale
Max doubleInstances - 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
.
- Constraints: The default value is
- Scale
Memory stringLimit - 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 is10
characters. The minimum length is0
characters. The value must match regular expression/^([0-9.]+)([eEinumkKMGTPB]*)$/
.
- Constraints: The default value is
- Scale
Min doubleInstances - 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
.
- Constraints: The default value is
- Scale
Request doubleTimeout - Optional amount of time in seconds that is allowed for a running app to respond to a request.
- Constraints: The default value is
300
.
- Constraints: The default value is
- Timeouts
Code
Engine App Timeouts
- Image
Reference string - The name of the image that is used for this app. The format is
REGISTRY/NAMESPACE/REPOSITORY:TAG
whereREGISTRY
andTAG
are optional. IfREGISTRY
is not specified, the default isdocker.io
. IfTAG
is not specified, the default islatest
. If the image reference points to a registry that requires authentication, make sure to also specify the propertyimage_secret
.- Constraints: The maximum length is
256
characters. The minimum length is1
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})?$/
.
- Constraints: The maximum length is
- Project
Id string - The ID of the project.
- Constraints: The maximum length is
36
characters. The minimum length is36
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}$/
.
- Constraints: The maximum length is
- Code
Engine stringApp Id - The unique identifier of the code_engine_app.
- Image
Port float64 - Optional port the app listens on. While the app will always be exposed via port
443
for end users, this port is used to connect to the port that is exposed by the container image.- Constraints: The default value is
8080
.
- Constraints: The default value is
- Image
Secret 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 is1
character. The value must match regular expression/^a-z0-9?(\\.a-z0-9?)*$/
.
- Constraints: The maximum length is
- Managed
Domain stringMappings - 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
.
- Constraints: The default value is
- Name string
- The name of the app.
- Constraints: The maximum length is
63
characters. The minimum length is1
character. The value must match regular expression/^a-z?$/
.
- Constraints: The maximum length is
- Probe
Liveness CodeEngine App Probe Liveness Args - Response model for probes. Nested schema for probe_liveness:
- Probe
Readiness CodeEngine App Probe Readiness Args - Response model for probes. Nested schema for probe_readiness:
- Run
Arguments []string - Optional arguments for the app that are passed to start the container. If not specified an empty string array will be applied and the arguments specified by the container image, will be used to start the container.
- Constraints: The list items must match regular expression
/^.*$/
. The maximum length is100
items. The minimum length is0
items.
- Constraints: The list items must match regular expression
- Run
As float64User - Optional user ID (UID) to run the app.
- Constraints: The default value is
0
.
- Constraints: The default value is
- Run
Commands []string - Optional commands for the app that are passed to start the container. If not specified an empty string array will be applied and the command specified by the container image, will be used to start the container.
- Constraints: The list items must match regular expression
/^.*$/
. The maximum length is100
items. The minimum length is0
items.
- Constraints: The list items must match regular expression
- Run
Env []CodeVariables Engine App Run Env Variable Args - 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 is0
items. Nested schema for run_env_variables:
- Constraints: The maximum length is
- Run
Service stringAccount - Optional name of the service account. For built-in service accounts, you can use the shortened names
manager
,none
,reader
, andwriter
.- Constraints: The default value is
default
. Allowable values are:default
,manager
,reader
,writer
,none
. The minimum length is0
characters. The value must match regular expression/^(manager|reader|writer|none|default)$/
.
- Constraints: The default value is
- Run
Volume []CodeMounts Engine App Run Volume Mount Args - Mounts of config maps or secrets.
- Constraints: The maximum length is
100
items. The minimum length is0
items. Nested schema for run_volume_mounts:
- Constraints: The maximum length is
- Scale
Concurrency float64 - Optional maximum number of requests that can be processed concurrently per instance.
- Constraints: The default value is
100
.
- Constraints: The default value is
- Scale
Concurrency float64Target - 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 is1000
. The minimum value is1
.
- Constraints: The default value is
- Scale
Cpu stringLimit - 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 is10
characters. The minimum length is0
characters. The value must match regular expression/^([0-9.]+)([eEinumkKMGTPB]*)$/
.
- Constraints: The default value is
- Scale
Down float64Delay - 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 is3600
. The minimum value is0
.
- Constraints: The default value is
- Scale
Ephemeral stringStorage Limit - 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 is10
characters. The minimum length is0
characters. The value must match regular expression/^([0-9.]+)([eEinumkKMGTPB]*)$/
.
- Constraints: The default value is
- Scale
Initial float64Instances - Optional initial number of instances that are created upon app creation or app update.
- Constraints: The default value is
1
.
- Constraints: The default value is
- Scale
Max float64Instances - 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
.
- Constraints: The default value is
- Scale
Memory stringLimit - 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 is10
characters. The minimum length is0
characters. The value must match regular expression/^([0-9.]+)([eEinumkKMGTPB]*)$/
.
- Constraints: The default value is
- Scale
Min float64Instances - 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
.
- Constraints: The default value is
- Scale
Request float64Timeout - Optional amount of time in seconds that is allowed for a running app to respond to a request.
- Constraints: The default value is
300
.
- Constraints: The default value is
- Timeouts
Code
Engine App Timeouts Args
- image
Reference String - The name of the image that is used for this app. The format is
REGISTRY/NAMESPACE/REPOSITORY:TAG
whereREGISTRY
andTAG
are optional. IfREGISTRY
is not specified, the default isdocker.io
. IfTAG
is not specified, the default islatest
. If the image reference points to a registry that requires authentication, make sure to also specify the propertyimage_secret
.- Constraints: The maximum length is
256
characters. The minimum length is1
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})?$/
.
- Constraints: The maximum length is
- project
Id String - The ID of the project.
- Constraints: The maximum length is
36
characters. The minimum length is36
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}$/
.
- Constraints: The maximum length is
- code
Engine StringApp Id - The unique identifier of the code_engine_app.
- image
Port Double - Optional port the app listens on. While the app will always be exposed via port
443
for end users, this port is used to connect to the port that is exposed by the container image.- Constraints: The default value is
8080
.
- Constraints: The default value is
- image
Secret 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 is1
character. The value must match regular expression/^a-z0-9?(\\.a-z0-9?)*$/
.
- Constraints: The maximum length is
- managed
Domain StringMappings - 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
.
- Constraints: The default value is
- name String
- The name of the app.
- Constraints: The maximum length is
63
characters. The minimum length is1
character. The value must match regular expression/^a-z?$/
.
- Constraints: The maximum length is
- probe
Liveness CodeEngine App Probe Liveness - Response model for probes. Nested schema for probe_liveness:
- probe
Readiness CodeEngine App Probe Readiness - Response model for probes. Nested schema for probe_readiness:
- run
Arguments List<String> - Optional arguments for the app that are passed to start the container. If not specified an empty string array will be applied and the arguments specified by the container image, will be used to start the container.
- Constraints: The list items must match regular expression
/^.*$/
. The maximum length is100
items. The minimum length is0
items.
- Constraints: The list items must match regular expression
- run
As DoubleUser - Optional user ID (UID) to run the app.
- Constraints: The default value is
0
.
- Constraints: The default value is
- run
Commands List<String> - Optional commands for the app that are passed to start the container. If not specified an empty string array will be applied and the command specified by the container image, will be used to start the container.
- Constraints: The list items must match regular expression
/^.*$/
. The maximum length is100
items. The minimum length is0
items.
- Constraints: The list items must match regular expression
- run
Env List<CodeVariables Engine App Run Env Variable> - 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 is0
items. Nested schema for run_env_variables:
- Constraints: The maximum length is
- run
Service StringAccount - Optional name of the service account. For built-in service accounts, you can use the shortened names
manager
,none
,reader
, andwriter
.- Constraints: The default value is
default
. Allowable values are:default
,manager
,reader
,writer
,none
. The minimum length is0
characters. The value must match regular expression/^(manager|reader|writer|none|default)$/
.
- Constraints: The default value is
- run
Volume List<CodeMounts Engine App Run Volume Mount> - Mounts of config maps or secrets.
- Constraints: The maximum length is
100
items. The minimum length is0
items. Nested schema for run_volume_mounts:
- Constraints: The maximum length is
- scale
Concurrency Double - Optional maximum number of requests that can be processed concurrently per instance.
- Constraints: The default value is
100
.
- Constraints: The default value is
- scale
Concurrency DoubleTarget - 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 is1000
. The minimum value is1
.
- Constraints: The default value is
- scale
Cpu StringLimit - 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 is10
characters. The minimum length is0
characters. The value must match regular expression/^([0-9.]+)([eEinumkKMGTPB]*)$/
.
- Constraints: The default value is
- scale
Down DoubleDelay - 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 is3600
. The minimum value is0
.
- Constraints: The default value is
- scale
Ephemeral StringStorage Limit - 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 is10
characters. The minimum length is0
characters. The value must match regular expression/^([0-9.]+)([eEinumkKMGTPB]*)$/
.
- Constraints: The default value is
- scale
Initial DoubleInstances - Optional initial number of instances that are created upon app creation or app update.
- Constraints: The default value is
1
.
- Constraints: The default value is
- scale
Max DoubleInstances - 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
.
- Constraints: The default value is
- scale
Memory StringLimit - 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 is10
characters. The minimum length is0
characters. The value must match regular expression/^([0-9.]+)([eEinumkKMGTPB]*)$/
.
- Constraints: The default value is
- scale
Min DoubleInstances - 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
.
- Constraints: The default value is
- scale
Request DoubleTimeout - Optional amount of time in seconds that is allowed for a running app to respond to a request.
- Constraints: The default value is
300
.
- Constraints: The default value is
- timeouts
Code
Engine App Timeouts
- image
Reference string - The name of the image that is used for this app. The format is
REGISTRY/NAMESPACE/REPOSITORY:TAG
whereREGISTRY
andTAG
are optional. IfREGISTRY
is not specified, the default isdocker.io
. IfTAG
is not specified, the default islatest
. If the image reference points to a registry that requires authentication, make sure to also specify the propertyimage_secret
.- Constraints: The maximum length is
256
characters. The minimum length is1
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})?$/
.
- Constraints: The maximum length is
- project
Id string - The ID of the project.
- Constraints: The maximum length is
36
characters. The minimum length is36
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}$/
.
- Constraints: The maximum length is
- code
Engine stringApp Id - The unique identifier of the code_engine_app.
- image
Port number - Optional port the app listens on. While the app will always be exposed via port
443
for end users, this port is used to connect to the port that is exposed by the container image.- Constraints: The default value is
8080
.
- Constraints: The default value is
- image
Secret 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 is1
character. The value must match regular expression/^a-z0-9?(\\.a-z0-9?)*$/
.
- Constraints: The maximum length is
- managed
Domain stringMappings - 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
.
- Constraints: The default value is
- name string
- The name of the app.
- Constraints: The maximum length is
63
characters. The minimum length is1
character. The value must match regular expression/^a-z?$/
.
- Constraints: The maximum length is
- probe
Liveness CodeEngine App Probe Liveness - Response model for probes. Nested schema for probe_liveness:
- probe
Readiness CodeEngine App Probe Readiness - Response model for probes. Nested schema for probe_readiness:
- run
Arguments string[] - Optional arguments for the app that are passed to start the container. If not specified an empty string array will be applied and the arguments specified by the container image, will be used to start the container.
- Constraints: The list items must match regular expression
/^.*$/
. The maximum length is100
items. The minimum length is0
items.
- Constraints: The list items must match regular expression
- run
As numberUser - Optional user ID (UID) to run the app.
- Constraints: The default value is
0
.
- Constraints: The default value is
- run
Commands string[] - Optional commands for the app that are passed to start the container. If not specified an empty string array will be applied and the command specified by the container image, will be used to start the container.
- Constraints: The list items must match regular expression
/^.*$/
. The maximum length is100
items. The minimum length is0
items.
- Constraints: The list items must match regular expression
- run
Env CodeVariables Engine App Run Env Variable[] - 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 is0
items. Nested schema for run_env_variables:
- Constraints: The maximum length is
- run
Service stringAccount - Optional name of the service account. For built-in service accounts, you can use the shortened names
manager
,none
,reader
, andwriter
.- Constraints: The default value is
default
. Allowable values are:default
,manager
,reader
,writer
,none
. The minimum length is0
characters. The value must match regular expression/^(manager|reader|writer|none|default)$/
.
- Constraints: The default value is
- run
Volume CodeMounts Engine App Run Volume Mount[] - Mounts of config maps or secrets.
- Constraints: The maximum length is
100
items. The minimum length is0
items. Nested schema for run_volume_mounts:
- Constraints: The maximum length is
- scale
Concurrency number - Optional maximum number of requests that can be processed concurrently per instance.
- Constraints: The default value is
100
.
- Constraints: The default value is
- scale
Concurrency numberTarget - 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 is1000
. The minimum value is1
.
- Constraints: The default value is
- scale
Cpu stringLimit - 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 is10
characters. The minimum length is0
characters. The value must match regular expression/^([0-9.]+)([eEinumkKMGTPB]*)$/
.
- Constraints: The default value is
- scale
Down numberDelay - 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 is3600
. The minimum value is0
.
- Constraints: The default value is
- scale
Ephemeral stringStorage Limit - 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 is10
characters. The minimum length is0
characters. The value must match regular expression/^([0-9.]+)([eEinumkKMGTPB]*)$/
.
- Constraints: The default value is
- scale
Initial numberInstances - Optional initial number of instances that are created upon app creation or app update.
- Constraints: The default value is
1
.
- Constraints: The default value is
- scale
Max numberInstances - 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
.
- Constraints: The default value is
- scale
Memory stringLimit - 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 is10
characters. The minimum length is0
characters. The value must match regular expression/^([0-9.]+)([eEinumkKMGTPB]*)$/
.
- Constraints: The default value is
- scale
Min numberInstances - 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
.
- Constraints: The default value is
- scale
Request numberTimeout - Optional amount of time in seconds that is allowed for a running app to respond to a request.
- Constraints: The default value is
300
.
- Constraints: The default value is
- timeouts
Code
Engine App Timeouts
- image_
reference str - The name of the image that is used for this app. The format is
REGISTRY/NAMESPACE/REPOSITORY:TAG
whereREGISTRY
andTAG
are optional. IfREGISTRY
is not specified, the default isdocker.io
. IfTAG
is not specified, the default islatest
. If the image reference points to a registry that requires authentication, make sure to also specify the propertyimage_secret
.- Constraints: The maximum length is
256
characters. The minimum length is1
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})?$/
.
- Constraints: The maximum length is
- project_
id str - The ID of the project.
- Constraints: The maximum length is
36
characters. The minimum length is36
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}$/
.
- Constraints: The maximum length is
- code_
engine_ strapp_ id - The unique identifier of the code_engine_app.
- image_
port float - Optional port the app listens on. While the app will always be exposed via port
443
for end users, this port is used to connect to the port that is exposed by the container image.- Constraints: The default value is
8080
.
- Constraints: The default value is
- image_
secret str - Optional name of the image registry access secret. The image registry access secret is used to authenticate with a private registry when you download the container image. If the image reference points to a registry that requires authentication, the app will be created but cannot reach the ready status, until this property is provided, too.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^a-z0-9?(\\.a-z0-9?)*$/
.
- Constraints: The maximum length is
- managed_
domain_ strmappings - 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
.
- Constraints: The default value is
- name str
- The name of the app.
- Constraints: The maximum length is
63
characters. The minimum length is1
character. The value must match regular expression/^a-z?$/
.
- Constraints: The maximum length is
- probe_
liveness CodeEngine App Probe Liveness Args - Response model for probes. Nested schema for probe_liveness:
- probe_
readiness CodeEngine App Probe Readiness Args - Response model for probes. Nested schema for probe_readiness:
- run_
arguments Sequence[str] - Optional arguments for the app that are passed to start the container. If not specified an empty string array will be applied and the arguments specified by the container image, will be used to start the container.
- Constraints: The list items must match regular expression
/^.*$/
. The maximum length is100
items. The minimum length is0
items.
- Constraints: The list items must match regular expression
- run_
as_ floatuser - Optional user ID (UID) to run the app.
- Constraints: The default value is
0
.
- Constraints: The default value is
- run_
commands Sequence[str] - Optional commands for the app that are passed to start the container. If not specified an empty string array will be applied and the command specified by the container image, will be used to start the container.
- Constraints: The list items must match regular expression
/^.*$/
. The maximum length is100
items. The minimum length is0
items.
- Constraints: The list items must match regular expression
- run_
env_ Sequence[Codevariables Engine App Run Env Variable Args] - 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 is0
items. Nested schema for run_env_variables:
- Constraints: The maximum length is
- run_
service_ straccount - Optional name of the service account. For built-in service accounts, you can use the shortened names
manager
,none
,reader
, andwriter
.- Constraints: The default value is
default
. Allowable values are:default
,manager
,reader
,writer
,none
. The minimum length is0
characters. The value must match regular expression/^(manager|reader|writer|none|default)$/
.
- Constraints: The default value is
- run_
volume_ Sequence[Codemounts Engine App Run Volume Mount Args] - Mounts of config maps or secrets.
- Constraints: The maximum length is
100
items. The minimum length is0
items. Nested schema for run_volume_mounts:
- Constraints: The maximum length is
- scale_
concurrency float - Optional maximum number of requests that can be processed concurrently per instance.
- Constraints: The default value is
100
.
- Constraints: The default value is
- scale_
concurrency_ floattarget - 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 is1000
. The minimum value is1
.
- Constraints: The default value is
- scale_
cpu_ strlimit - 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 is10
characters. The minimum length is0
characters. The value must match regular expression/^([0-9.]+)([eEinumkKMGTPB]*)$/
.
- Constraints: The default value is
- scale_
down_ floatdelay - 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 is3600
. The minimum value is0
.
- Constraints: The default value is
- scale_
ephemeral_ strstorage_ limit - 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 is10
characters. The minimum length is0
characters. The value must match regular expression/^([0-9.]+)([eEinumkKMGTPB]*)$/
.
- Constraints: The default value is
- scale_
initial_ floatinstances - Optional initial number of instances that are created upon app creation or app update.
- Constraints: The default value is
1
.
- Constraints: The default value is
- scale_
max_ floatinstances - 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
.
- Constraints: The default value is
- scale_
memory_ strlimit - 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 is10
characters. The minimum length is0
characters. The value must match regular expression/^([0-9.]+)([eEinumkKMGTPB]*)$/
.
- Constraints: The default value is
- scale_
min_ floatinstances - 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
.
- Constraints: The default value is
- scale_
request_ floattimeout - Optional amount of time in seconds that is allowed for a running app to respond to a request.
- Constraints: The default value is
300
.
- Constraints: The default value is
- timeouts
Code
Engine App Timeouts Args
- image
Reference String - The name of the image that is used for this app. The format is
REGISTRY/NAMESPACE/REPOSITORY:TAG
whereREGISTRY
andTAG
are optional. IfREGISTRY
is not specified, the default isdocker.io
. IfTAG
is not specified, the default islatest
. If the image reference points to a registry that requires authentication, make sure to also specify the propertyimage_secret
.- Constraints: The maximum length is
256
characters. The minimum length is1
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})?$/
.
- Constraints: The maximum length is
- project
Id String - The ID of the project.
- Constraints: The maximum length is
36
characters. The minimum length is36
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}$/
.
- Constraints: The maximum length is
- code
Engine StringApp Id - The unique identifier of the code_engine_app.
- image
Port Number - Optional port the app listens on. While the app will always be exposed via port
443
for end users, this port is used to connect to the port that is exposed by the container image.- Constraints: The default value is
8080
.
- Constraints: The default value is
- image
Secret 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 is1
character. The value must match regular expression/^a-z0-9?(\\.a-z0-9?)*$/
.
- Constraints: The maximum length is
- managed
Domain StringMappings - 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
.
- Constraints: The default value is
- name String
- The name of the app.
- Constraints: The maximum length is
63
characters. The minimum length is1
character. The value must match regular expression/^a-z?$/
.
- Constraints: The maximum length is
- probe
Liveness Property Map - Response model for probes. Nested schema for probe_liveness:
- probe
Readiness Property Map - Response model for probes. Nested schema for probe_readiness:
- run
Arguments List<String> - Optional arguments for the app that are passed to start the container. If not specified an empty string array will be applied and the arguments specified by the container image, will be used to start the container.
- Constraints: The list items must match regular expression
/^.*$/
. The maximum length is100
items. The minimum length is0
items.
- Constraints: The list items must match regular expression
- run
As NumberUser - Optional user ID (UID) to run the app.
- Constraints: The default value is
0
.
- Constraints: The default value is
- run
Commands List<String> - Optional commands for the app that are passed to start the container. If not specified an empty string array will be applied and the command specified by the container image, will be used to start the container.
- Constraints: The list items must match regular expression
/^.*$/
. The maximum length is100
items. The minimum length is0
items.
- Constraints: The list items must match regular expression
- run
Env List<Property Map>Variables - 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 is0
items. Nested schema for run_env_variables:
- Constraints: The maximum length is
- run
Service StringAccount - Optional name of the service account. For built-in service accounts, you can use the shortened names
manager
,none
,reader
, andwriter
.- Constraints: The default value is
default
. Allowable values are:default
,manager
,reader
,writer
,none
. The minimum length is0
characters. The value must match regular expression/^(manager|reader|writer|none|default)$/
.
- Constraints: The default value is
- run
Volume List<Property Map>Mounts - Mounts of config maps or secrets.
- Constraints: The maximum length is
100
items. The minimum length is0
items. Nested schema for run_volume_mounts:
- Constraints: The maximum length is
- scale
Concurrency Number - Optional maximum number of requests that can be processed concurrently per instance.
- Constraints: The default value is
100
.
- Constraints: The default value is
- scale
Concurrency NumberTarget - 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 is1000
. The minimum value is1
.
- Constraints: The default value is
- scale
Cpu StringLimit - 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 is10
characters. The minimum length is0
characters. The value must match regular expression/^([0-9.]+)([eEinumkKMGTPB]*)$/
.
- Constraints: The default value is
- scale
Down NumberDelay - 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 is3600
. The minimum value is0
.
- Constraints: The default value is
- scale
Ephemeral StringStorage Limit - 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 is10
characters. The minimum length is0
characters. The value must match regular expression/^([0-9.]+)([eEinumkKMGTPB]*)$/
.
- Constraints: The default value is
- scale
Initial NumberInstances - Optional initial number of instances that are created upon app creation or app update.
- Constraints: The default value is
1
.
- Constraints: The default value is
- scale
Max NumberInstances - 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
.
- Constraints: The default value is
- scale
Memory StringLimit - 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 is10
characters. The minimum length is0
characters. The value must match regular expression/^([0-9.]+)([eEinumkKMGTPB]*)$/
.
- Constraints: The default value is
- scale
Min NumberInstances - 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
.
- Constraints: The default value is
- scale
Request NumberTimeout - Optional amount of time in seconds that is allowed for a running app to respond to a request.
- Constraints: The default value is
300
.
- Constraints: The default value is
- timeouts Property Map
Outputs
All input properties are implicitly available as output properties. Additionally, the CodeEngineApp resource produces the following output properties:
- App
Id string - (String) The identifier of the resource.
- Constraints: The maximum length is
36
characters. The minimum length is36
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}$/
.
- Constraints: The maximum length is
- Build string
- (String) Reference to a build that is associated with the application.
- Build
Run string - (String) Reference to a build run that is associated with the application.
- Computed
Env List<CodeVariables Engine App Computed Env Variable> - (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 is0
items. Nested schema for computed_env_variables:
- Constraints: The maximum length is
- Created
At 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'.
- Endpoint
Internal string - (String) The URL to the app that is only visible within the project.
- Entity
Tag 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 is1
character. The value must match regular expression/^[\\*\\-a-z0-9]+$/
.
- Constraints: The maximum length is
- Etag string
- ETag identifier for code_engine_app.
- Href string
- (String) When you provision a new app, a URL is created identifying the location of the instance.
- Constraints: The maximum length is
2048
characters. The minimum length is0
characters. The value must match regular expression/(([^:\/?#]+):)?(\/\/([^\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$/
.
- Constraints: The maximum length is
- Id string
- The provider-assigned unique ID for this managed resource.
- Region string
- (String) The region of the project the resource is located in. Possible values: 'au-syd', 'br-sao', 'ca-tor', 'eu-de', 'eu-gb', 'jp-osa', 'jp-tok', 'us-east', 'us-south'.
- Resource
Type string - (String) The type of the app.
- Constraints: Allowable values are:
app_v2
.
- Constraints: Allowable values are:
- Status string
- (String) The current status of the app.
- Constraints: Allowable values are:
ready
,deploying
,failed
,warning
.
- Constraints: Allowable values are:
- Status
Details List<CodeEngine App Status Detail> - (List) The detailed status of the application. Nested schema for status_details:
- App
Id string - (String) The identifier of the resource.
- Constraints: The maximum length is
36
characters. The minimum length is36
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}$/
.
- Constraints: The maximum length is
- Build string
- (String) Reference to a build that is associated with the application.
- Build
Run string - (String) Reference to a build run that is associated with the application.
- Computed
Env []CodeVariables Engine App Computed Env Variable - (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 is0
items. Nested schema for computed_env_variables:
- Constraints: The maximum length is
- Created
At 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'.
- Endpoint
Internal string - (String) The URL to the app that is only visible within the project.
- Entity
Tag 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 is1
character. The value must match regular expression/^[\\*\\-a-z0-9]+$/
.
- Constraints: The maximum length is
- Etag string
- ETag identifier for code_engine_app.
- Href string
- (String) When you provision a new app, a URL is created identifying the location of the instance.
- Constraints: The maximum length is
2048
characters. The minimum length is0
characters. The value must match regular expression/(([^:\/?#]+):)?(\/\/([^\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$/
.
- Constraints: The maximum length is
- Id string
- The provider-assigned unique ID for this managed resource.
- Region string
- (String) The region of the project the resource is located in. Possible values: 'au-syd', 'br-sao', 'ca-tor', 'eu-de', 'eu-gb', 'jp-osa', 'jp-tok', 'us-east', 'us-south'.
- Resource
Type string - (String) The type of the app.
- Constraints: Allowable values are:
app_v2
.
- Constraints: Allowable values are:
- Status string
- (String) The current status of the app.
- Constraints: Allowable values are:
ready
,deploying
,failed
,warning
.
- Constraints: Allowable values are:
- Status
Details []CodeEngine App Status Detail - (List) The detailed status of the application. Nested schema for status_details:
- app
Id String - (String) The identifier of the resource.
- Constraints: The maximum length is
36
characters. The minimum length is36
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}$/
.
- Constraints: The maximum length is
- build String
- (String) Reference to a build that is associated with the application.
- build
Run String - (String) Reference to a build run that is associated with the application.
- computed
Env List<CodeVariables Engine App Computed Env Variable> - (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 is0
items. Nested schema for computed_env_variables:
- Constraints: The maximum length is
- created
At 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'.
- endpoint
Internal String - (String) The URL to the app that is only visible within the project.
- entity
Tag 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 is1
character. The value must match regular expression/^[\\*\\-a-z0-9]+$/
.
- Constraints: The maximum length is
- etag String
- ETag identifier for code_engine_app.
- href String
- (String) When you provision a new app, a URL is created identifying the location of the instance.
- Constraints: The maximum length is
2048
characters. The minimum length is0
characters. The value must match regular expression/(([^:\/?#]+):)?(\/\/([^\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$/
.
- Constraints: The maximum length is
- id String
- The provider-assigned unique ID for this managed resource.
- region String
- (String) The region of the project the resource is located in. Possible values: 'au-syd', 'br-sao', 'ca-tor', 'eu-de', 'eu-gb', 'jp-osa', 'jp-tok', 'us-east', 'us-south'.
- resource
Type String - (String) The type of the app.
- Constraints: Allowable values are:
app_v2
.
- Constraints: Allowable values are:
- status String
- (String) The current status of the app.
- Constraints: Allowable values are:
ready
,deploying
,failed
,warning
.
- Constraints: Allowable values are:
- status
Details List<CodeEngine App Status Detail> - (List) The detailed status of the application. Nested schema for status_details:
- app
Id string - (String) The identifier of the resource.
- Constraints: The maximum length is
36
characters. The minimum length is36
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}$/
.
- Constraints: The maximum length is
- build string
- (String) Reference to a build that is associated with the application.
- build
Run string - (String) Reference to a build run that is associated with the application.
- computed
Env CodeVariables Engine App Computed Env Variable[] - (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 is0
items. Nested schema for computed_env_variables:
- Constraints: The maximum length is
- created
At 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'.
- endpoint
Internal string - (String) The URL to the app that is only visible within the project.
- entity
Tag 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 is1
character. The value must match regular expression/^[\\*\\-a-z0-9]+$/
.
- Constraints: The maximum length is
- etag string
- ETag identifier for code_engine_app.
- href string
- (String) When you provision a new app, a URL is created identifying the location of the instance.
- Constraints: The maximum length is
2048
characters. The minimum length is0
characters. The value must match regular expression/(([^:\/?#]+):)?(\/\/([^\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$/
.
- Constraints: The maximum length is
- id string
- The provider-assigned unique ID for this managed resource.
- region string
- (String) The region of the project the resource is located in. Possible values: 'au-syd', 'br-sao', 'ca-tor', 'eu-de', 'eu-gb', 'jp-osa', 'jp-tok', 'us-east', 'us-south'.
- resource
Type string - (String) The type of the app.
- Constraints: Allowable values are:
app_v2
.
- Constraints: Allowable values are:
- status string
- (String) The current status of the app.
- Constraints: Allowable values are:
ready
,deploying
,failed
,warning
.
- Constraints: Allowable values are:
- status
Details CodeEngine App Status Detail[] - (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 is36
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}$/
.
- Constraints: The maximum length is
- 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_ Sequence[Codevariables Engine App Computed Env Variable] - (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 is0
items. Nested schema for computed_env_variables:
- Constraints: The maximum length is
- 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 is1
character. The value must match regular expression/^[\\*\\-a-z0-9]+$/
.
- Constraints: The maximum length is
- etag str
- ETag identifier for code_engine_app.
- href str
- (String) When you provision a new app, a URL is created identifying the location of the instance.
- Constraints: The maximum length is
2048
characters. The minimum length is0
characters. The value must match regular expression/(([^:\/?#]+):)?(\/\/([^\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$/
.
- Constraints: The maximum length is
- id str
- The provider-assigned unique ID for this managed resource.
- region str
- (String) The region of the project the resource is located in. Possible values: 'au-syd', 'br-sao', 'ca-tor', 'eu-de', 'eu-gb', 'jp-osa', 'jp-tok', 'us-east', 'us-south'.
- resource_
type str - (String) The type of the app.
- Constraints: Allowable values are:
app_v2
.
- Constraints: Allowable values are:
- status str
- (String) The current status of the app.
- Constraints: Allowable values are:
ready
,deploying
,failed
,warning
.
- Constraints: Allowable values are:
- status_
details Sequence[CodeEngine App Status Detail] - (List) The detailed status of the application. Nested schema for status_details:
- app
Id String - (String) The identifier of the resource.
- Constraints: The maximum length is
36
characters. The minimum length is36
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}$/
.
- Constraints: The maximum length is
- build String
- (String) Reference to a build that is associated with the application.
- build
Run String - (String) Reference to a build run that is associated with the application.
- computed
Env List<Property Map>Variables - (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 is0
items. Nested schema for computed_env_variables:
- Constraints: The maximum length is
- created
At 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'.
- endpoint
Internal String - (String) The URL to the app that is only visible within the project.
- entity
Tag 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 is1
character. The value must match regular expression/^[\\*\\-a-z0-9]+$/
.
- Constraints: The maximum length is
- etag String
- ETag identifier for code_engine_app.
- href String
- (String) When you provision a new app, a URL is created identifying the location of the instance.
- Constraints: The maximum length is
2048
characters. The minimum length is0
characters. The value must match regular expression/(([^:\/?#]+):)?(\/\/([^\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$/
.
- Constraints: The maximum length is
- id String
- The provider-assigned unique ID for this managed resource.
- region String
- (String) The region of the project the resource is located in. Possible values: 'au-syd', 'br-sao', 'ca-tor', 'eu-de', 'eu-gb', 'jp-osa', 'jp-tok', 'us-east', 'us-south'.
- resource
Type String - (String) The type of the app.
- Constraints: Allowable values are:
app_v2
.
- Constraints: Allowable values are:
- status String
- (String) The current status of the app.
- Constraints: Allowable values are:
ready
,deploying
,failed
,warning
.
- Constraints: Allowable values are:
- status
Details List<Property Map> - (List) The detailed status of the application. Nested schema for status_details:
Look up Existing CodeEngineApp Resource
Get an existing CodeEngineApp resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: CodeEngineAppState, opts?: CustomResourceOptions): CodeEngineApp
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
app_id: Optional[str] = None,
build: Optional[str] = None,
build_run: Optional[str] = None,
code_engine_app_id: Optional[str] = None,
computed_env_variables: Optional[Sequence[CodeEngineAppComputedEnvVariableArgs]] = None,
created_at: Optional[str] = None,
endpoint: Optional[str] = None,
endpoint_internal: Optional[str] = None,
entity_tag: Optional[str] = None,
etag: Optional[str] = None,
href: Optional[str] = None,
image_port: Optional[float] = None,
image_reference: Optional[str] = None,
image_secret: Optional[str] = None,
managed_domain_mappings: Optional[str] = None,
name: Optional[str] = None,
probe_liveness: Optional[CodeEngineAppProbeLivenessArgs] = None,
probe_readiness: Optional[CodeEngineAppProbeReadinessArgs] = None,
project_id: Optional[str] = None,
region: Optional[str] = None,
resource_type: Optional[str] = None,
run_arguments: Optional[Sequence[str]] = None,
run_as_user: Optional[float] = None,
run_commands: Optional[Sequence[str]] = None,
run_env_variables: Optional[Sequence[CodeEngineAppRunEnvVariableArgs]] = None,
run_service_account: Optional[str] = None,
run_volume_mounts: Optional[Sequence[CodeEngineAppRunVolumeMountArgs]] = None,
scale_concurrency: Optional[float] = None,
scale_concurrency_target: Optional[float] = None,
scale_cpu_limit: Optional[str] = None,
scale_down_delay: Optional[float] = None,
scale_ephemeral_storage_limit: Optional[str] = None,
scale_initial_instances: Optional[float] = None,
scale_max_instances: Optional[float] = None,
scale_memory_limit: Optional[str] = None,
scale_min_instances: Optional[float] = None,
scale_request_timeout: Optional[float] = None,
status: Optional[str] = None,
status_details: Optional[Sequence[CodeEngineAppStatusDetailArgs]] = None,
timeouts: Optional[CodeEngineAppTimeoutsArgs] = None) -> CodeEngineApp
func GetCodeEngineApp(ctx *Context, name string, id IDInput, state *CodeEngineAppState, opts ...ResourceOption) (*CodeEngineApp, error)
public static CodeEngineApp Get(string name, Input<string> id, CodeEngineAppState? state, CustomResourceOptions? opts = null)
public static CodeEngineApp get(String name, Output<String> id, CodeEngineAppState state, CustomResourceOptions options)
resources: _: type: ibm:CodeEngineApp get: id: ${id}
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- App
Id string - (String) The identifier of the resource.
- Constraints: The maximum length is
36
characters. The minimum length is36
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}$/
.
- Constraints: The maximum length is
- Build string
- (String) Reference to a build that is associated with the application.
- Build
Run string - (String) Reference to a build run that is associated with the application.
- Code
Engine stringApp Id - The unique identifier of the code_engine_app.
- Computed
Env List<CodeVariables Engine App Computed Env Variable> - (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 is0
items. Nested schema for computed_env_variables:
- Constraints: The maximum length is
- Created
At 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'.
- Endpoint
Internal string - (String) The URL to the app that is only visible within the project.
- Entity
Tag 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 is1
character. The value must match regular expression/^[\\*\\-a-z0-9]+$/
.
- Constraints: The maximum length is
- Etag string
- ETag identifier for code_engine_app.
- Href string
- (String) When you provision a new app, a URL is created identifying the location of the instance.
- Constraints: The maximum length is
2048
characters. The minimum length is0
characters. The value must match regular expression/(([^:\/?#]+):)?(\/\/([^\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$/
.
- Constraints: The maximum length is
- Image
Port double - Optional port the app listens on. While the app will always be exposed via port
443
for end users, this port is used to connect to the port that is exposed by the container image.- Constraints: The default value is
8080
.
- Constraints: The default value is
- Image
Reference string - The name of the image that is used for this app. The format is
REGISTRY/NAMESPACE/REPOSITORY:TAG
whereREGISTRY
andTAG
are optional. IfREGISTRY
is not specified, the default isdocker.io
. IfTAG
is not specified, the default islatest
. If the image reference points to a registry that requires authentication, make sure to also specify the propertyimage_secret
.- Constraints: The maximum length is
256
characters. The minimum length is1
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})?$/
.
- Constraints: The maximum length is
- Image
Secret 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 is1
character. The value must match regular expression/^a-z0-9?(\\.a-z0-9?)*$/
.
- Constraints: The maximum length is
- Managed
Domain stringMappings - 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
.
- Constraints: The default value is
- Name string
- The name of the app.
- Constraints: The maximum length is
63
characters. The minimum length is1
character. The value must match regular expression/^a-z?$/
.
- Constraints: The maximum length is
- Probe
Liveness CodeEngine App Probe Liveness - Response model for probes. Nested schema for probe_liveness:
- Probe
Readiness CodeEngine App Probe Readiness - Response model for probes. Nested schema for probe_readiness:
- Project
Id string - The ID of the project.
- Constraints: The maximum length is
36
characters. The minimum length is36
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}$/
.
- Constraints: The maximum length is
- 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'.
- Resource
Type string - (String) The type of the app.
- Constraints: Allowable values are:
app_v2
.
- Constraints: Allowable values are:
- Run
Arguments List<string> - Optional arguments for the app that are passed to start the container. If not specified an empty string array will be applied and the arguments specified by the container image, will be used to start the container.
- Constraints: The list items must match regular expression
/^.*$/
. The maximum length is100
items. The minimum length is0
items.
- Constraints: The list items must match regular expression
- Run
As doubleUser - Optional user ID (UID) to run the app.
- Constraints: The default value is
0
.
- Constraints: The default value is
- Run
Commands List<string> - Optional commands for the app that are passed to start the container. If not specified an empty string array will be applied and the command specified by the container image, will be used to start the container.
- Constraints: The list items must match regular expression
/^.*$/
. The maximum length is100
items. The minimum length is0
items.
- Constraints: The list items must match regular expression
- Run
Env List<CodeVariables Engine App Run Env Variable> - 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 is0
items. Nested schema for run_env_variables:
- Constraints: The maximum length is
- Run
Service stringAccount - Optional name of the service account. For built-in service accounts, you can use the shortened names
manager
,none
,reader
, andwriter
.- Constraints: The default value is
default
. Allowable values are:default
,manager
,reader
,writer
,none
. The minimum length is0
characters. The value must match regular expression/^(manager|reader|writer|none|default)$/
.
- Constraints: The default value is
- Run
Volume List<CodeMounts Engine App Run Volume Mount> - Mounts of config maps or secrets.
- Constraints: The maximum length is
100
items. The minimum length is0
items. Nested schema for run_volume_mounts:
- Constraints: The maximum length is
- Scale
Concurrency double - Optional maximum number of requests that can be processed concurrently per instance.
- Constraints: The default value is
100
.
- Constraints: The default value is
- Scale
Concurrency doubleTarget - 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 is1000
. The minimum value is1
.
- Constraints: The default value is
- Scale
Cpu stringLimit - 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 is10
characters. The minimum length is0
characters. The value must match regular expression/^([0-9.]+)([eEinumkKMGTPB]*)$/
.
- Constraints: The default value is
- Scale
Down doubleDelay - 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 is3600
. The minimum value is0
.
- Constraints: The default value is
- Scale
Ephemeral stringStorage Limit - 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 is10
characters. The minimum length is0
characters. The value must match regular expression/^([0-9.]+)([eEinumkKMGTPB]*)$/
.
- Constraints: The default value is
- Scale
Initial doubleInstances - Optional initial number of instances that are created upon app creation or app update.
- Constraints: The default value is
1
.
- Constraints: The default value is
- Scale
Max doubleInstances - 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
.
- Constraints: The default value is
- Scale
Memory stringLimit - 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 is10
characters. The minimum length is0
characters. The value must match regular expression/^([0-9.]+)([eEinumkKMGTPB]*)$/
.
- Constraints: The default value is
- Scale
Min doubleInstances - 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
.
- Constraints: The default value is
- Scale
Request doubleTimeout - Optional amount of time in seconds that is allowed for a running app to respond to a request.
- Constraints: The default value is
300
.
- Constraints: The default value is
- Status string
- (String) The current status of the app.
- Constraints: Allowable values are:
ready
,deploying
,failed
,warning
.
- Constraints: Allowable values are:
- Status
Details List<CodeEngine App Status Detail> - (List) The detailed status of the application. Nested schema for status_details:
- Timeouts
Code
Engine App Timeouts
- App
Id string - (String) The identifier of the resource.
- Constraints: The maximum length is
36
characters. The minimum length is36
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}$/
.
- Constraints: The maximum length is
- Build string
- (String) Reference to a build that is associated with the application.
- Build
Run string - (String) Reference to a build run that is associated with the application.
- Code
Engine stringApp Id - The unique identifier of the code_engine_app.
- Computed
Env []CodeVariables Engine App Computed Env Variable Args - (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 is0
items. Nested schema for computed_env_variables:
- Constraints: The maximum length is
- Created
At 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'.
- Endpoint
Internal string - (String) The URL to the app that is only visible within the project.
- Entity
Tag 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 is1
character. The value must match regular expression/^[\\*\\-a-z0-9]+$/
.
- Constraints: The maximum length is
- Etag string
- ETag identifier for code_engine_app.
- Href string
- (String) When you provision a new app, a URL is created identifying the location of the instance.
- Constraints: The maximum length is
2048
characters. The minimum length is0
characters. The value must match regular expression/(([^:\/?#]+):)?(\/\/([^\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$/
.
- Constraints: The maximum length is
- Image
Port float64 - Optional port the app listens on. While the app will always be exposed via port
443
for end users, this port is used to connect to the port that is exposed by the container image.- Constraints: The default value is
8080
.
- Constraints: The default value is
- Image
Reference string - The name of the image that is used for this app. The format is
REGISTRY/NAMESPACE/REPOSITORY:TAG
whereREGISTRY
andTAG
are optional. IfREGISTRY
is not specified, the default isdocker.io
. IfTAG
is not specified, the default islatest
. If the image reference points to a registry that requires authentication, make sure to also specify the propertyimage_secret
.- Constraints: The maximum length is
256
characters. The minimum length is1
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})?$/
.
- Constraints: The maximum length is
- Image
Secret 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 is1
character. The value must match regular expression/^a-z0-9?(\\.a-z0-9?)*$/
.
- Constraints: The maximum length is
- Managed
Domain stringMappings - 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
.
- Constraints: The default value is
- Name string
- The name of the app.
- Constraints: The maximum length is
63
characters. The minimum length is1
character. The value must match regular expression/^a-z?$/
.
- Constraints: The maximum length is
- Probe
Liveness CodeEngine App Probe Liveness Args - Response model for probes. Nested schema for probe_liveness:
- Probe
Readiness CodeEngine App Probe Readiness Args - Response model for probes. Nested schema for probe_readiness:
- Project
Id string - The ID of the project.
- Constraints: The maximum length is
36
characters. The minimum length is36
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}$/
.
- Constraints: The maximum length is
- 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'.
- Resource
Type string - (String) The type of the app.
- Constraints: Allowable values are:
app_v2
.
- Constraints: Allowable values are:
- Run
Arguments []string - Optional arguments for the app that are passed to start the container. If not specified an empty string array will be applied and the arguments specified by the container image, will be used to start the container.
- Constraints: The list items must match regular expression
/^.*$/
. The maximum length is100
items. The minimum length is0
items.
- Constraints: The list items must match regular expression
- Run
As float64User - Optional user ID (UID) to run the app.
- Constraints: The default value is
0
.
- Constraints: The default value is
- Run
Commands []string - Optional commands for the app that are passed to start the container. If not specified an empty string array will be applied and the command specified by the container image, will be used to start the container.
- Constraints: The list items must match regular expression
/^.*$/
. The maximum length is100
items. The minimum length is0
items.
- Constraints: The list items must match regular expression
- Run
Env []CodeVariables Engine App Run Env Variable Args - 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 is0
items. Nested schema for run_env_variables:
- Constraints: The maximum length is
- Run
Service stringAccount - Optional name of the service account. For built-in service accounts, you can use the shortened names
manager
,none
,reader
, andwriter
.- Constraints: The default value is
default
. Allowable values are:default
,manager
,reader
,writer
,none
. The minimum length is0
characters. The value must match regular expression/^(manager|reader|writer|none|default)$/
.
- Constraints: The default value is
- Run
Volume []CodeMounts Engine App Run Volume Mount Args - Mounts of config maps or secrets.
- Constraints: The maximum length is
100
items. The minimum length is0
items. Nested schema for run_volume_mounts:
- Constraints: The maximum length is
- Scale
Concurrency float64 - Optional maximum number of requests that can be processed concurrently per instance.
- Constraints: The default value is
100
.
- Constraints: The default value is
- Scale
Concurrency float64Target - 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 is1000
. The minimum value is1
.
- Constraints: The default value is
- Scale
Cpu stringLimit - 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 is10
characters. The minimum length is0
characters. The value must match regular expression/^([0-9.]+)([eEinumkKMGTPB]*)$/
.
- Constraints: The default value is
- Scale
Down float64Delay - 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 is3600
. The minimum value is0
.
- Constraints: The default value is
- Scale
Ephemeral stringStorage Limit - 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 is10
characters. The minimum length is0
characters. The value must match regular expression/^([0-9.]+)([eEinumkKMGTPB]*)$/
.
- Constraints: The default value is
- Scale
Initial float64Instances - Optional initial number of instances that are created upon app creation or app update.
- Constraints: The default value is
1
.
- Constraints: The default value is
- Scale
Max float64Instances - 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
.
- Constraints: The default value is
- Scale
Memory stringLimit - 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 is10
characters. The minimum length is0
characters. The value must match regular expression/^([0-9.]+)([eEinumkKMGTPB]*)$/
.
- Constraints: The default value is
- Scale
Min float64Instances - 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
.
- Constraints: The default value is
- Scale
Request float64Timeout - Optional amount of time in seconds that is allowed for a running app to respond to a request.
- Constraints: The default value is
300
.
- Constraints: The default value is
- Status string
- (String) The current status of the app.
- Constraints: Allowable values are:
ready
,deploying
,failed
,warning
.
- Constraints: Allowable values are:
- Status
Details []CodeEngine App Status Detail Args - (List) The detailed status of the application. Nested schema for status_details:
- Timeouts
Code
Engine App Timeouts Args
- app
Id String - (String) The identifier of the resource.
- Constraints: The maximum length is
36
characters. The minimum length is36
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}$/
.
- Constraints: The maximum length is
- build String
- (String) Reference to a build that is associated with the application.
- build
Run String - (String) Reference to a build run that is associated with the application.
- code
Engine StringApp Id - The unique identifier of the code_engine_app.
- computed
Env List<CodeVariables Engine App Computed Env Variable> - (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 is0
items. Nested schema for computed_env_variables:
- Constraints: The maximum length is
- created
At 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'.
- endpoint
Internal String - (String) The URL to the app that is only visible within the project.
- entity
Tag 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 is1
character. The value must match regular expression/^[\\*\\-a-z0-9]+$/
.
- Constraints: The maximum length is
- etag String
- ETag identifier for code_engine_app.
- href String
- (String) When you provision a new app, a URL is created identifying the location of the instance.
- Constraints: The maximum length is
2048
characters. The minimum length is0
characters. The value must match regular expression/(([^:\/?#]+):)?(\/\/([^\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$/
.
- Constraints: The maximum length is
- image
Port Double - Optional port the app listens on. While the app will always be exposed via port
443
for end users, this port is used to connect to the port that is exposed by the container image.- Constraints: The default value is
8080
.
- Constraints: The default value is
- image
Reference String - The name of the image that is used for this app. The format is
REGISTRY/NAMESPACE/REPOSITORY:TAG
whereREGISTRY
andTAG
are optional. IfREGISTRY
is not specified, the default isdocker.io
. IfTAG
is not specified, the default islatest
. If the image reference points to a registry that requires authentication, make sure to also specify the propertyimage_secret
.- Constraints: The maximum length is
256
characters. The minimum length is1
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})?$/
.
- Constraints: The maximum length is
- image
Secret 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 is1
character. The value must match regular expression/^a-z0-9?(\\.a-z0-9?)*$/
.
- Constraints: The maximum length is
- managed
Domain StringMappings - 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
.
- Constraints: The default value is
- name String
- The name of the app.
- Constraints: The maximum length is
63
characters. The minimum length is1
character. The value must match regular expression/^a-z?$/
.
- Constraints: The maximum length is
- probe
Liveness CodeEngine App Probe Liveness - Response model for probes. Nested schema for probe_liveness:
- probe
Readiness CodeEngine App Probe Readiness - Response model for probes. Nested schema for probe_readiness:
- project
Id String - The ID of the project.
- Constraints: The maximum length is
36
characters. The minimum length is36
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}$/
.
- Constraints: The maximum length is
- 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'.
- resource
Type String - (String) The type of the app.
- Constraints: Allowable values are:
app_v2
.
- Constraints: Allowable values are:
- run
Arguments List<String> - Optional arguments for the app that are passed to start the container. If not specified an empty string array will be applied and the arguments specified by the container image, will be used to start the container.
- Constraints: The list items must match regular expression
/^.*$/
. The maximum length is100
items. The minimum length is0
items.
- Constraints: The list items must match regular expression
- run
As DoubleUser - Optional user ID (UID) to run the app.
- Constraints: The default value is
0
.
- Constraints: The default value is
- run
Commands List<String> - Optional commands for the app that are passed to start the container. If not specified an empty string array will be applied and the command specified by the container image, will be used to start the container.
- Constraints: The list items must match regular expression
/^.*$/
. The maximum length is100
items. The minimum length is0
items.
- Constraints: The list items must match regular expression
- run
Env List<CodeVariables Engine App Run Env Variable> - 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 is0
items. Nested schema for run_env_variables:
- Constraints: The maximum length is
- run
Service StringAccount - Optional name of the service account. For built-in service accounts, you can use the shortened names
manager
,none
,reader
, andwriter
.- Constraints: The default value is
default
. Allowable values are:default
,manager
,reader
,writer
,none
. The minimum length is0
characters. The value must match regular expression/^(manager|reader|writer|none|default)$/
.
- Constraints: The default value is
- run
Volume List<CodeMounts Engine App Run Volume Mount> - Mounts of config maps or secrets.
- Constraints: The maximum length is
100
items. The minimum length is0
items. Nested schema for run_volume_mounts:
- Constraints: The maximum length is
- scale
Concurrency Double - Optional maximum number of requests that can be processed concurrently per instance.
- Constraints: The default value is
100
.
- Constraints: The default value is
- scale
Concurrency DoubleTarget - 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 is1000
. The minimum value is1
.
- Constraints: The default value is
- scale
Cpu StringLimit - 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 is10
characters. The minimum length is0
characters. The value must match regular expression/^([0-9.]+)([eEinumkKMGTPB]*)$/
.
- Constraints: The default value is
- scale
Down DoubleDelay - 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 is3600
. The minimum value is0
.
- Constraints: The default value is
- scale
Ephemeral StringStorage Limit - 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 is10
characters. The minimum length is0
characters. The value must match regular expression/^([0-9.]+)([eEinumkKMGTPB]*)$/
.
- Constraints: The default value is
- scale
Initial DoubleInstances - Optional initial number of instances that are created upon app creation or app update.
- Constraints: The default value is
1
.
- Constraints: The default value is
- scale
Max DoubleInstances - 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
.
- Constraints: The default value is
- scale
Memory StringLimit - 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 is10
characters. The minimum length is0
characters. The value must match regular expression/^([0-9.]+)([eEinumkKMGTPB]*)$/
.
- Constraints: The default value is
- scale
Min DoubleInstances - 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
.
- Constraints: The default value is
- scale
Request DoubleTimeout - Optional amount of time in seconds that is allowed for a running app to respond to a request.
- Constraints: The default value is
300
.
- Constraints: The default value is
- status String
- (String) The current status of the app.
- Constraints: Allowable values are:
ready
,deploying
,failed
,warning
.
- Constraints: Allowable values are:
- status
Details List<CodeEngine App Status Detail> - (List) The detailed status of the application. Nested schema for status_details:
- timeouts
Code
Engine App Timeouts
- app
Id string - (String) The identifier of the resource.
- Constraints: The maximum length is
36
characters. The minimum length is36
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}$/
.
- Constraints: The maximum length is
- build string
- (String) Reference to a build that is associated with the application.
- build
Run string - (String) Reference to a build run that is associated with the application.
- code
Engine stringApp Id - The unique identifier of the code_engine_app.
- computed
Env CodeVariables Engine App Computed Env Variable[] - (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 is0
items. Nested schema for computed_env_variables:
- Constraints: The maximum length is
- created
At 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'.
- endpoint
Internal string - (String) The URL to the app that is only visible within the project.
- entity
Tag 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 is1
character. The value must match regular expression/^[\\*\\-a-z0-9]+$/
.
- Constraints: The maximum length is
- etag string
- ETag identifier for code_engine_app.
- href string
- (String) When you provision a new app, a URL is created identifying the location of the instance.
- Constraints: The maximum length is
2048
characters. The minimum length is0
characters. The value must match regular expression/(([^:\/?#]+):)?(\/\/([^\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$/
.
- Constraints: The maximum length is
- image
Port number - Optional port the app listens on. While the app will always be exposed via port
443
for end users, this port is used to connect to the port that is exposed by the container image.- Constraints: The default value is
8080
.
- Constraints: The default value is
- image
Reference string - The name of the image that is used for this app. The format is
REGISTRY/NAMESPACE/REPOSITORY:TAG
whereREGISTRY
andTAG
are optional. IfREGISTRY
is not specified, the default isdocker.io
. IfTAG
is not specified, the default islatest
. If the image reference points to a registry that requires authentication, make sure to also specify the propertyimage_secret
.- Constraints: The maximum length is
256
characters. The minimum length is1
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})?$/
.
- Constraints: The maximum length is
- image
Secret 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 is1
character. The value must match regular expression/^a-z0-9?(\\.a-z0-9?)*$/
.
- Constraints: The maximum length is
- managed
Domain stringMappings - 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
.
- Constraints: The default value is
- name string
- The name of the app.
- Constraints: The maximum length is
63
characters. The minimum length is1
character. The value must match regular expression/^a-z?$/
.
- Constraints: The maximum length is
- probe
Liveness CodeEngine App Probe Liveness - Response model for probes. Nested schema for probe_liveness:
- probe
Readiness CodeEngine App Probe Readiness - Response model for probes. Nested schema for probe_readiness:
- project
Id string - The ID of the project.
- Constraints: The maximum length is
36
characters. The minimum length is36
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}$/
.
- Constraints: The maximum length is
- 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'.
- resource
Type string - (String) The type of the app.
- Constraints: Allowable values are:
app_v2
.
- Constraints: Allowable values are:
- run
Arguments string[] - Optional arguments for the app that are passed to start the container. If not specified an empty string array will be applied and the arguments specified by the container image, will be used to start the container.
- Constraints: The list items must match regular expression
/^.*$/
. The maximum length is100
items. The minimum length is0
items.
- Constraints: The list items must match regular expression
- run
As numberUser - Optional user ID (UID) to run the app.
- Constraints: The default value is
0
.
- Constraints: The default value is
- run
Commands string[] - Optional commands for the app that are passed to start the container. If not specified an empty string array will be applied and the command specified by the container image, will be used to start the container.
- Constraints: The list items must match regular expression
/^.*$/
. The maximum length is100
items. The minimum length is0
items.
- Constraints: The list items must match regular expression
- run
Env CodeVariables Engine App Run Env Variable[] - 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 is0
items. Nested schema for run_env_variables:
- Constraints: The maximum length is
- run
Service stringAccount - Optional name of the service account. For built-in service accounts, you can use the shortened names
manager
,none
,reader
, andwriter
.- Constraints: The default value is
default
. Allowable values are:default
,manager
,reader
,writer
,none
. The minimum length is0
characters. The value must match regular expression/^(manager|reader|writer|none|default)$/
.
- Constraints: The default value is
- run
Volume CodeMounts Engine App Run Volume Mount[] - Mounts of config maps or secrets.
- Constraints: The maximum length is
100
items. The minimum length is0
items. Nested schema for run_volume_mounts:
- Constraints: The maximum length is
- scale
Concurrency number - Optional maximum number of requests that can be processed concurrently per instance.
- Constraints: The default value is
100
.
- Constraints: The default value is
- scale
Concurrency numberTarget - 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 is1000
. The minimum value is1
.
- Constraints: The default value is
- scale
Cpu stringLimit - 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 is10
characters. The minimum length is0
characters. The value must match regular expression/^([0-9.]+)([eEinumkKMGTPB]*)$/
.
- Constraints: The default value is
- scale
Down numberDelay - 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 is3600
. The minimum value is0
.
- Constraints: The default value is
- scale
Ephemeral stringStorage Limit - 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 is10
characters. The minimum length is0
characters. The value must match regular expression/^([0-9.]+)([eEinumkKMGTPB]*)$/
.
- Constraints: The default value is
- scale
Initial numberInstances - Optional initial number of instances that are created upon app creation or app update.
- Constraints: The default value is
1
.
- Constraints: The default value is
- scale
Max numberInstances - 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
.
- Constraints: The default value is
- scale
Memory stringLimit - 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 is10
characters. The minimum length is0
characters. The value must match regular expression/^([0-9.]+)([eEinumkKMGTPB]*)$/
.
- Constraints: The default value is
- scale
Min numberInstances - 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
.
- Constraints: The default value is
- scale
Request numberTimeout - Optional amount of time in seconds that is allowed for a running app to respond to a request.
- Constraints: The default value is
300
.
- Constraints: The default value is
- status string
- (String) The current status of the app.
- Constraints: Allowable values are:
ready
,deploying
,failed
,warning
.
- Constraints: Allowable values are:
- status
Details CodeEngine App Status Detail[] - (List) The detailed status of the application. Nested schema for status_details:
- timeouts
Code
Engine App Timeouts
- app_
id str - (String) The identifier of the resource.
- Constraints: The maximum length is
36
characters. The minimum length is36
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}$/
.
- Constraints: The maximum length is
- build str
- (String) Reference to a build that is associated with the application.
- build_
run str - (String) Reference to a build run that is associated with the application.
- code_
engine_ strapp_ id - The unique identifier of the code_engine_app.
- computed_
env_ Sequence[Codevariables Engine App Computed Env Variable Args] - (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 is0
items. Nested schema for computed_env_variables:
- Constraints: The maximum length is
- 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 is1
character. The value must match regular expression/^[\\*\\-a-z0-9]+$/
.
- Constraints: The maximum length is
- etag str
- ETag identifier for code_engine_app.
- href str
- (String) When you provision a new app, a URL is created identifying the location of the instance.
- Constraints: The maximum length is
2048
characters. The minimum length is0
characters. The value must match regular expression/(([^:\/?#]+):)?(\/\/([^\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$/
.
- Constraints: The maximum length is
- image_
port float - Optional port the app listens on. While the app will always be exposed via port
443
for end users, this port is used to connect to the port that is exposed by the container image.- Constraints: The default value is
8080
.
- Constraints: The default value is
- image_
reference str - The name of the image that is used for this app. The format is
REGISTRY/NAMESPACE/REPOSITORY:TAG
whereREGISTRY
andTAG
are optional. IfREGISTRY
is not specified, the default isdocker.io
. IfTAG
is not specified, the default islatest
. If the image reference points to a registry that requires authentication, make sure to also specify the propertyimage_secret
.- Constraints: The maximum length is
256
characters. The minimum length is1
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})?$/
.
- Constraints: The maximum length is
- image_
secret str - Optional name of the image registry access secret. The image registry access secret is used to authenticate with a private registry when you download the container image. If the image reference points to a registry that requires authentication, the app will be created but cannot reach the ready status, until this property is provided, too.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^a-z0-9?(\\.a-z0-9?)*$/
.
- Constraints: The maximum length is
- managed_
domain_ strmappings - 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
.
- Constraints: The default value is
- name str
- The name of the app.
- Constraints: The maximum length is
63
characters. The minimum length is1
character. The value must match regular expression/^a-z?$/
.
- Constraints: The maximum length is
- probe_
liveness CodeEngine App Probe Liveness Args - Response model for probes. Nested schema for probe_liveness:
- probe_
readiness CodeEngine App Probe Readiness Args - Response model for probes. Nested schema for probe_readiness:
- project_
id str - The ID of the project.
- Constraints: The maximum length is
36
characters. The minimum length is36
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}$/
.
- Constraints: The maximum length is
- 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
.
- Constraints: Allowable values are:
- run_
arguments Sequence[str] - Optional arguments for the app that are passed to start the container. If not specified an empty string array will be applied and the arguments specified by the container image, will be used to start the container.
- Constraints: The list items must match regular expression
/^.*$/
. The maximum length is100
items. The minimum length is0
items.
- Constraints: The list items must match regular expression
- run_
as_ floatuser - Optional user ID (UID) to run the app.
- Constraints: The default value is
0
.
- Constraints: The default value is
- run_
commands Sequence[str] - Optional commands for the app that are passed to start the container. If not specified an empty string array will be applied and the command specified by the container image, will be used to start the container.
- Constraints: The list items must match regular expression
/^.*$/
. The maximum length is100
items. The minimum length is0
items.
- Constraints: The list items must match regular expression
- run_
env_ Sequence[Codevariables Engine App Run Env Variable Args] - 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 is0
items. Nested schema for run_env_variables:
- Constraints: The maximum length is
- run_
service_ straccount - Optional name of the service account. For built-in service accounts, you can use the shortened names
manager
,none
,reader
, andwriter
.- Constraints: The default value is
default
. Allowable values are:default
,manager
,reader
,writer
,none
. The minimum length is0
characters. The value must match regular expression/^(manager|reader|writer|none|default)$/
.
- Constraints: The default value is
- run_
volume_ Sequence[Codemounts Engine App Run Volume Mount Args] - Mounts of config maps or secrets.
- Constraints: The maximum length is
100
items. The minimum length is0
items. Nested schema for run_volume_mounts:
- Constraints: The maximum length is
- scale_
concurrency float - Optional maximum number of requests that can be processed concurrently per instance.
- Constraints: The default value is
100
.
- Constraints: The default value is
- scale_
concurrency_ floattarget - 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 is1000
. The minimum value is1
.
- Constraints: The default value is
- scale_
cpu_ strlimit - 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 is10
characters. The minimum length is0
characters. The value must match regular expression/^([0-9.]+)([eEinumkKMGTPB]*)$/
.
- Constraints: The default value is
- scale_
down_ floatdelay - 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 is3600
. The minimum value is0
.
- Constraints: The default value is
- scale_
ephemeral_ strstorage_ limit - 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 is10
characters. The minimum length is0
characters. The value must match regular expression/^([0-9.]+)([eEinumkKMGTPB]*)$/
.
- Constraints: The default value is
- scale_
initial_ floatinstances - Optional initial number of instances that are created upon app creation or app update.
- Constraints: The default value is
1
.
- Constraints: The default value is
- scale_
max_ floatinstances - 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
.
- Constraints: The default value is
- scale_
memory_ strlimit - 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 is10
characters. The minimum length is0
characters. The value must match regular expression/^([0-9.]+)([eEinumkKMGTPB]*)$/
.
- Constraints: The default value is
- scale_
min_ floatinstances - 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
.
- Constraints: The default value is
- scale_
request_ floattimeout - Optional amount of time in seconds that is allowed for a running app to respond to a request.
- Constraints: The default value is
300
.
- Constraints: The default value is
- status str
- (String) The current status of the app.
- Constraints: Allowable values are:
ready
,deploying
,failed
,warning
.
- Constraints: Allowable values are:
- status_
details Sequence[CodeEngine App Status Detail Args] - (List) The detailed status of the application. Nested schema for status_details:
- timeouts
Code
Engine App Timeouts Args
- app
Id String - (String) The identifier of the resource.
- Constraints: The maximum length is
36
characters. The minimum length is36
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}$/
.
- Constraints: The maximum length is
- build String
- (String) Reference to a build that is associated with the application.
- build
Run String - (String) Reference to a build run that is associated with the application.
- code
Engine StringApp Id - The unique identifier of the code_engine_app.
- computed
Env List<Property Map>Variables - (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 is0
items. Nested schema for computed_env_variables:
- Constraints: The maximum length is
- created
At 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'.
- endpoint
Internal String - (String) The URL to the app that is only visible within the project.
- entity
Tag 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 is1
character. The value must match regular expression/^[\\*\\-a-z0-9]+$/
.
- Constraints: The maximum length is
- etag String
- ETag identifier for code_engine_app.
- href String
- (String) When you provision a new app, a URL is created identifying the location of the instance.
- Constraints: The maximum length is
2048
characters. The minimum length is0
characters. The value must match regular expression/(([^:\/?#]+):)?(\/\/([^\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$/
.
- Constraints: The maximum length is
- image
Port Number - Optional port the app listens on. While the app will always be exposed via port
443
for end users, this port is used to connect to the port that is exposed by the container image.- Constraints: The default value is
8080
.
- Constraints: The default value is
- image
Reference String - The name of the image that is used for this app. The format is
REGISTRY/NAMESPACE/REPOSITORY:TAG
whereREGISTRY
andTAG
are optional. IfREGISTRY
is not specified, the default isdocker.io
. IfTAG
is not specified, the default islatest
. If the image reference points to a registry that requires authentication, make sure to also specify the propertyimage_secret
.- Constraints: The maximum length is
256
characters. The minimum length is1
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})?$/
.
- Constraints: The maximum length is
- image
Secret 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 is1
character. The value must match regular expression/^a-z0-9?(\\.a-z0-9?)*$/
.
- Constraints: The maximum length is
- managed
Domain StringMappings - 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
.
- Constraints: The default value is
- name String
- The name of the app.
- Constraints: The maximum length is
63
characters. The minimum length is1
character. The value must match regular expression/^a-z?$/
.
- Constraints: The maximum length is
- probe
Liveness Property Map - Response model for probes. Nested schema for probe_liveness:
- probe
Readiness Property Map - Response model for probes. Nested schema for probe_readiness:
- project
Id String - The ID of the project.
- Constraints: The maximum length is
36
characters. The minimum length is36
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}$/
.
- Constraints: The maximum length is
- 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'.
- resource
Type String - (String) The type of the app.
- Constraints: Allowable values are:
app_v2
.
- Constraints: Allowable values are:
- run
Arguments List<String> - Optional arguments for the app that are passed to start the container. If not specified an empty string array will be applied and the arguments specified by the container image, will be used to start the container.
- Constraints: The list items must match regular expression
/^.*$/
. The maximum length is100
items. The minimum length is0
items.
- Constraints: The list items must match regular expression
- run
As NumberUser - Optional user ID (UID) to run the app.
- Constraints: The default value is
0
.
- Constraints: The default value is
- run
Commands List<String> - Optional commands for the app that are passed to start the container. If not specified an empty string array will be applied and the command specified by the container image, will be used to start the container.
- Constraints: The list items must match regular expression
/^.*$/
. The maximum length is100
items. The minimum length is0
items.
- Constraints: The list items must match regular expression
- run
Env List<Property Map>Variables - 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 is0
items. Nested schema for run_env_variables:
- Constraints: The maximum length is
- run
Service StringAccount - Optional name of the service account. For built-in service accounts, you can use the shortened names
manager
,none
,reader
, andwriter
.- Constraints: The default value is
default
. Allowable values are:default
,manager
,reader
,writer
,none
. The minimum length is0
characters. The value must match regular expression/^(manager|reader|writer|none|default)$/
.
- Constraints: The default value is
- run
Volume List<Property Map>Mounts - Mounts of config maps or secrets.
- Constraints: The maximum length is
100
items. The minimum length is0
items. Nested schema for run_volume_mounts:
- Constraints: The maximum length is
- scale
Concurrency Number - Optional maximum number of requests that can be processed concurrently per instance.
- Constraints: The default value is
100
.
- Constraints: The default value is
- scale
Concurrency NumberTarget - 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 is1000
. The minimum value is1
.
- Constraints: The default value is
- scale
Cpu StringLimit - 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 is10
characters. The minimum length is0
characters. The value must match regular expression/^([0-9.]+)([eEinumkKMGTPB]*)$/
.
- Constraints: The default value is
- scale
Down NumberDelay - 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 is3600
. The minimum value is0
.
- Constraints: The default value is
- scale
Ephemeral StringStorage Limit - 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 is10
characters. The minimum length is0
characters. The value must match regular expression/^([0-9.]+)([eEinumkKMGTPB]*)$/
.
- Constraints: The default value is
- scale
Initial NumberInstances - Optional initial number of instances that are created upon app creation or app update.
- Constraints: The default value is
1
.
- Constraints: The default value is
- scale
Max NumberInstances - 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
.
- Constraints: The default value is
- scale
Memory StringLimit - 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 is10
characters. The minimum length is0
characters. The value must match regular expression/^([0-9.]+)([eEinumkKMGTPB]*)$/
.
- Constraints: The default value is
- scale
Min NumberInstances - 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
.
- Constraints: The default value is
- scale
Request NumberTimeout - Optional amount of time in seconds that is allowed for a running app to respond to a request.
- Constraints: The default value is
300
.
- Constraints: The default value is
- status String
- (String) The current status of the app.
- Constraints: Allowable values are:
ready
,deploying
,failed
,warning
.
- Constraints: Allowable values are:
- status
Details List<Property Map> - (List) The detailed status of the application. Nested schema for status_details:
- timeouts Property Map
Supporting Types
CodeEngineAppComputedEnvVariable, CodeEngineAppComputedEnvVariableArgs
- Key string
- (String) The key to reference as environment variable.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^[\\-._a-zA-Z0-9]+$/
.
- Constraints: The maximum length is
- Name string
- The name of the app.
- Constraints: The maximum length is
63
characters. The minimum length is1
character. The value must match regular expression/^a-z?$/
.
- Constraints: The maximum length is
- Prefix 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 is0
characters. The value must match regular expression/^[a-zA-Z_][a-zA-Z0-9_]*$/
.
- Constraints: The maximum length is
- Reference string
- (String) The name of the secret or config map.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^a-z0-9?(\\.a-z0-9?)*$/
.
- Constraints: The maximum length is
- Type string
- (String) Specify the type of the environment variable.
- Constraints: The default value is
literal
. Allowable values are:literal
,config_map_full_reference
,secret_full_reference
,config_map_key_reference
,secret_key_reference
. The value must match regular expression/^(literal|config_map_full_reference|secret_full_reference|config_map_key_reference|secret_key_reference)$/
.
- Constraints: The default value is
- Value string
- (String) The literal value of the environment variable.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^[\\-._a-zA-Z0-9]+$/
.
- Constraints: The maximum length is
- Key string
- (String) The key to reference as environment variable.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^[\\-._a-zA-Z0-9]+$/
.
- Constraints: The maximum length is
- Name string
- The name of the app.
- Constraints: The maximum length is
63
characters. The minimum length is1
character. The value must match regular expression/^a-z?$/
.
- Constraints: The maximum length is
- Prefix 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 is0
characters. The value must match regular expression/^[a-zA-Z_][a-zA-Z0-9_]*$/
.
- Constraints: The maximum length is
- Reference string
- (String) The name of the secret or config map.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^a-z0-9?(\\.a-z0-9?)*$/
.
- Constraints: The maximum length is
- Type string
- (String) Specify the type of the environment variable.
- Constraints: The default value is
literal
. Allowable values are:literal
,config_map_full_reference
,secret_full_reference
,config_map_key_reference
,secret_key_reference
. The value must match regular expression/^(literal|config_map_full_reference|secret_full_reference|config_map_key_reference|secret_key_reference)$/
.
- Constraints: The default value is
- Value string
- (String) The literal value of the environment variable.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^[\\-._a-zA-Z0-9]+$/
.
- Constraints: The maximum length is
- key String
- (String) The key to reference as environment variable.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^[\\-._a-zA-Z0-9]+$/
.
- Constraints: The maximum length is
- name String
- The name of the app.
- Constraints: The maximum length is
63
characters. The minimum length is1
character. The value must match regular expression/^a-z?$/
.
- Constraints: The maximum length is
- prefix 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 is0
characters. The value must match regular expression/^[a-zA-Z_][a-zA-Z0-9_]*$/
.
- Constraints: The maximum length is
- reference String
- (String) The name of the secret or config map.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^a-z0-9?(\\.a-z0-9?)*$/
.
- Constraints: The maximum length is
- type String
- (String) Specify the type of the environment variable.
- Constraints: The default value is
literal
. Allowable values are:literal
,config_map_full_reference
,secret_full_reference
,config_map_key_reference
,secret_key_reference
. The value must match regular expression/^(literal|config_map_full_reference|secret_full_reference|config_map_key_reference|secret_key_reference)$/
.
- Constraints: The default value is
- value String
- (String) The literal value of the environment variable.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^[\\-._a-zA-Z0-9]+$/
.
- Constraints: The maximum length is
- key string
- (String) The key to reference as environment variable.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^[\\-._a-zA-Z0-9]+$/
.
- Constraints: The maximum length is
- name string
- The name of the app.
- Constraints: The maximum length is
63
characters. The minimum length is1
character. The value must match regular expression/^a-z?$/
.
- Constraints: The maximum length is
- prefix 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 is0
characters. The value must match regular expression/^[a-zA-Z_][a-zA-Z0-9_]*$/
.
- Constraints: The maximum length is
- reference string
- (String) The name of the secret or config map.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^a-z0-9?(\\.a-z0-9?)*$/
.
- Constraints: The maximum length is
- type string
- (String) Specify the type of the environment variable.
- Constraints: The default value is
literal
. Allowable values are:literal
,config_map_full_reference
,secret_full_reference
,config_map_key_reference
,secret_key_reference
. The value must match regular expression/^(literal|config_map_full_reference|secret_full_reference|config_map_key_reference|secret_key_reference)$/
.
- Constraints: The default value is
- value string
- (String) The literal value of the environment variable.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^[\\-._a-zA-Z0-9]+$/
.
- Constraints: The maximum length is
- key str
- (String) The key to reference as environment variable.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^[\\-._a-zA-Z0-9]+$/
.
- Constraints: The maximum length is
- name str
- The name of the app.
- Constraints: The maximum length is
63
characters. The minimum length is1
character. The value must match regular expression/^a-z?$/
.
- Constraints: The maximum length is
- prefix 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 is0
characters. The value must match regular expression/^[a-zA-Z_][a-zA-Z0-9_]*$/
.
- Constraints: The maximum length is
- reference str
- (String) The name of the secret or config map.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^a-z0-9?(\\.a-z0-9?)*$/
.
- Constraints: The maximum length is
- type str
- (String) Specify the type of the environment variable.
- Constraints: The default value is
literal
. Allowable values are:literal
,config_map_full_reference
,secret_full_reference
,config_map_key_reference
,secret_key_reference
. The value must match regular expression/^(literal|config_map_full_reference|secret_full_reference|config_map_key_reference|secret_key_reference)$/
.
- Constraints: The default value is
- value str
- (String) The literal value of the environment variable.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^[\\-._a-zA-Z0-9]+$/
.
- Constraints: The maximum length is
- key String
- (String) The key to reference as environment variable.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^[\\-._a-zA-Z0-9]+$/
.
- Constraints: The maximum length is
- name String
- The name of the app.
- Constraints: The maximum length is
63
characters. The minimum length is1
character. The value must match regular expression/^a-z?$/
.
- Constraints: The maximum length is
- prefix 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 is0
characters. The value must match regular expression/^[a-zA-Z_][a-zA-Z0-9_]*$/
.
- Constraints: The maximum length is
- reference String
- (String) The name of the secret or config map.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^a-z0-9?(\\.a-z0-9?)*$/
.
- Constraints: The maximum length is
- type String
- (String) Specify the type of the environment variable.
- Constraints: The default value is
literal
. Allowable values are:literal
,config_map_full_reference
,secret_full_reference
,config_map_key_reference
,secret_key_reference
. The value must match regular expression/^(literal|config_map_full_reference|secret_full_reference|config_map_key_reference|secret_key_reference)$/
.
- Constraints: The default value is
- value String
- (String) The literal value of the environment variable.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^[\\-._a-zA-Z0-9]+$/
.
- Constraints: The maximum length is
CodeEngineAppProbeLiveness, CodeEngineAppProbeLivenessArgs
- Failure
Threshold double - The number of consecutive, unsuccessful checks for the probe to be considered failed.
- Constraints: The default value is
1
. The maximum value is10
. The minimum value is1
.
- Constraints: The default value is
- Initial
Delay double - The amount of time in seconds to wait before the first probe check is performed.
- Constraints: The maximum value is
10
. The minimum value is1
.
- Constraints: The maximum value is
- Interval double
- The amount of time in seconds between probe checks.
- Constraints: The default value is
10
. The maximum value is60
. The minimum value is1
.
- Constraints: The default value is
- Path string
- The path of the HTTP request to the resource. A path is only supported for a probe with a
type
ofhttp
.- Constraints: The maximum length is
2048
characters. The minimum length is0
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})*)?$/
.
- Constraints: The maximum length is
- Port double
- The port on which to probe the resource.
- Constraints: The maximum value is
65535
. The minimum value is1
.
- Constraints: The maximum value is
- Timeout double
- The amount of time in seconds that the probe waits for a response from the application before it times out and fails.
- Constraints: The default value is
1
. The maximum value is3600
. The minimum value is1
.
- Constraints: The default value is
- Type string
- Specifies whether to use HTTP or TCP for the probe checks. The default is TCP.
- Constraints: Allowable values are:
tcp
,http
.
- Constraints: Allowable values are:
- Failure
Threshold float64 - The number of consecutive, unsuccessful checks for the probe to be considered failed.
- Constraints: The default value is
1
. The maximum value is10
. The minimum value is1
.
- Constraints: The default value is
- Initial
Delay float64 - The amount of time in seconds to wait before the first probe check is performed.
- Constraints: The maximum value is
10
. The minimum value is1
.
- Constraints: The maximum value is
- Interval float64
- The amount of time in seconds between probe checks.
- Constraints: The default value is
10
. The maximum value is60
. The minimum value is1
.
- Constraints: The default value is
- Path string
- The path of the HTTP request to the resource. A path is only supported for a probe with a
type
ofhttp
.- Constraints: The maximum length is
2048
characters. The minimum length is0
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})*)?$/
.
- Constraints: The maximum length is
- Port float64
- The port on which to probe the resource.
- Constraints: The maximum value is
65535
. The minimum value is1
.
- Constraints: The maximum value is
- Timeout float64
- The amount of time in seconds that the probe waits for a response from the application before it times out and fails.
- Constraints: The default value is
1
. The maximum value is3600
. The minimum value is1
.
- Constraints: The default value is
- Type string
- Specifies whether to use HTTP or TCP for the probe checks. The default is TCP.
- Constraints: Allowable values are:
tcp
,http
.
- Constraints: Allowable values are:
- failure
Threshold Double - The number of consecutive, unsuccessful checks for the probe to be considered failed.
- Constraints: The default value is
1
. The maximum value is10
. The minimum value is1
.
- Constraints: The default value is
- initial
Delay Double - The amount of time in seconds to wait before the first probe check is performed.
- Constraints: The maximum value is
10
. The minimum value is1
.
- Constraints: The maximum value is
- interval Double
- The amount of time in seconds between probe checks.
- Constraints: The default value is
10
. The maximum value is60
. The minimum value is1
.
- Constraints: The default value is
- path String
- The path of the HTTP request to the resource. A path is only supported for a probe with a
type
ofhttp
.- Constraints: The maximum length is
2048
characters. The minimum length is0
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})*)?$/
.
- Constraints: The maximum length is
- port Double
- The port on which to probe the resource.
- Constraints: The maximum value is
65535
. The minimum value is1
.
- Constraints: The maximum value is
- timeout Double
- The amount of time in seconds that the probe waits for a response from the application before it times out and fails.
- Constraints: The default value is
1
. The maximum value is3600
. The minimum value is1
.
- Constraints: The default value is
- type String
- Specifies whether to use HTTP or TCP for the probe checks. The default is TCP.
- Constraints: Allowable values are:
tcp
,http
.
- Constraints: Allowable values are:
- failure
Threshold number - The number of consecutive, unsuccessful checks for the probe to be considered failed.
- Constraints: The default value is
1
. The maximum value is10
. The minimum value is1
.
- Constraints: The default value is
- initial
Delay number - The amount of time in seconds to wait before the first probe check is performed.
- Constraints: The maximum value is
10
. The minimum value is1
.
- Constraints: The maximum value is
- interval number
- The amount of time in seconds between probe checks.
- Constraints: The default value is
10
. The maximum value is60
. The minimum value is1
.
- Constraints: The default value is
- path string
- The path of the HTTP request to the resource. A path is only supported for a probe with a
type
ofhttp
.- Constraints: The maximum length is
2048
characters. The minimum length is0
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})*)?$/
.
- Constraints: The maximum length is
- port number
- The port on which to probe the resource.
- Constraints: The maximum value is
65535
. The minimum value is1
.
- Constraints: The maximum value is
- timeout number
- The amount of time in seconds that the probe waits for a response from the application before it times out and fails.
- Constraints: The default value is
1
. The maximum value is3600
. The minimum value is1
.
- Constraints: The default value is
- type string
- Specifies whether to use HTTP or TCP for the probe checks. The default is TCP.
- Constraints: Allowable values are:
tcp
,http
.
- Constraints: Allowable values are:
- failure_
threshold float - The number of consecutive, unsuccessful checks for the probe to be considered failed.
- Constraints: The default value is
1
. The maximum value is10
. The minimum value is1
.
- Constraints: The default value is
- initial_
delay float - The amount of time in seconds to wait before the first probe check is performed.
- Constraints: The maximum value is
10
. The minimum value is1
.
- Constraints: The maximum value is
- interval float
- The amount of time in seconds between probe checks.
- Constraints: The default value is
10
. The maximum value is60
. The minimum value is1
.
- Constraints: The default value is
- path str
- The path of the HTTP request to the resource. A path is only supported for a probe with a
type
ofhttp
.- Constraints: The maximum length is
2048
characters. The minimum length is0
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})*)?$/
.
- Constraints: The maximum length is
- port float
- The port on which to probe the resource.
- Constraints: The maximum value is
65535
. The minimum value is1
.
- Constraints: The maximum value is
- timeout float
- The amount of time in seconds that the probe waits for a response from the application before it times out and fails.
- Constraints: The default value is
1
. The maximum value is3600
. The minimum value is1
.
- Constraints: The default value is
- type str
- Specifies whether to use HTTP or TCP for the probe checks. The default is TCP.
- Constraints: Allowable values are:
tcp
,http
.
- Constraints: Allowable values are:
- failure
Threshold Number - The number of consecutive, unsuccessful checks for the probe to be considered failed.
- Constraints: The default value is
1
. The maximum value is10
. The minimum value is1
.
- Constraints: The default value is
- initial
Delay Number - The amount of time in seconds to wait before the first probe check is performed.
- Constraints: The maximum value is
10
. The minimum value is1
.
- Constraints: The maximum value is
- interval Number
- The amount of time in seconds between probe checks.
- Constraints: The default value is
10
. The maximum value is60
. The minimum value is1
.
- Constraints: The default value is
- path String
- The path of the HTTP request to the resource. A path is only supported for a probe with a
type
ofhttp
.- Constraints: The maximum length is
2048
characters. The minimum length is0
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})*)?$/
.
- Constraints: The maximum length is
- port Number
- The port on which to probe the resource.
- Constraints: The maximum value is
65535
. The minimum value is1
.
- Constraints: The maximum value is
- timeout Number
- The amount of time in seconds that the probe waits for a response from the application before it times out and fails.
- Constraints: The default value is
1
. The maximum value is3600
. The minimum value is1
.
- Constraints: The default value is
- type String
- Specifies whether to use HTTP or TCP for the probe checks. The default is TCP.
- Constraints: Allowable values are:
tcp
,http
.
- Constraints: Allowable values are:
CodeEngineAppProbeReadiness, CodeEngineAppProbeReadinessArgs
- Failure
Threshold double - The number of consecutive, unsuccessful checks for the probe to be considered failed.
- Constraints: The default value is
1
. The maximum value is10
. The minimum value is1
.
- Constraints: The default value is
- Initial
Delay double - The amount of time in seconds to wait before the first probe check is performed.
- Constraints: The maximum value is
10
. The minimum value is1
.
- Constraints: The maximum value is
- Interval double
- The amount of time in seconds between probe checks.
- Constraints: The default value is
10
. The maximum value is60
. The minimum value is1
.
- Constraints: The default value is
- Path string
- The path of the HTTP request to the resource. A path is only supported for a probe with a
type
ofhttp
.- Constraints: The maximum length is
2048
characters. The minimum length is0
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})*)?$/
.
- Constraints: The maximum length is
- Port double
- The port on which to probe the resource.
- Constraints: The maximum value is
65535
. The minimum value is1
.
- Constraints: The maximum value is
- Timeout double
- The amount of time in seconds that the probe waits for a response from the application before it times out and fails.
- Constraints: The default value is
1
. The maximum value is3600
. The minimum value is1
.
- Constraints: The default value is
- Type string
- Specifies whether to use HTTP or TCP for the probe checks. The default is TCP.
- Constraints: Allowable values are:
tcp
,http
.
- Constraints: Allowable values are:
- Failure
Threshold float64 - The number of consecutive, unsuccessful checks for the probe to be considered failed.
- Constraints: The default value is
1
. The maximum value is10
. The minimum value is1
.
- Constraints: The default value is
- Initial
Delay float64 - The amount of time in seconds to wait before the first probe check is performed.
- Constraints: The maximum value is
10
. The minimum value is1
.
- Constraints: The maximum value is
- Interval float64
- The amount of time in seconds between probe checks.
- Constraints: The default value is
10
. The maximum value is60
. The minimum value is1
.
- Constraints: The default value is
- Path string
- The path of the HTTP request to the resource. A path is only supported for a probe with a
type
ofhttp
.- Constraints: The maximum length is
2048
characters. The minimum length is0
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})*)?$/
.
- Constraints: The maximum length is
- Port float64
- The port on which to probe the resource.
- Constraints: The maximum value is
65535
. The minimum value is1
.
- Constraints: The maximum value is
- Timeout float64
- The amount of time in seconds that the probe waits for a response from the application before it times out and fails.
- Constraints: The default value is
1
. The maximum value is3600
. The minimum value is1
.
- Constraints: The default value is
- Type string
- Specifies whether to use HTTP or TCP for the probe checks. The default is TCP.
- Constraints: Allowable values are:
tcp
,http
.
- Constraints: Allowable values are:
- failure
Threshold Double - The number of consecutive, unsuccessful checks for the probe to be considered failed.
- Constraints: The default value is
1
. The maximum value is10
. The minimum value is1
.
- Constraints: The default value is
- initial
Delay Double - The amount of time in seconds to wait before the first probe check is performed.
- Constraints: The maximum value is
10
. The minimum value is1
.
- Constraints: The maximum value is
- interval Double
- The amount of time in seconds between probe checks.
- Constraints: The default value is
10
. The maximum value is60
. The minimum value is1
.
- Constraints: The default value is
- path String
- The path of the HTTP request to the resource. A path is only supported for a probe with a
type
ofhttp
.- Constraints: The maximum length is
2048
characters. The minimum length is0
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})*)?$/
.
- Constraints: The maximum length is
- port Double
- The port on which to probe the resource.
- Constraints: The maximum value is
65535
. The minimum value is1
.
- Constraints: The maximum value is
- timeout Double
- The amount of time in seconds that the probe waits for a response from the application before it times out and fails.
- Constraints: The default value is
1
. The maximum value is3600
. The minimum value is1
.
- Constraints: The default value is
- type String
- Specifies whether to use HTTP or TCP for the probe checks. The default is TCP.
- Constraints: Allowable values are:
tcp
,http
.
- Constraints: Allowable values are:
- failure
Threshold number - The number of consecutive, unsuccessful checks for the probe to be considered failed.
- Constraints: The default value is
1
. The maximum value is10
. The minimum value is1
.
- Constraints: The default value is
- initial
Delay number - The amount of time in seconds to wait before the first probe check is performed.
- Constraints: The maximum value is
10
. The minimum value is1
.
- Constraints: The maximum value is
- interval number
- The amount of time in seconds between probe checks.
- Constraints: The default value is
10
. The maximum value is60
. The minimum value is1
.
- Constraints: The default value is
- path string
- The path of the HTTP request to the resource. A path is only supported for a probe with a
type
ofhttp
.- Constraints: The maximum length is
2048
characters. The minimum length is0
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})*)?$/
.
- Constraints: The maximum length is
- port number
- The port on which to probe the resource.
- Constraints: The maximum value is
65535
. The minimum value is1
.
- Constraints: The maximum value is
- timeout number
- The amount of time in seconds that the probe waits for a response from the application before it times out and fails.
- Constraints: The default value is
1
. The maximum value is3600
. The minimum value is1
.
- Constraints: The default value is
- type string
- Specifies whether to use HTTP or TCP for the probe checks. The default is TCP.
- Constraints: Allowable values are:
tcp
,http
.
- Constraints: Allowable values are:
- failure_
threshold float - The number of consecutive, unsuccessful checks for the probe to be considered failed.
- Constraints: The default value is
1
. The maximum value is10
. The minimum value is1
.
- Constraints: The default value is
- initial_
delay float - The amount of time in seconds to wait before the first probe check is performed.
- Constraints: The maximum value is
10
. The minimum value is1
.
- Constraints: The maximum value is
- interval float
- The amount of time in seconds between probe checks.
- Constraints: The default value is
10
. The maximum value is60
. The minimum value is1
.
- Constraints: The default value is
- path str
- The path of the HTTP request to the resource. A path is only supported for a probe with a
type
ofhttp
.- Constraints: The maximum length is
2048
characters. The minimum length is0
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})*)?$/
.
- Constraints: The maximum length is
- port float
- The port on which to probe the resource.
- Constraints: The maximum value is
65535
. The minimum value is1
.
- Constraints: The maximum value is
- timeout float
- The amount of time in seconds that the probe waits for a response from the application before it times out and fails.
- Constraints: The default value is
1
. The maximum value is3600
. The minimum value is1
.
- Constraints: The default value is
- type str
- Specifies whether to use HTTP or TCP for the probe checks. The default is TCP.
- Constraints: Allowable values are:
tcp
,http
.
- Constraints: Allowable values are:
- failure
Threshold Number - The number of consecutive, unsuccessful checks for the probe to be considered failed.
- Constraints: The default value is
1
. The maximum value is10
. The minimum value is1
.
- Constraints: The default value is
- initial
Delay Number - The amount of time in seconds to wait before the first probe check is performed.
- Constraints: The maximum value is
10
. The minimum value is1
.
- Constraints: The maximum value is
- interval Number
- The amount of time in seconds between probe checks.
- Constraints: The default value is
10
. The maximum value is60
. The minimum value is1
.
- Constraints: The default value is
- path String
- The path of the HTTP request to the resource. A path is only supported for a probe with a
type
ofhttp
.- Constraints: The maximum length is
2048
characters. The minimum length is0
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})*)?$/
.
- Constraints: The maximum length is
- port Number
- The port on which to probe the resource.
- Constraints: The maximum value is
65535
. The minimum value is1
.
- Constraints: The maximum value is
- timeout Number
- The amount of time in seconds that the probe waits for a response from the application before it times out and fails.
- Constraints: The default value is
1
. The maximum value is3600
. The minimum value is1
.
- Constraints: The default value is
- type String
- Specifies whether to use HTTP or TCP for the probe checks. The default is TCP.
- Constraints: Allowable values are:
tcp
,http
.
- Constraints: Allowable values are:
CodeEngineAppRunEnvVariable, CodeEngineAppRunEnvVariableArgs
- Key string
- The key to reference as environment variable.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^[\\-._a-zA-Z0-9]+$/
.
- Constraints: The maximum length is
- Name string
- The name of the environment variable.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^[\\-._a-zA-Z0-9]+$/
.
- Constraints: The maximum length is
- Prefix string
- A prefix that can be added to all keys of a full secret or config map reference.
- Constraints: The maximum length is
253
characters. The minimum length is0
characters. The value must match regular expression/^[a-zA-Z_][a-zA-Z0-9_]*$/
.
- Constraints: The maximum length is
- Reference string
- The name of the secret or config map.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^a-z0-9?(\\.a-z0-9?)*$/
.
- Constraints: The maximum length is
- Type string
- Specify the type of the environment variable.
- Constraints: The default value is
literal
. Allowable values are:literal
,config_map_full_reference
,secret_full_reference
,config_map_key_reference
,secret_key_reference
. The value must match regular expression/^(literal|config_map_full_reference|secret_full_reference|config_map_key_reference|secret_key_reference)$/
. When referencing a secret or configmap, thereference
must be specified. When referencing a secret or configmap key, akey
must also be specified.
- Constraints: The default value is
- Value string
- The literal value of the environment variable.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^[\\-._a-zA-Z0-9]+$/
.
- Constraints: The maximum length is
- Key string
- The key to reference as environment variable.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^[\\-._a-zA-Z0-9]+$/
.
- Constraints: The maximum length is
- Name string
- The name of the environment variable.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^[\\-._a-zA-Z0-9]+$/
.
- Constraints: The maximum length is
- Prefix string
- A prefix that can be added to all keys of a full secret or config map reference.
- Constraints: The maximum length is
253
characters. The minimum length is0
characters. The value must match regular expression/^[a-zA-Z_][a-zA-Z0-9_]*$/
.
- Constraints: The maximum length is
- Reference string
- The name of the secret or config map.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^a-z0-9?(\\.a-z0-9?)*$/
.
- Constraints: The maximum length is
- Type string
- Specify the type of the environment variable.
- Constraints: The default value is
literal
. Allowable values are:literal
,config_map_full_reference
,secret_full_reference
,config_map_key_reference
,secret_key_reference
. The value must match regular expression/^(literal|config_map_full_reference|secret_full_reference|config_map_key_reference|secret_key_reference)$/
. When referencing a secret or configmap, thereference
must be specified. When referencing a secret or configmap key, akey
must also be specified.
- Constraints: The default value is
- Value string
- The literal value of the environment variable.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^[\\-._a-zA-Z0-9]+$/
.
- Constraints: The maximum length is
- key String
- The key to reference as environment variable.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^[\\-._a-zA-Z0-9]+$/
.
- Constraints: The maximum length is
- name String
- The name of the environment variable.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^[\\-._a-zA-Z0-9]+$/
.
- Constraints: The maximum length is
- prefix String
- A prefix that can be added to all keys of a full secret or config map reference.
- Constraints: The maximum length is
253
characters. The minimum length is0
characters. The value must match regular expression/^[a-zA-Z_][a-zA-Z0-9_]*$/
.
- Constraints: The maximum length is
- reference String
- The name of the secret or config map.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^a-z0-9?(\\.a-z0-9?)*$/
.
- Constraints: The maximum length is
- type String
- Specify the type of the environment variable.
- Constraints: The default value is
literal
. Allowable values are:literal
,config_map_full_reference
,secret_full_reference
,config_map_key_reference
,secret_key_reference
. The value must match regular expression/^(literal|config_map_full_reference|secret_full_reference|config_map_key_reference|secret_key_reference)$/
. When referencing a secret or configmap, thereference
must be specified. When referencing a secret or configmap key, akey
must also be specified.
- Constraints: The default value is
- value String
- The literal value of the environment variable.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^[\\-._a-zA-Z0-9]+$/
.
- Constraints: The maximum length is
- key string
- The key to reference as environment variable.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^[\\-._a-zA-Z0-9]+$/
.
- Constraints: The maximum length is
- name string
- The name of the environment variable.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^[\\-._a-zA-Z0-9]+$/
.
- Constraints: The maximum length is
- prefix string
- A prefix that can be added to all keys of a full secret or config map reference.
- Constraints: The maximum length is
253
characters. The minimum length is0
characters. The value must match regular expression/^[a-zA-Z_][a-zA-Z0-9_]*$/
.
- Constraints: The maximum length is
- reference string
- The name of the secret or config map.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^a-z0-9?(\\.a-z0-9?)*$/
.
- Constraints: The maximum length is
- type string
- Specify the type of the environment variable.
- Constraints: The default value is
literal
. Allowable values are:literal
,config_map_full_reference
,secret_full_reference
,config_map_key_reference
,secret_key_reference
. The value must match regular expression/^(literal|config_map_full_reference|secret_full_reference|config_map_key_reference|secret_key_reference)$/
. When referencing a secret or configmap, thereference
must be specified. When referencing a secret or configmap key, akey
must also be specified.
- Constraints: The default value is
- value string
- The literal value of the environment variable.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^[\\-._a-zA-Z0-9]+$/
.
- Constraints: The maximum length is
- key str
- The key to reference as environment variable.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^[\\-._a-zA-Z0-9]+$/
.
- Constraints: The maximum length is
- name str
- The name of the environment variable.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^[\\-._a-zA-Z0-9]+$/
.
- Constraints: The maximum length is
- prefix str
- A prefix that can be added to all keys of a full secret or config map reference.
- Constraints: The maximum length is
253
characters. The minimum length is0
characters. The value must match regular expression/^[a-zA-Z_][a-zA-Z0-9_]*$/
.
- Constraints: The maximum length is
- reference str
- The name of the secret or config map.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^a-z0-9?(\\.a-z0-9?)*$/
.
- Constraints: The maximum length is
- type str
- Specify the type of the environment variable.
- Constraints: The default value is
literal
. Allowable values are:literal
,config_map_full_reference
,secret_full_reference
,config_map_key_reference
,secret_key_reference
. The value must match regular expression/^(literal|config_map_full_reference|secret_full_reference|config_map_key_reference|secret_key_reference)$/
. When referencing a secret or configmap, thereference
must be specified. When referencing a secret or configmap key, akey
must also be specified.
- Constraints: The default value is
- value str
- The literal value of the environment variable.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^[\\-._a-zA-Z0-9]+$/
.
- Constraints: The maximum length is
- key String
- The key to reference as environment variable.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^[\\-._a-zA-Z0-9]+$/
.
- Constraints: The maximum length is
- name String
- The name of the environment variable.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^[\\-._a-zA-Z0-9]+$/
.
- Constraints: The maximum length is
- prefix String
- A prefix that can be added to all keys of a full secret or config map reference.
- Constraints: The maximum length is
253
characters. The minimum length is0
characters. The value must match regular expression/^[a-zA-Z_][a-zA-Z0-9_]*$/
.
- Constraints: The maximum length is
- reference String
- The name of the secret or config map.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^a-z0-9?(\\.a-z0-9?)*$/
.
- Constraints: The maximum length is
- type String
- Specify the type of the environment variable.
- Constraints: The default value is
literal
. Allowable values are:literal
,config_map_full_reference
,secret_full_reference
,config_map_key_reference
,secret_key_reference
. The value must match regular expression/^(literal|config_map_full_reference|secret_full_reference|config_map_key_reference|secret_key_reference)$/
. When referencing a secret or configmap, thereference
must be specified. When referencing a secret or configmap key, akey
must also be specified.
- Constraints: The default value is
- value String
- The literal value of the environment variable.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^[\\-._a-zA-Z0-9]+$/
.
- Constraints: The maximum length is
CodeEngineAppRunVolumeMount, CodeEngineAppRunVolumeMountArgs
- Mount
Path string - The path that should be mounted.
- Constraints: The maximum length is
256
characters. The minimum length is1
character. The value must match regular expression/^\/([^\/\\0]+\/?)+$/
.
- Constraints: The maximum length is
- Name string
- The name of the mount.
- Constraints: The maximum length is
63
characters. The minimum length is0
characters. The value must match regular expression/^a-z?$/
.
- Constraints: The maximum length is
- Reference string
- The name of the referenced secret or config map.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^a-z0-9?(\\.a-z0-9?)*$/
.
- Constraints: The maximum length is
- Type 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)$/
.
- Constraints: The default value is
- Mount
Path string - The path that should be mounted.
- Constraints: The maximum length is
256
characters. The minimum length is1
character. The value must match regular expression/^\/([^\/\\0]+\/?)+$/
.
- Constraints: The maximum length is
- Name string
- The name of the mount.
- Constraints: The maximum length is
63
characters. The minimum length is0
characters. The value must match regular expression/^a-z?$/
.
- Constraints: The maximum length is
- Reference string
- The name of the referenced secret or config map.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^a-z0-9?(\\.a-z0-9?)*$/
.
- Constraints: The maximum length is
- Type 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)$/
.
- Constraints: The default value is
- mount
Path String - The path that should be mounted.
- Constraints: The maximum length is
256
characters. The minimum length is1
character. The value must match regular expression/^\/([^\/\\0]+\/?)+$/
.
- Constraints: The maximum length is
- name String
- The name of the mount.
- Constraints: The maximum length is
63
characters. The minimum length is0
characters. The value must match regular expression/^a-z?$/
.
- Constraints: The maximum length is
- reference String
- The name of the referenced secret or config map.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^a-z0-9?(\\.a-z0-9?)*$/
.
- Constraints: The maximum length is
- type 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)$/
.
- Constraints: The default value is
- mount
Path string - The path that should be mounted.
- Constraints: The maximum length is
256
characters. The minimum length is1
character. The value must match regular expression/^\/([^\/\\0]+\/?)+$/
.
- Constraints: The maximum length is
- name string
- The name of the mount.
- Constraints: The maximum length is
63
characters. The minimum length is0
characters. The value must match regular expression/^a-z?$/
.
- Constraints: The maximum length is
- reference string
- The name of the referenced secret or config map.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^a-z0-9?(\\.a-z0-9?)*$/
.
- Constraints: The maximum length is
- type 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)$/
.
- Constraints: The default value is
- mount_
path str - The path that should be mounted.
- Constraints: The maximum length is
256
characters. The minimum length is1
character. The value must match regular expression/^\/([^\/\\0]+\/?)+$/
.
- Constraints: The maximum length is
- name str
- The name of the mount.
- Constraints: The maximum length is
63
characters. The minimum length is0
characters. The value must match regular expression/^a-z?$/
.
- Constraints: The maximum length is
- reference str
- The name of the referenced secret or config map.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^a-z0-9?(\\.a-z0-9?)*$/
.
- Constraints: The maximum length is
- type str
- Specify the type of the volume mount. Allowed types are: 'config_map', 'secret'.
- Constraints: The default value is
secret
. Allowable values are:config_map
,secret
. The value must match regular expression/^(config_map|secret)$/
.
- Constraints: The default value is
- mount
Path String - The path that should be mounted.
- Constraints: The maximum length is
256
characters. The minimum length is1
character. The value must match regular expression/^\/([^\/\\0]+\/?)+$/
.
- Constraints: The maximum length is
- name String
- The name of the mount.
- Constraints: The maximum length is
63
characters. The minimum length is0
characters. The value must match regular expression/^a-z?$/
.
- Constraints: The maximum length is
- reference String
- The name of the referenced secret or config map.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^a-z0-9?(\\.a-z0-9?)*$/
.
- Constraints: The maximum length is
- type 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)$/
.
- Constraints: The default value is
CodeEngineAppStatusDetail, CodeEngineAppStatusDetailArgs
- Latest
Created stringRevision - (String) Latest app revision that has been created.
- Latest
Ready stringRevision - (String) Latest app revision that reached a ready state.
- Reason 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
.
- Constraints: Allowable values are:
- Latest
Created stringRevision - (String) Latest app revision that has been created.
- Latest
Ready stringRevision - (String) Latest app revision that reached a ready state.
- Reason 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
.
- Constraints: Allowable values are:
- latest
Created StringRevision - (String) Latest app revision that has been created.
- latest
Ready StringRevision - (String) Latest app revision that reached a ready state.
- reason 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
.
- Constraints: Allowable values are:
- latest
Created stringRevision - (String) Latest app revision that has been created.
- latest
Ready stringRevision - (String) Latest app revision that reached a ready state.
- reason 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
.
- Constraints: Allowable values are:
- latest_
created_ strrevision - (String) Latest app revision that has been created.
- latest_
ready_ strrevision - (String) Latest app revision that reached a ready state.
- reason 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
.
- Constraints: Allowable values are:
- latest
Created StringRevision - (String) Latest app revision that has been created.
- latest
Ready StringRevision - (String) Latest app revision that reached a ready state.
- reason 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
.
- Constraints: Allowable values are:
CodeEngineAppTimeouts, CodeEngineAppTimeoutsArgs
Import
You can import the ibm_code_engine_app
resource by using name
.
The name
property can be formed from project_id
, and name
in the following format:
<project_id>/<name>
project_id
: A string in the format15314cc3-85b4-4338-903f-c28cdee6d005
. The ID of the project.name
: A string in the formatmy-app
. The name of the app.
Syntax
```sh $ pulumi import ibm:index/codeEngineApp:CodeEngineApp code_engine_app <project_id>/<name> ```
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- ibm ibm-cloud/terraform-provider-ibm
- License
- Notes
- This Pulumi package is based on the
ibm
Terraform Provider.