ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
ibm.getCodeEngineFunction
Explore with Pulumi AI
Provides a read-only data source to retrieve information about a code_engine_function. You can then reference the fields of the data source in other resources within the same configuration by using interpolation syntax.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as ibm from "@pulumi/ibm";
const codeEngineFunction = ibm.getCodeEngineFunction({
name: ibm_code_engine_function.code_engine_function_instance.name,
projectId: ibm_code_engine_function.code_engine_function_instance.project_id,
});
import pulumi
import pulumi_ibm as ibm
code_engine_function = ibm.get_code_engine_function(name=ibm_code_engine_function["code_engine_function_instance"]["name"],
project_id=ibm_code_engine_function["code_engine_function_instance"]["project_id"])
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.LookupCodeEngineFunction(ctx, &ibm.LookupCodeEngineFunctionArgs{
Name: ibm_code_engine_function.Code_engine_function_instance.Name,
ProjectId: ibm_code_engine_function.Code_engine_function_instance.Project_id,
}, nil)
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;
return await Deployment.RunAsync(() =>
{
var codeEngineFunction = Ibm.GetCodeEngineFunction.Invoke(new()
{
Name = ibm_code_engine_function.Code_engine_function_instance.Name,
ProjectId = ibm_code_engine_function.Code_engine_function_instance.Project_id,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.IbmFunctions;
import com.pulumi.ibm.inputs.GetCodeEngineFunctionArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var codeEngineFunction = IbmFunctions.getCodeEngineFunction(GetCodeEngineFunctionArgs.builder()
.name(ibm_code_engine_function.code_engine_function_instance().name())
.projectId(ibm_code_engine_function.code_engine_function_instance().project_id())
.build());
}
}
variables:
codeEngineFunction:
fn::invoke:
function: ibm:getCodeEngineFunction
arguments:
name: ${ibm_code_engine_function.code_engine_function_instance.name}
projectId: ${ibm_code_engine_function.code_engine_function_instance.project_id}
Using getCodeEngineFunction
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getCodeEngineFunction(args: GetCodeEngineFunctionArgs, opts?: InvokeOptions): Promise<GetCodeEngineFunctionResult>
function getCodeEngineFunctionOutput(args: GetCodeEngineFunctionOutputArgs, opts?: InvokeOptions): Output<GetCodeEngineFunctionResult>
def get_code_engine_function(id: Optional[str] = None,
name: Optional[str] = None,
project_id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetCodeEngineFunctionResult
def get_code_engine_function_output(id: Optional[pulumi.Input[str]] = None,
name: Optional[pulumi.Input[str]] = None,
project_id: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetCodeEngineFunctionResult]
func LookupCodeEngineFunction(ctx *Context, args *LookupCodeEngineFunctionArgs, opts ...InvokeOption) (*LookupCodeEngineFunctionResult, error)
func LookupCodeEngineFunctionOutput(ctx *Context, args *LookupCodeEngineFunctionOutputArgs, opts ...InvokeOption) LookupCodeEngineFunctionResultOutput
> Note: This function is named LookupCodeEngineFunction
in the Go SDK.
public static class GetCodeEngineFunction
{
public static Task<GetCodeEngineFunctionResult> InvokeAsync(GetCodeEngineFunctionArgs args, InvokeOptions? opts = null)
public static Output<GetCodeEngineFunctionResult> Invoke(GetCodeEngineFunctionInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetCodeEngineFunctionResult> getCodeEngineFunction(GetCodeEngineFunctionArgs args, InvokeOptions options)
public static Output<GetCodeEngineFunctionResult> getCodeEngineFunction(GetCodeEngineFunctionArgs args, InvokeOptions options)
fn::invoke:
function: ibm:index/getCodeEngineFunction:getCodeEngineFunction
arguments:
# arguments dictionary
The following arguments are supported:
- Name string
- The name of your 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
- Id string
- The unique identifier of the code_engine_function.
- Name string
- The name of your 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
- Id string
- The unique identifier of the code_engine_function.
- name String
- The name of your 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
- id String
- The unique identifier of the code_engine_function.
- name string
- The name of your 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
- id string
- The unique identifier of the code_engine_function.
- name str
- The name of your 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
- id str
- The unique identifier of the code_engine_function.
- name String
- The name of your 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
- id String
- The unique identifier of the code_engine_function.
getCodeEngineFunction Result
The following output properties are available:
- Code
Binary bool - (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
Main string - (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 - (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 - (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<GetVariables Code 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
- 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 unique identifier of the code_engine_function.
- Managed
Domain stringMappings - (String) 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
- (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
- Project
Id string - Region string
- (String) The region of the project the resource is located in. Possible values: 'au-syd', 'br-sao', 'ca-tor', 'eu-de', 'eu-gb', 'jp-osa', 'jp-tok', 'us-east', 'us-south'.
- Resource
Type string - (String) The type of the function.
- Constraints: Allowable values are:
function_v2
.
- Constraints: Allowable values are:
- Run
Env List<GetVariables Code Engine Function Run Env Variable> - (List) 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
- (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 - (Integer) 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 - (String) 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 - (Integer) 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 - (Integer) 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 - (String) 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<GetCode Engine Function Status Detail> - (List) The detailed status of the function. Nested schema for status_details:
- Code
Binary bool - (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
Main string - (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 - (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 - (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 []GetVariables Code 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
- 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 unique identifier of the code_engine_function.
- Managed
Domain stringMappings - (String) 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
- (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
- Project
Id string - Region string
- (String) The region of the project the resource is located in. Possible values: 'au-syd', 'br-sao', 'ca-tor', 'eu-de', 'eu-gb', 'jp-osa', 'jp-tok', 'us-east', 'us-south'.
- Resource
Type string - (String) The type of the function.
- Constraints: Allowable values are:
function_v2
.
- Constraints: Allowable values are:
- Run
Env []GetVariables Code Engine Function Run Env Variable - (List) 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
- (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 - (Integer) 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 - (String) 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 - (Integer) 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 - (Integer) 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 - (String) 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 []GetCode Engine Function Status Detail - (List) The detailed status of the function. Nested schema for status_details:
- code
Binary Boolean - (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
Main String - (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 - (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 - (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<GetVariables Code 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
- 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 unique identifier of the code_engine_function.
- managed
Domain StringMappings - (String) 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
- (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
- project
Id String - region String
- (String) The region of the project the resource is located in. Possible values: 'au-syd', 'br-sao', 'ca-tor', 'eu-de', 'eu-gb', 'jp-osa', 'jp-tok', 'us-east', 'us-south'.
- resource
Type String - (String) The type of the function.
- Constraints: Allowable values are:
function_v2
.
- Constraints: Allowable values are:
- run
Env List<GetVariables Code Engine Function Run Env Variable> - (List) 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
- (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 - (Integer) 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 - (String) 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 - (Integer) 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 - (Integer) 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 - (String) 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<GetCode Engine Function Status Detail> - (List) The detailed status of the function. Nested schema for status_details:
- code
Binary boolean - (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
Main string - (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 - (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 - (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 GetVariables Code 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
- 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 unique identifier of the code_engine_function.
- managed
Domain stringMappings - (String) 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
- (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
- project
Id string - region string
- (String) The region of the project the resource is located in. Possible values: 'au-syd', 'br-sao', 'ca-tor', 'eu-de', 'eu-gb', 'jp-osa', 'jp-tok', 'us-east', 'us-south'.
- resource
Type string - (String) The type of the function.
- Constraints: Allowable values are:
function_v2
.
- Constraints: Allowable values are:
- run
Env GetVariables Code Engine Function Run Env Variable[] - (List) 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
- (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 - (Integer) 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 - (String) 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 - (Integer) 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 - (Integer) 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 - (String) 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 GetCode Engine Function Status Detail[] - (List) The detailed status of the function. Nested schema for status_details:
- code_
binary bool - (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_
main str - (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 str - (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 str - (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_ Sequence[Getvariables Code 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
- 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 unique identifier of the code_engine_function.
- managed_
domain_ strmappings - (String) 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
- (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
- project_
id str - region str
- (String) The region of the project the resource is located in. Possible values: 'au-syd', 'br-sao', 'ca-tor', 'eu-de', 'eu-gb', 'jp-osa', 'jp-tok', 'us-east', 'us-south'.
- resource_
type str - (String) The type of the function.
- Constraints: Allowable values are:
function_v2
.
- Constraints: Allowable values are:
- run_
env_ Sequence[Getvariables Code Engine Function Run Env Variable] - (List) 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
- (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 float - (Integer) 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 - (String) 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 - (Integer) 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 - (Integer) 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 - (String) 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[GetCode Engine Function Status Detail] - (List) The detailed status of the function. Nested schema for status_details:
- code
Binary Boolean - (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
Main String - (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 - (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 - (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
- 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 unique identifier of the code_engine_function.
- managed
Domain StringMappings - (String) 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
- (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
- project
Id String - region String
- (String) The region of the project the resource is located in. Possible values: 'au-syd', 'br-sao', 'ca-tor', 'eu-de', 'eu-gb', 'jp-osa', 'jp-tok', 'us-east', 'us-south'.
- resource
Type String - (String) The type of the function.
- Constraints: Allowable values are:
function_v2
.
- Constraints: Allowable values are:
- run
Env List<Property Map>Variables - (List) 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
- (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 - (Integer) 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 - (String) 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 - (Integer) 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 - (Integer) 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 - (String) 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:
Supporting Types
GetCodeEngineFunctionComputedEnvVariable
- Key string
- (String) The key to reference as environment variable.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^[\\-._a-zA-Z0-9]+$/
.
- Constraints: The maximum length is
- Name string
- The name of your 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 your 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 your 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 your 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 your 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 your 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
GetCodeEngineFunctionRunEnvVariable
- Key string
- (String) The key to reference as environment variable.
- Constraints: The maximum length is
253
characters. The minimum length is1
character. The value must match regular expression/^[\\-._a-zA-Z0-9]+$/
.
- Constraints: The maximum length is
- Name string
- The name of your 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 your 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 your 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 your 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 your 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 your 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
GetCodeEngineFunctionStatusDetail
- 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:
Package Details
- Repository
- ibm ibm-cloud/terraform-provider-ibm
- License
- Notes
- This Pulumi package is based on the
ibm
Terraform Provider.