ibm.CodeEngineFunction
Explore with Pulumi AI
Create, update, and delete code_engine_functions with this resource.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as ibm from "@pulumi/ibm";
const codeEngineFunctionInstance = new ibm.CodeEngineFunction("codeEngineFunctionInstance", {
projectId: ibm_code_engine_project.code_engine_project_instance.project_id,
runtime: "nodejs-20",
codeReference: "icr.io/codeengine/samples/function-nodejs-codebundle",
});
import pulumi
import pulumi_ibm as ibm
code_engine_function_instance = ibm.CodeEngineFunction("codeEngineFunctionInstance",
project_id=ibm_code_engine_project["code_engine_project_instance"]["project_id"],
runtime="nodejs-20",
code_reference="icr.io/codeengine/samples/function-nodejs-codebundle")
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.NewCodeEngineFunction(ctx, "codeEngineFunctionInstance", &ibm.CodeEngineFunctionArgs{
ProjectId: pulumi.Any(ibm_code_engine_project.Code_engine_project_instance.Project_id),
Runtime: pulumi.String("nodejs-20"),
CodeReference: pulumi.String("icr.io/codeengine/samples/function-nodejs-codebundle"),
})
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 codeEngineFunctionInstance = new Ibm.CodeEngineFunction("codeEngineFunctionInstance", new()
{
ProjectId = ibm_code_engine_project.Code_engine_project_instance.Project_id,
Runtime = "nodejs-20",
CodeReference = "icr.io/codeengine/samples/function-nodejs-codebundle",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.CodeEngineFunction;
import com.pulumi.ibm.CodeEngineFunctionArgs;
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 codeEngineFunctionInstance = new CodeEngineFunction("codeEngineFunctionInstance", CodeEngineFunctionArgs.builder()
.projectId(ibm_code_engine_project.code_engine_project_instance().project_id())
.runtime("nodejs-20")
.codeReference("icr.io/codeengine/samples/function-nodejs-codebundle")
.build());
}
}
resources:
codeEngineFunctionInstance:
type: ibm:CodeEngineFunction
properties:
projectId: ${ibm_code_engine_project.code_engine_project_instance.project_id}
runtime: nodejs-20
codeReference: icr.io/codeengine/samples/function-nodejs-codebundle
Create CodeEngineFunction Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new CodeEngineFunction(name: string, args: CodeEngineFunctionArgs, opts?: CustomResourceOptions);
@overload
def CodeEngineFunction(resource_name: str,
args: CodeEngineFunctionArgs,
opts: Optional[ResourceOptions] = None)
@overload
def CodeEngineFunction(resource_name: str,
opts: Optional[ResourceOptions] = None,
code_reference: Optional[str] = None,
runtime: Optional[str] = None,
project_id: Optional[str] = None,
run_env_variables: Optional[Sequence[CodeEngineFunctionRunEnvVariableArgs]] = None,
code_secret: Optional[str] = None,
managed_domain_mappings: Optional[str] = None,
name: Optional[str] = None,
code_main: Optional[str] = None,
code_binary: Optional[bool] = None,
code_engine_function_id: Optional[str] = None,
scale_concurrency: Optional[float] = None,
scale_cpu_limit: Optional[str] = None,
scale_down_delay: Optional[float] = None,
scale_max_execution_time: Optional[float] = None,
scale_memory_limit: Optional[str] = None,
timeouts: Optional[CodeEngineFunctionTimeoutsArgs] = None)
func NewCodeEngineFunction(ctx *Context, name string, args CodeEngineFunctionArgs, opts ...ResourceOption) (*CodeEngineFunction, error)
public CodeEngineFunction(string name, CodeEngineFunctionArgs args, CustomResourceOptions? opts = null)
public CodeEngineFunction(String name, CodeEngineFunctionArgs args)
public CodeEngineFunction(String name, CodeEngineFunctionArgs args, CustomResourceOptions options)
type: ibm:CodeEngineFunction
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args CodeEngineFunctionArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args CodeEngineFunctionArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args CodeEngineFunctionArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args CodeEngineFunctionArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args CodeEngineFunctionArgs
- 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 codeEngineFunctionResource = new Ibm.CodeEngineFunction("codeEngineFunctionResource", new()
{
CodeReference = "string",
Runtime = "string",
ProjectId = "string",
RunEnvVariables = new[]
{
new Ibm.Inputs.CodeEngineFunctionRunEnvVariableArgs
{
Key = "string",
Name = "string",
Prefix = "string",
Reference = "string",
Type = "string",
Value = "string",
},
},
CodeSecret = "string",
ManagedDomainMappings = "string",
Name = "string",
CodeMain = "string",
CodeBinary = false,
CodeEngineFunctionId = "string",
ScaleConcurrency = 0,
ScaleCpuLimit = "string",
ScaleDownDelay = 0,
ScaleMaxExecutionTime = 0,
ScaleMemoryLimit = "string",
Timeouts = new Ibm.Inputs.CodeEngineFunctionTimeoutsArgs
{
Create = "string",
Update = "string",
},
});
example, err := ibm.NewCodeEngineFunction(ctx, "codeEngineFunctionResource", &ibm.CodeEngineFunctionArgs{
CodeReference: pulumi.String("string"),
Runtime: pulumi.String("string"),
ProjectId: pulumi.String("string"),
RunEnvVariables: ibm.CodeEngineFunctionRunEnvVariableArray{
&ibm.CodeEngineFunctionRunEnvVariableArgs{
Key: pulumi.String("string"),
Name: pulumi.String("string"),
Prefix: pulumi.String("string"),
Reference: pulumi.String("string"),
Type: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
CodeSecret: pulumi.String("string"),
ManagedDomainMappings: pulumi.String("string"),
Name: pulumi.String("string"),
CodeMain: pulumi.String("string"),
CodeBinary: pulumi.Bool(false),
CodeEngineFunctionId: pulumi.String("string"),
ScaleConcurrency: pulumi.Float64(0),
ScaleCpuLimit: pulumi.String("string"),
ScaleDownDelay: pulumi.Float64(0),
ScaleMaxExecutionTime: pulumi.Float64(0),
ScaleMemoryLimit: pulumi.String("string"),
Timeouts: &ibm.CodeEngineFunctionTimeoutsArgs{
Create: pulumi.String("string"),
Update: pulumi.String("string"),
},
})
var codeEngineFunctionResource = new CodeEngineFunction("codeEngineFunctionResource", CodeEngineFunctionArgs.builder()
.codeReference("string")
.runtime("string")
.projectId("string")
.runEnvVariables(CodeEngineFunctionRunEnvVariableArgs.builder()
.key("string")
.name("string")
.prefix("string")
.reference("string")
.type("string")
.value("string")
.build())
.codeSecret("string")
.managedDomainMappings("string")
.name("string")
.codeMain("string")
.codeBinary(false)
.codeEngineFunctionId("string")
.scaleConcurrency(0)
.scaleCpuLimit("string")
.scaleDownDelay(0)
.scaleMaxExecutionTime(0)
.scaleMemoryLimit("string")
.timeouts(CodeEngineFunctionTimeoutsArgs.builder()
.create("string")
.update("string")
.build())
.build());
code_engine_function_resource = ibm.CodeEngineFunction("codeEngineFunctionResource",
code_reference="string",
runtime="string",
project_id="string",
run_env_variables=[{
"key": "string",
"name": "string",
"prefix": "string",
"reference": "string",
"type": "string",
"value": "string",
}],
code_secret="string",
managed_domain_mappings="string",
name="string",
code_main="string",
code_binary=False,
code_engine_function_id="string",
scale_concurrency=0,
scale_cpu_limit="string",
scale_down_delay=0,
scale_max_execution_time=0,
scale_memory_limit="string",
timeouts={
"create": "string",
"update": "string",
})
const codeEngineFunctionResource = new ibm.CodeEngineFunction("codeEngineFunctionResource", {
codeReference: "string",
runtime: "string",
projectId: "string",
runEnvVariables: [{
key: "string",
name: "string",
prefix: "string",
reference: "string",
type: "string",
value: "string",
}],
codeSecret: "string",
managedDomainMappings: "string",
name: "string",
codeMain: "string",
codeBinary: false,
codeEngineFunctionId: "string",
scaleConcurrency: 0,
scaleCpuLimit: "string",
scaleDownDelay: 0,
scaleMaxExecutionTime: 0,
scaleMemoryLimit: "string",
timeouts: {
create: "string",
update: "string",
},
});
type: ibm:CodeEngineFunction
properties:
codeBinary: false
codeEngineFunctionId: string
codeMain: string
codeReference: string
codeSecret: string
managedDomainMappings: string
name: string
projectId: string
runEnvVariables:
- key: string
name: string
prefix: string
reference: string
type: string
value: string
runtime: string
scaleConcurrency: 0
scaleCpuLimit: string
scaleDownDelay: 0
scaleMaxExecutionTime: 0
scaleMemoryLimit: string
timeouts:
create: string
update: string
CodeEngineFunction 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 CodeEngineFunction resource accepts the following input properties:
- Code
Reference string - Specifies either a reference to a code bundle or the source code itself. To specify the source code, use the data URL scheme and include the source code as base64 encoded. The data URL scheme is defined in RFC 2397.
- Constraints: The maximum length is
1048576
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})?$|data:([-\\w]+\/[-+\\w.]+)?(;?\\w+=[-\\w]+)*;base64,.*/
.
- 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
- Runtime string
- The managed runtime used to execute the injected code.
- Constraints: The maximum length is
63
characters. The minimum length is1
character. The value must match regular expression/^[a-z]*\\-[0-9]*(\\.[0-9]*)?$/
.
- Constraints: The maximum length is
- Code
Binary bool - Specifies whether the code is binary or not. Defaults to false when
code_reference
is set to a data URL. Whencode_reference
is set to a code bundle URL, this field is always true. - Code
Engine stringFunction Id - The unique identifier of the code_engine_function.
- Code
Main string - Specifies the name of the function that should be invoked.
- Constraints: The default value is
main
. The maximum length is63
characters. The minimum length is1
character. The value must match regular expression/^[a-zA-Z_][a-zA-Z0-9_]*$/
.
- Constraints: The default value is
- Code
Secret string - The name of the secret that is used to access the specified
code_reference
. The secret is used to authenticate with a non-public endpoint that is specified ascode_reference
.- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^a-z0-9?(\\.a-z0-9?)*$/
.
- Constraints: The maximum length is
- Managed
Domain stringMappings - Optional value controlling which of the system managed domain mappings will be setup for the function. Valid values are 'local_public', 'local_private' and 'local'. Visibility can only be 'local_private' if the project supports function private visibility.
- Constraints: The default value is
local_public
. Allowable values are:local
,local_private
,local_public
.
- Constraints: The default value is
- Name string
- The name of the function.
- Constraints: The maximum length is
63
characters. The minimum length is1
character. The value must match regular expression/^a-z?$/
.
- Constraints: The maximum length is
- Run
Env List<CodeVariables Engine Function Run Env Variable> - References to config maps, secrets or literal values, which are defined by the function owner and are exposed as environment variables in the function.
- Constraints: The maximum length is
100
items. The minimum length is0
items. Nested schema for run_env_variables:
- Constraints: The maximum length is
- Scale
Concurrency double - Number of parallel requests handled by a single instance, supported only by Node.js, default is
1
.- Constraints: The default value is
1
. The maximum value is100
. The minimum value is1
.
- Constraints: The default value is
- Scale
Cpu stringLimit - Optional amount of CPU set for the instance of the function. For valid values see Supported memory and CPU combinations.
- Constraints: The default value is
1
. The maximum length is10
characters. The minimum length is0
characters. The value must match regular expression/^([0-9.]+)([eEinumkKMGTPB]*)$/
.
- Constraints: The default value is
- Scale
Down doubleDelay - Optional amount of time in seconds that delays the scale down behavior for a function.
- Constraints: The default value is
1
. The maximum value is600
. The minimum value is0
.
- Constraints: The default value is
- Scale
Max doubleExecution Time - Timeout in secs after which the function is terminated.
- Constraints: The default value is
60
. The maximum value is120
. The minimum value is1
.
- Constraints: The default value is
- Scale
Memory stringLimit - Optional amount of memory set for the instance of the function. 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
- Timeouts
Code
Engine Function Timeouts
- Code
Reference string - Specifies either a reference to a code bundle or the source code itself. To specify the source code, use the data URL scheme and include the source code as base64 encoded. The data URL scheme is defined in RFC 2397.
- Constraints: The maximum length is
1048576
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})?$|data:([-\\w]+\/[-+\\w.]+)?(;?\\w+=[-\\w]+)*;base64,.*/
.
- 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
- Runtime string
- The managed runtime used to execute the injected code.
- Constraints: The maximum length is
63
characters. The minimum length is1
character. The value must match regular expression/^[a-z]*\\-[0-9]*(\\.[0-9]*)?$/
.
- Constraints: The maximum length is
- Code
Binary bool - Specifies whether the code is binary or not. Defaults to false when
code_reference
is set to a data URL. Whencode_reference
is set to a code bundle URL, this field is always true. - Code
Engine stringFunction Id - The unique identifier of the code_engine_function.
- Code
Main string - Specifies the name of the function that should be invoked.
- Constraints: The default value is
main
. The maximum length is63
characters. The minimum length is1
character. The value must match regular expression/^[a-zA-Z_][a-zA-Z0-9_]*$/
.
- Constraints: The default value is
- Code
Secret string - The name of the secret that is used to access the specified
code_reference
. The secret is used to authenticate with a non-public endpoint that is specified ascode_reference
.- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^a-z0-9?(\\.a-z0-9?)*$/
.
- Constraints: The maximum length is
- Managed
Domain stringMappings - Optional value controlling which of the system managed domain mappings will be setup for the function. Valid values are 'local_public', 'local_private' and 'local'. Visibility can only be 'local_private' if the project supports function private visibility.
- Constraints: The default value is
local_public
. Allowable values are:local
,local_private
,local_public
.
- Constraints: The default value is
- Name string
- The name of the function.
- Constraints: The maximum length is
63
characters. The minimum length is1
character. The value must match regular expression/^a-z?$/
.
- Constraints: The maximum length is
- Run
Env []CodeVariables Engine Function Run Env Variable Args - References to config maps, secrets or literal values, which are defined by the function owner and are exposed as environment variables in the function.
- Constraints: The maximum length is
100
items. The minimum length is0
items. Nested schema for run_env_variables:
- Constraints: The maximum length is
- Scale
Concurrency float64 - Number of parallel requests handled by a single instance, supported only by Node.js, default is
1
.- Constraints: The default value is
1
. The maximum value is100
. The minimum value is1
.
- Constraints: The default value is
- Scale
Cpu stringLimit - Optional amount of CPU set for the instance of the function. For valid values see Supported memory and CPU combinations.
- Constraints: The default value is
1
. The maximum length is10
characters. The minimum length is0
characters. The value must match regular expression/^([0-9.]+)([eEinumkKMGTPB]*)$/
.
- Constraints: The default value is
- Scale
Down float64Delay - Optional amount of time in seconds that delays the scale down behavior for a function.
- Constraints: The default value is
1
. The maximum value is600
. The minimum value is0
.
- Constraints: The default value is
- Scale
Max float64Execution Time - Timeout in secs after which the function is terminated.
- Constraints: The default value is
60
. The maximum value is120
. The minimum value is1
.
- Constraints: The default value is
- Scale
Memory stringLimit - Optional amount of memory set for the instance of the function. 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
- Timeouts
Code
Engine Function Timeouts Args
- code
Reference String - Specifies either a reference to a code bundle or the source code itself. To specify the source code, use the data URL scheme and include the source code as base64 encoded. The data URL scheme is defined in RFC 2397.
- Constraints: The maximum length is
1048576
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})?$|data:([-\\w]+\/[-+\\w.]+)?(;?\\w+=[-\\w]+)*;base64,.*/
.
- 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
- runtime String
- The managed runtime used to execute the injected code.
- Constraints: The maximum length is
63
characters. The minimum length is1
character. The value must match regular expression/^[a-z]*\\-[0-9]*(\\.[0-9]*)?$/
.
- Constraints: The maximum length is
- code
Binary Boolean - Specifies whether the code is binary or not. Defaults to false when
code_reference
is set to a data URL. Whencode_reference
is set to a code bundle URL, this field is always true. - code
Engine StringFunction Id - The unique identifier of the code_engine_function.
- code
Main String - Specifies the name of the function that should be invoked.
- Constraints: The default value is
main
. The maximum length is63
characters. The minimum length is1
character. The value must match regular expression/^[a-zA-Z_][a-zA-Z0-9_]*$/
.
- Constraints: The default value is
- code
Secret String - The name of the secret that is used to access the specified
code_reference
. The secret is used to authenticate with a non-public endpoint that is specified ascode_reference
.- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^a-z0-9?(\\.a-z0-9?)*$/
.
- Constraints: The maximum length is
- managed
Domain StringMappings - Optional value controlling which of the system managed domain mappings will be setup for the function. Valid values are 'local_public', 'local_private' and 'local'. Visibility can only be 'local_private' if the project supports function private visibility.
- Constraints: The default value is
local_public
. Allowable values are:local
,local_private
,local_public
.
- Constraints: The default value is
- name String
- The name of the function.
- Constraints: The maximum length is
63
characters. The minimum length is1
character. The value must match regular expression/^a-z?$/
.
- Constraints: The maximum length is
- run
Env List<CodeVariables Engine Function Run Env Variable> - References to config maps, secrets or literal values, which are defined by the function owner and are exposed as environment variables in the function.
- Constraints: The maximum length is
100
items. The minimum length is0
items. Nested schema for run_env_variables:
- Constraints: The maximum length is
- scale
Concurrency Double - Number of parallel requests handled by a single instance, supported only by Node.js, default is
1
.- Constraints: The default value is
1
. The maximum value is100
. The minimum value is1
.
- Constraints: The default value is
- scale
Cpu StringLimit - Optional amount of CPU set for the instance of the function. For valid values see Supported memory and CPU combinations.
- Constraints: The default value is
1
. The maximum length is10
characters. The minimum length is0
characters. The value must match regular expression/^([0-9.]+)([eEinumkKMGTPB]*)$/
.
- Constraints: The default value is
- scale
Down DoubleDelay - Optional amount of time in seconds that delays the scale down behavior for a function.
- Constraints: The default value is
1
. The maximum value is600
. The minimum value is0
.
- Constraints: The default value is
- scale
Max DoubleExecution Time - Timeout in secs after which the function is terminated.
- Constraints: The default value is
60
. The maximum value is120
. The minimum value is1
.
- Constraints: The default value is
- scale
Memory StringLimit - Optional amount of memory set for the instance of the function. 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
- timeouts
Code
Engine Function Timeouts
- code
Reference string - Specifies either a reference to a code bundle or the source code itself. To specify the source code, use the data URL scheme and include the source code as base64 encoded. The data URL scheme is defined in RFC 2397.
- Constraints: The maximum length is
1048576
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})?$|data:([-\\w]+\/[-+\\w.]+)?(;?\\w+=[-\\w]+)*;base64,.*/
.
- 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
- runtime string
- The managed runtime used to execute the injected code.
- Constraints: The maximum length is
63
characters. The minimum length is1
character. The value must match regular expression/^[a-z]*\\-[0-9]*(\\.[0-9]*)?$/
.
- Constraints: The maximum length is
- code
Binary boolean - Specifies whether the code is binary or not. Defaults to false when
code_reference
is set to a data URL. Whencode_reference
is set to a code bundle URL, this field is always true. - code
Engine stringFunction Id - The unique identifier of the code_engine_function.
- code
Main string - Specifies the name of the function that should be invoked.
- Constraints: The default value is
main
. The maximum length is63
characters. The minimum length is1
character. The value must match regular expression/^[a-zA-Z_][a-zA-Z0-9_]*$/
.
- Constraints: The default value is
- code
Secret string - The name of the secret that is used to access the specified
code_reference
. The secret is used to authenticate with a non-public endpoint that is specified ascode_reference
.- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^a-z0-9?(\\.a-z0-9?)*$/
.
- Constraints: The maximum length is
- managed
Domain stringMappings - Optional value controlling which of the system managed domain mappings will be setup for the function. Valid values are 'local_public', 'local_private' and 'local'. Visibility can only be 'local_private' if the project supports function private visibility.
- Constraints: The default value is
local_public
. Allowable values are:local
,local_private
,local_public
.
- Constraints: The default value is
- name string
- The name of the function.
- Constraints: The maximum length is
63
characters. The minimum length is1
character. The value must match regular expression/^a-z?$/
.
- Constraints: The maximum length is
- run
Env CodeVariables Engine Function Run Env Variable[] - References to config maps, secrets or literal values, which are defined by the function owner and are exposed as environment variables in the function.
- Constraints: The maximum length is
100
items. The minimum length is0
items. Nested schema for run_env_variables:
- Constraints: The maximum length is
- scale
Concurrency number - Number of parallel requests handled by a single instance, supported only by Node.js, default is
1
.- Constraints: The default value is
1
. The maximum value is100
. The minimum value is1
.
- Constraints: The default value is
- scale
Cpu stringLimit - Optional amount of CPU set for the instance of the function. For valid values see Supported memory and CPU combinations.
- Constraints: The default value is
1
. The maximum length is10
characters. The minimum length is0
characters. The value must match regular expression/^([0-9.]+)([eEinumkKMGTPB]*)$/
.
- Constraints: The default value is
- scale
Down numberDelay - Optional amount of time in seconds that delays the scale down behavior for a function.
- Constraints: The default value is
1
. The maximum value is600
. The minimum value is0
.
- Constraints: The default value is
- scale
Max numberExecution Time - Timeout in secs after which the function is terminated.
- Constraints: The default value is
60
. The maximum value is120
. The minimum value is1
.
- Constraints: The default value is
- scale
Memory stringLimit - Optional amount of memory set for the instance of the function. 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
- timeouts
Code
Engine Function Timeouts
- code_
reference str - Specifies either a reference to a code bundle or the source code itself. To specify the source code, use the data URL scheme and include the source code as base64 encoded. The data URL scheme is defined in RFC 2397.
- Constraints: The maximum length is
1048576
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})?$|data:([-\\w]+\/[-+\\w.]+)?(;?\\w+=[-\\w]+)*;base64,.*/
.
- 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
- runtime str
- The managed runtime used to execute the injected code.
- Constraints: The maximum length is
63
characters. The minimum length is1
character. The value must match regular expression/^[a-z]*\\-[0-9]*(\\.[0-9]*)?$/
.
- Constraints: The maximum length is
- code_
binary bool - Specifies whether the code is binary or not. Defaults to false when
code_reference
is set to a data URL. Whencode_reference
is set to a code bundle URL, this field is always true. - code_
engine_ strfunction_ id - The unique identifier of the code_engine_function.
- code_
main str - Specifies the name of the function that should be invoked.
- Constraints: The default value is
main
. The maximum length is63
characters. The minimum length is1
character. The value must match regular expression/^[a-zA-Z_][a-zA-Z0-9_]*$/
.
- Constraints: The default value is
- code_
secret str - The name of the secret that is used to access the specified
code_reference
. The secret is used to authenticate with a non-public endpoint that is specified ascode_reference
.- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^a-z0-9?(\\.a-z0-9?)*$/
.
- Constraints: The maximum length is
- managed_
domain_ strmappings - Optional value controlling which of the system managed domain mappings will be setup for the function. Valid values are 'local_public', 'local_private' and 'local'. Visibility can only be 'local_private' if the project supports function private visibility.
- Constraints: The default value is
local_public
. Allowable values are:local
,local_private
,local_public
.
- Constraints: The default value is
- name str
- The name of the function.
- Constraints: The maximum length is
63
characters. The minimum length is1
character. The value must match regular expression/^a-z?$/
.
- Constraints: The maximum length is
- run_
env_ Sequence[Codevariables Engine Function Run Env Variable Args] - References to config maps, secrets or literal values, which are defined by the function owner and are exposed as environment variables in the function.
- Constraints: The maximum length is
100
items. The minimum length is0
items. Nested schema for run_env_variables:
- Constraints: The maximum length is
- scale_
concurrency float - Number of parallel requests handled by a single instance, supported only by Node.js, default is
1
.- Constraints: The default value is
1
. The maximum value is100
. The minimum value is1
.
- Constraints: The default value is
- scale_
cpu_ strlimit - Optional amount of CPU set for the instance of the function. For valid values see Supported memory and CPU combinations.
- Constraints: The default value is
1
. The maximum length is10
characters. The minimum length is0
characters. The value must match regular expression/^([0-9.]+)([eEinumkKMGTPB]*)$/
.
- Constraints: The default value is
- scale_
down_ floatdelay - Optional amount of time in seconds that delays the scale down behavior for a function.
- Constraints: The default value is
1
. The maximum value is600
. The minimum value is0
.
- Constraints: The default value is
- scale_
max_ floatexecution_ time - Timeout in secs after which the function is terminated.
- Constraints: The default value is
60
. The maximum value is120
. The minimum value is1
.
- Constraints: The default value is
- scale_
memory_ strlimit - Optional amount of memory set for the instance of the function. 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
- timeouts
Code
Engine Function Timeouts Args
- code
Reference String - Specifies either a reference to a code bundle or the source code itself. To specify the source code, use the data URL scheme and include the source code as base64 encoded. The data URL scheme is defined in RFC 2397.
- Constraints: The maximum length is
1048576
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})?$|data:([-\\w]+\/[-+\\w.]+)?(;?\\w+=[-\\w]+)*;base64,.*/
.
- 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
- runtime String
- The managed runtime used to execute the injected code.
- Constraints: The maximum length is
63
characters. The minimum length is1
character. The value must match regular expression/^[a-z]*\\-[0-9]*(\\.[0-9]*)?$/
.
- Constraints: The maximum length is
- code
Binary Boolean - Specifies whether the code is binary or not. Defaults to false when
code_reference
is set to a data URL. Whencode_reference
is set to a code bundle URL, this field is always true. - code
Engine StringFunction Id - The unique identifier of the code_engine_function.
- code
Main String - Specifies the name of the function that should be invoked.
- Constraints: The default value is
main
. The maximum length is63
characters. The minimum length is1
character. The value must match regular expression/^[a-zA-Z_][a-zA-Z0-9_]*$/
.
- Constraints: The default value is
- code
Secret String - The name of the secret that is used to access the specified
code_reference
. The secret is used to authenticate with a non-public endpoint that is specified ascode_reference
.- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^a-z0-9?(\\.a-z0-9?)*$/
.
- Constraints: The maximum length is
- managed
Domain StringMappings - Optional value controlling which of the system managed domain mappings will be setup for the function. Valid values are 'local_public', 'local_private' and 'local'. Visibility can only be 'local_private' if the project supports function private visibility.
- Constraints: The default value is
local_public
. Allowable values are:local
,local_private
,local_public
.
- Constraints: The default value is
- name String
- The name of the function.
- Constraints: The maximum length is
63
characters. The minimum length is1
character. The value must match regular expression/^a-z?$/
.
- Constraints: The maximum length is
- run
Env List<Property Map>Variables - References to config maps, secrets or literal values, which are defined by the function owner and are exposed as environment variables in the function.
- Constraints: The maximum length is
100
items. The minimum length is0
items. Nested schema for run_env_variables:
- Constraints: The maximum length is
- scale
Concurrency Number - Number of parallel requests handled by a single instance, supported only by Node.js, default is
1
.- Constraints: The default value is
1
. The maximum value is100
. The minimum value is1
.
- Constraints: The default value is
- scale
Cpu StringLimit - Optional amount of CPU set for the instance of the function. For valid values see Supported memory and CPU combinations.
- Constraints: The default value is
1
. The maximum length is10
characters. The minimum length is0
characters. The value must match regular expression/^([0-9.]+)([eEinumkKMGTPB]*)$/
.
- Constraints: The default value is
- scale
Down NumberDelay - Optional amount of time in seconds that delays the scale down behavior for a function.
- Constraints: The default value is
1
. The maximum value is600
. The minimum value is0
.
- Constraints: The default value is
- scale
Max NumberExecution Time - Timeout in secs after which the function is terminated.
- Constraints: The default value is
60
. The maximum value is120
. The minimum value is1
.
- Constraints: The default value is
- scale
Memory StringLimit - Optional amount of memory set for the instance of the function. 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
- timeouts Property Map
Outputs
All input properties are implicitly available as output properties. Additionally, the CodeEngineFunction resource produces the following output properties:
- Computed
Env List<CodeVariables Engine Function 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 function.
- Constraints: The maximum length is
100
items. The minimum length is0
items. Nested schema for computed_env_variables:
- Constraints: The maximum length is
- Created
At string - (String) The timestamp when the resource was created.
- Endpoint string
- (String) URL to invoke the function.
- Constraints: The maximum length is
2048
characters. The minimum length is0
characters. The value must match regular expression/(([^:\/?#]+):)?(\/\/([^\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$/
.
- Constraints: The maximum length is
- Endpoint
Internal string - (String) URL to function that is only visible within the project.
- Constraints: The maximum length is
2048
characters. The minimum length is0
characters. The value must match regular expression/(([^:\/?#]+):)?(\/\/([^\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$/
.
- Constraints: The maximum length is
- Entity
Tag string - (String) The version of the function instance, which is used to achieve optimistic locking.
- Constraints: The maximum length is
63
characters. The minimum length is1
character. The value must match regular expression/^[\\*\\-a-z0-9]+$/
.
- Constraints: The maximum length is
- Etag string
- ETag identifier for code_engine_function.
- Function
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
- Href string
- (String) When you provision a new function, a relative URL path is created identifying the location of the instance.
- Constraints: The maximum length is
2048
characters. The minimum length is0
characters. The value must match regular expression/(([^:\/?#]+):)?(\/\/([^\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$/
.
- Constraints: The maximum length is
- Id string
- The provider-assigned unique ID for this managed resource.
- Region string
- (String) The region of the project the resource is located in. Possible values: 'au-syd', 'br-sao', 'ca-tor', 'eu-de', 'eu-gb', 'jp-osa', 'jp-tok', 'us-east', 'us-south'.
- Resource
Type string - (String) The type of the function.
- Constraints: Allowable values are:
function_v2
.
- Constraints: Allowable values are:
- Status string
- (String) The current status of the function.
- Constraints: Allowable values are:
offline
,deploying
,ready
,failed
.
- Constraints: Allowable values are:
- Status
Details List<CodeEngine Function Status Detail> - (List) The detailed status of the function. Nested schema for status_details:
- Computed
Env []CodeVariables Engine Function 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 function.
- Constraints: The maximum length is
100
items. The minimum length is0
items. Nested schema for computed_env_variables:
- Constraints: The maximum length is
- Created
At string - (String) The timestamp when the resource was created.
- Endpoint string
- (String) URL to invoke the function.
- Constraints: The maximum length is
2048
characters. The minimum length is0
characters. The value must match regular expression/(([^:\/?#]+):)?(\/\/([^\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$/
.
- Constraints: The maximum length is
- Endpoint
Internal string - (String) URL to function that is only visible within the project.
- Constraints: The maximum length is
2048
characters. The minimum length is0
characters. The value must match regular expression/(([^:\/?#]+):)?(\/\/([^\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$/
.
- Constraints: The maximum length is
- Entity
Tag string - (String) The version of the function instance, which is used to achieve optimistic locking.
- Constraints: The maximum length is
63
characters. The minimum length is1
character. The value must match regular expression/^[\\*\\-a-z0-9]+$/
.
- Constraints: The maximum length is
- Etag string
- ETag identifier for code_engine_function.
- Function
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
- Href string
- (String) When you provision a new function, a relative URL path is created identifying the location of the instance.
- Constraints: The maximum length is
2048
characters. The minimum length is0
characters. The value must match regular expression/(([^:\/?#]+):)?(\/\/([^\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$/
.
- Constraints: The maximum length is
- Id string
- The provider-assigned unique ID for this managed resource.
- Region string
- (String) The region of the project the resource is located in. Possible values: 'au-syd', 'br-sao', 'ca-tor', 'eu-de', 'eu-gb', 'jp-osa', 'jp-tok', 'us-east', 'us-south'.
- Resource
Type string - (String) The type of the function.
- Constraints: Allowable values are:
function_v2
.
- Constraints: Allowable values are:
- Status string
- (String) The current status of the function.
- Constraints: Allowable values are:
offline
,deploying
,ready
,failed
.
- Constraints: Allowable values are:
- Status
Details []CodeEngine Function Status Detail - (List) The detailed status of the function. Nested schema for status_details:
- computed
Env List<CodeVariables Engine Function 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 function.
- Constraints: The maximum length is
100
items. The minimum length is0
items. Nested schema for computed_env_variables:
- Constraints: The maximum length is
- created
At String - (String) The timestamp when the resource was created.
- endpoint String
- (String) URL to invoke the function.
- Constraints: The maximum length is
2048
characters. The minimum length is0
characters. The value must match regular expression/(([^:\/?#]+):)?(\/\/([^\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$/
.
- Constraints: The maximum length is
- endpoint
Internal String - (String) URL to function that is only visible within the project.
- Constraints: The maximum length is
2048
characters. The minimum length is0
characters. The value must match regular expression/(([^:\/?#]+):)?(\/\/([^\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$/
.
- Constraints: The maximum length is
- entity
Tag String - (String) The version of the function instance, which is used to achieve optimistic locking.
- Constraints: The maximum length is
63
characters. The minimum length is1
character. The value must match regular expression/^[\\*\\-a-z0-9]+$/
.
- Constraints: The maximum length is
- etag String
- ETag identifier for code_engine_function.
- function
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
- href String
- (String) When you provision a new function, a relative URL path is created identifying the location of the instance.
- Constraints: The maximum length is
2048
characters. The minimum length is0
characters. The value must match regular expression/(([^:\/?#]+):)?(\/\/([^\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$/
.
- Constraints: The maximum length is
- id String
- The provider-assigned unique ID for this managed resource.
- region String
- (String) The region of the project the resource is located in. Possible values: 'au-syd', 'br-sao', 'ca-tor', 'eu-de', 'eu-gb', 'jp-osa', 'jp-tok', 'us-east', 'us-south'.
- resource
Type String - (String) The type of the function.
- Constraints: Allowable values are:
function_v2
.
- Constraints: Allowable values are:
- status String
- (String) The current status of the function.
- Constraints: Allowable values are:
offline
,deploying
,ready
,failed
.
- Constraints: Allowable values are:
- status
Details List<CodeEngine Function Status Detail> - (List) The detailed status of the function. Nested schema for status_details:
- computed
Env CodeVariables Engine Function 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 function.
- Constraints: The maximum length is
100
items. The minimum length is0
items. Nested schema for computed_env_variables:
- Constraints: The maximum length is
- created
At string - (String) The timestamp when the resource was created.
- endpoint string
- (String) URL to invoke the function.
- Constraints: The maximum length is
2048
characters. The minimum length is0
characters. The value must match regular expression/(([^:\/?#]+):)?(\/\/([^\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$/
.
- Constraints: The maximum length is
- endpoint
Internal string - (String) URL to function that is only visible within the project.
- Constraints: The maximum length is
2048
characters. The minimum length is0
characters. The value must match regular expression/(([^:\/?#]+):)?(\/\/([^\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$/
.
- Constraints: The maximum length is
- entity
Tag string - (String) The version of the function instance, which is used to achieve optimistic locking.
- Constraints: The maximum length is
63
characters. The minimum length is1
character. The value must match regular expression/^[\\*\\-a-z0-9]+$/
.
- Constraints: The maximum length is
- etag string
- ETag identifier for code_engine_function.
- function
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
- href string
- (String) When you provision a new function, a relative URL path is created identifying the location of the instance.
- Constraints: The maximum length is
2048
characters. The minimum length is0
characters. The value must match regular expression/(([^:\/?#]+):)?(\/\/([^\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$/
.
- Constraints: The maximum length is
- id string
- The provider-assigned unique ID for this managed resource.
- region string
- (String) The region of the project the resource is located in. Possible values: 'au-syd', 'br-sao', 'ca-tor', 'eu-de', 'eu-gb', 'jp-osa', 'jp-tok', 'us-east', 'us-south'.
- resource
Type string - (String) The type of the function.
- Constraints: Allowable values are:
function_v2
.
- Constraints: Allowable values are:
- status string
- (String) The current status of the function.
- Constraints: Allowable values are:
offline
,deploying
,ready
,failed
.
- Constraints: Allowable values are:
- status
Details CodeEngine Function Status Detail[] - (List) The detailed status of the function. Nested schema for status_details:
- computed_
env_ Sequence[Codevariables Engine Function 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 function.
- Constraints: The maximum length is
100
items. The minimum length is0
items. Nested schema for computed_env_variables:
- Constraints: The maximum length is
- created_
at str - (String) The timestamp when the resource was created.
- endpoint str
- (String) URL to invoke the function.
- Constraints: The maximum length is
2048
characters. The minimum length is0
characters. The value must match regular expression/(([^:\/?#]+):)?(\/\/([^\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$/
.
- Constraints: The maximum length is
- endpoint_
internal str - (String) URL to function that is only visible within the project.
- Constraints: The maximum length is
2048
characters. The minimum length is0
characters. The value must match regular expression/(([^:\/?#]+):)?(\/\/([^\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$/
.
- Constraints: The maximum length is
- entity_
tag str - (String) The version of the function instance, which is used to achieve optimistic locking.
- Constraints: The maximum length is
63
characters. The minimum length is1
character. The value must match regular expression/^[\\*\\-a-z0-9]+$/
.
- Constraints: The maximum length is
- etag str
- ETag identifier for code_engine_function.
- function_
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
- href str
- (String) When you provision a new function, a relative URL path is created identifying the location of the instance.
- Constraints: The maximum length is
2048
characters. The minimum length is0
characters. The value must match regular expression/(([^:\/?#]+):)?(\/\/([^\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$/
.
- Constraints: The maximum length is
- id str
- The provider-assigned unique ID for this managed resource.
- region str
- (String) The region of the project the resource is located in. Possible values: 'au-syd', 'br-sao', 'ca-tor', 'eu-de', 'eu-gb', 'jp-osa', 'jp-tok', 'us-east', 'us-south'.
- resource_
type str - (String) The type of the function.
- Constraints: Allowable values are:
function_v2
.
- Constraints: Allowable values are:
- status str
- (String) The current status of the function.
- Constraints: Allowable values are:
offline
,deploying
,ready
,failed
.
- Constraints: Allowable values are:
- status_
details Sequence[CodeEngine Function Status Detail] - (List) The detailed status of the function. Nested schema for status_details:
- 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 function.
- Constraints: The maximum length is
100
items. The minimum length is0
items. Nested schema for computed_env_variables:
- Constraints: The maximum length is
- created
At String - (String) The timestamp when the resource was created.
- endpoint String
- (String) URL to invoke the function.
- Constraints: The maximum length is
2048
characters. The minimum length is0
characters. The value must match regular expression/(([^:\/?#]+):)?(\/\/([^\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$/
.
- Constraints: The maximum length is
- endpoint
Internal String - (String) URL to function that is only visible within the project.
- Constraints: The maximum length is
2048
characters. The minimum length is0
characters. The value must match regular expression/(([^:\/?#]+):)?(\/\/([^\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$/
.
- Constraints: The maximum length is
- entity
Tag String - (String) The version of the function instance, which is used to achieve optimistic locking.
- Constraints: The maximum length is
63
characters. The minimum length is1
character. The value must match regular expression/^[\\*\\-a-z0-9]+$/
.
- Constraints: The maximum length is
- etag String
- ETag identifier for code_engine_function.
- function
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
- href String
- (String) When you provision a new function, a relative URL path is created identifying the location of the instance.
- Constraints: The maximum length is
2048
characters. The minimum length is0
characters. The value must match regular expression/(([^:\/?#]+):)?(\/\/([^\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$/
.
- Constraints: The maximum length is
- id String
- The provider-assigned unique ID for this managed resource.
- region String
- (String) The region of the project the resource is located in. Possible values: 'au-syd', 'br-sao', 'ca-tor', 'eu-de', 'eu-gb', 'jp-osa', 'jp-tok', 'us-east', 'us-south'.
- resource
Type String - (String) The type of the function.
- Constraints: Allowable values are:
function_v2
.
- Constraints: Allowable values are:
- status String
- (String) The current status of the function.
- Constraints: Allowable values are:
offline
,deploying
,ready
,failed
.
- Constraints: Allowable values are:
- status
Details List<Property Map> - (List) The detailed status of the function. Nested schema for status_details:
Look up Existing CodeEngineFunction Resource
Get an existing CodeEngineFunction 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?: CodeEngineFunctionState, opts?: CustomResourceOptions): CodeEngineFunction
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
code_binary: Optional[bool] = None,
code_engine_function_id: Optional[str] = None,
code_main: Optional[str] = None,
code_reference: Optional[str] = None,
code_secret: Optional[str] = None,
computed_env_variables: Optional[Sequence[CodeEngineFunctionComputedEnvVariableArgs]] = None,
created_at: Optional[str] = None,
endpoint: Optional[str] = None,
endpoint_internal: Optional[str] = None,
entity_tag: Optional[str] = None,
etag: Optional[str] = None,
function_id: Optional[str] = None,
href: Optional[str] = None,
managed_domain_mappings: Optional[str] = None,
name: Optional[str] = None,
project_id: Optional[str] = None,
region: Optional[str] = None,
resource_type: Optional[str] = None,
run_env_variables: Optional[Sequence[CodeEngineFunctionRunEnvVariableArgs]] = None,
runtime: Optional[str] = None,
scale_concurrency: Optional[float] = None,
scale_cpu_limit: Optional[str] = None,
scale_down_delay: Optional[float] = None,
scale_max_execution_time: Optional[float] = None,
scale_memory_limit: Optional[str] = None,
status: Optional[str] = None,
status_details: Optional[Sequence[CodeEngineFunctionStatusDetailArgs]] = None,
timeouts: Optional[CodeEngineFunctionTimeoutsArgs] = None) -> CodeEngineFunction
func GetCodeEngineFunction(ctx *Context, name string, id IDInput, state *CodeEngineFunctionState, opts ...ResourceOption) (*CodeEngineFunction, error)
public static CodeEngineFunction Get(string name, Input<string> id, CodeEngineFunctionState? state, CustomResourceOptions? opts = null)
public static CodeEngineFunction get(String name, Output<String> id, CodeEngineFunctionState state, CustomResourceOptions options)
resources: _: type: ibm:CodeEngineFunction get: id: ${id}
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Code
Binary bool - Specifies whether the code is binary or not. Defaults to false when
code_reference
is set to a data URL. Whencode_reference
is set to a code bundle URL, this field is always true. - Code
Engine stringFunction Id - The unique identifier of the code_engine_function.
- Code
Main string - Specifies the name of the function that should be invoked.
- Constraints: The default value is
main
. The maximum length is63
characters. The minimum length is1
character. The value must match regular expression/^[a-zA-Z_][a-zA-Z0-9_]*$/
.
- Constraints: The default value is
- Code
Reference string - Specifies either a reference to a code bundle or the source code itself. To specify the source code, use the data URL scheme and include the source code as base64 encoded. The data URL scheme is defined in RFC 2397.
- Constraints: The maximum length is
1048576
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})?$|data:([-\\w]+\/[-+\\w.]+)?(;?\\w+=[-\\w]+)*;base64,.*/
.
- Constraints: The maximum length is
- Code
Secret string - The name of the secret that is used to access the specified
code_reference
. The secret is used to authenticate with a non-public endpoint that is specified ascode_reference
.- 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
- Computed
Env List<CodeVariables Engine Function 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 function.
- Constraints: The maximum length is
100
items. The minimum length is0
items. Nested schema for computed_env_variables:
- Constraints: The maximum length is
- Created
At string - (String) The timestamp when the resource was created.
- Endpoint string
- (String) URL to invoke the function.
- Constraints: The maximum length is
2048
characters. The minimum length is0
characters. The value must match regular expression/(([^:\/?#]+):)?(\/\/([^\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$/
.
- Constraints: The maximum length is
- Endpoint
Internal string - (String) URL to function that is only visible within the project.
- Constraints: The maximum length is
2048
characters. The minimum length is0
characters. The value must match regular expression/(([^:\/?#]+):)?(\/\/([^\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$/
.
- Constraints: The maximum length is
- Entity
Tag string - (String) The version of the function instance, which is used to achieve optimistic locking.
- Constraints: The maximum length is
63
characters. The minimum length is1
character. The value must match regular expression/^[\\*\\-a-z0-9]+$/
.
- Constraints: The maximum length is
- Etag string
- ETag identifier for code_engine_function.
- Function
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
- Href string
- (String) When you provision a new function, a relative URL path 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
- Managed
Domain stringMappings - Optional value controlling which of the system managed domain mappings will be setup for the function. Valid values are 'local_public', 'local_private' and 'local'. Visibility can only be 'local_private' if the project supports function private visibility.
- Constraints: The default value is
local_public
. Allowable values are:local
,local_private
,local_public
.
- Constraints: The default value is
- Name string
- The name of the function.
- Constraints: The maximum length is
63
characters. The minimum length is1
character. The value must match regular expression/^a-z?$/
.
- Constraints: The maximum length is
- Project
Id string - The ID of the project.
- Constraints: The maximum length is
36
characters. The minimum length is36
characters. The value must match regular expression/^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$/
.
- Constraints: The maximum length is
- Region string
- (String) The region of the project the resource is located in. Possible values: 'au-syd', 'br-sao', 'ca-tor', 'eu-de', 'eu-gb', 'jp-osa', 'jp-tok', 'us-east', 'us-south'.
- Resource
Type string - (String) The type of the function.
- Constraints: Allowable values are:
function_v2
.
- Constraints: Allowable values are:
- Run
Env List<CodeVariables Engine Function Run Env Variable> - References to config maps, secrets or literal values, which are defined by the function owner and are exposed as environment variables in the function.
- Constraints: The maximum length is
100
items. The minimum length is0
items. Nested schema for run_env_variables:
- Constraints: The maximum length is
- Runtime string
- The managed runtime used to execute the injected code.
- Constraints: The maximum length is
63
characters. The minimum length is1
character. The value must match regular expression/^[a-z]*\\-[0-9]*(\\.[0-9]*)?$/
.
- Constraints: The maximum length is
- Scale
Concurrency double - Number of parallel requests handled by a single instance, supported only by Node.js, default is
1
.- Constraints: The default value is
1
. The maximum value is100
. The minimum value is1
.
- Constraints: The default value is
- Scale
Cpu stringLimit - Optional amount of CPU set for the instance of the function. For valid values see Supported memory and CPU combinations.
- Constraints: The default value is
1
. The maximum length is10
characters. The minimum length is0
characters. The value must match regular expression/^([0-9.]+)([eEinumkKMGTPB]*)$/
.
- Constraints: The default value is
- Scale
Down doubleDelay - Optional amount of time in seconds that delays the scale down behavior for a function.
- Constraints: The default value is
1
. The maximum value is600
. The minimum value is0
.
- Constraints: The default value is
- Scale
Max doubleExecution Time - Timeout in secs after which the function is terminated.
- Constraints: The default value is
60
. The maximum value is120
. The minimum value is1
.
- Constraints: The default value is
- Scale
Memory stringLimit - Optional amount of memory set for the instance of the function. 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
- Status string
- (String) The current status of the function.
- Constraints: Allowable values are:
offline
,deploying
,ready
,failed
.
- Constraints: Allowable values are:
- Status
Details List<CodeEngine Function Status Detail> - (List) The detailed status of the function. Nested schema for status_details:
- Timeouts
Code
Engine Function Timeouts
- Code
Binary bool - Specifies whether the code is binary or not. Defaults to false when
code_reference
is set to a data URL. Whencode_reference
is set to a code bundle URL, this field is always true. - Code
Engine stringFunction Id - The unique identifier of the code_engine_function.
- Code
Main string - Specifies the name of the function that should be invoked.
- Constraints: The default value is
main
. The maximum length is63
characters. The minimum length is1
character. The value must match regular expression/^[a-zA-Z_][a-zA-Z0-9_]*$/
.
- Constraints: The default value is
- Code
Reference string - Specifies either a reference to a code bundle or the source code itself. To specify the source code, use the data URL scheme and include the source code as base64 encoded. The data URL scheme is defined in RFC 2397.
- Constraints: The maximum length is
1048576
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})?$|data:([-\\w]+\/[-+\\w.]+)?(;?\\w+=[-\\w]+)*;base64,.*/
.
- Constraints: The maximum length is
- Code
Secret string - The name of the secret that is used to access the specified
code_reference
. The secret is used to authenticate with a non-public endpoint that is specified ascode_reference
.- 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
- Computed
Env []CodeVariables Engine Function Computed Env Variable Args - (List) References to config maps, secrets or literal values, which are defined and set by Code Engine and are exposed as environment variables in the function.
- Constraints: The maximum length is
100
items. The minimum length is0
items. Nested schema for computed_env_variables:
- Constraints: The maximum length is
- Created
At string - (String) The timestamp when the resource was created.
- Endpoint string
- (String) URL to invoke the function.
- Constraints: The maximum length is
2048
characters. The minimum length is0
characters. The value must match regular expression/(([^:\/?#]+):)?(\/\/([^\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$/
.
- Constraints: The maximum length is
- Endpoint
Internal string - (String) URL to function that is only visible within the project.
- Constraints: The maximum length is
2048
characters. The minimum length is0
characters. The value must match regular expression/(([^:\/?#]+):)?(\/\/([^\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$/
.
- Constraints: The maximum length is
- Entity
Tag string - (String) The version of the function instance, which is used to achieve optimistic locking.
- Constraints: The maximum length is
63
characters. The minimum length is1
character. The value must match regular expression/^[\\*\\-a-z0-9]+$/
.
- Constraints: The maximum length is
- Etag string
- ETag identifier for code_engine_function.
- Function
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
- Href string
- (String) When you provision a new function, a relative URL path 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
- Managed
Domain stringMappings - Optional value controlling which of the system managed domain mappings will be setup for the function. Valid values are 'local_public', 'local_private' and 'local'. Visibility can only be 'local_private' if the project supports function private visibility.
- Constraints: The default value is
local_public
. Allowable values are:local
,local_private
,local_public
.
- Constraints: The default value is
- Name string
- The name of the function.
- Constraints: The maximum length is
63
characters. The minimum length is1
character. The value must match regular expression/^a-z?$/
.
- Constraints: The maximum length is
- Project
Id string - The ID of the project.
- Constraints: The maximum length is
36
characters. The minimum length is36
characters. The value must match regular expression/^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$/
.
- Constraints: The maximum length is
- Region string
- (String) The region of the project the resource is located in. Possible values: 'au-syd', 'br-sao', 'ca-tor', 'eu-de', 'eu-gb', 'jp-osa', 'jp-tok', 'us-east', 'us-south'.
- Resource
Type string - (String) The type of the function.
- Constraints: Allowable values are:
function_v2
.
- Constraints: Allowable values are:
- Run
Env []CodeVariables Engine Function Run Env Variable Args - References to config maps, secrets or literal values, which are defined by the function owner and are exposed as environment variables in the function.
- Constraints: The maximum length is
100
items. The minimum length is0
items. Nested schema for run_env_variables:
- Constraints: The maximum length is
- Runtime string
- The managed runtime used to execute the injected code.
- Constraints: The maximum length is
63
characters. The minimum length is1
character. The value must match regular expression/^[a-z]*\\-[0-9]*(\\.[0-9]*)?$/
.
- Constraints: The maximum length is
- Scale
Concurrency float64 - Number of parallel requests handled by a single instance, supported only by Node.js, default is
1
.- Constraints: The default value is
1
. The maximum value is100
. The minimum value is1
.
- Constraints: The default value is
- Scale
Cpu stringLimit - Optional amount of CPU set for the instance of the function. For valid values see Supported memory and CPU combinations.
- Constraints: The default value is
1
. The maximum length is10
characters. The minimum length is0
characters. The value must match regular expression/^([0-9.]+)([eEinumkKMGTPB]*)$/
.
- Constraints: The default value is
- Scale
Down float64Delay - Optional amount of time in seconds that delays the scale down behavior for a function.
- Constraints: The default value is
1
. The maximum value is600
. The minimum value is0
.
- Constraints: The default value is
- Scale
Max float64Execution Time - Timeout in secs after which the function is terminated.
- Constraints: The default value is
60
. The maximum value is120
. The minimum value is1
.
- Constraints: The default value is
- Scale
Memory stringLimit - Optional amount of memory set for the instance of the function. 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
- Status string
- (String) The current status of the function.
- Constraints: Allowable values are:
offline
,deploying
,ready
,failed
.
- Constraints: Allowable values are:
- Status
Details []CodeEngine Function Status Detail Args - (List) The detailed status of the function. Nested schema for status_details:
- Timeouts
Code
Engine Function Timeouts Args
- code
Binary Boolean - Specifies whether the code is binary or not. Defaults to false when
code_reference
is set to a data URL. Whencode_reference
is set to a code bundle URL, this field is always true. - code
Engine StringFunction Id - The unique identifier of the code_engine_function.
- code
Main String - Specifies the name of the function that should be invoked.
- Constraints: The default value is
main
. The maximum length is63
characters. The minimum length is1
character. The value must match regular expression/^[a-zA-Z_][a-zA-Z0-9_]*$/
.
- Constraints: The default value is
- code
Reference String - Specifies either a reference to a code bundle or the source code itself. To specify the source code, use the data URL scheme and include the source code as base64 encoded. The data URL scheme is defined in RFC 2397.
- Constraints: The maximum length is
1048576
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})?$|data:([-\\w]+\/[-+\\w.]+)?(;?\\w+=[-\\w]+)*;base64,.*/
.
- Constraints: The maximum length is
- code
Secret String - The name of the secret that is used to access the specified
code_reference
. The secret is used to authenticate with a non-public endpoint that is specified ascode_reference
.- 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
- computed
Env List<CodeVariables Engine Function 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 function.
- Constraints: The maximum length is
100
items. The minimum length is0
items. Nested schema for computed_env_variables:
- Constraints: The maximum length is
- created
At String - (String) The timestamp when the resource was created.
- endpoint String
- (String) URL to invoke the function.
- Constraints: The maximum length is
2048
characters. The minimum length is0
characters. The value must match regular expression/(([^:\/?#]+):)?(\/\/([^\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$/
.
- Constraints: The maximum length is
- endpoint
Internal String - (String) URL to function that is only visible within the project.
- Constraints: The maximum length is
2048
characters. The minimum length is0
characters. The value must match regular expression/(([^:\/?#]+):)?(\/\/([^\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$/
.
- Constraints: The maximum length is
- entity
Tag String - (String) The version of the function instance, which is used to achieve optimistic locking.
- Constraints: The maximum length is
63
characters. The minimum length is1
character. The value must match regular expression/^[\\*\\-a-z0-9]+$/
.
- Constraints: The maximum length is
- etag String
- ETag identifier for code_engine_function.
- function
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
- href String
- (String) When you provision a new function, a relative URL path 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
- managed
Domain StringMappings - Optional value controlling which of the system managed domain mappings will be setup for the function. Valid values are 'local_public', 'local_private' and 'local'. Visibility can only be 'local_private' if the project supports function private visibility.
- Constraints: The default value is
local_public
. Allowable values are:local
,local_private
,local_public
.
- Constraints: The default value is
- name String
- The name of the function.
- Constraints: The maximum length is
63
characters. The minimum length is1
character. The value must match regular expression/^a-z?$/
.
- Constraints: The maximum length is
- project
Id String - The ID of the project.
- Constraints: The maximum length is
36
characters. The minimum length is36
characters. The value must match regular expression/^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$/
.
- Constraints: The maximum length is
- region String
- (String) The region of the project the resource is located in. Possible values: 'au-syd', 'br-sao', 'ca-tor', 'eu-de', 'eu-gb', 'jp-osa', 'jp-tok', 'us-east', 'us-south'.
- resource
Type String - (String) The type of the function.
- Constraints: Allowable values are:
function_v2
.
- Constraints: Allowable values are:
- run
Env List<CodeVariables Engine Function Run Env Variable> - References to config maps, secrets or literal values, which are defined by the function owner and are exposed as environment variables in the function.
- Constraints: The maximum length is
100
items. The minimum length is0
items. Nested schema for run_env_variables:
- Constraints: The maximum length is
- runtime String
- The managed runtime used to execute the injected code.
- Constraints: The maximum length is
63
characters. The minimum length is1
character. The value must match regular expression/^[a-z]*\\-[0-9]*(\\.[0-9]*)?$/
.
- Constraints: The maximum length is
- scale
Concurrency Double - Number of parallel requests handled by a single instance, supported only by Node.js, default is
1
.- Constraints: The default value is
1
. The maximum value is100
. The minimum value is1
.
- Constraints: The default value is
- scale
Cpu StringLimit - Optional amount of CPU set for the instance of the function. For valid values see Supported memory and CPU combinations.
- Constraints: The default value is
1
. The maximum length is10
characters. The minimum length is0
characters. The value must match regular expression/^([0-9.]+)([eEinumkKMGTPB]*)$/
.
- Constraints: The default value is
- scale
Down DoubleDelay - Optional amount of time in seconds that delays the scale down behavior for a function.
- Constraints: The default value is
1
. The maximum value is600
. The minimum value is0
.
- Constraints: The default value is
- scale
Max DoubleExecution Time - Timeout in secs after which the function is terminated.
- Constraints: The default value is
60
. The maximum value is120
. The minimum value is1
.
- Constraints: The default value is
- scale
Memory StringLimit - Optional amount of memory set for the instance of the function. 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
- status String
- (String) The current status of the function.
- Constraints: Allowable values are:
offline
,deploying
,ready
,failed
.
- Constraints: Allowable values are:
- status
Details List<CodeEngine Function Status Detail> - (List) The detailed status of the function. Nested schema for status_details:
- timeouts
Code
Engine Function Timeouts
- code
Binary boolean - Specifies whether the code is binary or not. Defaults to false when
code_reference
is set to a data URL. Whencode_reference
is set to a code bundle URL, this field is always true. - code
Engine stringFunction Id - The unique identifier of the code_engine_function.
- code
Main string - Specifies the name of the function that should be invoked.
- Constraints: The default value is
main
. The maximum length is63
characters. The minimum length is1
character. The value must match regular expression/^[a-zA-Z_][a-zA-Z0-9_]*$/
.
- Constraints: The default value is
- code
Reference string - Specifies either a reference to a code bundle or the source code itself. To specify the source code, use the data URL scheme and include the source code as base64 encoded. The data URL scheme is defined in RFC 2397.
- Constraints: The maximum length is
1048576
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})?$|data:([-\\w]+\/[-+\\w.]+)?(;?\\w+=[-\\w]+)*;base64,.*/
.
- Constraints: The maximum length is
- code
Secret string - The name of the secret that is used to access the specified
code_reference
. The secret is used to authenticate with a non-public endpoint that is specified ascode_reference
.- 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
- computed
Env CodeVariables Engine Function 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 function.
- Constraints: The maximum length is
100
items. The minimum length is0
items. Nested schema for computed_env_variables:
- Constraints: The maximum length is
- created
At string - (String) The timestamp when the resource was created.
- endpoint string
- (String) URL to invoke the function.
- Constraints: The maximum length is
2048
characters. The minimum length is0
characters. The value must match regular expression/(([^:\/?#]+):)?(\/\/([^\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$/
.
- Constraints: The maximum length is
- endpoint
Internal string - (String) URL to function that is only visible within the project.
- Constraints: The maximum length is
2048
characters. The minimum length is0
characters. The value must match regular expression/(([^:\/?#]+):)?(\/\/([^\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$/
.
- Constraints: The maximum length is
- entity
Tag string - (String) The version of the function instance, which is used to achieve optimistic locking.
- Constraints: The maximum length is
63
characters. The minimum length is1
character. The value must match regular expression/^[\\*\\-a-z0-9]+$/
.
- Constraints: The maximum length is
- etag string
- ETag identifier for code_engine_function.
- function
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
- href string
- (String) When you provision a new function, a relative URL path 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
- managed
Domain stringMappings - Optional value controlling which of the system managed domain mappings will be setup for the function. Valid values are 'local_public', 'local_private' and 'local'. Visibility can only be 'local_private' if the project supports function private visibility.
- Constraints: The default value is
local_public
. Allowable values are:local
,local_private
,local_public
.
- Constraints: The default value is
- name string
- The name of the function.
- Constraints: The maximum length is
63
characters. The minimum length is1
character. The value must match regular expression/^a-z?$/
.
- Constraints: The maximum length is
- project
Id string - The ID of the project.
- Constraints: The maximum length is
36
characters. The minimum length is36
characters. The value must match regular expression/^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$/
.
- Constraints: The maximum length is
- region string
- (String) The region of the project the resource is located in. Possible values: 'au-syd', 'br-sao', 'ca-tor', 'eu-de', 'eu-gb', 'jp-osa', 'jp-tok', 'us-east', 'us-south'.
- resource
Type string - (String) The type of the function.
- Constraints: Allowable values are:
function_v2
.
- Constraints: Allowable values are:
- run
Env CodeVariables Engine Function Run Env Variable[] - References to config maps, secrets or literal values, which are defined by the function owner and are exposed as environment variables in the function.
- Constraints: The maximum length is
100
items. The minimum length is0
items. Nested schema for run_env_variables:
- Constraints: The maximum length is
- runtime string
- The managed runtime used to execute the injected code.
- Constraints: The maximum length is
63
characters. The minimum length is1
character. The value must match regular expression/^[a-z]*\\-[0-9]*(\\.[0-9]*)?$/
.
- Constraints: The maximum length is
- scale
Concurrency number - Number of parallel requests handled by a single instance, supported only by Node.js, default is
1
.- Constraints: The default value is
1
. The maximum value is100
. The minimum value is1
.
- Constraints: The default value is
- scale
Cpu stringLimit - Optional amount of CPU set for the instance of the function. For valid values see Supported memory and CPU combinations.
- Constraints: The default value is
1
. The maximum length is10
characters. The minimum length is0
characters. The value must match regular expression/^([0-9.]+)([eEinumkKMGTPB]*)$/
.
- Constraints: The default value is
- scale
Down numberDelay - Optional amount of time in seconds that delays the scale down behavior for a function.
- Constraints: The default value is
1
. The maximum value is600
. The minimum value is0
.
- Constraints: The default value is
- scale
Max numberExecution Time - Timeout in secs after which the function is terminated.
- Constraints: The default value is
60
. The maximum value is120
. The minimum value is1
.
- Constraints: The default value is
- scale
Memory stringLimit - Optional amount of memory set for the instance of the function. 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
- status string
- (String) The current status of the function.
- Constraints: Allowable values are:
offline
,deploying
,ready
,failed
.
- Constraints: Allowable values are:
- status
Details CodeEngine Function Status Detail[] - (List) The detailed status of the function. Nested schema for status_details:
- timeouts
Code
Engine Function Timeouts
- code_
binary bool - Specifies whether the code is binary or not. Defaults to false when
code_reference
is set to a data URL. Whencode_reference
is set to a code bundle URL, this field is always true. - code_
engine_ strfunction_ id - The unique identifier of the code_engine_function.
- code_
main str - Specifies the name of the function that should be invoked.
- Constraints: The default value is
main
. The maximum length is63
characters. The minimum length is1
character. The value must match regular expression/^[a-zA-Z_][a-zA-Z0-9_]*$/
.
- Constraints: The default value is
- code_
reference str - Specifies either a reference to a code bundle or the source code itself. To specify the source code, use the data URL scheme and include the source code as base64 encoded. The data URL scheme is defined in RFC 2397.
- Constraints: The maximum length is
1048576
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})?$|data:([-\\w]+\/[-+\\w.]+)?(;?\\w+=[-\\w]+)*;base64,.*/
.
- Constraints: The maximum length is
- code_
secret str - The name of the secret that is used to access the specified
code_reference
. The secret is used to authenticate with a non-public endpoint that is specified ascode_reference
.- 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
- computed_
env_ Sequence[Codevariables Engine Function Computed Env Variable Args] - (List) References to config maps, secrets or literal values, which are defined and set by Code Engine and are exposed as environment variables in the function.
- Constraints: The maximum length is
100
items. The minimum length is0
items. Nested schema for computed_env_variables:
- Constraints: The maximum length is
- created_
at str - (String) The timestamp when the resource was created.
- endpoint str
- (String) URL to invoke the function.
- Constraints: The maximum length is
2048
characters. The minimum length is0
characters. The value must match regular expression/(([^:\/?#]+):)?(\/\/([^\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$/
.
- Constraints: The maximum length is
- endpoint_
internal str - (String) URL to function that is only visible within the project.
- Constraints: The maximum length is
2048
characters. The minimum length is0
characters. The value must match regular expression/(([^:\/?#]+):)?(\/\/([^\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$/
.
- Constraints: The maximum length is
- entity_
tag str - (String) The version of the function instance, which is used to achieve optimistic locking.
- Constraints: The maximum length is
63
characters. The minimum length is1
character. The value must match regular expression/^[\\*\\-a-z0-9]+$/
.
- Constraints: The maximum length is
- etag str
- ETag identifier for code_engine_function.
- function_
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
- href str
- (String) When you provision a new function, a relative URL path 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
- managed_
domain_ strmappings - Optional value controlling which of the system managed domain mappings will be setup for the function. Valid values are 'local_public', 'local_private' and 'local'. Visibility can only be 'local_private' if the project supports function private visibility.
- Constraints: The default value is
local_public
. Allowable values are:local
,local_private
,local_public
.
- Constraints: The default value is
- name str
- The name of the function.
- Constraints: The maximum length is
63
characters. The minimum length is1
character. The value must match regular expression/^a-z?$/
.
- Constraints: The maximum length is
- project_
id str - The ID of the project.
- Constraints: The maximum length is
36
characters. The minimum length is36
characters. The value must match regular expression/^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$/
.
- Constraints: The maximum length is
- region str
- (String) The region of the project the resource is located in. Possible values: 'au-syd', 'br-sao', 'ca-tor', 'eu-de', 'eu-gb', 'jp-osa', 'jp-tok', 'us-east', 'us-south'.
- resource_
type str - (String) The type of the function.
- Constraints: Allowable values are:
function_v2
.
- Constraints: Allowable values are:
- run_
env_ Sequence[Codevariables Engine Function Run Env Variable Args] - References to config maps, secrets or literal values, which are defined by the function owner and are exposed as environment variables in the function.
- Constraints: The maximum length is
100
items. The minimum length is0
items. Nested schema for run_env_variables:
- Constraints: The maximum length is
- runtime str
- The managed runtime used to execute the injected code.
- Constraints: The maximum length is
63
characters. The minimum length is1
character. The value must match regular expression/^[a-z]*\\-[0-9]*(\\.[0-9]*)?$/
.
- Constraints: The maximum length is
- scale_
concurrency float - Number of parallel requests handled by a single instance, supported only by Node.js, default is
1
.- Constraints: The default value is
1
. The maximum value is100
. The minimum value is1
.
- Constraints: The default value is
- scale_
cpu_ strlimit - Optional amount of CPU set for the instance of the function. For valid values see Supported memory and CPU combinations.
- Constraints: The default value is
1
. The maximum length is10
characters. The minimum length is0
characters. The value must match regular expression/^([0-9.]+)([eEinumkKMGTPB]*)$/
.
- Constraints: The default value is
- scale_
down_ floatdelay - Optional amount of time in seconds that delays the scale down behavior for a function.
- Constraints: The default value is
1
. The maximum value is600
. The minimum value is0
.
- Constraints: The default value is
- scale_
max_ floatexecution_ time - Timeout in secs after which the function is terminated.
- Constraints: The default value is
60
. The maximum value is120
. The minimum value is1
.
- Constraints: The default value is
- scale_
memory_ strlimit - Optional amount of memory set for the instance of the function. 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
- status str
- (String) The current status of the function.
- Constraints: Allowable values are:
offline
,deploying
,ready
,failed
.
- Constraints: Allowable values are:
- status_
details Sequence[CodeEngine Function Status Detail Args] - (List) The detailed status of the function. Nested schema for status_details:
- timeouts
Code
Engine Function Timeouts Args
- code
Binary Boolean - Specifies whether the code is binary or not. Defaults to false when
code_reference
is set to a data URL. Whencode_reference
is set to a code bundle URL, this field is always true. - code
Engine StringFunction Id - The unique identifier of the code_engine_function.
- code
Main String - Specifies the name of the function that should be invoked.
- Constraints: The default value is
main
. The maximum length is63
characters. The minimum length is1
character. The value must match regular expression/^[a-zA-Z_][a-zA-Z0-9_]*$/
.
- Constraints: The default value is
- code
Reference String - Specifies either a reference to a code bundle or the source code itself. To specify the source code, use the data URL scheme and include the source code as base64 encoded. The data URL scheme is defined in RFC 2397.
- Constraints: The maximum length is
1048576
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})?$|data:([-\\w]+\/[-+\\w.]+)?(;?\\w+=[-\\w]+)*;base64,.*/
.
- Constraints: The maximum length is
- code
Secret String - The name of the secret that is used to access the specified
code_reference
. The secret is used to authenticate with a non-public endpoint that is specified ascode_reference
.- 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
- 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 function.
- Constraints: The maximum length is
100
items. The minimum length is0
items. Nested schema for computed_env_variables:
- Constraints: The maximum length is
- created
At String - (String) The timestamp when the resource was created.
- endpoint String
- (String) URL to invoke the function.
- Constraints: The maximum length is
2048
characters. The minimum length is0
characters. The value must match regular expression/(([^:\/?#]+):)?(\/\/([^\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$/
.
- Constraints: The maximum length is
- endpoint
Internal String - (String) URL to function that is only visible within the project.
- Constraints: The maximum length is
2048
characters. The minimum length is0
characters. The value must match regular expression/(([^:\/?#]+):)?(\/\/([^\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$/
.
- Constraints: The maximum length is
- entity
Tag String - (String) The version of the function instance, which is used to achieve optimistic locking.
- Constraints: The maximum length is
63
characters. The minimum length is1
character. The value must match regular expression/^[\\*\\-a-z0-9]+$/
.
- Constraints: The maximum length is
- etag String
- ETag identifier for code_engine_function.
- function
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
- href String
- (String) When you provision a new function, a relative URL path 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
- managed
Domain StringMappings - Optional value controlling which of the system managed domain mappings will be setup for the function. Valid values are 'local_public', 'local_private' and 'local'. Visibility can only be 'local_private' if the project supports function private visibility.
- Constraints: The default value is
local_public
. Allowable values are:local
,local_private
,local_public
.
- Constraints: The default value is
- name String
- The name of the function.
- Constraints: The maximum length is
63
characters. The minimum length is1
character. The value must match regular expression/^a-z?$/
.
- Constraints: The maximum length is
- project
Id String - The ID of the project.
- Constraints: The maximum length is
36
characters. The minimum length is36
characters. The value must match regular expression/^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$/
.
- Constraints: The maximum length is
- region String
- (String) The region of the project the resource is located in. Possible values: 'au-syd', 'br-sao', 'ca-tor', 'eu-de', 'eu-gb', 'jp-osa', 'jp-tok', 'us-east', 'us-south'.
- resource
Type String - (String) The type of the function.
- Constraints: Allowable values are:
function_v2
.
- Constraints: Allowable values are:
- run
Env List<Property Map>Variables - References to config maps, secrets or literal values, which are defined by the function owner and are exposed as environment variables in the function.
- Constraints: The maximum length is
100
items. The minimum length is0
items. Nested schema for run_env_variables:
- Constraints: The maximum length is
- runtime String
- The managed runtime used to execute the injected code.
- Constraints: The maximum length is
63
characters. The minimum length is1
character. The value must match regular expression/^[a-z]*\\-[0-9]*(\\.[0-9]*)?$/
.
- Constraints: The maximum length is
- scale
Concurrency Number - Number of parallel requests handled by a single instance, supported only by Node.js, default is
1
.- Constraints: The default value is
1
. The maximum value is100
. The minimum value is1
.
- Constraints: The default value is
- scale
Cpu StringLimit - Optional amount of CPU set for the instance of the function. For valid values see Supported memory and CPU combinations.
- Constraints: The default value is
1
. The maximum length is10
characters. The minimum length is0
characters. The value must match regular expression/^([0-9.]+)([eEinumkKMGTPB]*)$/
.
- Constraints: The default value is
- scale
Down NumberDelay - Optional amount of time in seconds that delays the scale down behavior for a function.
- Constraints: The default value is
1
. The maximum value is600
. The minimum value is0
.
- Constraints: The default value is
- scale
Max NumberExecution Time - Timeout in secs after which the function is terminated.
- Constraints: The default value is
60
. The maximum value is120
. The minimum value is1
.
- Constraints: The default value is
- scale
Memory StringLimit - Optional amount of memory set for the instance of the function. 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
- status String
- (String) The current status of the function.
- Constraints: Allowable values are:
offline
,deploying
,ready
,failed
.
- Constraints: Allowable values are:
- status
Details List<Property Map> - (List) The detailed status of the function. Nested schema for status_details:
- timeouts Property Map
Supporting Types
CodeEngineFunctionComputedEnvVariable, CodeEngineFunctionComputedEnvVariableArgs
- Key string
- (String) The key to reference as environment variable.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^[\\-._a-zA-Z0-9]+$/
.
- Constraints: The maximum length is
- Name string
- The name of the function.
- Constraints: The maximum length is
63
characters. The minimum length is1
character. The value must match regular expression/^a-z?$/
.
- Constraints: The maximum length is
- Prefix string
- (String) A prefix that can be added to all keys of a full secret or config map reference.
- Constraints: The maximum length is
253
characters. The minimum length is0
characters. The value must match regular expression/^[a-zA-Z_][a-zA-Z0-9_]*$/
.
- Constraints: The maximum length is
- Reference string
- (String) The name of the secret or config map.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^a-z0-9?(\\.a-z0-9?)*$/
.
- Constraints: The maximum length is
- Type string
- (String) Specify the type of the environment variable.
- Constraints: The default value is
literal
. Allowable values are:literal
,config_map_full_reference
,secret_full_reference
,config_map_key_reference
,secret_key_reference
. The value must match regular expression/^(literal|config_map_full_reference|secret_full_reference|config_map_key_reference|secret_key_reference)$/
.
- Constraints: The default value is
- Value string
- (String) The literal value of the environment variable.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^[\\-._a-zA-Z0-9]+$/
.
- Constraints: The maximum length is
- Key string
- (String) The key to reference as environment variable.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^[\\-._a-zA-Z0-9]+$/
.
- Constraints: The maximum length is
- Name string
- The name of the function.
- Constraints: The maximum length is
63
characters. The minimum length is1
character. The value must match regular expression/^a-z?$/
.
- Constraints: The maximum length is
- Prefix string
- (String) A prefix that can be added to all keys of a full secret or config map reference.
- Constraints: The maximum length is
253
characters. The minimum length is0
characters. The value must match regular expression/^[a-zA-Z_][a-zA-Z0-9_]*$/
.
- Constraints: The maximum length is
- Reference string
- (String) The name of the secret or config map.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^a-z0-9?(\\.a-z0-9?)*$/
.
- Constraints: The maximum length is
- Type string
- (String) Specify the type of the environment variable.
- Constraints: The default value is
literal
. Allowable values are:literal
,config_map_full_reference
,secret_full_reference
,config_map_key_reference
,secret_key_reference
. The value must match regular expression/^(literal|config_map_full_reference|secret_full_reference|config_map_key_reference|secret_key_reference)$/
.
- Constraints: The default value is
- Value string
- (String) The literal value of the environment variable.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^[\\-._a-zA-Z0-9]+$/
.
- Constraints: The maximum length is
- key String
- (String) The key to reference as environment variable.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^[\\-._a-zA-Z0-9]+$/
.
- Constraints: The maximum length is
- name String
- The name of the function.
- Constraints: The maximum length is
63
characters. The minimum length is1
character. The value must match regular expression/^a-z?$/
.
- Constraints: The maximum length is
- prefix String
- (String) A prefix that can be added to all keys of a full secret or config map reference.
- Constraints: The maximum length is
253
characters. The minimum length is0
characters. The value must match regular expression/^[a-zA-Z_][a-zA-Z0-9_]*$/
.
- Constraints: The maximum length is
- reference String
- (String) The name of the secret or config map.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^a-z0-9?(\\.a-z0-9?)*$/
.
- Constraints: The maximum length is
- type String
- (String) Specify the type of the environment variable.
- Constraints: The default value is
literal
. Allowable values are:literal
,config_map_full_reference
,secret_full_reference
,config_map_key_reference
,secret_key_reference
. The value must match regular expression/^(literal|config_map_full_reference|secret_full_reference|config_map_key_reference|secret_key_reference)$/
.
- Constraints: The default value is
- value String
- (String) The literal value of the environment variable.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^[\\-._a-zA-Z0-9]+$/
.
- Constraints: The maximum length is
- key string
- (String) The key to reference as environment variable.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^[\\-._a-zA-Z0-9]+$/
.
- Constraints: The maximum length is
- name string
- The name of the function.
- Constraints: The maximum length is
63
characters. The minimum length is1
character. The value must match regular expression/^a-z?$/
.
- Constraints: The maximum length is
- prefix string
- (String) A prefix that can be added to all keys of a full secret or config map reference.
- Constraints: The maximum length is
253
characters. The minimum length is0
characters. The value must match regular expression/^[a-zA-Z_][a-zA-Z0-9_]*$/
.
- Constraints: The maximum length is
- reference string
- (String) The name of the secret or config map.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^a-z0-9?(\\.a-z0-9?)*$/
.
- Constraints: The maximum length is
- type string
- (String) Specify the type of the environment variable.
- Constraints: The default value is
literal
. Allowable values are:literal
,config_map_full_reference
,secret_full_reference
,config_map_key_reference
,secret_key_reference
. The value must match regular expression/^(literal|config_map_full_reference|secret_full_reference|config_map_key_reference|secret_key_reference)$/
.
- Constraints: The default value is
- value string
- (String) The literal value of the environment variable.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^[\\-._a-zA-Z0-9]+$/
.
- Constraints: The maximum length is
- key str
- (String) The key to reference as environment variable.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^[\\-._a-zA-Z0-9]+$/
.
- Constraints: The maximum length is
- name str
- The name of the function.
- Constraints: The maximum length is
63
characters. The minimum length is1
character. The value must match regular expression/^a-z?$/
.
- Constraints: The maximum length is
- prefix str
- (String) A prefix that can be added to all keys of a full secret or config map reference.
- Constraints: The maximum length is
253
characters. The minimum length is0
characters. The value must match regular expression/^[a-zA-Z_][a-zA-Z0-9_]*$/
.
- Constraints: The maximum length is
- reference str
- (String) The name of the secret or config map.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^a-z0-9?(\\.a-z0-9?)*$/
.
- Constraints: The maximum length is
- type str
- (String) Specify the type of the environment variable.
- Constraints: The default value is
literal
. Allowable values are:literal
,config_map_full_reference
,secret_full_reference
,config_map_key_reference
,secret_key_reference
. The value must match regular expression/^(literal|config_map_full_reference|secret_full_reference|config_map_key_reference|secret_key_reference)$/
.
- Constraints: The default value is
- value str
- (String) The literal value of the environment variable.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^[\\-._a-zA-Z0-9]+$/
.
- Constraints: The maximum length is
- key String
- (String) The key to reference as environment variable.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^[\\-._a-zA-Z0-9]+$/
.
- Constraints: The maximum length is
- name String
- The name of the function.
- Constraints: The maximum length is
63
characters. The minimum length is1
character. The value must match regular expression/^a-z?$/
.
- Constraints: The maximum length is
- prefix String
- (String) A prefix that can be added to all keys of a full secret or config map reference.
- Constraints: The maximum length is
253
characters. The minimum length is0
characters. The value must match regular expression/^[a-zA-Z_][a-zA-Z0-9_]*$/
.
- Constraints: The maximum length is
- reference String
- (String) The name of the secret or config map.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^a-z0-9?(\\.a-z0-9?)*$/
.
- Constraints: The maximum length is
- type String
- (String) Specify the type of the environment variable.
- Constraints: The default value is
literal
. Allowable values are:literal
,config_map_full_reference
,secret_full_reference
,config_map_key_reference
,secret_key_reference
. The value must match regular expression/^(literal|config_map_full_reference|secret_full_reference|config_map_key_reference|secret_key_reference)$/
.
- Constraints: The default value is
- value String
- (String) The literal value of the environment variable.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^[\\-._a-zA-Z0-9]+$/
.
- Constraints: The maximum length is
CodeEngineFunctionRunEnvVariable, CodeEngineFunctionRunEnvVariableArgs
- Key string
- The key to reference as environment variable.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^[\\-._a-zA-Z0-9]+$/
.
- Constraints: The maximum length is
- Name string
- The name of the environment variable.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^[\\-._a-zA-Z0-9]+$/
.
- Constraints: The maximum length is
- Prefix string
- A prefix that can be added to all keys of a full secret or config map reference.
- Constraints: The maximum length is
253
characters. The minimum length is0
characters. The value must match regular expression/^[a-zA-Z_][a-zA-Z0-9_]*$/
.
- Constraints: The maximum length is
- Reference string
- The name of the secret or config map.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^a-z0-9?(\\.a-z0-9?)*$/
.
- Constraints: The maximum length is
- Type string
- Specify the type of the environment variable.
- Constraints: The default value is
literal
. Allowable values are:literal
,config_map_full_reference
,secret_full_reference
,config_map_key_reference
,secret_key_reference
. The value must match regular expression/^(literal|config_map_full_reference|secret_full_reference|config_map_key_reference|secret_key_reference)$/
. When referencing a secret or configmap, thereference
must be specified. When referencing a secret or configmap key, akey
must also be specified.
- Constraints: The default value is
- Value string
- The literal value of the environment variable.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^[\\-._a-zA-Z0-9]+$/
.
- Constraints: The maximum length is
- Key string
- The key to reference as environment variable.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^[\\-._a-zA-Z0-9]+$/
.
- Constraints: The maximum length is
- Name string
- The name of the environment variable.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^[\\-._a-zA-Z0-9]+$/
.
- Constraints: The maximum length is
- Prefix string
- A prefix that can be added to all keys of a full secret or config map reference.
- Constraints: The maximum length is
253
characters. The minimum length is0
characters. The value must match regular expression/^[a-zA-Z_][a-zA-Z0-9_]*$/
.
- Constraints: The maximum length is
- Reference string
- The name of the secret or config map.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^a-z0-9?(\\.a-z0-9?)*$/
.
- Constraints: The maximum length is
- Type string
- Specify the type of the environment variable.
- Constraints: The default value is
literal
. Allowable values are:literal
,config_map_full_reference
,secret_full_reference
,config_map_key_reference
,secret_key_reference
. The value must match regular expression/^(literal|config_map_full_reference|secret_full_reference|config_map_key_reference|secret_key_reference)$/
. When referencing a secret or configmap, thereference
must be specified. When referencing a secret or configmap key, akey
must also be specified.
- Constraints: The default value is
- Value string
- The literal value of the environment variable.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^[\\-._a-zA-Z0-9]+$/
.
- Constraints: The maximum length is
- key String
- The key to reference as environment variable.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^[\\-._a-zA-Z0-9]+$/
.
- Constraints: The maximum length is
- name String
- The name of the environment variable.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^[\\-._a-zA-Z0-9]+$/
.
- Constraints: The maximum length is
- prefix String
- A prefix that can be added to all keys of a full secret or config map reference.
- Constraints: The maximum length is
253
characters. The minimum length is0
characters. The value must match regular expression/^[a-zA-Z_][a-zA-Z0-9_]*$/
.
- Constraints: The maximum length is
- reference String
- The name of the secret or config map.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^a-z0-9?(\\.a-z0-9?)*$/
.
- Constraints: The maximum length is
- type String
- Specify the type of the environment variable.
- Constraints: The default value is
literal
. Allowable values are:literal
,config_map_full_reference
,secret_full_reference
,config_map_key_reference
,secret_key_reference
. The value must match regular expression/^(literal|config_map_full_reference|secret_full_reference|config_map_key_reference|secret_key_reference)$/
. When referencing a secret or configmap, thereference
must be specified. When referencing a secret or configmap key, akey
must also be specified.
- Constraints: The default value is
- value String
- The literal value of the environment variable.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^[\\-._a-zA-Z0-9]+$/
.
- Constraints: The maximum length is
- key string
- The key to reference as environment variable.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^[\\-._a-zA-Z0-9]+$/
.
- Constraints: The maximum length is
- name string
- The name of the environment variable.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^[\\-._a-zA-Z0-9]+$/
.
- Constraints: The maximum length is
- prefix string
- A prefix that can be added to all keys of a full secret or config map reference.
- Constraints: The maximum length is
253
characters. The minimum length is0
characters. The value must match regular expression/^[a-zA-Z_][a-zA-Z0-9_]*$/
.
- Constraints: The maximum length is
- reference string
- The name of the secret or config map.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^a-z0-9?(\\.a-z0-9?)*$/
.
- Constraints: The maximum length is
- type string
- Specify the type of the environment variable.
- Constraints: The default value is
literal
. Allowable values are:literal
,config_map_full_reference
,secret_full_reference
,config_map_key_reference
,secret_key_reference
. The value must match regular expression/^(literal|config_map_full_reference|secret_full_reference|config_map_key_reference|secret_key_reference)$/
. When referencing a secret or configmap, thereference
must be specified. When referencing a secret or configmap key, akey
must also be specified.
- Constraints: The default value is
- value string
- The literal value of the environment variable.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^[\\-._a-zA-Z0-9]+$/
.
- Constraints: The maximum length is
- key str
- The key to reference as environment variable.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^[\\-._a-zA-Z0-9]+$/
.
- Constraints: The maximum length is
- name str
- The name of the environment variable.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^[\\-._a-zA-Z0-9]+$/
.
- Constraints: The maximum length is
- prefix str
- A prefix that can be added to all keys of a full secret or config map reference.
- Constraints: The maximum length is
253
characters. The minimum length is0
characters. The value must match regular expression/^[a-zA-Z_][a-zA-Z0-9_]*$/
.
- Constraints: The maximum length is
- reference str
- The name of the secret or config map.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^a-z0-9?(\\.a-z0-9?)*$/
.
- Constraints: The maximum length is
- type str
- Specify the type of the environment variable.
- Constraints: The default value is
literal
. Allowable values are:literal
,config_map_full_reference
,secret_full_reference
,config_map_key_reference
,secret_key_reference
. The value must match regular expression/^(literal|config_map_full_reference|secret_full_reference|config_map_key_reference|secret_key_reference)$/
. When referencing a secret or configmap, thereference
must be specified. When referencing a secret or configmap key, akey
must also be specified.
- Constraints: The default value is
- value str
- The literal value of the environment variable.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^[\\-._a-zA-Z0-9]+$/
.
- Constraints: The maximum length is
- key String
- The key to reference as environment variable.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^[\\-._a-zA-Z0-9]+$/
.
- Constraints: The maximum length is
- name String
- The name of the environment variable.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^[\\-._a-zA-Z0-9]+$/
.
- Constraints: The maximum length is
- prefix String
- A prefix that can be added to all keys of a full secret or config map reference.
- Constraints: The maximum length is
253
characters. The minimum length is0
characters. The value must match regular expression/^[a-zA-Z_][a-zA-Z0-9_]*$/
.
- Constraints: The maximum length is
- reference String
- The name of the secret or config map.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^a-z0-9?(\\.a-z0-9?)*$/
.
- Constraints: The maximum length is
- type String
- Specify the type of the environment variable.
- Constraints: The default value is
literal
. Allowable values are:literal
,config_map_full_reference
,secret_full_reference
,config_map_key_reference
,secret_key_reference
. The value must match regular expression/^(literal|config_map_full_reference|secret_full_reference|config_map_key_reference|secret_key_reference)$/
. When referencing a secret or configmap, thereference
must be specified. When referencing a secret or configmap key, akey
must also be specified.
- Constraints: The default value is
- value String
- The literal value of the environment variable.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^[\\-._a-zA-Z0-9]+$/
.
- Constraints: The maximum length is
CodeEngineFunctionStatusDetail, CodeEngineFunctionStatusDetailArgs
- Reason string
- (String) Provides additional information about the status of the function.
- Constraints: Allowable values are:
offline
,deploying_configuring_routes
,ready_update_in_progress
,deploying
,ready_last_update_failed
,ready
,unknown_reason
,no_code_bundle
.
- Constraints: Allowable values are:
- Reason string
- (String) Provides additional information about the status of the function.
- Constraints: Allowable values are:
offline
,deploying_configuring_routes
,ready_update_in_progress
,deploying
,ready_last_update_failed
,ready
,unknown_reason
,no_code_bundle
.
- Constraints: Allowable values are:
- reason String
- (String) Provides additional information about the status of the function.
- Constraints: Allowable values are:
offline
,deploying_configuring_routes
,ready_update_in_progress
,deploying
,ready_last_update_failed
,ready
,unknown_reason
,no_code_bundle
.
- Constraints: Allowable values are:
- reason string
- (String) Provides additional information about the status of the function.
- Constraints: Allowable values are:
offline
,deploying_configuring_routes
,ready_update_in_progress
,deploying
,ready_last_update_failed
,ready
,unknown_reason
,no_code_bundle
.
- Constraints: Allowable values are:
- reason str
- (String) Provides additional information about the status of the function.
- Constraints: Allowable values are:
offline
,deploying_configuring_routes
,ready_update_in_progress
,deploying
,ready_last_update_failed
,ready
,unknown_reason
,no_code_bundle
.
- Constraints: Allowable values are:
- reason String
- (String) Provides additional information about the status of the function.
- Constraints: Allowable values are:
offline
,deploying_configuring_routes
,ready_update_in_progress
,deploying
,ready_last_update_failed
,ready
,unknown_reason
,no_code_bundle
.
- Constraints: Allowable values are:
CodeEngineFunctionTimeouts, CodeEngineFunctionTimeoutsArgs
Import
You can import the ibm_code_engine_function
resource by using name
.
The name
property can be formed from project_id
, and name
in the following format:
<project_id>/<name>
project_id
: A string in the format15314cc3-85b4-4338-903f-c28cdee6d005
. The ID of the project.name
: A string in the formatmy-function
. The name of the function.
Syntax
```sh $ pulumi import ibm:index/codeEngineFunction:CodeEngineFunction code_engine_function <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.