Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Ibm Provider
  3. API Docs
  4. CodeEngineJob
ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

ibm.CodeEngineJob

Explore with Pulumi AI

ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

Create, update, and delete code_engine_job with this resource.

Example Usage

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

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

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

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

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

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

});
Copy
package generated_program;

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

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

Create CodeEngineJob Resource

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

Constructor syntax

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

@overload
def CodeEngineJob(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  project_id: Optional[str] = None,
                  image_reference: Optional[str] = None,
                  run_env_variables: Optional[Sequence[CodeEngineJobRunEnvVariableArgs]] = None,
                  run_mode: Optional[str] = None,
                  image_secret: Optional[str] = None,
                  run_arguments: Optional[Sequence[str]] = None,
                  run_as_user: Optional[float] = None,
                  run_commands: Optional[Sequence[str]] = None,
                  code_engine_job_id: Optional[str] = None,
                  name: Optional[str] = None,
                  run_service_account: Optional[str] = None,
                  run_volume_mounts: Optional[Sequence[CodeEngineJobRunVolumeMountArgs]] = None,
                  scale_array_spec: Optional[str] = None,
                  scale_cpu_limit: Optional[str] = None,
                  scale_ephemeral_storage_limit: Optional[str] = None,
                  scale_max_execution_time: Optional[float] = None,
                  scale_memory_limit: Optional[str] = None,
                  scale_retry_limit: Optional[float] = None)
func NewCodeEngineJob(ctx *Context, name string, args CodeEngineJobArgs, opts ...ResourceOption) (*CodeEngineJob, error)
public CodeEngineJob(string name, CodeEngineJobArgs args, CustomResourceOptions? opts = null)
public CodeEngineJob(String name, CodeEngineJobArgs args)
public CodeEngineJob(String name, CodeEngineJobArgs args, CustomResourceOptions options)

type: ibm:CodeEngineJob
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. CodeEngineJobArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. CodeEngineJobArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. CodeEngineJobArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. CodeEngineJobArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. CodeEngineJobArgs
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 codeEngineJobResource = new Ibm.CodeEngineJob("codeEngineJobResource", new()
{
    ProjectId = "string",
    ImageReference = "string",
    RunEnvVariables = new[]
    {
        new Ibm.Inputs.CodeEngineJobRunEnvVariableArgs
        {
            Key = "string",
            Name = "string",
            Prefix = "string",
            Reference = "string",
            Type = "string",
            Value = "string",
        },
    },
    RunMode = "string",
    ImageSecret = "string",
    RunArguments = new[]
    {
        "string",
    },
    RunAsUser = 0,
    RunCommands = new[]
    {
        "string",
    },
    CodeEngineJobId = "string",
    Name = "string",
    RunServiceAccount = "string",
    RunVolumeMounts = new[]
    {
        new Ibm.Inputs.CodeEngineJobRunVolumeMountArgs
        {
            MountPath = "string",
            Name = "string",
            Reference = "string",
            Type = "string",
        },
    },
    ScaleArraySpec = "string",
    ScaleCpuLimit = "string",
    ScaleEphemeralStorageLimit = "string",
    ScaleMaxExecutionTime = 0,
    ScaleMemoryLimit = "string",
    ScaleRetryLimit = 0,
});
Copy
example, err := ibm.NewCodeEngineJob(ctx, "codeEngineJobResource", &ibm.CodeEngineJobArgs{
ProjectId: pulumi.String("string"),
ImageReference: pulumi.String("string"),
RunEnvVariables: .CodeEngineJobRunEnvVariableArray{
&.CodeEngineJobRunEnvVariableArgs{
Key: pulumi.String("string"),
Name: pulumi.String("string"),
Prefix: pulumi.String("string"),
Reference: pulumi.String("string"),
Type: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
RunMode: pulumi.String("string"),
ImageSecret: pulumi.String("string"),
RunArguments: pulumi.StringArray{
pulumi.String("string"),
},
RunAsUser: pulumi.Float64(0),
RunCommands: pulumi.StringArray{
pulumi.String("string"),
},
CodeEngineJobId: pulumi.String("string"),
Name: pulumi.String("string"),
RunServiceAccount: pulumi.String("string"),
RunVolumeMounts: .CodeEngineJobRunVolumeMountArray{
&.CodeEngineJobRunVolumeMountArgs{
MountPath: pulumi.String("string"),
Name: pulumi.String("string"),
Reference: pulumi.String("string"),
Type: pulumi.String("string"),
},
},
ScaleArraySpec: pulumi.String("string"),
ScaleCpuLimit: pulumi.String("string"),
ScaleEphemeralStorageLimit: pulumi.String("string"),
ScaleMaxExecutionTime: pulumi.Float64(0),
ScaleMemoryLimit: pulumi.String("string"),
ScaleRetryLimit: pulumi.Float64(0),
})
Copy
var codeEngineJobResource = new CodeEngineJob("codeEngineJobResource", CodeEngineJobArgs.builder()
    .projectId("string")
    .imageReference("string")
    .runEnvVariables(CodeEngineJobRunEnvVariableArgs.builder()
        .key("string")
        .name("string")
        .prefix("string")
        .reference("string")
        .type("string")
        .value("string")
        .build())
    .runMode("string")
    .imageSecret("string")
    .runArguments("string")
    .runAsUser(0)
    .runCommands("string")
    .codeEngineJobId("string")
    .name("string")
    .runServiceAccount("string")
    .runVolumeMounts(CodeEngineJobRunVolumeMountArgs.builder()
        .mountPath("string")
        .name("string")
        .reference("string")
        .type("string")
        .build())
    .scaleArraySpec("string")
    .scaleCpuLimit("string")
    .scaleEphemeralStorageLimit("string")
    .scaleMaxExecutionTime(0)
    .scaleMemoryLimit("string")
    .scaleRetryLimit(0)
    .build());
Copy
code_engine_job_resource = ibm.CodeEngineJob("codeEngineJobResource",
    project_id="string",
    image_reference="string",
    run_env_variables=[{
        "key": "string",
        "name": "string",
        "prefix": "string",
        "reference": "string",
        "type": "string",
        "value": "string",
    }],
    run_mode="string",
    image_secret="string",
    run_arguments=["string"],
    run_as_user=0,
    run_commands=["string"],
    code_engine_job_id="string",
    name="string",
    run_service_account="string",
    run_volume_mounts=[{
        "mount_path": "string",
        "name": "string",
        "reference": "string",
        "type": "string",
    }],
    scale_array_spec="string",
    scale_cpu_limit="string",
    scale_ephemeral_storage_limit="string",
    scale_max_execution_time=0,
    scale_memory_limit="string",
    scale_retry_limit=0)
Copy
const codeEngineJobResource = new ibm.CodeEngineJob("codeEngineJobResource", {
    projectId: "string",
    imageReference: "string",
    runEnvVariables: [{
        key: "string",
        name: "string",
        prefix: "string",
        reference: "string",
        type: "string",
        value: "string",
    }],
    runMode: "string",
    imageSecret: "string",
    runArguments: ["string"],
    runAsUser: 0,
    runCommands: ["string"],
    codeEngineJobId: "string",
    name: "string",
    runServiceAccount: "string",
    runVolumeMounts: [{
        mountPath: "string",
        name: "string",
        reference: "string",
        type: "string",
    }],
    scaleArraySpec: "string",
    scaleCpuLimit: "string",
    scaleEphemeralStorageLimit: "string",
    scaleMaxExecutionTime: 0,
    scaleMemoryLimit: "string",
    scaleRetryLimit: 0,
});
Copy
type: ibm:CodeEngineJob
properties:
    codeEngineJobId: string
    imageReference: string
    imageSecret: string
    name: string
    projectId: string
    runArguments:
        - string
    runAsUser: 0
    runCommands:
        - string
    runEnvVariables:
        - key: string
          name: string
          prefix: string
          reference: string
          type: string
          value: string
    runMode: string
    runServiceAccount: string
    runVolumeMounts:
        - mountPath: string
          name: string
          reference: string
          type: string
    scaleArraySpec: string
    scaleCpuLimit: string
    scaleEphemeralStorageLimit: string
    scaleMaxExecutionTime: 0
    scaleMemoryLimit: string
    scaleRetryLimit: 0
Copy

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

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

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

  • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$/.
CodeEngineJobId string
The unique identifier of the code_engine_job.
ImageSecret string
The 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 job / job runs will be created but submitted job runs will fail, until this property is provided, too. This property must not be set on a job run, which references a job template.

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

  • Constraints: The maximum length is 63 characters. The minimum length is 1 character. The value must match regular expression /^a-z0-9?$/.
RunArguments List<string>
Set arguments for the job that are passed to start job run containers. If not specified an empty string array will be applied and the arguments specified by the container image, will be used to start the container.

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

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

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

  • Constraints: The maximum length is 100 items. The minimum length is 0 items. Nested schema for run_env_variables:
RunMode string
The mode for runs of the job. Valid values are task and daemon. In task mode, the max_execution_time and retry_limit properties apply. In daemon mode, since there is no timeout and failed instances are restarted indefinitely, the max_execution_time and retry_limit properties are not allowed.

  • Constraints: The default value is task. Allowable values are: task, daemon. The minimum length is 0 characters. The value must match regular expression /^(task|daemon)$/.
RunServiceAccount string
The name of the service account. For built-in service accounts, you can use the shortened names manager, none, reader, and writer. This property must not be set on a job run, which references a job template.

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

  • Constraints: The maximum length is 100 items. The minimum length is 0 items. Nested schema for run_volume_mounts:
ScaleArraySpec string
Define a custom set of array indices as a comma-separated list containing single values and hyphen-separated ranges, such as 5,12-14,23,27. Each instance gets its array index value from the environment variable JOB_INDEX. The number of unique array indices that you specify with this parameter determines the number of job instances to run.

  • Constraints: The default value is 0. The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /^(?:[1-9]\\d\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d|[1-9]\\d\\d\\d|[1-9]\\d\\d|[1-9]?\\d)(?:-(?:[1-9]\\d\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d|[1-9]\\d\\d\\d|[1-9]\\d\\d|[1-9]?\\d))?(?:,(?:[1-9]\\d\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d|[1-9]\\d\\d\\d|[1-9]\\d\\d|[1-9]?\\d)(?:-(?:[1-9]\\d\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d|[1-9]\\d\\d\\d|[1-9]\\d\\d|[1-9]?\\d))?)*$/.
ScaleCpuLimit string
Optional amount of CPU set for the instance of the job. For valid values see Supported memory and CPU combinations.

  • Constraints: The default value is 1. The maximum length is 10 characters. The minimum length is 0 characters. The value must match regular expression /^([0-9.]+)([eEinumkKMGTPB]*)$/.
ScaleEphemeralStorageLimit string
Optional amount of ephemeral storage to set for the instance of the job. The amount specified as ephemeral storage, must not exceed the amount of scale_memory_limit. The units for specifying ephemeral storage are Megabyte (M) or Gigabyte (G), whereas G and M are the shorthand expressions for GB and MB. For more information see Units of measurement.

  • Constraints: The default value is 400M. The maximum length is 10 characters. The minimum length is 0 characters. The value must match regular expression /^([0-9.]+)([eEinumkKMGTPB]*)$/.
ScaleMaxExecutionTime double
The maximum execution time in seconds for runs of the job. This property can only be specified if run_mode is task.

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

  • Constraints: The default value is 4G. The maximum length is 10 characters. The minimum length is 0 characters. The value must match regular expression /^([0-9.]+)([eEinumkKMGTPB]*)$/.
ScaleRetryLimit double
The number of times to rerun an instance of the job before the job is marked as failed. This property can only be specified if run_mode is task.

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

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

  • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$/.
CodeEngineJobId string
The unique identifier of the code_engine_job.
ImageSecret string
The 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 job / job runs will be created but submitted job runs will fail, until this property is provided, too. This property must not be set on a job run, which references a job template.

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

  • Constraints: The maximum length is 63 characters. The minimum length is 1 character. The value must match regular expression /^a-z0-9?$/.
RunArguments []string
Set arguments for the job that are passed to start job run containers. If not specified an empty string array will be applied and the arguments specified by the container image, will be used to start the container.

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

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

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

  • Constraints: The maximum length is 100 items. The minimum length is 0 items. Nested schema for run_env_variables:
RunMode string
The mode for runs of the job. Valid values are task and daemon. In task mode, the max_execution_time and retry_limit properties apply. In daemon mode, since there is no timeout and failed instances are restarted indefinitely, the max_execution_time and retry_limit properties are not allowed.

  • Constraints: The default value is task. Allowable values are: task, daemon. The minimum length is 0 characters. The value must match regular expression /^(task|daemon)$/.
RunServiceAccount string
The name of the service account. For built-in service accounts, you can use the shortened names manager, none, reader, and writer. This property must not be set on a job run, which references a job template.

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

  • Constraints: The maximum length is 100 items. The minimum length is 0 items. Nested schema for run_volume_mounts:
ScaleArraySpec string
Define a custom set of array indices as a comma-separated list containing single values and hyphen-separated ranges, such as 5,12-14,23,27. Each instance gets its array index value from the environment variable JOB_INDEX. The number of unique array indices that you specify with this parameter determines the number of job instances to run.

  • Constraints: The default value is 0. The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /^(?:[1-9]\\d\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d|[1-9]\\d\\d\\d|[1-9]\\d\\d|[1-9]?\\d)(?:-(?:[1-9]\\d\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d|[1-9]\\d\\d\\d|[1-9]\\d\\d|[1-9]?\\d))?(?:,(?:[1-9]\\d\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d|[1-9]\\d\\d\\d|[1-9]\\d\\d|[1-9]?\\d)(?:-(?:[1-9]\\d\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d|[1-9]\\d\\d\\d|[1-9]\\d\\d|[1-9]?\\d))?)*$/.
ScaleCpuLimit string
Optional amount of CPU set for the instance of the job. For valid values see Supported memory and CPU combinations.

  • Constraints: The default value is 1. The maximum length is 10 characters. The minimum length is 0 characters. The value must match regular expression /^([0-9.]+)([eEinumkKMGTPB]*)$/.
ScaleEphemeralStorageLimit string
Optional amount of ephemeral storage to set for the instance of the job. The amount specified as ephemeral storage, must not exceed the amount of scale_memory_limit. The units for specifying ephemeral storage are Megabyte (M) or Gigabyte (G), whereas G and M are the shorthand expressions for GB and MB. For more information see Units of measurement.

  • Constraints: The default value is 400M. The maximum length is 10 characters. The minimum length is 0 characters. The value must match regular expression /^([0-9.]+)([eEinumkKMGTPB]*)$/.
ScaleMaxExecutionTime float64
The maximum execution time in seconds for runs of the job. This property can only be specified if run_mode is task.

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

  • Constraints: The default value is 4G. The maximum length is 10 characters. The minimum length is 0 characters. The value must match regular expression /^([0-9.]+)([eEinumkKMGTPB]*)$/.
ScaleRetryLimit float64
The number of times to rerun an instance of the job before the job is marked as failed. This property can only be specified if run_mode is task.

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

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

  • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$/.
codeEngineJobId String
The unique identifier of the code_engine_job.
imageSecret String
The 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 job / job runs will be created but submitted job runs will fail, until this property is provided, too. This property must not be set on a job run, which references a job template.

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

  • Constraints: The maximum length is 63 characters. The minimum length is 1 character. The value must match regular expression /^a-z0-9?$/.
runArguments List<String>
Set arguments for the job that are passed to start job run containers. If not specified an empty string array will be applied and the arguments specified by the container image, will be used to start the container.

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

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

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

  • Constraints: The maximum length is 100 items. The minimum length is 0 items. Nested schema for run_env_variables:
runMode String
The mode for runs of the job. Valid values are task and daemon. In task mode, the max_execution_time and retry_limit properties apply. In daemon mode, since there is no timeout and failed instances are restarted indefinitely, the max_execution_time and retry_limit properties are not allowed.

  • Constraints: The default value is task. Allowable values are: task, daemon. The minimum length is 0 characters. The value must match regular expression /^(task|daemon)$/.
runServiceAccount String
The name of the service account. For built-in service accounts, you can use the shortened names manager, none, reader, and writer. This property must not be set on a job run, which references a job template.

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

  • Constraints: The maximum length is 100 items. The minimum length is 0 items. Nested schema for run_volume_mounts:
scaleArraySpec String
Define a custom set of array indices as a comma-separated list containing single values and hyphen-separated ranges, such as 5,12-14,23,27. Each instance gets its array index value from the environment variable JOB_INDEX. The number of unique array indices that you specify with this parameter determines the number of job instances to run.

  • Constraints: The default value is 0. The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /^(?:[1-9]\\d\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d|[1-9]\\d\\d\\d|[1-9]\\d\\d|[1-9]?\\d)(?:-(?:[1-9]\\d\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d|[1-9]\\d\\d\\d|[1-9]\\d\\d|[1-9]?\\d))?(?:,(?:[1-9]\\d\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d|[1-9]\\d\\d\\d|[1-9]\\d\\d|[1-9]?\\d)(?:-(?:[1-9]\\d\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d|[1-9]\\d\\d\\d|[1-9]\\d\\d|[1-9]?\\d))?)*$/.
scaleCpuLimit String
Optional amount of CPU set for the instance of the job. For valid values see Supported memory and CPU combinations.

  • Constraints: The default value is 1. The maximum length is 10 characters. The minimum length is 0 characters. The value must match regular expression /^([0-9.]+)([eEinumkKMGTPB]*)$/.
scaleEphemeralStorageLimit String
Optional amount of ephemeral storage to set for the instance of the job. The amount specified as ephemeral storage, must not exceed the amount of scale_memory_limit. The units for specifying ephemeral storage are Megabyte (M) or Gigabyte (G), whereas G and M are the shorthand expressions for GB and MB. For more information see Units of measurement.

  • Constraints: The default value is 400M. The maximum length is 10 characters. The minimum length is 0 characters. The value must match regular expression /^([0-9.]+)([eEinumkKMGTPB]*)$/.
scaleMaxExecutionTime Double
The maximum execution time in seconds for runs of the job. This property can only be specified if run_mode is task.

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

  • Constraints: The default value is 4G. The maximum length is 10 characters. The minimum length is 0 characters. The value must match regular expression /^([0-9.]+)([eEinumkKMGTPB]*)$/.
scaleRetryLimit Double
The number of times to rerun an instance of the job before the job is marked as failed. This property can only be specified if run_mode is task.

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

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

  • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$/.
codeEngineJobId string
The unique identifier of the code_engine_job.
imageSecret string
The 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 job / job runs will be created but submitted job runs will fail, until this property is provided, too. This property must not be set on a job run, which references a job template.

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

  • Constraints: The maximum length is 63 characters. The minimum length is 1 character. The value must match regular expression /^a-z0-9?$/.
runArguments string[]
Set arguments for the job that are passed to start job run containers. If not specified an empty string array will be applied and the arguments specified by the container image, will be used to start the container.

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

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

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

  • Constraints: The maximum length is 100 items. The minimum length is 0 items. Nested schema for run_env_variables:
runMode string
The mode for runs of the job. Valid values are task and daemon. In task mode, the max_execution_time and retry_limit properties apply. In daemon mode, since there is no timeout and failed instances are restarted indefinitely, the max_execution_time and retry_limit properties are not allowed.

  • Constraints: The default value is task. Allowable values are: task, daemon. The minimum length is 0 characters. The value must match regular expression /^(task|daemon)$/.
runServiceAccount string
The name of the service account. For built-in service accounts, you can use the shortened names manager, none, reader, and writer. This property must not be set on a job run, which references a job template.

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

  • Constraints: The maximum length is 100 items. The minimum length is 0 items. Nested schema for run_volume_mounts:
scaleArraySpec string
Define a custom set of array indices as a comma-separated list containing single values and hyphen-separated ranges, such as 5,12-14,23,27. Each instance gets its array index value from the environment variable JOB_INDEX. The number of unique array indices that you specify with this parameter determines the number of job instances to run.

  • Constraints: The default value is 0. The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /^(?:[1-9]\\d\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d|[1-9]\\d\\d\\d|[1-9]\\d\\d|[1-9]?\\d)(?:-(?:[1-9]\\d\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d|[1-9]\\d\\d\\d|[1-9]\\d\\d|[1-9]?\\d))?(?:,(?:[1-9]\\d\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d|[1-9]\\d\\d\\d|[1-9]\\d\\d|[1-9]?\\d)(?:-(?:[1-9]\\d\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d|[1-9]\\d\\d\\d|[1-9]\\d\\d|[1-9]?\\d))?)*$/.
scaleCpuLimit string
Optional amount of CPU set for the instance of the job. For valid values see Supported memory and CPU combinations.

  • Constraints: The default value is 1. The maximum length is 10 characters. The minimum length is 0 characters. The value must match regular expression /^([0-9.]+)([eEinumkKMGTPB]*)$/.
scaleEphemeralStorageLimit string
Optional amount of ephemeral storage to set for the instance of the job. The amount specified as ephemeral storage, must not exceed the amount of scale_memory_limit. The units for specifying ephemeral storage are Megabyte (M) or Gigabyte (G), whereas G and M are the shorthand expressions for GB and MB. For more information see Units of measurement.

  • Constraints: The default value is 400M. The maximum length is 10 characters. The minimum length is 0 characters. The value must match regular expression /^([0-9.]+)([eEinumkKMGTPB]*)$/.
scaleMaxExecutionTime number
The maximum execution time in seconds for runs of the job. This property can only be specified if run_mode is task.

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

  • Constraints: The default value is 4G. The maximum length is 10 characters. The minimum length is 0 characters. The value must match regular expression /^([0-9.]+)([eEinumkKMGTPB]*)$/.
scaleRetryLimit number
The number of times to rerun an instance of the job before the job is marked as failed. This property can only be specified if run_mode is task.

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

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

  • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$/.
code_engine_job_id str
The unique identifier of the code_engine_job.
image_secret str
The 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 job / job runs will be created but submitted job runs will fail, until this property is provided, too. This property must not be set on a job run, which references a job template.

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

  • Constraints: The maximum length is 63 characters. The minimum length is 1 character. The value must match regular expression /^a-z0-9?$/.
run_arguments Sequence[str]
Set arguments for the job that are passed to start job run containers. If not specified an empty string array will be applied and the arguments specified by the container image, will be used to start the container.

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

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

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

  • Constraints: The maximum length is 100 items. The minimum length is 0 items. Nested schema for run_env_variables:
run_mode str
The mode for runs of the job. Valid values are task and daemon. In task mode, the max_execution_time and retry_limit properties apply. In daemon mode, since there is no timeout and failed instances are restarted indefinitely, the max_execution_time and retry_limit properties are not allowed.

  • Constraints: The default value is task. Allowable values are: task, daemon. The minimum length is 0 characters. The value must match regular expression /^(task|daemon)$/.
run_service_account str
The name of the service account. For built-in service accounts, you can use the shortened names manager, none, reader, and writer. This property must not be set on a job run, which references a job template.

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

  • Constraints: The maximum length is 100 items. The minimum length is 0 items. Nested schema for run_volume_mounts:
scale_array_spec str
Define a custom set of array indices as a comma-separated list containing single values and hyphen-separated ranges, such as 5,12-14,23,27. Each instance gets its array index value from the environment variable JOB_INDEX. The number of unique array indices that you specify with this parameter determines the number of job instances to run.

  • Constraints: The default value is 0. The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /^(?:[1-9]\\d\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d|[1-9]\\d\\d\\d|[1-9]\\d\\d|[1-9]?\\d)(?:-(?:[1-9]\\d\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d|[1-9]\\d\\d\\d|[1-9]\\d\\d|[1-9]?\\d))?(?:,(?:[1-9]\\d\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d|[1-9]\\d\\d\\d|[1-9]\\d\\d|[1-9]?\\d)(?:-(?:[1-9]\\d\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d|[1-9]\\d\\d\\d|[1-9]\\d\\d|[1-9]?\\d))?)*$/.
scale_cpu_limit str
Optional amount of CPU set for the instance of the job. For valid values see Supported memory and CPU combinations.

  • Constraints: The default value is 1. The maximum length is 10 characters. The minimum length is 0 characters. The value must match regular expression /^([0-9.]+)([eEinumkKMGTPB]*)$/.
scale_ephemeral_storage_limit str
Optional amount of ephemeral storage to set for the instance of the job. The amount specified as ephemeral storage, must not exceed the amount of scale_memory_limit. The units for specifying ephemeral storage are Megabyte (M) or Gigabyte (G), whereas G and M are the shorthand expressions for GB and MB. For more information see Units of measurement.

  • Constraints: The default value is 400M. The maximum length is 10 characters. The minimum length is 0 characters. The value must match regular expression /^([0-9.]+)([eEinumkKMGTPB]*)$/.
scale_max_execution_time float
The maximum execution time in seconds for runs of the job. This property can only be specified if run_mode is task.

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

  • Constraints: The default value is 4G. The maximum length is 10 characters. The minimum length is 0 characters. The value must match regular expression /^([0-9.]+)([eEinumkKMGTPB]*)$/.
scale_retry_limit float
The number of times to rerun an instance of the job before the job is marked as failed. This property can only be specified if run_mode is task.

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

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

  • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$/.
codeEngineJobId String
The unique identifier of the code_engine_job.
imageSecret String
The 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 job / job runs will be created but submitted job runs will fail, until this property is provided, too. This property must not be set on a job run, which references a job template.

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

  • Constraints: The maximum length is 63 characters. The minimum length is 1 character. The value must match regular expression /^a-z0-9?$/.
runArguments List<String>
Set arguments for the job that are passed to start job run containers. If not specified an empty string array will be applied and the arguments specified by the container image, will be used to start the container.

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

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

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

  • Constraints: The maximum length is 100 items. The minimum length is 0 items. Nested schema for run_env_variables:
runMode String
The mode for runs of the job. Valid values are task and daemon. In task mode, the max_execution_time and retry_limit properties apply. In daemon mode, since there is no timeout and failed instances are restarted indefinitely, the max_execution_time and retry_limit properties are not allowed.

  • Constraints: The default value is task. Allowable values are: task, daemon. The minimum length is 0 characters. The value must match regular expression /^(task|daemon)$/.
runServiceAccount String
The name of the service account. For built-in service accounts, you can use the shortened names manager, none, reader, and writer. This property must not be set on a job run, which references a job template.

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

  • Constraints: The maximum length is 100 items. The minimum length is 0 items. Nested schema for run_volume_mounts:
scaleArraySpec String
Define a custom set of array indices as a comma-separated list containing single values and hyphen-separated ranges, such as 5,12-14,23,27. Each instance gets its array index value from the environment variable JOB_INDEX. The number of unique array indices that you specify with this parameter determines the number of job instances to run.

  • Constraints: The default value is 0. The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /^(?:[1-9]\\d\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d|[1-9]\\d\\d\\d|[1-9]\\d\\d|[1-9]?\\d)(?:-(?:[1-9]\\d\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d|[1-9]\\d\\d\\d|[1-9]\\d\\d|[1-9]?\\d))?(?:,(?:[1-9]\\d\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d|[1-9]\\d\\d\\d|[1-9]\\d\\d|[1-9]?\\d)(?:-(?:[1-9]\\d\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d|[1-9]\\d\\d\\d|[1-9]\\d\\d|[1-9]?\\d))?)*$/.
scaleCpuLimit String
Optional amount of CPU set for the instance of the job. For valid values see Supported memory and CPU combinations.

  • Constraints: The default value is 1. The maximum length is 10 characters. The minimum length is 0 characters. The value must match regular expression /^([0-9.]+)([eEinumkKMGTPB]*)$/.
scaleEphemeralStorageLimit String
Optional amount of ephemeral storage to set for the instance of the job. The amount specified as ephemeral storage, must not exceed the amount of scale_memory_limit. The units for specifying ephemeral storage are Megabyte (M) or Gigabyte (G), whereas G and M are the shorthand expressions for GB and MB. For more information see Units of measurement.

  • Constraints: The default value is 400M. The maximum length is 10 characters. The minimum length is 0 characters. The value must match regular expression /^([0-9.]+)([eEinumkKMGTPB]*)$/.
scaleMaxExecutionTime Number
The maximum execution time in seconds for runs of the job. This property can only be specified if run_mode is task.

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

  • Constraints: The default value is 4G. The maximum length is 10 characters. The minimum length is 0 characters. The value must match regular expression /^([0-9.]+)([eEinumkKMGTPB]*)$/.
scaleRetryLimit Number
The number of times to rerun an instance of the job before the job is marked as failed. This property can only be specified if run_mode is task.

  • Constraints: The default value is 3.

Outputs

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

Build string
(String) Reference to a build that is associated with the job.
BuildRun string
(String) Reference to a build run that is associated with the job.
ComputedEnvVariables List<CodeEngineJobComputedEnvVariable>
(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 job run.

  • Constraints: The maximum length is 100 items. The minimum length is 0 items. Nested schema for computed_env_variables:
CreatedAt string
(String) The timestamp when the resource was created.
EntityTag string
(String) The version of the job instance, which is used to achieve optimistic locking.

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

  • Constraints: The maximum length is 2048 characters. The minimum length is 0 characters. The value must match regular expression /(([^:\/?#]+):)?(\/\/([^\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$/.
Id string
The provider-assigned unique ID for this managed resource.
JobId string
(String) The identifier of the resource.

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

  • Constraints: Allowable values are: job_v2.
Build string
(String) Reference to a build that is associated with the job.
BuildRun string
(String) Reference to a build run that is associated with the job.
ComputedEnvVariables []CodeEngineJobComputedEnvVariable
(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 job run.

  • Constraints: The maximum length is 100 items. The minimum length is 0 items. Nested schema for computed_env_variables:
CreatedAt string
(String) The timestamp when the resource was created.
EntityTag string
(String) The version of the job instance, which is used to achieve optimistic locking.

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

  • Constraints: The maximum length is 2048 characters. The minimum length is 0 characters. The value must match regular expression /(([^:\/?#]+):)?(\/\/([^\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$/.
Id string
The provider-assigned unique ID for this managed resource.
JobId string
(String) The identifier of the resource.

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

  • Constraints: Allowable values are: job_v2.
build String
(String) Reference to a build that is associated with the job.
buildRun String
(String) Reference to a build run that is associated with the job.
computedEnvVariables List<CodeEngineJobComputedEnvVariable>
(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 job run.

  • Constraints: The maximum length is 100 items. The minimum length is 0 items. Nested schema for computed_env_variables:
createdAt String
(String) The timestamp when the resource was created.
entityTag String
(String) The version of the job instance, which is used to achieve optimistic locking.

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

  • Constraints: The maximum length is 2048 characters. The minimum length is 0 characters. The value must match regular expression /(([^:\/?#]+):)?(\/\/([^\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$/.
id String
The provider-assigned unique ID for this managed resource.
jobId String
(String) The identifier of the resource.

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

  • Constraints: Allowable values are: job_v2.
build string
(String) Reference to a build that is associated with the job.
buildRun string
(String) Reference to a build run that is associated with the job.
computedEnvVariables CodeEngineJobComputedEnvVariable[]
(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 job run.

  • Constraints: The maximum length is 100 items. The minimum length is 0 items. Nested schema for computed_env_variables:
createdAt string
(String) The timestamp when the resource was created.
entityTag string
(String) The version of the job instance, which is used to achieve optimistic locking.

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

  • Constraints: The maximum length is 2048 characters. The minimum length is 0 characters. The value must match regular expression /(([^:\/?#]+):)?(\/\/([^\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$/.
id string
The provider-assigned unique ID for this managed resource.
jobId string
(String) The identifier of the resource.

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

  • Constraints: Allowable values are: job_v2.
build str
(String) Reference to a build that is associated with the job.
build_run str
(String) Reference to a build run that is associated with the job.
computed_env_variables Sequence[CodeEngineJobComputedEnvVariable]
(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 job run.

  • Constraints: The maximum length is 100 items. The minimum length is 0 items. Nested schema for computed_env_variables:
created_at str
(String) The timestamp when the resource was created.
entity_tag str
(String) The version of the job instance, which is used to achieve optimistic locking.

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

  • Constraints: The maximum length is 2048 characters. The minimum length is 0 characters. The value must match regular expression /(([^:\/?#]+):)?(\/\/([^\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$/.
id str
The provider-assigned unique ID for this managed resource.
job_id str
(String) The identifier of the resource.

  • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$/.
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 job.

  • Constraints: Allowable values are: job_v2.
build String
(String) Reference to a build that is associated with the job.
buildRun String
(String) Reference to a build run that is associated with the job.
computedEnvVariables List<Property Map>
(List) References to config maps, secrets or literal values, which are defined and set by Code Engine and are exposed as environment variables in the job run.

  • Constraints: The maximum length is 100 items. The minimum length is 0 items. Nested schema for computed_env_variables:
createdAt String
(String) The timestamp when the resource was created.
entityTag String
(String) The version of the job instance, which is used to achieve optimistic locking.

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

  • Constraints: The maximum length is 2048 characters. The minimum length is 0 characters. The value must match regular expression /(([^:\/?#]+):)?(\/\/([^\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$/.
id String
The provider-assigned unique ID for this managed resource.
jobId String
(String) The identifier of the resource.

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

  • Constraints: Allowable values are: job_v2.

Look up Existing CodeEngineJob Resource

Get an existing CodeEngineJob 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?: CodeEngineJobState, opts?: CustomResourceOptions): CodeEngineJob
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        build: Optional[str] = None,
        build_run: Optional[str] = None,
        code_engine_job_id: Optional[str] = None,
        computed_env_variables: Optional[Sequence[CodeEngineJobComputedEnvVariableArgs]] = None,
        created_at: Optional[str] = None,
        entity_tag: Optional[str] = None,
        etag: Optional[str] = None,
        href: Optional[str] = None,
        image_reference: Optional[str] = None,
        image_secret: Optional[str] = None,
        job_id: Optional[str] = None,
        name: Optional[str] = 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[CodeEngineJobRunEnvVariableArgs]] = None,
        run_mode: Optional[str] = None,
        run_service_account: Optional[str] = None,
        run_volume_mounts: Optional[Sequence[CodeEngineJobRunVolumeMountArgs]] = None,
        scale_array_spec: Optional[str] = None,
        scale_cpu_limit: Optional[str] = None,
        scale_ephemeral_storage_limit: Optional[str] = None,
        scale_max_execution_time: Optional[float] = None,
        scale_memory_limit: Optional[str] = None,
        scale_retry_limit: Optional[float] = None) -> CodeEngineJob
func GetCodeEngineJob(ctx *Context, name string, id IDInput, state *CodeEngineJobState, opts ...ResourceOption) (*CodeEngineJob, error)
public static CodeEngineJob Get(string name, Input<string> id, CodeEngineJobState? state, CustomResourceOptions? opts = null)
public static CodeEngineJob get(String name, Output<String> id, CodeEngineJobState state, CustomResourceOptions options)
resources:  _:    type: ibm:CodeEngineJob    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Build string
(String) Reference to a build that is associated with the job.
BuildRun string
(String) Reference to a build run that is associated with the job.
CodeEngineJobId string
The unique identifier of the code_engine_job.
ComputedEnvVariables List<CodeEngineJobComputedEnvVariable>
(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 job run.

  • Constraints: The maximum length is 100 items. The minimum length is 0 items. Nested schema for computed_env_variables:
CreatedAt string
(String) The timestamp when the resource was created.
EntityTag string
(String) The version of the job instance, which is used to achieve optimistic locking.

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

  • Constraints: The maximum length is 2048 characters. The minimum length is 0 characters. The value must match regular expression /(([^:\/?#]+):)?(\/\/([^\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$/.
ImageReference string
The name of the image that is used for this job. The format is REGISTRY/NAMESPACE/REPOSITORY:TAG where REGISTRY and TAG are optional. If REGISTRY is not specified, the default is docker.io. If TAG is not specified, the default is latest. If the image reference points to a registry that requires authentication, make sure to also specify the property image_secret.

  • Constraints: The maximum length is 256 characters. The minimum length is 1 character. The value must match regular expression /^([a-z0-9][a-z0-9\\-_.]+[a-z0-9][\/])?([a-z0-9][a-z0-9\\-_]+[a-z0-9][\/])?[a-z0-9][a-z0-9\\-_.\/]+a-z0-9?(@sha256:[a-fA-F0-9]{64})?$/.
ImageSecret string
The 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 job / job runs will be created but submitted job runs will fail, until this property is provided, too. This property must not be set on a job run, which references a job template.

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

  • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$/.
Name string
The name of the job.

  • Constraints: The maximum length is 63 characters. The minimum length is 1 character. The value must match regular expression /^a-z0-9?$/.
ProjectId string
The ID of the project.

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

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

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

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

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

  • Constraints: The maximum length is 100 items. The minimum length is 0 items. Nested schema for run_env_variables:
RunMode string
The mode for runs of the job. Valid values are task and daemon. In task mode, the max_execution_time and retry_limit properties apply. In daemon mode, since there is no timeout and failed instances are restarted indefinitely, the max_execution_time and retry_limit properties are not allowed.

  • Constraints: The default value is task. Allowable values are: task, daemon. The minimum length is 0 characters. The value must match regular expression /^(task|daemon)$/.
RunServiceAccount string
The name of the service account. For built-in service accounts, you can use the shortened names manager, none, reader, and writer. This property must not be set on a job run, which references a job template.

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

  • Constraints: The maximum length is 100 items. The minimum length is 0 items. Nested schema for run_volume_mounts:
ScaleArraySpec string
Define a custom set of array indices as a comma-separated list containing single values and hyphen-separated ranges, such as 5,12-14,23,27. Each instance gets its array index value from the environment variable JOB_INDEX. The number of unique array indices that you specify with this parameter determines the number of job instances to run.

  • Constraints: The default value is 0. The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /^(?:[1-9]\\d\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d|[1-9]\\d\\d\\d|[1-9]\\d\\d|[1-9]?\\d)(?:-(?:[1-9]\\d\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d|[1-9]\\d\\d\\d|[1-9]\\d\\d|[1-9]?\\d))?(?:,(?:[1-9]\\d\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d|[1-9]\\d\\d\\d|[1-9]\\d\\d|[1-9]?\\d)(?:-(?:[1-9]\\d\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d|[1-9]\\d\\d\\d|[1-9]\\d\\d|[1-9]?\\d))?)*$/.
ScaleCpuLimit string
Optional amount of CPU set for the instance of the job. For valid values see Supported memory and CPU combinations.

  • Constraints: The default value is 1. The maximum length is 10 characters. The minimum length is 0 characters. The value must match regular expression /^([0-9.]+)([eEinumkKMGTPB]*)$/.
ScaleEphemeralStorageLimit string
Optional amount of ephemeral storage to set for the instance of the job. The amount specified as ephemeral storage, must not exceed the amount of scale_memory_limit. The units for specifying ephemeral storage are Megabyte (M) or Gigabyte (G), whereas G and M are the shorthand expressions for GB and MB. For more information see Units of measurement.

  • Constraints: The default value is 400M. The maximum length is 10 characters. The minimum length is 0 characters. The value must match regular expression /^([0-9.]+)([eEinumkKMGTPB]*)$/.
ScaleMaxExecutionTime double
The maximum execution time in seconds for runs of the job. This property can only be specified if run_mode is task.

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

  • Constraints: The default value is 4G. The maximum length is 10 characters. The minimum length is 0 characters. The value must match regular expression /^([0-9.]+)([eEinumkKMGTPB]*)$/.
ScaleRetryLimit double
The number of times to rerun an instance of the job before the job is marked as failed. This property can only be specified if run_mode is task.

  • Constraints: The default value is 3.
Build string
(String) Reference to a build that is associated with the job.
BuildRun string
(String) Reference to a build run that is associated with the job.
CodeEngineJobId string
The unique identifier of the code_engine_job.
ComputedEnvVariables []CodeEngineJobComputedEnvVariableArgs
(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 job run.

  • Constraints: The maximum length is 100 items. The minimum length is 0 items. Nested schema for computed_env_variables:
CreatedAt string
(String) The timestamp when the resource was created.
EntityTag string
(String) The version of the job instance, which is used to achieve optimistic locking.

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

  • Constraints: The maximum length is 2048 characters. The minimum length is 0 characters. The value must match regular expression /(([^:\/?#]+):)?(\/\/([^\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$/.
ImageReference string
The name of the image that is used for this job. The format is REGISTRY/NAMESPACE/REPOSITORY:TAG where REGISTRY and TAG are optional. If REGISTRY is not specified, the default is docker.io. If TAG is not specified, the default is latest. If the image reference points to a registry that requires authentication, make sure to also specify the property image_secret.

  • Constraints: The maximum length is 256 characters. The minimum length is 1 character. The value must match regular expression /^([a-z0-9][a-z0-9\\-_.]+[a-z0-9][\/])?([a-z0-9][a-z0-9\\-_]+[a-z0-9][\/])?[a-z0-9][a-z0-9\\-_.\/]+a-z0-9?(@sha256:[a-fA-F0-9]{64})?$/.
ImageSecret string
The 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 job / job runs will be created but submitted job runs will fail, until this property is provided, too. This property must not be set on a job run, which references a job template.

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

  • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$/.
Name string
The name of the job.

  • Constraints: The maximum length is 63 characters. The minimum length is 1 character. The value must match regular expression /^a-z0-9?$/.
ProjectId string
The ID of the project.

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

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

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

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

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

  • Constraints: The maximum length is 100 items. The minimum length is 0 items. Nested schema for run_env_variables:
RunMode string
The mode for runs of the job. Valid values are task and daemon. In task mode, the max_execution_time and retry_limit properties apply. In daemon mode, since there is no timeout and failed instances are restarted indefinitely, the max_execution_time and retry_limit properties are not allowed.

  • Constraints: The default value is task. Allowable values are: task, daemon. The minimum length is 0 characters. The value must match regular expression /^(task|daemon)$/.
RunServiceAccount string
The name of the service account. For built-in service accounts, you can use the shortened names manager, none, reader, and writer. This property must not be set on a job run, which references a job template.

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

  • Constraints: The maximum length is 100 items. The minimum length is 0 items. Nested schema for run_volume_mounts:
ScaleArraySpec string
Define a custom set of array indices as a comma-separated list containing single values and hyphen-separated ranges, such as 5,12-14,23,27. Each instance gets its array index value from the environment variable JOB_INDEX. The number of unique array indices that you specify with this parameter determines the number of job instances to run.

  • Constraints: The default value is 0. The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /^(?:[1-9]\\d\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d|[1-9]\\d\\d\\d|[1-9]\\d\\d|[1-9]?\\d)(?:-(?:[1-9]\\d\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d|[1-9]\\d\\d\\d|[1-9]\\d\\d|[1-9]?\\d))?(?:,(?:[1-9]\\d\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d|[1-9]\\d\\d\\d|[1-9]\\d\\d|[1-9]?\\d)(?:-(?:[1-9]\\d\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d|[1-9]\\d\\d\\d|[1-9]\\d\\d|[1-9]?\\d))?)*$/.
ScaleCpuLimit string
Optional amount of CPU set for the instance of the job. For valid values see Supported memory and CPU combinations.

  • Constraints: The default value is 1. The maximum length is 10 characters. The minimum length is 0 characters. The value must match regular expression /^([0-9.]+)([eEinumkKMGTPB]*)$/.
ScaleEphemeralStorageLimit string
Optional amount of ephemeral storage to set for the instance of the job. The amount specified as ephemeral storage, must not exceed the amount of scale_memory_limit. The units for specifying ephemeral storage are Megabyte (M) or Gigabyte (G), whereas G and M are the shorthand expressions for GB and MB. For more information see Units of measurement.

  • Constraints: The default value is 400M. The maximum length is 10 characters. The minimum length is 0 characters. The value must match regular expression /^([0-9.]+)([eEinumkKMGTPB]*)$/.
ScaleMaxExecutionTime float64
The maximum execution time in seconds for runs of the job. This property can only be specified if run_mode is task.

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

  • Constraints: The default value is 4G. The maximum length is 10 characters. The minimum length is 0 characters. The value must match regular expression /^([0-9.]+)([eEinumkKMGTPB]*)$/.
ScaleRetryLimit float64
The number of times to rerun an instance of the job before the job is marked as failed. This property can only be specified if run_mode is task.

  • Constraints: The default value is 3.
build String
(String) Reference to a build that is associated with the job.
buildRun String
(String) Reference to a build run that is associated with the job.
codeEngineJobId String
The unique identifier of the code_engine_job.
computedEnvVariables List<CodeEngineJobComputedEnvVariable>
(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 job run.

  • Constraints: The maximum length is 100 items. The minimum length is 0 items. Nested schema for computed_env_variables:
createdAt String
(String) The timestamp when the resource was created.
entityTag String
(String) The version of the job instance, which is used to achieve optimistic locking.

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

  • Constraints: The maximum length is 2048 characters. The minimum length is 0 characters. The value must match regular expression /(([^:\/?#]+):)?(\/\/([^\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$/.
imageReference String
The name of the image that is used for this job. The format is REGISTRY/NAMESPACE/REPOSITORY:TAG where REGISTRY and TAG are optional. If REGISTRY is not specified, the default is docker.io. If TAG is not specified, the default is latest. If the image reference points to a registry that requires authentication, make sure to also specify the property image_secret.

  • Constraints: The maximum length is 256 characters. The minimum length is 1 character. The value must match regular expression /^([a-z0-9][a-z0-9\\-_.]+[a-z0-9][\/])?([a-z0-9][a-z0-9\\-_]+[a-z0-9][\/])?[a-z0-9][a-z0-9\\-_.\/]+a-z0-9?(@sha256:[a-fA-F0-9]{64})?$/.
imageSecret String
The 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 job / job runs will be created but submitted job runs will fail, until this property is provided, too. This property must not be set on a job run, which references a job template.

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

  • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$/.
name String
The name of the job.

  • Constraints: The maximum length is 63 characters. The minimum length is 1 character. The value must match regular expression /^a-z0-9?$/.
projectId String
The ID of the project.

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

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

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

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

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

  • Constraints: The maximum length is 100 items. The minimum length is 0 items. Nested schema for run_env_variables:
runMode String
The mode for runs of the job. Valid values are task and daemon. In task mode, the max_execution_time and retry_limit properties apply. In daemon mode, since there is no timeout and failed instances are restarted indefinitely, the max_execution_time and retry_limit properties are not allowed.

  • Constraints: The default value is task. Allowable values are: task, daemon. The minimum length is 0 characters. The value must match regular expression /^(task|daemon)$/.
runServiceAccount String
The name of the service account. For built-in service accounts, you can use the shortened names manager, none, reader, and writer. This property must not be set on a job run, which references a job template.

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

  • Constraints: The maximum length is 100 items. The minimum length is 0 items. Nested schema for run_volume_mounts:
scaleArraySpec String
Define a custom set of array indices as a comma-separated list containing single values and hyphen-separated ranges, such as 5,12-14,23,27. Each instance gets its array index value from the environment variable JOB_INDEX. The number of unique array indices that you specify with this parameter determines the number of job instances to run.

  • Constraints: The default value is 0. The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /^(?:[1-9]\\d\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d|[1-9]\\d\\d\\d|[1-9]\\d\\d|[1-9]?\\d)(?:-(?:[1-9]\\d\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d|[1-9]\\d\\d\\d|[1-9]\\d\\d|[1-9]?\\d))?(?:,(?:[1-9]\\d\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d|[1-9]\\d\\d\\d|[1-9]\\d\\d|[1-9]?\\d)(?:-(?:[1-9]\\d\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d|[1-9]\\d\\d\\d|[1-9]\\d\\d|[1-9]?\\d))?)*$/.
scaleCpuLimit String
Optional amount of CPU set for the instance of the job. For valid values see Supported memory and CPU combinations.

  • Constraints: The default value is 1. The maximum length is 10 characters. The minimum length is 0 characters. The value must match regular expression /^([0-9.]+)([eEinumkKMGTPB]*)$/.
scaleEphemeralStorageLimit String
Optional amount of ephemeral storage to set for the instance of the job. The amount specified as ephemeral storage, must not exceed the amount of scale_memory_limit. The units for specifying ephemeral storage are Megabyte (M) or Gigabyte (G), whereas G and M are the shorthand expressions for GB and MB. For more information see Units of measurement.

  • Constraints: The default value is 400M. The maximum length is 10 characters. The minimum length is 0 characters. The value must match regular expression /^([0-9.]+)([eEinumkKMGTPB]*)$/.
scaleMaxExecutionTime Double
The maximum execution time in seconds for runs of the job. This property can only be specified if run_mode is task.

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

  • Constraints: The default value is 4G. The maximum length is 10 characters. The minimum length is 0 characters. The value must match regular expression /^([0-9.]+)([eEinumkKMGTPB]*)$/.
scaleRetryLimit Double
The number of times to rerun an instance of the job before the job is marked as failed. This property can only be specified if run_mode is task.

  • Constraints: The default value is 3.
build string
(String) Reference to a build that is associated with the job.
buildRun string
(String) Reference to a build run that is associated with the job.
codeEngineJobId string
The unique identifier of the code_engine_job.
computedEnvVariables CodeEngineJobComputedEnvVariable[]
(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 job run.

  • Constraints: The maximum length is 100 items. The minimum length is 0 items. Nested schema for computed_env_variables:
createdAt string
(String) The timestamp when the resource was created.
entityTag string
(String) The version of the job instance, which is used to achieve optimistic locking.

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

  • Constraints: The maximum length is 2048 characters. The minimum length is 0 characters. The value must match regular expression /(([^:\/?#]+):)?(\/\/([^\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$/.
imageReference string
The name of the image that is used for this job. The format is REGISTRY/NAMESPACE/REPOSITORY:TAG where REGISTRY and TAG are optional. If REGISTRY is not specified, the default is docker.io. If TAG is not specified, the default is latest. If the image reference points to a registry that requires authentication, make sure to also specify the property image_secret.

  • Constraints: The maximum length is 256 characters. The minimum length is 1 character. The value must match regular expression /^([a-z0-9][a-z0-9\\-_.]+[a-z0-9][\/])?([a-z0-9][a-z0-9\\-_]+[a-z0-9][\/])?[a-z0-9][a-z0-9\\-_.\/]+a-z0-9?(@sha256:[a-fA-F0-9]{64})?$/.
imageSecret string
The 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 job / job runs will be created but submitted job runs will fail, until this property is provided, too. This property must not be set on a job run, which references a job template.

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

  • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$/.
name string
The name of the job.

  • Constraints: The maximum length is 63 characters. The minimum length is 1 character. The value must match regular expression /^a-z0-9?$/.
projectId string
The ID of the project.

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

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

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

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

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

  • Constraints: The maximum length is 100 items. The minimum length is 0 items. Nested schema for run_env_variables:
runMode string
The mode for runs of the job. Valid values are task and daemon. In task mode, the max_execution_time and retry_limit properties apply. In daemon mode, since there is no timeout and failed instances are restarted indefinitely, the max_execution_time and retry_limit properties are not allowed.

  • Constraints: The default value is task. Allowable values are: task, daemon. The minimum length is 0 characters. The value must match regular expression /^(task|daemon)$/.
runServiceAccount string
The name of the service account. For built-in service accounts, you can use the shortened names manager, none, reader, and writer. This property must not be set on a job run, which references a job template.

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

  • Constraints: The maximum length is 100 items. The minimum length is 0 items. Nested schema for run_volume_mounts:
scaleArraySpec string
Define a custom set of array indices as a comma-separated list containing single values and hyphen-separated ranges, such as 5,12-14,23,27. Each instance gets its array index value from the environment variable JOB_INDEX. The number of unique array indices that you specify with this parameter determines the number of job instances to run.

  • Constraints: The default value is 0. The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /^(?:[1-9]\\d\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d|[1-9]\\d\\d\\d|[1-9]\\d\\d|[1-9]?\\d)(?:-(?:[1-9]\\d\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d|[1-9]\\d\\d\\d|[1-9]\\d\\d|[1-9]?\\d))?(?:,(?:[1-9]\\d\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d|[1-9]\\d\\d\\d|[1-9]\\d\\d|[1-9]?\\d)(?:-(?:[1-9]\\d\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d|[1-9]\\d\\d\\d|[1-9]\\d\\d|[1-9]?\\d))?)*$/.
scaleCpuLimit string
Optional amount of CPU set for the instance of the job. For valid values see Supported memory and CPU combinations.

  • Constraints: The default value is 1. The maximum length is 10 characters. The minimum length is 0 characters. The value must match regular expression /^([0-9.]+)([eEinumkKMGTPB]*)$/.
scaleEphemeralStorageLimit string
Optional amount of ephemeral storage to set for the instance of the job. The amount specified as ephemeral storage, must not exceed the amount of scale_memory_limit. The units for specifying ephemeral storage are Megabyte (M) or Gigabyte (G), whereas G and M are the shorthand expressions for GB and MB. For more information see Units of measurement.

  • Constraints: The default value is 400M. The maximum length is 10 characters. The minimum length is 0 characters. The value must match regular expression /^([0-9.]+)([eEinumkKMGTPB]*)$/.
scaleMaxExecutionTime number
The maximum execution time in seconds for runs of the job. This property can only be specified if run_mode is task.

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

  • Constraints: The default value is 4G. The maximum length is 10 characters. The minimum length is 0 characters. The value must match regular expression /^([0-9.]+)([eEinumkKMGTPB]*)$/.
scaleRetryLimit number
The number of times to rerun an instance of the job before the job is marked as failed. This property can only be specified if run_mode is task.

  • Constraints: The default value is 3.
build str
(String) Reference to a build that is associated with the job.
build_run str
(String) Reference to a build run that is associated with the job.
code_engine_job_id str
The unique identifier of the code_engine_job.
computed_env_variables Sequence[CodeEngineJobComputedEnvVariableArgs]
(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 job run.

  • Constraints: The maximum length is 100 items. The minimum length is 0 items. Nested schema for computed_env_variables:
created_at str
(String) The timestamp when the resource was created.
entity_tag str
(String) The version of the job instance, which is used to achieve optimistic locking.

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

  • Constraints: The maximum length is 2048 characters. The minimum length is 0 characters. The value must match regular expression /(([^:\/?#]+):)?(\/\/([^\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$/.
image_reference str
The name of the image that is used for this job. The format is REGISTRY/NAMESPACE/REPOSITORY:TAG where REGISTRY and TAG are optional. If REGISTRY is not specified, the default is docker.io. If TAG is not specified, the default is latest. If the image reference points to a registry that requires authentication, make sure to also specify the property image_secret.

  • Constraints: The maximum length is 256 characters. The minimum length is 1 character. The value must match regular expression /^([a-z0-9][a-z0-9\\-_.]+[a-z0-9][\/])?([a-z0-9][a-z0-9\\-_]+[a-z0-9][\/])?[a-z0-9][a-z0-9\\-_.\/]+a-z0-9?(@sha256:[a-fA-F0-9]{64})?$/.
image_secret str
The 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 job / job runs will be created but submitted job runs will fail, until this property is provided, too. This property must not be set on a job run, which references a job template.

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

  • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$/.
name str
The name of the job.

  • Constraints: The maximum length is 63 characters. The minimum length is 1 character. The value must match regular expression /^a-z0-9?$/.
project_id str
The ID of the project.

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

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

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

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

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

  • Constraints: The maximum length is 100 items. The minimum length is 0 items. Nested schema for run_env_variables:
run_mode str
The mode for runs of the job. Valid values are task and daemon. In task mode, the max_execution_time and retry_limit properties apply. In daemon mode, since there is no timeout and failed instances are restarted indefinitely, the max_execution_time and retry_limit properties are not allowed.

  • Constraints: The default value is task. Allowable values are: task, daemon. The minimum length is 0 characters. The value must match regular expression /^(task|daemon)$/.
run_service_account str
The name of the service account. For built-in service accounts, you can use the shortened names manager, none, reader, and writer. This property must not be set on a job run, which references a job template.

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

  • Constraints: The maximum length is 100 items. The minimum length is 0 items. Nested schema for run_volume_mounts:
scale_array_spec str
Define a custom set of array indices as a comma-separated list containing single values and hyphen-separated ranges, such as 5,12-14,23,27. Each instance gets its array index value from the environment variable JOB_INDEX. The number of unique array indices that you specify with this parameter determines the number of job instances to run.

  • Constraints: The default value is 0. The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /^(?:[1-9]\\d\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d|[1-9]\\d\\d\\d|[1-9]\\d\\d|[1-9]?\\d)(?:-(?:[1-9]\\d\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d|[1-9]\\d\\d\\d|[1-9]\\d\\d|[1-9]?\\d))?(?:,(?:[1-9]\\d\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d|[1-9]\\d\\d\\d|[1-9]\\d\\d|[1-9]?\\d)(?:-(?:[1-9]\\d\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d|[1-9]\\d\\d\\d|[1-9]\\d\\d|[1-9]?\\d))?)*$/.
scale_cpu_limit str
Optional amount of CPU set for the instance of the job. For valid values see Supported memory and CPU combinations.

  • Constraints: The default value is 1. The maximum length is 10 characters. The minimum length is 0 characters. The value must match regular expression /^([0-9.]+)([eEinumkKMGTPB]*)$/.
scale_ephemeral_storage_limit str
Optional amount of ephemeral storage to set for the instance of the job. The amount specified as ephemeral storage, must not exceed the amount of scale_memory_limit. The units for specifying ephemeral storage are Megabyte (M) or Gigabyte (G), whereas G and M are the shorthand expressions for GB and MB. For more information see Units of measurement.

  • Constraints: The default value is 400M. The maximum length is 10 characters. The minimum length is 0 characters. The value must match regular expression /^([0-9.]+)([eEinumkKMGTPB]*)$/.
scale_max_execution_time float
The maximum execution time in seconds for runs of the job. This property can only be specified if run_mode is task.

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

  • Constraints: The default value is 4G. The maximum length is 10 characters. The minimum length is 0 characters. The value must match regular expression /^([0-9.]+)([eEinumkKMGTPB]*)$/.
scale_retry_limit float
The number of times to rerun an instance of the job before the job is marked as failed. This property can only be specified if run_mode is task.

  • Constraints: The default value is 3.
build String
(String) Reference to a build that is associated with the job.
buildRun String
(String) Reference to a build run that is associated with the job.
codeEngineJobId String
The unique identifier of the code_engine_job.
computedEnvVariables List<Property Map>
(List) References to config maps, secrets or literal values, which are defined and set by Code Engine and are exposed as environment variables in the job run.

  • Constraints: The maximum length is 100 items. The minimum length is 0 items. Nested schema for computed_env_variables:
createdAt String
(String) The timestamp when the resource was created.
entityTag String
(String) The version of the job instance, which is used to achieve optimistic locking.

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

  • Constraints: The maximum length is 2048 characters. The minimum length is 0 characters. The value must match regular expression /(([^:\/?#]+):)?(\/\/([^\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$/.
imageReference String
The name of the image that is used for this job. The format is REGISTRY/NAMESPACE/REPOSITORY:TAG where REGISTRY and TAG are optional. If REGISTRY is not specified, the default is docker.io. If TAG is not specified, the default is latest. If the image reference points to a registry that requires authentication, make sure to also specify the property image_secret.

  • Constraints: The maximum length is 256 characters. The minimum length is 1 character. The value must match regular expression /^([a-z0-9][a-z0-9\\-_.]+[a-z0-9][\/])?([a-z0-9][a-z0-9\\-_]+[a-z0-9][\/])?[a-z0-9][a-z0-9\\-_.\/]+a-z0-9?(@sha256:[a-fA-F0-9]{64})?$/.
imageSecret String
The 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 job / job runs will be created but submitted job runs will fail, until this property is provided, too. This property must not be set on a job run, which references a job template.

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

  • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$/.
name String
The name of the job.

  • Constraints: The maximum length is 63 characters. The minimum length is 1 character. The value must match regular expression /^a-z0-9?$/.
projectId String
The ID of the project.

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

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

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

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

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

  • Constraints: The maximum length is 100 items. The minimum length is 0 items. Nested schema for run_env_variables:
runMode String
The mode for runs of the job. Valid values are task and daemon. In task mode, the max_execution_time and retry_limit properties apply. In daemon mode, since there is no timeout and failed instances are restarted indefinitely, the max_execution_time and retry_limit properties are not allowed.

  • Constraints: The default value is task. Allowable values are: task, daemon. The minimum length is 0 characters. The value must match regular expression /^(task|daemon)$/.
runServiceAccount String
The name of the service account. For built-in service accounts, you can use the shortened names manager, none, reader, and writer. This property must not be set on a job run, which references a job template.

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

  • Constraints: The maximum length is 100 items. The minimum length is 0 items. Nested schema for run_volume_mounts:
scaleArraySpec String
Define a custom set of array indices as a comma-separated list containing single values and hyphen-separated ranges, such as 5,12-14,23,27. Each instance gets its array index value from the environment variable JOB_INDEX. The number of unique array indices that you specify with this parameter determines the number of job instances to run.

  • Constraints: The default value is 0. The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /^(?:[1-9]\\d\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d|[1-9]\\d\\d\\d|[1-9]\\d\\d|[1-9]?\\d)(?:-(?:[1-9]\\d\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d|[1-9]\\d\\d\\d|[1-9]\\d\\d|[1-9]?\\d))?(?:,(?:[1-9]\\d\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d|[1-9]\\d\\d\\d|[1-9]\\d\\d|[1-9]?\\d)(?:-(?:[1-9]\\d\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d\\d|[1-9]\\d\\d\\d\\d|[1-9]\\d\\d\\d|[1-9]\\d\\d|[1-9]?\\d))?)*$/.
scaleCpuLimit String
Optional amount of CPU set for the instance of the job. For valid values see Supported memory and CPU combinations.

  • Constraints: The default value is 1. The maximum length is 10 characters. The minimum length is 0 characters. The value must match regular expression /^([0-9.]+)([eEinumkKMGTPB]*)$/.
scaleEphemeralStorageLimit String
Optional amount of ephemeral storage to set for the instance of the job. The amount specified as ephemeral storage, must not exceed the amount of scale_memory_limit. The units for specifying ephemeral storage are Megabyte (M) or Gigabyte (G), whereas G and M are the shorthand expressions for GB and MB. For more information see Units of measurement.

  • Constraints: The default value is 400M. The maximum length is 10 characters. The minimum length is 0 characters. The value must match regular expression /^([0-9.]+)([eEinumkKMGTPB]*)$/.
scaleMaxExecutionTime Number
The maximum execution time in seconds for runs of the job. This property can only be specified if run_mode is task.

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

  • Constraints: The default value is 4G. The maximum length is 10 characters. The minimum length is 0 characters. The value must match regular expression /^([0-9.]+)([eEinumkKMGTPB]*)$/.
scaleRetryLimit Number
The number of times to rerun an instance of the job before the job is marked as failed. This property can only be specified if run_mode is task.

  • Constraints: The default value is 3.

Supporting Types

CodeEngineJobComputedEnvVariable
, CodeEngineJobComputedEnvVariableArgs

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

CodeEngineJobRunEnvVariable
, CodeEngineJobRunEnvVariableArgs

Key string
The key to reference as environment variable.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

CodeEngineJobRunVolumeMount
, CodeEngineJobRunVolumeMountArgs

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Import

You can import the ibm_code_engine_job resource by using name.

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

<project_id>/<name>

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

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

Syntax

```sh
$ pulumi import ibm:index/codeEngineJob:CodeEngineJob code_engine_job <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.
ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm