ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
ibm.getCodeEngineJob
Explore with Pulumi AI
Provides a read-only data source to retrieve information about a code_engine_job. You can then reference the fields of the data source in other resources within the same configuration by using interpolation syntax.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as ibm from "@pulumi/ibm";
const codeEngineJob = ibm.getCodeEngineJob({
projectId: data.ibm_code_engine_project.code_engine_project.project_id,
name: "my-job",
});
import pulumi
import pulumi_ibm as ibm
code_engine_job = ibm.get_code_engine_job(project_id=data["ibm_code_engine_project"]["code_engine_project"]["project_id"],
name="my-job")
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.LookupCodeEngineJob(ctx, &ibm.LookupCodeEngineJobArgs{
ProjectId: data.Ibm_code_engine_project.Code_engine_project.Project_id,
Name: "my-job",
}, nil)
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;
return await Deployment.RunAsync(() =>
{
var codeEngineJob = Ibm.GetCodeEngineJob.Invoke(new()
{
ProjectId = data.Ibm_code_engine_project.Code_engine_project.Project_id,
Name = "my-job",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.IbmFunctions;
import com.pulumi.ibm.inputs.GetCodeEngineJobArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var codeEngineJob = IbmFunctions.getCodeEngineJob(GetCodeEngineJobArgs.builder()
.projectId(data.ibm_code_engine_project().code_engine_project().project_id())
.name("my-job")
.build());
}
}
variables:
codeEngineJob:
fn::invoke:
function: ibm:getCodeEngineJob
arguments:
projectId: ${data.ibm_code_engine_project.code_engine_project.project_id}
name: my-job
Using getCodeEngineJob
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getCodeEngineJob(args: GetCodeEngineJobArgs, opts?: InvokeOptions): Promise<GetCodeEngineJobResult>
function getCodeEngineJobOutput(args: GetCodeEngineJobOutputArgs, opts?: InvokeOptions): Output<GetCodeEngineJobResult>
def get_code_engine_job(id: Optional[str] = None,
name: Optional[str] = None,
project_id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetCodeEngineJobResult
def get_code_engine_job_output(id: Optional[pulumi.Input[str]] = None,
name: Optional[pulumi.Input[str]] = None,
project_id: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetCodeEngineJobResult]
func LookupCodeEngineJob(ctx *Context, args *LookupCodeEngineJobArgs, opts ...InvokeOption) (*LookupCodeEngineJobResult, error)
func LookupCodeEngineJobOutput(ctx *Context, args *LookupCodeEngineJobOutputArgs, opts ...InvokeOption) LookupCodeEngineJobResultOutput
> Note: This function is named LookupCodeEngineJob
in the Go SDK.
public static class GetCodeEngineJob
{
public static Task<GetCodeEngineJobResult> InvokeAsync(GetCodeEngineJobArgs args, InvokeOptions? opts = null)
public static Output<GetCodeEngineJobResult> Invoke(GetCodeEngineJobInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetCodeEngineJobResult> getCodeEngineJob(GetCodeEngineJobArgs args, InvokeOptions options)
public static Output<GetCodeEngineJobResult> getCodeEngineJob(GetCodeEngineJobArgs args, InvokeOptions options)
fn::invoke:
function: ibm:index/getCodeEngineJob:getCodeEngineJob
arguments:
# arguments dictionary
The following arguments are supported:
- Name string
- The name of your job.
- Constraints: The maximum length is
63
characters. The minimum length is1
character. The value must match regular expression/^a-z0-9?$/
.
- Constraints: The maximum length is
- Project
Id string - The ID of the project.
- Constraints: The maximum length is
36
characters. The minimum length is36
characters. The value must match regular expression/^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$/
.
- Constraints: The maximum length is
- Id string
- The unique identifier of the code_engine_job.
- Name string
- The name of your job.
- Constraints: The maximum length is
63
characters. The minimum length is1
character. The value must match regular expression/^a-z0-9?$/
.
- Constraints: The maximum length is
- Project
Id string - The ID of the project.
- Constraints: The maximum length is
36
characters. The minimum length is36
characters. The value must match regular expression/^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$/
.
- Constraints: The maximum length is
- Id string
- The unique identifier of the code_engine_job.
- name String
- The name of your job.
- Constraints: The maximum length is
63
characters. The minimum length is1
character. The value must match regular expression/^a-z0-9?$/
.
- Constraints: The maximum length is
- project
Id String - The ID of the project.
- Constraints: The maximum length is
36
characters. The minimum length is36
characters. The value must match regular expression/^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$/
.
- Constraints: The maximum length is
- id String
- The unique identifier of the code_engine_job.
- name string
- The name of your job.
- Constraints: The maximum length is
63
characters. The minimum length is1
character. The value must match regular expression/^a-z0-9?$/
.
- Constraints: The maximum length is
- project
Id string - The ID of the project.
- Constraints: The maximum length is
36
characters. The minimum length is36
characters. The value must match regular expression/^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$/
.
- Constraints: The maximum length is
- id string
- The unique identifier of the code_engine_job.
- name str
- The name of your job.
- Constraints: The maximum length is
63
characters. The minimum length is1
character. The value must match regular expression/^a-z0-9?$/
.
- Constraints: The maximum length is
- project_
id str - The ID of the project.
- Constraints: The maximum length is
36
characters. The minimum length is36
characters. The value must match regular expression/^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$/
.
- Constraints: The maximum length is
- id str
- The unique identifier of the code_engine_job.
- name String
- The name of your job.
- Constraints: The maximum length is
63
characters. The minimum length is1
character. The value must match regular expression/^a-z0-9?$/
.
- Constraints: The maximum length is
- project
Id String - The ID of the project.
- Constraints: The maximum length is
36
characters. The minimum length is36
characters. The value must match regular expression/^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$/
.
- Constraints: The maximum length is
- id String
- The unique identifier of the code_engine_job.
getCodeEngineJob Result
The following output properties are available:
- Build string
- (String) Reference to a build that is associated with the job.
- Build
Run string - (String) Reference to a build run that is associated with the job.
- Computed
Env List<GetVariables Code Engine Job Computed Env Variable> - (List) References to config maps, secrets or literal values, which are defined and set by Code Engine and are exposed as environment variables in the job run.
- Constraints: The maximum length is
100
items. The minimum length is0
items. Nested schema for computed_env_variables:
- Constraints: The maximum length is
- Created
At string - (String) The timestamp when the resource was created.
- Entity
Tag 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 is1
character. The value must match regular expression/^[\\*\\-a-z0-9]+$/
.
- Constraints: The maximum length is
- 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 is0
characters. The value must match regular expression/(([^:\/?#]+):)?(\/\/([^\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$/
.
- Constraints: The maximum length is
- Id string
- The unique identifier of the code_engine_job.
- Image
Reference string - (String) The name of the image that is used for this job. The format is
REGISTRY/NAMESPACE/REPOSITORY:TAG
whereREGISTRY
andTAG
are optional. IfREGISTRY
is not specified, the default isdocker.io
. IfTAG
is not specified, the default islatest
. If the image reference points to a registry that requires authentication, make sure to also specify the propertyimage_secret
.- Constraints: The maximum length is
256
characters. The minimum length is1
character. The value must match regular expression/^([a-z0-9][a-z0-9\\-_.]+[a-z0-9][\/])?([a-z0-9][a-z0-9\\-_]+[a-z0-9][\/])?[a-z0-9][a-z0-9\\-_.\/]+a-z0-9?(@sha256:[a-fA-F0-9]{64})?$/
.
- Constraints: The maximum length is
- Image
Secret string - (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 is1
character. The value must match regular expression/^a-z0-9?(\\.a-z0-9?)*$/
.
- Constraints: The maximum length is
- Job
Id string - (String) The identifier of the resource.
- Constraints: The maximum length is
36
characters. The minimum length is36
characters. The value must match regular expression/^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$/
.
- Constraints: The maximum length is
- Name string
- (String) The name of the mount.
- Constraints: The maximum length is
63
characters. The minimum length is0
characters. The value must match regular expression/^a-z?$/
.
- Constraints: The maximum length is
- Project
Id string - Region string
- (String) The region of the project the resource is located in. Possible values: 'au-syd', 'br-sao', 'ca-tor', 'eu-de', 'eu-gb', 'jp-osa', 'jp-tok', 'us-east', 'us-south'.
- Resource
Type string - (String) The type of the job.
- Constraints: Allowable values are:
job_v2
.
- Constraints: Allowable values are:
- Run
Arguments List<string> - (List) 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 is100
items. The minimum length is0
items.
- Constraints: The list items must match regular expression
- Run
As doubleUser - (Integer) The user ID (UID) to run the job.
- Constraints: The default value is
0
.
- Constraints: The default value is
- Run
Commands List<string> - (List) 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 is100
items. The minimum length is0
items.
- Constraints: The list items must match regular expression
- Run
Env List<GetVariables Code Engine Job Run Env Variable> - (List) 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 is0
items. Nested schema for run_env_variables:
- Constraints: The maximum length is
- Run
Mode string - (String) The mode for runs of the job. Valid values are
task
anddaemon
. Intask
mode, themax_execution_time
andretry_limit
properties apply. Indaemon
mode, since there is no timeout and failed instances are restarted indefinitely, themax_execution_time
andretry_limit
properties are not allowed.- Constraints: The default value is
task
. Allowable values are:task
,daemon
. The minimum length is0
characters. The value must match regular expression/^(task|daemon)$/
.
- Constraints: The default value is
- Run
Service stringAccount - (String) The name of the service account. For built-in service accounts, you can use the shortened names
manager
,none
,reader
, andwriter
. 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 is0
characters. The value must match regular expression/^(manager|reader|writer|none|default)$/
.
- Constraints: The default value is
- Run
Volume List<GetMounts Code Engine Job Run Volume Mount> - (List) Optional mounts of config maps or secrets.
- Constraints: The maximum length is
100
items. The minimum length is0
items. Nested schema for run_volume_mounts:
- Constraints: The maximum length is
- Scale
Array stringSpec - (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 maximum length is
253
characters. The minimum length is1
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))?)*$/
.
- Constraints: The maximum length is
- Scale
Cpu stringLimit - (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 is10
characters. The minimum length is0
characters. The value must match regular expression/^([0-9.]+)([eEinumkKMGTPB]*)$/
.
- Constraints: The default value is
- Scale
Ephemeral stringStorage Limit - (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 is10
characters. The minimum length is0
characters. The value must match regular expression/^([0-9.]+)([eEinumkKMGTPB]*)$/
.
- Constraints: The default value is
- Scale
Max doubleExecution Time - (Integer) The maximum execution time in seconds for runs of the job. This property can only be specified if
run_mode
istask
.- Constraints: The default value is
7200
.
- Constraints: The default value is
- Scale
Memory stringLimit - (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 is10
characters. The minimum length is0
characters. The value must match regular expression/^([0-9.]+)([eEinumkKMGTPB]*)$/
.
- Constraints: The default value is
- Scale
Retry doubleLimit - (Integer) 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
istask
.- Constraints: The default value is
3
.
- Constraints: The default value is
- Build string
- (String) Reference to a build that is associated with the job.
- Build
Run string - (String) Reference to a build run that is associated with the job.
- Computed
Env []GetVariables Code Engine Job Computed Env Variable - (List) References to config maps, secrets or literal values, which are defined and set by Code Engine and are exposed as environment variables in the job run.
- Constraints: The maximum length is
100
items. The minimum length is0
items. Nested schema for computed_env_variables:
- Constraints: The maximum length is
- Created
At string - (String) The timestamp when the resource was created.
- Entity
Tag 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 is1
character. The value must match regular expression/^[\\*\\-a-z0-9]+$/
.
- Constraints: The maximum length is
- 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 is0
characters. The value must match regular expression/(([^:\/?#]+):)?(\/\/([^\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$/
.
- Constraints: The maximum length is
- Id string
- The unique identifier of the code_engine_job.
- Image
Reference string - (String) The name of the image that is used for this job. The format is
REGISTRY/NAMESPACE/REPOSITORY:TAG
whereREGISTRY
andTAG
are optional. IfREGISTRY
is not specified, the default isdocker.io
. IfTAG
is not specified, the default islatest
. If the image reference points to a registry that requires authentication, make sure to also specify the propertyimage_secret
.- Constraints: The maximum length is
256
characters. The minimum length is1
character. The value must match regular expression/^([a-z0-9][a-z0-9\\-_.]+[a-z0-9][\/])?([a-z0-9][a-z0-9\\-_]+[a-z0-9][\/])?[a-z0-9][a-z0-9\\-_.\/]+a-z0-9?(@sha256:[a-fA-F0-9]{64})?$/
.
- Constraints: The maximum length is
- Image
Secret string - (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 is1
character. The value must match regular expression/^a-z0-9?(\\.a-z0-9?)*$/
.
- Constraints: The maximum length is
- Job
Id string - (String) The identifier of the resource.
- Constraints: The maximum length is
36
characters. The minimum length is36
characters. The value must match regular expression/^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$/
.
- Constraints: The maximum length is
- Name string
- (String) The name of the mount.
- Constraints: The maximum length is
63
characters. The minimum length is0
characters. The value must match regular expression/^a-z?$/
.
- Constraints: The maximum length is
- Project
Id string - Region string
- (String) The region of the project the resource is located in. Possible values: 'au-syd', 'br-sao', 'ca-tor', 'eu-de', 'eu-gb', 'jp-osa', 'jp-tok', 'us-east', 'us-south'.
- Resource
Type string - (String) The type of the job.
- Constraints: Allowable values are:
job_v2
.
- Constraints: Allowable values are:
- Run
Arguments []string - (List) 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 is100
items. The minimum length is0
items.
- Constraints: The list items must match regular expression
- Run
As float64User - (Integer) The user ID (UID) to run the job.
- Constraints: The default value is
0
.
- Constraints: The default value is
- Run
Commands []string - (List) 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 is100
items. The minimum length is0
items.
- Constraints: The list items must match regular expression
- Run
Env []GetVariables Code Engine Job Run Env Variable - (List) 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 is0
items. Nested schema for run_env_variables:
- Constraints: The maximum length is
- Run
Mode string - (String) The mode for runs of the job. Valid values are
task
anddaemon
. Intask
mode, themax_execution_time
andretry_limit
properties apply. Indaemon
mode, since there is no timeout and failed instances are restarted indefinitely, themax_execution_time
andretry_limit
properties are not allowed.- Constraints: The default value is
task
. Allowable values are:task
,daemon
. The minimum length is0
characters. The value must match regular expression/^(task|daemon)$/
.
- Constraints: The default value is
- Run
Service stringAccount - (String) The name of the service account. For built-in service accounts, you can use the shortened names
manager
,none
,reader
, andwriter
. 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 is0
characters. The value must match regular expression/^(manager|reader|writer|none|default)$/
.
- Constraints: The default value is
- Run
Volume []GetMounts Code Engine Job Run Volume Mount - (List) Optional mounts of config maps or secrets.
- Constraints: The maximum length is
100
items. The minimum length is0
items. Nested schema for run_volume_mounts:
- Constraints: The maximum length is
- Scale
Array stringSpec - (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 maximum length is
253
characters. The minimum length is1
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))?)*$/
.
- Constraints: The maximum length is
- Scale
Cpu stringLimit - (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 is10
characters. The minimum length is0
characters. The value must match regular expression/^([0-9.]+)([eEinumkKMGTPB]*)$/
.
- Constraints: The default value is
- Scale
Ephemeral stringStorage Limit - (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 is10
characters. The minimum length is0
characters. The value must match regular expression/^([0-9.]+)([eEinumkKMGTPB]*)$/
.
- Constraints: The default value is
- Scale
Max float64Execution Time - (Integer) The maximum execution time in seconds for runs of the job. This property can only be specified if
run_mode
istask
.- Constraints: The default value is
7200
.
- Constraints: The default value is
- Scale
Memory stringLimit - (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 is10
characters. The minimum length is0
characters. The value must match regular expression/^([0-9.]+)([eEinumkKMGTPB]*)$/
.
- Constraints: The default value is
- Scale
Retry float64Limit - (Integer) 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
istask
.- Constraints: The default value is
3
.
- Constraints: The default value is
- build String
- (String) Reference to a build that is associated with the job.
- build
Run String - (String) Reference to a build run that is associated with the job.
- computed
Env List<GetVariables Code Engine Job Computed Env Variable> - (List) References to config maps, secrets or literal values, which are defined and set by Code Engine and are exposed as environment variables in the job run.
- Constraints: The maximum length is
100
items. The minimum length is0
items. Nested schema for computed_env_variables:
- Constraints: The maximum length is
- created
At String - (String) The timestamp when the resource was created.
- entity
Tag 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 is1
character. The value must match regular expression/^[\\*\\-a-z0-9]+$/
.
- Constraints: The maximum length is
- 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 is0
characters. The value must match regular expression/(([^:\/?#]+):)?(\/\/([^\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$/
.
- Constraints: The maximum length is
- id String
- The unique identifier of the code_engine_job.
- image
Reference String - (String) The name of the image that is used for this job. The format is
REGISTRY/NAMESPACE/REPOSITORY:TAG
whereREGISTRY
andTAG
are optional. IfREGISTRY
is not specified, the default isdocker.io
. IfTAG
is not specified, the default islatest
. If the image reference points to a registry that requires authentication, make sure to also specify the propertyimage_secret
.- Constraints: The maximum length is
256
characters. The minimum length is1
character. The value must match regular expression/^([a-z0-9][a-z0-9\\-_.]+[a-z0-9][\/])?([a-z0-9][a-z0-9\\-_]+[a-z0-9][\/])?[a-z0-9][a-z0-9\\-_.\/]+a-z0-9?(@sha256:[a-fA-F0-9]{64})?$/
.
- Constraints: The maximum length is
- image
Secret String - (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 is1
character. The value must match regular expression/^a-z0-9?(\\.a-z0-9?)*$/
.
- Constraints: The maximum length is
- job
Id String - (String) The identifier of the resource.
- Constraints: The maximum length is
36
characters. The minimum length is36
characters. The value must match regular expression/^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$/
.
- Constraints: The maximum length is
- name String
- (String) The name of the mount.
- Constraints: The maximum length is
63
characters. The minimum length is0
characters. The value must match regular expression/^a-z?$/
.
- Constraints: The maximum length is
- project
Id String - region String
- (String) The region of the project the resource is located in. Possible values: 'au-syd', 'br-sao', 'ca-tor', 'eu-de', 'eu-gb', 'jp-osa', 'jp-tok', 'us-east', 'us-south'.
- resource
Type String - (String) The type of the job.
- Constraints: Allowable values are:
job_v2
.
- Constraints: Allowable values are:
- run
Arguments List<String> - (List) 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 is100
items. The minimum length is0
items.
- Constraints: The list items must match regular expression
- run
As DoubleUser - (Integer) The user ID (UID) to run the job.
- Constraints: The default value is
0
.
- Constraints: The default value is
- run
Commands List<String> - (List) 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 is100
items. The minimum length is0
items.
- Constraints: The list items must match regular expression
- run
Env List<GetVariables Code Engine Job Run Env Variable> - (List) 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 is0
items. Nested schema for run_env_variables:
- Constraints: The maximum length is
- run
Mode String - (String) The mode for runs of the job. Valid values are
task
anddaemon
. Intask
mode, themax_execution_time
andretry_limit
properties apply. Indaemon
mode, since there is no timeout and failed instances are restarted indefinitely, themax_execution_time
andretry_limit
properties are not allowed.- Constraints: The default value is
task
. Allowable values are:task
,daemon
. The minimum length is0
characters. The value must match regular expression/^(task|daemon)$/
.
- Constraints: The default value is
- run
Service StringAccount - (String) The name of the service account. For built-in service accounts, you can use the shortened names
manager
,none
,reader
, andwriter
. 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 is0
characters. The value must match regular expression/^(manager|reader|writer|none|default)$/
.
- Constraints: The default value is
- run
Volume List<GetMounts Code Engine Job Run Volume Mount> - (List) Optional mounts of config maps or secrets.
- Constraints: The maximum length is
100
items. The minimum length is0
items. Nested schema for run_volume_mounts:
- Constraints: The maximum length is
- scale
Array StringSpec - (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 maximum length is
253
characters. The minimum length is1
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))?)*$/
.
- Constraints: The maximum length is
- scale
Cpu StringLimit - (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 is10
characters. The minimum length is0
characters. The value must match regular expression/^([0-9.]+)([eEinumkKMGTPB]*)$/
.
- Constraints: The default value is
- scale
Ephemeral StringStorage Limit - (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 is10
characters. The minimum length is0
characters. The value must match regular expression/^([0-9.]+)([eEinumkKMGTPB]*)$/
.
- Constraints: The default value is
- scale
Max DoubleExecution Time - (Integer) The maximum execution time in seconds for runs of the job. This property can only be specified if
run_mode
istask
.- Constraints: The default value is
7200
.
- Constraints: The default value is
- scale
Memory StringLimit - (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 is10
characters. The minimum length is0
characters. The value must match regular expression/^([0-9.]+)([eEinumkKMGTPB]*)$/
.
- Constraints: The default value is
- scale
Retry DoubleLimit - (Integer) 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
istask
.- Constraints: The default value is
3
.
- Constraints: The default value is
- build string
- (String) Reference to a build that is associated with the job.
- build
Run string - (String) Reference to a build run that is associated with the job.
- computed
Env GetVariables Code Engine Job Computed Env Variable[] - (List) References to config maps, secrets or literal values, which are defined and set by Code Engine and are exposed as environment variables in the job run.
- Constraints: The maximum length is
100
items. The minimum length is0
items. Nested schema for computed_env_variables:
- Constraints: The maximum length is
- created
At string - (String) The timestamp when the resource was created.
- entity
Tag 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 is1
character. The value must match regular expression/^[\\*\\-a-z0-9]+$/
.
- Constraints: The maximum length is
- 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 is0
characters. The value must match regular expression/(([^:\/?#]+):)?(\/\/([^\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$/
.
- Constraints: The maximum length is
- id string
- The unique identifier of the code_engine_job.
- image
Reference string - (String) The name of the image that is used for this job. The format is
REGISTRY/NAMESPACE/REPOSITORY:TAG
whereREGISTRY
andTAG
are optional. IfREGISTRY
is not specified, the default isdocker.io
. IfTAG
is not specified, the default islatest
. If the image reference points to a registry that requires authentication, make sure to also specify the propertyimage_secret
.- Constraints: The maximum length is
256
characters. The minimum length is1
character. The value must match regular expression/^([a-z0-9][a-z0-9\\-_.]+[a-z0-9][\/])?([a-z0-9][a-z0-9\\-_]+[a-z0-9][\/])?[a-z0-9][a-z0-9\\-_.\/]+a-z0-9?(@sha256:[a-fA-F0-9]{64})?$/
.
- Constraints: The maximum length is
- image
Secret string - (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 is1
character. The value must match regular expression/^a-z0-9?(\\.a-z0-9?)*$/
.
- Constraints: The maximum length is
- job
Id string - (String) The identifier of the resource.
- Constraints: The maximum length is
36
characters. The minimum length is36
characters. The value must match regular expression/^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$/
.
- Constraints: The maximum length is
- name string
- (String) The name of the mount.
- Constraints: The maximum length is
63
characters. The minimum length is0
characters. The value must match regular expression/^a-z?$/
.
- Constraints: The maximum length is
- project
Id string - region string
- (String) The region of the project the resource is located in. Possible values: 'au-syd', 'br-sao', 'ca-tor', 'eu-de', 'eu-gb', 'jp-osa', 'jp-tok', 'us-east', 'us-south'.
- resource
Type string - (String) The type of the job.
- Constraints: Allowable values are:
job_v2
.
- Constraints: Allowable values are:
- run
Arguments string[] - (List) 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 is100
items. The minimum length is0
items.
- Constraints: The list items must match regular expression
- run
As numberUser - (Integer) The user ID (UID) to run the job.
- Constraints: The default value is
0
.
- Constraints: The default value is
- run
Commands string[] - (List) 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 is100
items. The minimum length is0
items.
- Constraints: The list items must match regular expression
- run
Env GetVariables Code Engine Job Run Env Variable[] - (List) 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 is0
items. Nested schema for run_env_variables:
- Constraints: The maximum length is
- run
Mode string - (String) The mode for runs of the job. Valid values are
task
anddaemon
. Intask
mode, themax_execution_time
andretry_limit
properties apply. Indaemon
mode, since there is no timeout and failed instances are restarted indefinitely, themax_execution_time
andretry_limit
properties are not allowed.- Constraints: The default value is
task
. Allowable values are:task
,daemon
. The minimum length is0
characters. The value must match regular expression/^(task|daemon)$/
.
- Constraints: The default value is
- run
Service stringAccount - (String) The name of the service account. For built-in service accounts, you can use the shortened names
manager
,none
,reader
, andwriter
. 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 is0
characters. The value must match regular expression/^(manager|reader|writer|none|default)$/
.
- Constraints: The default value is
- run
Volume GetMounts Code Engine Job Run Volume Mount[] - (List) Optional mounts of config maps or secrets.
- Constraints: The maximum length is
100
items. The minimum length is0
items. Nested schema for run_volume_mounts:
- Constraints: The maximum length is
- scale
Array stringSpec - (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 maximum length is
253
characters. The minimum length is1
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))?)*$/
.
- Constraints: The maximum length is
- scale
Cpu stringLimit - (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 is10
characters. The minimum length is0
characters. The value must match regular expression/^([0-9.]+)([eEinumkKMGTPB]*)$/
.
- Constraints: The default value is
- scale
Ephemeral stringStorage Limit - (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 is10
characters. The minimum length is0
characters. The value must match regular expression/^([0-9.]+)([eEinumkKMGTPB]*)$/
.
- Constraints: The default value is
- scale
Max numberExecution Time - (Integer) The maximum execution time in seconds for runs of the job. This property can only be specified if
run_mode
istask
.- Constraints: The default value is
7200
.
- Constraints: The default value is
- scale
Memory stringLimit - (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 is10
characters. The minimum length is0
characters. The value must match regular expression/^([0-9.]+)([eEinumkKMGTPB]*)$/
.
- Constraints: The default value is
- scale
Retry numberLimit - (Integer) 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
istask
.- Constraints: The default value is
3
.
- Constraints: The default value is
- 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_ Sequence[Getvariables Code Engine Job Computed Env Variable] - (List) References to config maps, secrets or literal values, which are defined and set by Code Engine and are exposed as environment variables in the job run.
- Constraints: The maximum length is
100
items. The minimum length is0
items. Nested schema for computed_env_variables:
- Constraints: The maximum length is
- created_
at str - (String) The timestamp when the resource was created.
- 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 is1
character. The value must match regular expression/^[\\*\\-a-z0-9]+$/
.
- Constraints: The maximum length is
- 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 is0
characters. The value must match regular expression/(([^:\/?#]+):)?(\/\/([^\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$/
.
- Constraints: The maximum length is
- id str
- The unique identifier of the code_engine_job.
- image_
reference str - (String) The name of the image that is used for this job. The format is
REGISTRY/NAMESPACE/REPOSITORY:TAG
whereREGISTRY
andTAG
are optional. IfREGISTRY
is not specified, the default isdocker.io
. IfTAG
is not specified, the default islatest
. If the image reference points to a registry that requires authentication, make sure to also specify the propertyimage_secret
.- Constraints: The maximum length is
256
characters. The minimum length is1
character. The value must match regular expression/^([a-z0-9][a-z0-9\\-_.]+[a-z0-9][\/])?([a-z0-9][a-z0-9\\-_]+[a-z0-9][\/])?[a-z0-9][a-z0-9\\-_.\/]+a-z0-9?(@sha256:[a-fA-F0-9]{64})?$/
.
- Constraints: The maximum length is
- image_
secret str - (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 is1
character. The value must match regular expression/^a-z0-9?(\\.a-z0-9?)*$/
.
- Constraints: The maximum length is
- job_
id str - (String) The identifier of the resource.
- Constraints: The maximum length is
36
characters. The minimum length is36
characters. The value must match regular expression/^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$/
.
- Constraints: The maximum length is
- name str
- (String) The name of the mount.
- Constraints: The maximum length is
63
characters. The minimum length is0
characters. The value must match regular expression/^a-z?$/
.
- Constraints: The maximum length is
- project_
id str - region str
- (String) The region of the project the resource is located in. Possible values: 'au-syd', 'br-sao', 'ca-tor', 'eu-de', 'eu-gb', 'jp-osa', 'jp-tok', 'us-east', 'us-south'.
- resource_
type str - (String) The type of the job.
- Constraints: Allowable values are:
job_v2
.
- Constraints: Allowable values are:
- run_
arguments Sequence[str] - (List) 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 is100
items. The minimum length is0
items.
- Constraints: The list items must match regular expression
- run_
as_ floatuser - (Integer) The user ID (UID) to run the job.
- Constraints: The default value is
0
.
- Constraints: The default value is
- run_
commands Sequence[str] - (List) 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 is100
items. The minimum length is0
items.
- Constraints: The list items must match regular expression
- run_
env_ Sequence[Getvariables Code Engine Job Run Env Variable] - (List) 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 is0
items. Nested schema for run_env_variables:
- Constraints: The maximum length is
- run_
mode str - (String) The mode for runs of the job. Valid values are
task
anddaemon
. Intask
mode, themax_execution_time
andretry_limit
properties apply. Indaemon
mode, since there is no timeout and failed instances are restarted indefinitely, themax_execution_time
andretry_limit
properties are not allowed.- Constraints: The default value is
task
. Allowable values are:task
,daemon
. The minimum length is0
characters. The value must match regular expression/^(task|daemon)$/
.
- Constraints: The default value is
- run_
service_ straccount - (String) The name of the service account. For built-in service accounts, you can use the shortened names
manager
,none
,reader
, andwriter
. 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 is0
characters. The value must match regular expression/^(manager|reader|writer|none|default)$/
.
- Constraints: The default value is
- run_
volume_ Sequence[Getmounts Code Engine Job Run Volume Mount] - (List) Optional mounts of config maps or secrets.
- Constraints: The maximum length is
100
items. The minimum length is0
items. Nested schema for run_volume_mounts:
- Constraints: The maximum length is
- scale_
array_ strspec - (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 maximum length is
253
characters. The minimum length is1
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))?)*$/
.
- Constraints: The maximum length is
- scale_
cpu_ strlimit - (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 is10
characters. The minimum length is0
characters. The value must match regular expression/^([0-9.]+)([eEinumkKMGTPB]*)$/
.
- Constraints: The default value is
- scale_
ephemeral_ strstorage_ limit - (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 is10
characters. The minimum length is0
characters. The value must match regular expression/^([0-9.]+)([eEinumkKMGTPB]*)$/
.
- Constraints: The default value is
- scale_
max_ floatexecution_ time - (Integer) The maximum execution time in seconds for runs of the job. This property can only be specified if
run_mode
istask
.- Constraints: The default value is
7200
.
- Constraints: The default value is
- scale_
memory_ strlimit - (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 is10
characters. The minimum length is0
characters. The value must match regular expression/^([0-9.]+)([eEinumkKMGTPB]*)$/
.
- Constraints: The default value is
- scale_
retry_ floatlimit - (Integer) 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
istask
.- Constraints: The default value is
3
.
- Constraints: The default value is
- build String
- (String) Reference to a build that is associated with the job.
- build
Run String - (String) Reference to a build run that is associated with the job.
- computed
Env List<Property Map>Variables - (List) References to config maps, secrets or literal values, which are defined and set by Code Engine and are exposed as environment variables in the job run.
- Constraints: The maximum length is
100
items. The minimum length is0
items. Nested schema for computed_env_variables:
- Constraints: The maximum length is
- created
At String - (String) The timestamp when the resource was created.
- entity
Tag 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 is1
character. The value must match regular expression/^[\\*\\-a-z0-9]+$/
.
- Constraints: The maximum length is
- 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 is0
characters. The value must match regular expression/(([^:\/?#]+):)?(\/\/([^\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$/
.
- Constraints: The maximum length is
- id String
- The unique identifier of the code_engine_job.
- image
Reference String - (String) The name of the image that is used for this job. The format is
REGISTRY/NAMESPACE/REPOSITORY:TAG
whereREGISTRY
andTAG
are optional. IfREGISTRY
is not specified, the default isdocker.io
. IfTAG
is not specified, the default islatest
. If the image reference points to a registry that requires authentication, make sure to also specify the propertyimage_secret
.- Constraints: The maximum length is
256
characters. The minimum length is1
character. The value must match regular expression/^([a-z0-9][a-z0-9\\-_.]+[a-z0-9][\/])?([a-z0-9][a-z0-9\\-_]+[a-z0-9][\/])?[a-z0-9][a-z0-9\\-_.\/]+a-z0-9?(@sha256:[a-fA-F0-9]{64})?$/
.
- Constraints: The maximum length is
- image
Secret String - (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 is1
character. The value must match regular expression/^a-z0-9?(\\.a-z0-9?)*$/
.
- Constraints: The maximum length is
- job
Id String - (String) The identifier of the resource.
- Constraints: The maximum length is
36
characters. The minimum length is36
characters. The value must match regular expression/^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$/
.
- Constraints: The maximum length is
- name String
- (String) The name of the mount.
- Constraints: The maximum length is
63
characters. The minimum length is0
characters. The value must match regular expression/^a-z?$/
.
- Constraints: The maximum length is
- project
Id String - region String
- (String) The region of the project the resource is located in. Possible values: 'au-syd', 'br-sao', 'ca-tor', 'eu-de', 'eu-gb', 'jp-osa', 'jp-tok', 'us-east', 'us-south'.
- resource
Type String - (String) The type of the job.
- Constraints: Allowable values are:
job_v2
.
- Constraints: Allowable values are:
- run
Arguments List<String> - (List) 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 is100
items. The minimum length is0
items.
- Constraints: The list items must match regular expression
- run
As NumberUser - (Integer) The user ID (UID) to run the job.
- Constraints: The default value is
0
.
- Constraints: The default value is
- run
Commands List<String> - (List) 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 is100
items. The minimum length is0
items.
- Constraints: The list items must match regular expression
- run
Env List<Property Map>Variables - (List) 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 is0
items. Nested schema for run_env_variables:
- Constraints: The maximum length is
- run
Mode String - (String) The mode for runs of the job. Valid values are
task
anddaemon
. Intask
mode, themax_execution_time
andretry_limit
properties apply. Indaemon
mode, since there is no timeout and failed instances are restarted indefinitely, themax_execution_time
andretry_limit
properties are not allowed.- Constraints: The default value is
task
. Allowable values are:task
,daemon
. The minimum length is0
characters. The value must match regular expression/^(task|daemon)$/
.
- Constraints: The default value is
- run
Service StringAccount - (String) The name of the service account. For built-in service accounts, you can use the shortened names
manager
,none
,reader
, andwriter
. 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 is0
characters. The value must match regular expression/^(manager|reader|writer|none|default)$/
.
- Constraints: The default value is
- run
Volume List<Property Map>Mounts - (List) Optional mounts of config maps or secrets.
- Constraints: The maximum length is
100
items. The minimum length is0
items. Nested schema for run_volume_mounts:
- Constraints: The maximum length is
- scale
Array StringSpec - (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 maximum length is
253
characters. The minimum length is1
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))?)*$/
.
- Constraints: The maximum length is
- scale
Cpu StringLimit - (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 is10
characters. The minimum length is0
characters. The value must match regular expression/^([0-9.]+)([eEinumkKMGTPB]*)$/
.
- Constraints: The default value is
- scale
Ephemeral StringStorage Limit - (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 is10
characters. The minimum length is0
characters. The value must match regular expression/^([0-9.]+)([eEinumkKMGTPB]*)$/
.
- Constraints: The default value is
- scale
Max NumberExecution Time - (Integer) The maximum execution time in seconds for runs of the job. This property can only be specified if
run_mode
istask
.- Constraints: The default value is
7200
.
- Constraints: The default value is
- scale
Memory StringLimit - (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 is10
characters. The minimum length is0
characters. The value must match regular expression/^([0-9.]+)([eEinumkKMGTPB]*)$/
.
- Constraints: The default value is
- scale
Retry NumberLimit - (Integer) 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
istask
.- Constraints: The default value is
3
.
- Constraints: The default value is
Supporting Types
GetCodeEngineJobComputedEnvVariable
- Key string
- (String) The key to reference as environment variable.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^[\\-._a-zA-Z0-9]+$/
.
- Constraints: The maximum length is
- Name string
- The name of your job.
- Constraints: The maximum length is
63
characters. The minimum length is1
character. The value must match regular expression/^a-z0-9?$/
.
- Constraints: The maximum length is
- Prefix string
- (String) A prefix that can be added to all keys of a full secret or config map reference.
- Constraints: The maximum length is
253
characters. The minimum length is0
characters. The value must match regular expression/^[a-zA-Z_][a-zA-Z0-9_]*$/
.
- Constraints: The maximum length is
- Reference string
- (String) The name of the referenced secret or config map.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^a-z0-9?(\\.a-z0-9?)*$/
.
- Constraints: The maximum length is
- Type string
- (String) Specify the type of the volume mount. Allowed types are: 'config_map', 'secret'.
- Constraints: The default value is
secret
. Allowable values are:config_map
,secret
. The value must match regular expression/^(config_map|secret)$/
.
- Constraints: The default value is
- Value string
- (String) The literal value of the environment variable.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^[\\-._a-zA-Z0-9]+$/
.
- Constraints: The maximum length is
- Key string
- (String) The key to reference as environment variable.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^[\\-._a-zA-Z0-9]+$/
.
- Constraints: The maximum length is
- Name string
- The name of your job.
- Constraints: The maximum length is
63
characters. The minimum length is1
character. The value must match regular expression/^a-z0-9?$/
.
- Constraints: The maximum length is
- Prefix string
- (String) A prefix that can be added to all keys of a full secret or config map reference.
- Constraints: The maximum length is
253
characters. The minimum length is0
characters. The value must match regular expression/^[a-zA-Z_][a-zA-Z0-9_]*$/
.
- Constraints: The maximum length is
- Reference string
- (String) The name of the referenced secret or config map.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^a-z0-9?(\\.a-z0-9?)*$/
.
- Constraints: The maximum length is
- Type string
- (String) Specify the type of the volume mount. Allowed types are: 'config_map', 'secret'.
- Constraints: The default value is
secret
. Allowable values are:config_map
,secret
. The value must match regular expression/^(config_map|secret)$/
.
- Constraints: The default value is
- Value string
- (String) The literal value of the environment variable.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^[\\-._a-zA-Z0-9]+$/
.
- Constraints: The maximum length is
- key String
- (String) The key to reference as environment variable.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^[\\-._a-zA-Z0-9]+$/
.
- Constraints: The maximum length is
- name String
- The name of your job.
- Constraints: The maximum length is
63
characters. The minimum length is1
character. The value must match regular expression/^a-z0-9?$/
.
- Constraints: The maximum length is
- prefix String
- (String) A prefix that can be added to all keys of a full secret or config map reference.
- Constraints: The maximum length is
253
characters. The minimum length is0
characters. The value must match regular expression/^[a-zA-Z_][a-zA-Z0-9_]*$/
.
- Constraints: The maximum length is
- reference String
- (String) The name of the referenced secret or config map.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^a-z0-9?(\\.a-z0-9?)*$/
.
- Constraints: The maximum length is
- type String
- (String) Specify the type of the volume mount. Allowed types are: 'config_map', 'secret'.
- Constraints: The default value is
secret
. Allowable values are:config_map
,secret
. The value must match regular expression/^(config_map|secret)$/
.
- Constraints: The default value is
- value String
- (String) The literal value of the environment variable.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^[\\-._a-zA-Z0-9]+$/
.
- Constraints: The maximum length is
- key string
- (String) The key to reference as environment variable.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^[\\-._a-zA-Z0-9]+$/
.
- Constraints: The maximum length is
- name string
- The name of your job.
- Constraints: The maximum length is
63
characters. The minimum length is1
character. The value must match regular expression/^a-z0-9?$/
.
- Constraints: The maximum length is
- prefix string
- (String) A prefix that can be added to all keys of a full secret or config map reference.
- Constraints: The maximum length is
253
characters. The minimum length is0
characters. The value must match regular expression/^[a-zA-Z_][a-zA-Z0-9_]*$/
.
- Constraints: The maximum length is
- reference string
- (String) The name of the referenced secret or config map.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^a-z0-9?(\\.a-z0-9?)*$/
.
- Constraints: The maximum length is
- type string
- (String) Specify the type of the volume mount. Allowed types are: 'config_map', 'secret'.
- Constraints: The default value is
secret
. Allowable values are:config_map
,secret
. The value must match regular expression/^(config_map|secret)$/
.
- Constraints: The default value is
- value string
- (String) The literal value of the environment variable.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^[\\-._a-zA-Z0-9]+$/
.
- Constraints: The maximum length is
- key str
- (String) The key to reference as environment variable.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^[\\-._a-zA-Z0-9]+$/
.
- Constraints: The maximum length is
- name str
- The name of your job.
- Constraints: The maximum length is
63
characters. The minimum length is1
character. The value must match regular expression/^a-z0-9?$/
.
- Constraints: The maximum length is
- prefix str
- (String) A prefix that can be added to all keys of a full secret or config map reference.
- Constraints: The maximum length is
253
characters. The minimum length is0
characters. The value must match regular expression/^[a-zA-Z_][a-zA-Z0-9_]*$/
.
- Constraints: The maximum length is
- reference str
- (String) The name of the referenced secret or config map.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^a-z0-9?(\\.a-z0-9?)*$/
.
- Constraints: The maximum length is
- type str
- (String) Specify the type of the volume mount. Allowed types are: 'config_map', 'secret'.
- Constraints: The default value is
secret
. Allowable values are:config_map
,secret
. The value must match regular expression/^(config_map|secret)$/
.
- Constraints: The default value is
- value str
- (String) The literal value of the environment variable.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^[\\-._a-zA-Z0-9]+$/
.
- Constraints: The maximum length is
- key String
- (String) The key to reference as environment variable.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^[\\-._a-zA-Z0-9]+$/
.
- Constraints: The maximum length is
- name String
- The name of your job.
- Constraints: The maximum length is
63
characters. The minimum length is1
character. The value must match regular expression/^a-z0-9?$/
.
- Constraints: The maximum length is
- prefix String
- (String) A prefix that can be added to all keys of a full secret or config map reference.
- Constraints: The maximum length is
253
characters. The minimum length is0
characters. The value must match regular expression/^[a-zA-Z_][a-zA-Z0-9_]*$/
.
- Constraints: The maximum length is
- reference String
- (String) The name of the referenced secret or config map.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^a-z0-9?(\\.a-z0-9?)*$/
.
- Constraints: The maximum length is
- type String
- (String) Specify the type of the volume mount. Allowed types are: 'config_map', 'secret'.
- Constraints: The default value is
secret
. Allowable values are:config_map
,secret
. The value must match regular expression/^(config_map|secret)$/
.
- Constraints: The default value is
- value String
- (String) The literal value of the environment variable.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^[\\-._a-zA-Z0-9]+$/
.
- Constraints: The maximum length is
GetCodeEngineJobRunEnvVariable
- Key string
- (String) The key to reference as environment variable.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^[\\-._a-zA-Z0-9]+$/
.
- Constraints: The maximum length is
- Name string
- The name of your job.
- Constraints: The maximum length is
63
characters. The minimum length is1
character. The value must match regular expression/^a-z0-9?$/
.
- Constraints: The maximum length is
- Prefix string
- (String) A prefix that can be added to all keys of a full secret or config map reference.
- Constraints: The maximum length is
253
characters. The minimum length is0
characters. The value must match regular expression/^[a-zA-Z_][a-zA-Z0-9_]*$/
.
- Constraints: The maximum length is
- Reference string
- (String) The name of the referenced secret or config map.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^a-z0-9?(\\.a-z0-9?)*$/
.
- Constraints: The maximum length is
- Type string
- (String) Specify the type of the volume mount. Allowed types are: 'config_map', 'secret'.
- Constraints: The default value is
secret
. Allowable values are:config_map
,secret
. The value must match regular expression/^(config_map|secret)$/
.
- Constraints: The default value is
- Value string
- (String) The literal value of the environment variable.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^[\\-._a-zA-Z0-9]+$/
.
- Constraints: The maximum length is
- Key string
- (String) The key to reference as environment variable.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^[\\-._a-zA-Z0-9]+$/
.
- Constraints: The maximum length is
- Name string
- The name of your job.
- Constraints: The maximum length is
63
characters. The minimum length is1
character. The value must match regular expression/^a-z0-9?$/
.
- Constraints: The maximum length is
- Prefix string
- (String) A prefix that can be added to all keys of a full secret or config map reference.
- Constraints: The maximum length is
253
characters. The minimum length is0
characters. The value must match regular expression/^[a-zA-Z_][a-zA-Z0-9_]*$/
.
- Constraints: The maximum length is
- Reference string
- (String) The name of the referenced secret or config map.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^a-z0-9?(\\.a-z0-9?)*$/
.
- Constraints: The maximum length is
- Type string
- (String) Specify the type of the volume mount. Allowed types are: 'config_map', 'secret'.
- Constraints: The default value is
secret
. Allowable values are:config_map
,secret
. The value must match regular expression/^(config_map|secret)$/
.
- Constraints: The default value is
- Value string
- (String) The literal value of the environment variable.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^[\\-._a-zA-Z0-9]+$/
.
- Constraints: The maximum length is
- key String
- (String) The key to reference as environment variable.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^[\\-._a-zA-Z0-9]+$/
.
- Constraints: The maximum length is
- name String
- The name of your job.
- Constraints: The maximum length is
63
characters. The minimum length is1
character. The value must match regular expression/^a-z0-9?$/
.
- Constraints: The maximum length is
- prefix String
- (String) A prefix that can be added to all keys of a full secret or config map reference.
- Constraints: The maximum length is
253
characters. The minimum length is0
characters. The value must match regular expression/^[a-zA-Z_][a-zA-Z0-9_]*$/
.
- Constraints: The maximum length is
- reference String
- (String) The name of the referenced secret or config map.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^a-z0-9?(\\.a-z0-9?)*$/
.
- Constraints: The maximum length is
- type String
- (String) Specify the type of the volume mount. Allowed types are: 'config_map', 'secret'.
- Constraints: The default value is
secret
. Allowable values are:config_map
,secret
. The value must match regular expression/^(config_map|secret)$/
.
- Constraints: The default value is
- value String
- (String) The literal value of the environment variable.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^[\\-._a-zA-Z0-9]+$/
.
- Constraints: The maximum length is
- key string
- (String) The key to reference as environment variable.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^[\\-._a-zA-Z0-9]+$/
.
- Constraints: The maximum length is
- name string
- The name of your job.
- Constraints: The maximum length is
63
characters. The minimum length is1
character. The value must match regular expression/^a-z0-9?$/
.
- Constraints: The maximum length is
- prefix string
- (String) A prefix that can be added to all keys of a full secret or config map reference.
- Constraints: The maximum length is
253
characters. The minimum length is0
characters. The value must match regular expression/^[a-zA-Z_][a-zA-Z0-9_]*$/
.
- Constraints: The maximum length is
- reference string
- (String) The name of the referenced secret or config map.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^a-z0-9?(\\.a-z0-9?)*$/
.
- Constraints: The maximum length is
- type string
- (String) Specify the type of the volume mount. Allowed types are: 'config_map', 'secret'.
- Constraints: The default value is
secret
. Allowable values are:config_map
,secret
. The value must match regular expression/^(config_map|secret)$/
.
- Constraints: The default value is
- value string
- (String) The literal value of the environment variable.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^[\\-._a-zA-Z0-9]+$/
.
- Constraints: The maximum length is
- key str
- (String) The key to reference as environment variable.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^[\\-._a-zA-Z0-9]+$/
.
- Constraints: The maximum length is
- name str
- The name of your job.
- Constraints: The maximum length is
63
characters. The minimum length is1
character. The value must match regular expression/^a-z0-9?$/
.
- Constraints: The maximum length is
- prefix str
- (String) A prefix that can be added to all keys of a full secret or config map reference.
- Constraints: The maximum length is
253
characters. The minimum length is0
characters. The value must match regular expression/^[a-zA-Z_][a-zA-Z0-9_]*$/
.
- Constraints: The maximum length is
- reference str
- (String) The name of the referenced secret or config map.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^a-z0-9?(\\.a-z0-9?)*$/
.
- Constraints: The maximum length is
- type str
- (String) Specify the type of the volume mount. Allowed types are: 'config_map', 'secret'.
- Constraints: The default value is
secret
. Allowable values are:config_map
,secret
. The value must match regular expression/^(config_map|secret)$/
.
- Constraints: The default value is
- value str
- (String) The literal value of the environment variable.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^[\\-._a-zA-Z0-9]+$/
.
- Constraints: The maximum length is
- key String
- (String) The key to reference as environment variable.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^[\\-._a-zA-Z0-9]+$/
.
- Constraints: The maximum length is
- name String
- The name of your job.
- Constraints: The maximum length is
63
characters. The minimum length is1
character. The value must match regular expression/^a-z0-9?$/
.
- Constraints: The maximum length is
- prefix String
- (String) A prefix that can be added to all keys of a full secret or config map reference.
- Constraints: The maximum length is
253
characters. The minimum length is0
characters. The value must match regular expression/^[a-zA-Z_][a-zA-Z0-9_]*$/
.
- Constraints: The maximum length is
- reference String
- (String) The name of the referenced secret or config map.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^a-z0-9?(\\.a-z0-9?)*$/
.
- Constraints: The maximum length is
- type String
- (String) Specify the type of the volume mount. Allowed types are: 'config_map', 'secret'.
- Constraints: The default value is
secret
. Allowable values are:config_map
,secret
. The value must match regular expression/^(config_map|secret)$/
.
- Constraints: The default value is
- value String
- (String) The literal value of the environment variable.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^[\\-._a-zA-Z0-9]+$/
.
- Constraints: The maximum length is
GetCodeEngineJobRunVolumeMount
- Mount
Path string - (String) The path that should be mounted.
- Constraints: The maximum length is
256
characters. The minimum length is1
character. The value must match regular expression/^\/([^\/\\0]+\/?)+$/
.
- Constraints: The maximum length is
- Name string
- The name of your job.
- Constraints: The maximum length is
63
characters. The minimum length is1
character. The value must match regular expression/^a-z0-9?$/
.
- Constraints: The maximum length is
- Reference string
- (String) The name of the referenced secret or config map.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^a-z0-9?(\\.a-z0-9?)*$/
.
- Constraints: The maximum length is
- Type string
- (String) Specify the type of the volume mount. Allowed types are: 'config_map', 'secret'.
- Constraints: The default value is
secret
. Allowable values are:config_map
,secret
. The value must match regular expression/^(config_map|secret)$/
.
- Constraints: The default value is
- Mount
Path string - (String) The path that should be mounted.
- Constraints: The maximum length is
256
characters. The minimum length is1
character. The value must match regular expression/^\/([^\/\\0]+\/?)+$/
.
- Constraints: The maximum length is
- Name string
- The name of your job.
- Constraints: The maximum length is
63
characters. The minimum length is1
character. The value must match regular expression/^a-z0-9?$/
.
- Constraints: The maximum length is
- Reference string
- (String) The name of the referenced secret or config map.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^a-z0-9?(\\.a-z0-9?)*$/
.
- Constraints: The maximum length is
- Type string
- (String) Specify the type of the volume mount. Allowed types are: 'config_map', 'secret'.
- Constraints: The default value is
secret
. Allowable values are:config_map
,secret
. The value must match regular expression/^(config_map|secret)$/
.
- Constraints: The default value is
- mount
Path String - (String) The path that should be mounted.
- Constraints: The maximum length is
256
characters. The minimum length is1
character. The value must match regular expression/^\/([^\/\\0]+\/?)+$/
.
- Constraints: The maximum length is
- name String
- The name of your job.
- Constraints: The maximum length is
63
characters. The minimum length is1
character. The value must match regular expression/^a-z0-9?$/
.
- Constraints: The maximum length is
- reference String
- (String) The name of the referenced secret or config map.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^a-z0-9?(\\.a-z0-9?)*$/
.
- Constraints: The maximum length is
- type String
- (String) Specify the type of the volume mount. Allowed types are: 'config_map', 'secret'.
- Constraints: The default value is
secret
. Allowable values are:config_map
,secret
. The value must match regular expression/^(config_map|secret)$/
.
- Constraints: The default value is
- mount
Path string - (String) The path that should be mounted.
- Constraints: The maximum length is
256
characters. The minimum length is1
character. The value must match regular expression/^\/([^\/\\0]+\/?)+$/
.
- Constraints: The maximum length is
- name string
- The name of your job.
- Constraints: The maximum length is
63
characters. The minimum length is1
character. The value must match regular expression/^a-z0-9?$/
.
- Constraints: The maximum length is
- reference string
- (String) The name of the referenced secret or config map.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^a-z0-9?(\\.a-z0-9?)*$/
.
- Constraints: The maximum length is
- type string
- (String) Specify the type of the volume mount. Allowed types are: 'config_map', 'secret'.
- Constraints: The default value is
secret
. Allowable values are:config_map
,secret
. The value must match regular expression/^(config_map|secret)$/
.
- Constraints: The default value is
- mount_
path str - (String) The path that should be mounted.
- Constraints: The maximum length is
256
characters. The minimum length is1
character. The value must match regular expression/^\/([^\/\\0]+\/?)+$/
.
- Constraints: The maximum length is
- name str
- The name of your job.
- Constraints: The maximum length is
63
characters. The minimum length is1
character. The value must match regular expression/^a-z0-9?$/
.
- Constraints: The maximum length is
- reference str
- (String) The name of the referenced secret or config map.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^a-z0-9?(\\.a-z0-9?)*$/
.
- Constraints: The maximum length is
- type str
- (String) Specify the type of the volume mount. Allowed types are: 'config_map', 'secret'.
- Constraints: The default value is
secret
. Allowable values are:config_map
,secret
. The value must match regular expression/^(config_map|secret)$/
.
- Constraints: The default value is
- mount
Path String - (String) The path that should be mounted.
- Constraints: The maximum length is
256
characters. The minimum length is1
character. The value must match regular expression/^\/([^\/\\0]+\/?)+$/
.
- Constraints: The maximum length is
- name String
- The name of your job.
- Constraints: The maximum length is
63
characters. The minimum length is1
character. The value must match regular expression/^a-z0-9?$/
.
- Constraints: The maximum length is
- reference String
- (String) The name of the referenced secret or config map.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^a-z0-9?(\\.a-z0-9?)*$/
.
- Constraints: The maximum length is
- type String
- (String) Specify the type of the volume mount. Allowed types are: 'config_map', 'secret'.
- Constraints: The default value is
secret
. Allowable values are:config_map
,secret
. The value must match regular expression/^(config_map|secret)$/
.
- Constraints: The default value is
Package Details
- Repository
- ibm ibm-cloud/terraform-provider-ibm
- License
- Notes
- This Pulumi package is based on the
ibm
Terraform Provider.