1. Packages
  2. Ibm Provider
  3. API Docs
  4. getCodeEngineFunction
ibm 1.77.1 published on Monday, Apr 14, 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,
});
Copy
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"])
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ibm.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
	})
}
Copy
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,
    });

});
Copy
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());

    }
}
Copy
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}
Copy

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>
Copy
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]
Copy
func LookupCodeEngineFunction(ctx *Context, args *LookupCodeEngineFunctionArgs, opts ...InvokeOption) (*LookupCodeEngineFunctionResult, error)
func LookupCodeEngineFunctionOutput(ctx *Context, args *LookupCodeEngineFunctionOutputArgs, opts ...InvokeOption) LookupCodeEngineFunctionResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetCodeEngineFunctionResult> getCodeEngineFunction(GetCodeEngineFunctionArgs args, InvokeOptions options)
public static Output<GetCodeEngineFunctionResult> getCodeEngineFunction(GetCodeEngineFunctionArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: ibm:index/getCodeEngineFunction:getCodeEngineFunction
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Name This property is required. string
The name of your function.

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

  • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$/.
Id string
The unique identifier of the code_engine_function.
Name This property is required. string
The name of your function.

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

  • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$/.
Id string
The unique identifier of the code_engine_function.
name This property is required. String
The name of your function.

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

  • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$/.
id String
The unique identifier of the code_engine_function.
name This property is required. string
The name of your function.

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

  • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$/.
id string
The unique identifier of the code_engine_function.
name This property is required. str
The name of your function.

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

  • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$/.
id str
The unique identifier of the code_engine_function.
name This property is required. String
The name of your function.

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

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

getCodeEngineFunction Result

The following output properties are available:

CodeBinary bool
(Boolean) Specifies whether the code is binary or not. Defaults to false when code_reference is set to a data URL. When code_reference is set to a code bundle URL, this field is always true.
CodeMain string
(String) Specifies the name of the function that should be invoked.

  • Constraints: The default value is main. The maximum length is 63 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z_][a-zA-Z0-9_]*$/.
CodeReference 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 is 1 character. The value must match regular expression /^([a-z0-9][a-z0-9\\-_.]+[a-z0-9][\/])?([a-z0-9][a-z0-9\\-_]+[a-z0-9][\/])?[a-z0-9][a-z0-9\\-_.\/]+a-z0-9?(@sha256:[a-fA-F0-9]{64})?$|data:([-\\w]+\/[-+\\w.]+)?(;?\\w+=[-\\w]+)*;base64,.*/.
CodeSecret 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 is 1 character. The value must match regular expression /^a-z0-9?(\\.a-z0-9?)*$/.
ComputedEnvVariables List<GetCodeEngineFunctionComputedEnvVariable>
(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 is 0 items. Nested schema for computed_env_variables:
CreatedAt 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 is 0 characters. The value must match regular expression /(([^:\/?#]+):)?(\/\/([^\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$/.
EndpointInternal string
(String) URL to function that is only visible within the project.

  • Constraints: The maximum length is 2048 characters. The minimum length is 0 characters. The value must match regular expression /(([^:\/?#]+):)?(\/\/([^\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$/.
EntityTag 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 is 1 character. The value must match regular expression /^[\\*\\-a-z0-9]+$/.
FunctionId string
(String) The identifier of the resource.

  • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$/.
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 is 0 characters. The value must match regular expression /(([^:\/?#]+):)?(\/\/([^\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$/.
Id string
The unique identifier of the code_engine_function.
ManagedDomainMappings string
(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.
Name string
(String) The name of the environment variable.

  • Constraints: The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /^[\\-._a-zA-Z0-9]+$/.
ProjectId 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'.
ResourceType string
(String) The type of the function.

  • Constraints: Allowable values are: function_v2.
RunEnvVariables List<GetCodeEngineFunctionRunEnvVariable>
(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 is 0 items. Nested schema for run_env_variables:
Runtime string
(String) The managed runtime used to execute the injected code.

  • Constraints: The maximum length is 63 characters. The minimum length is 1 character. The value must match regular expression /^[a-z]*\\-[0-9]*(\\.[0-9]*)?$/.
ScaleConcurrency 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 is 100. The minimum value is 1.
ScaleCpuLimit string
(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 is 10 characters. The minimum length is 0 characters. The value must match regular expression /^([0-9.]+)([eEinumkKMGTPB]*)$/.
ScaleDownDelay double
(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 is 600. The minimum value is 0.
ScaleMaxExecutionTime double
(Integer) Timeout in secs after which the function is terminated.

  • Constraints: The default value is 60. The maximum value is 120. The minimum value is 1.
ScaleMemoryLimit string
(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 is 10 characters. The minimum length is 0 characters. The value must match regular expression /^([0-9.]+)([eEinumkKMGTPB]*)$/.
Status string
(String) The current status of the function.

  • Constraints: Allowable values are: offline, deploying, ready, failed.
StatusDetails List<GetCodeEngineFunctionStatusDetail>
(List) The detailed status of the function. Nested schema for status_details:
CodeBinary bool
(Boolean) Specifies whether the code is binary or not. Defaults to false when code_reference is set to a data URL. When code_reference is set to a code bundle URL, this field is always true.
CodeMain string
(String) Specifies the name of the function that should be invoked.

  • Constraints: The default value is main. The maximum length is 63 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z_][a-zA-Z0-9_]*$/.
CodeReference 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 is 1 character. The value must match regular expression /^([a-z0-9][a-z0-9\\-_.]+[a-z0-9][\/])?([a-z0-9][a-z0-9\\-_]+[a-z0-9][\/])?[a-z0-9][a-z0-9\\-_.\/]+a-z0-9?(@sha256:[a-fA-F0-9]{64})?$|data:([-\\w]+\/[-+\\w.]+)?(;?\\w+=[-\\w]+)*;base64,.*/.
CodeSecret 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 is 1 character. The value must match regular expression /^a-z0-9?(\\.a-z0-9?)*$/.
ComputedEnvVariables []GetCodeEngineFunctionComputedEnvVariable
(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 is 0 items. Nested schema for computed_env_variables:
CreatedAt 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 is 0 characters. The value must match regular expression /(([^:\/?#]+):)?(\/\/([^\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$/.
EndpointInternal string
(String) URL to function that is only visible within the project.

  • Constraints: The maximum length is 2048 characters. The minimum length is 0 characters. The value must match regular expression /(([^:\/?#]+):)?(\/\/([^\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$/.
EntityTag 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 is 1 character. The value must match regular expression /^[\\*\\-a-z0-9]+$/.
FunctionId string
(String) The identifier of the resource.

  • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$/.
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 is 0 characters. The value must match regular expression /(([^:\/?#]+):)?(\/\/([^\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$/.
Id string
The unique identifier of the code_engine_function.
ManagedDomainMappings string
(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.
Name string
(String) The name of the environment variable.

  • Constraints: The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /^[\\-._a-zA-Z0-9]+$/.
ProjectId 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'.
ResourceType string
(String) The type of the function.

  • Constraints: Allowable values are: function_v2.
RunEnvVariables []GetCodeEngineFunctionRunEnvVariable
(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 is 0 items. Nested schema for run_env_variables:
Runtime string
(String) The managed runtime used to execute the injected code.

  • Constraints: The maximum length is 63 characters. The minimum length is 1 character. The value must match regular expression /^[a-z]*\\-[0-9]*(\\.[0-9]*)?$/.
ScaleConcurrency 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 is 100. The minimum value is 1.
ScaleCpuLimit string
(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 is 10 characters. The minimum length is 0 characters. The value must match regular expression /^([0-9.]+)([eEinumkKMGTPB]*)$/.
ScaleDownDelay float64
(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 is 600. The minimum value is 0.
ScaleMaxExecutionTime float64
(Integer) Timeout in secs after which the function is terminated.

  • Constraints: The default value is 60. The maximum value is 120. The minimum value is 1.
ScaleMemoryLimit string
(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 is 10 characters. The minimum length is 0 characters. The value must match regular expression /^([0-9.]+)([eEinumkKMGTPB]*)$/.
Status string
(String) The current status of the function.

  • Constraints: Allowable values are: offline, deploying, ready, failed.
StatusDetails []GetCodeEngineFunctionStatusDetail
(List) The detailed status of the function. Nested schema for status_details:
codeBinary Boolean
(Boolean) Specifies whether the code is binary or not. Defaults to false when code_reference is set to a data URL. When code_reference is set to a code bundle URL, this field is always true.
codeMain String
(String) Specifies the name of the function that should be invoked.

  • Constraints: The default value is main. The maximum length is 63 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z_][a-zA-Z0-9_]*$/.
codeReference 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 is 1 character. The value must match regular expression /^([a-z0-9][a-z0-9\\-_.]+[a-z0-9][\/])?([a-z0-9][a-z0-9\\-_]+[a-z0-9][\/])?[a-z0-9][a-z0-9\\-_.\/]+a-z0-9?(@sha256:[a-fA-F0-9]{64})?$|data:([-\\w]+\/[-+\\w.]+)?(;?\\w+=[-\\w]+)*;base64,.*/.
codeSecret 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 is 1 character. The value must match regular expression /^a-z0-9?(\\.a-z0-9?)*$/.
computedEnvVariables List<GetCodeEngineFunctionComputedEnvVariable>
(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 is 0 items. Nested schema for computed_env_variables:
createdAt 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 is 0 characters. The value must match regular expression /(([^:\/?#]+):)?(\/\/([^\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$/.
endpointInternal String
(String) URL to function that is only visible within the project.

  • Constraints: The maximum length is 2048 characters. The minimum length is 0 characters. The value must match regular expression /(([^:\/?#]+):)?(\/\/([^\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$/.
entityTag 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 is 1 character. The value must match regular expression /^[\\*\\-a-z0-9]+$/.
functionId String
(String) The identifier of the resource.

  • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$/.
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 is 0 characters. The value must match regular expression /(([^:\/?#]+):)?(\/\/([^\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$/.
id String
The unique identifier of the code_engine_function.
managedDomainMappings String
(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.
name String
(String) The name of the environment variable.

  • Constraints: The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /^[\\-._a-zA-Z0-9]+$/.
projectId 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'.
resourceType String
(String) The type of the function.

  • Constraints: Allowable values are: function_v2.
runEnvVariables List<GetCodeEngineFunctionRunEnvVariable>
(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 is 0 items. Nested schema for run_env_variables:
runtime String
(String) The managed runtime used to execute the injected code.

  • Constraints: The maximum length is 63 characters. The minimum length is 1 character. The value must match regular expression /^[a-z]*\\-[0-9]*(\\.[0-9]*)?$/.
scaleConcurrency 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 is 100. The minimum value is 1.
scaleCpuLimit String
(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 is 10 characters. The minimum length is 0 characters. The value must match regular expression /^([0-9.]+)([eEinumkKMGTPB]*)$/.
scaleDownDelay Double
(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 is 600. The minimum value is 0.
scaleMaxExecutionTime Double
(Integer) Timeout in secs after which the function is terminated.

  • Constraints: The default value is 60. The maximum value is 120. The minimum value is 1.
scaleMemoryLimit String
(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 is 10 characters. The minimum length is 0 characters. The value must match regular expression /^([0-9.]+)([eEinumkKMGTPB]*)$/.
status String
(String) The current status of the function.

  • Constraints: Allowable values are: offline, deploying, ready, failed.
statusDetails List<GetCodeEngineFunctionStatusDetail>
(List) The detailed status of the function. Nested schema for status_details:
codeBinary boolean
(Boolean) Specifies whether the code is binary or not. Defaults to false when code_reference is set to a data URL. When code_reference is set to a code bundle URL, this field is always true.
codeMain string
(String) Specifies the name of the function that should be invoked.

  • Constraints: The default value is main. The maximum length is 63 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z_][a-zA-Z0-9_]*$/.
codeReference 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 is 1 character. The value must match regular expression /^([a-z0-9][a-z0-9\\-_.]+[a-z0-9][\/])?([a-z0-9][a-z0-9\\-_]+[a-z0-9][\/])?[a-z0-9][a-z0-9\\-_.\/]+a-z0-9?(@sha256:[a-fA-F0-9]{64})?$|data:([-\\w]+\/[-+\\w.]+)?(;?\\w+=[-\\w]+)*;base64,.*/.
codeSecret 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 is 1 character. The value must match regular expression /^a-z0-9?(\\.a-z0-9?)*$/.
computedEnvVariables GetCodeEngineFunctionComputedEnvVariable[]
(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 is 0 items. Nested schema for computed_env_variables:
createdAt 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 is 0 characters. The value must match regular expression /(([^:\/?#]+):)?(\/\/([^\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$/.
endpointInternal string
(String) URL to function that is only visible within the project.

  • Constraints: The maximum length is 2048 characters. The minimum length is 0 characters. The value must match regular expression /(([^:\/?#]+):)?(\/\/([^\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$/.
entityTag 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 is 1 character. The value must match regular expression /^[\\*\\-a-z0-9]+$/.
functionId string
(String) The identifier of the resource.

  • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$/.
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 is 0 characters. The value must match regular expression /(([^:\/?#]+):)?(\/\/([^\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$/.
id string
The unique identifier of the code_engine_function.
managedDomainMappings string
(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.
name string
(String) The name of the environment variable.

  • Constraints: The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /^[\\-._a-zA-Z0-9]+$/.
projectId 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'.
resourceType string
(String) The type of the function.

  • Constraints: Allowable values are: function_v2.
runEnvVariables GetCodeEngineFunctionRunEnvVariable[]
(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 is 0 items. Nested schema for run_env_variables:
runtime string
(String) The managed runtime used to execute the injected code.

  • Constraints: The maximum length is 63 characters. The minimum length is 1 character. The value must match regular expression /^[a-z]*\\-[0-9]*(\\.[0-9]*)?$/.
scaleConcurrency 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 is 100. The minimum value is 1.
scaleCpuLimit string
(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 is 10 characters. The minimum length is 0 characters. The value must match regular expression /^([0-9.]+)([eEinumkKMGTPB]*)$/.
scaleDownDelay number
(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 is 600. The minimum value is 0.
scaleMaxExecutionTime number
(Integer) Timeout in secs after which the function is terminated.

  • Constraints: The default value is 60. The maximum value is 120. The minimum value is 1.
scaleMemoryLimit string
(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 is 10 characters. The minimum length is 0 characters. The value must match regular expression /^([0-9.]+)([eEinumkKMGTPB]*)$/.
status string
(String) The current status of the function.

  • Constraints: Allowable values are: offline, deploying, ready, failed.
statusDetails GetCodeEngineFunctionStatusDetail[]
(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. When code_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 is 63 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z_][a-zA-Z0-9_]*$/.
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 is 1 character. The value must match regular expression /^([a-z0-9][a-z0-9\\-_.]+[a-z0-9][\/])?([a-z0-9][a-z0-9\\-_]+[a-z0-9][\/])?[a-z0-9][a-z0-9\\-_.\/]+a-z0-9?(@sha256:[a-fA-F0-9]{64})?$|data:([-\\w]+\/[-+\\w.]+)?(;?\\w+=[-\\w]+)*;base64,.*/.
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 is 1 character. The value must match regular expression /^a-z0-9?(\\.a-z0-9?)*$/.
computed_env_variables Sequence[GetCodeEngineFunctionComputedEnvVariable]
(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 is 0 items. Nested schema for computed_env_variables:
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 is 0 characters. The value must match regular expression /(([^:\/?#]+):)?(\/\/([^\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$/.
endpoint_internal str
(String) URL to function that is only visible within the project.

  • Constraints: The maximum length is 2048 characters. The minimum length is 0 characters. The value must match regular expression /(([^:\/?#]+):)?(\/\/([^\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$/.
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 is 1 character. The value must match regular expression /^[\\*\\-a-z0-9]+$/.
function_id str
(String) The identifier of the resource.

  • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$/.
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 is 0 characters. The value must match regular expression /(([^:\/?#]+):)?(\/\/([^\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$/.
id str
The unique identifier of the code_engine_function.
managed_domain_mappings str
(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.
name str
(String) The name of the environment variable.

  • Constraints: The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /^[\\-._a-zA-Z0-9]+$/.
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.
run_env_variables Sequence[GetCodeEngineFunctionRunEnvVariable]
(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 is 0 items. Nested schema for run_env_variables:
runtime str
(String) The managed runtime used to execute the injected code.

  • Constraints: The maximum length is 63 characters. The minimum length is 1 character. The value must match regular expression /^[a-z]*\\-[0-9]*(\\.[0-9]*)?$/.
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 is 100. The minimum value is 1.
scale_cpu_limit str
(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 is 10 characters. The minimum length is 0 characters. The value must match regular expression /^([0-9.]+)([eEinumkKMGTPB]*)$/.
scale_down_delay float
(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 is 600. The minimum value is 0.
scale_max_execution_time float
(Integer) Timeout in secs after which the function is terminated.

  • Constraints: The default value is 60. The maximum value is 120. The minimum value is 1.
scale_memory_limit str
(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 is 10 characters. The minimum length is 0 characters. The value must match regular expression /^([0-9.]+)([eEinumkKMGTPB]*)$/.
status str
(String) The current status of the function.

  • Constraints: Allowable values are: offline, deploying, ready, failed.
status_details Sequence[GetCodeEngineFunctionStatusDetail]
(List) The detailed status of the function. Nested schema for status_details:
codeBinary Boolean
(Boolean) Specifies whether the code is binary or not. Defaults to false when code_reference is set to a data URL. When code_reference is set to a code bundle URL, this field is always true.
codeMain String
(String) Specifies the name of the function that should be invoked.

  • Constraints: The default value is main. The maximum length is 63 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z_][a-zA-Z0-9_]*$/.
codeReference 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 is 1 character. The value must match regular expression /^([a-z0-9][a-z0-9\\-_.]+[a-z0-9][\/])?([a-z0-9][a-z0-9\\-_]+[a-z0-9][\/])?[a-z0-9][a-z0-9\\-_.\/]+a-z0-9?(@sha256:[a-fA-F0-9]{64})?$|data:([-\\w]+\/[-+\\w.]+)?(;?\\w+=[-\\w]+)*;base64,.*/.
codeSecret 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 is 1 character. The value must match regular expression /^a-z0-9?(\\.a-z0-9?)*$/.
computedEnvVariables List<Property Map>
(List) References to config maps, secrets or literal values, which are defined and set by Code Engine and are exposed as environment variables in the function.

  • Constraints: The maximum length is 100 items. The minimum length is 0 items. Nested schema for computed_env_variables:
createdAt String
(String) The timestamp when the resource was created.
endpoint String
(String) URL to invoke the function.

  • Constraints: The maximum length is 2048 characters. The minimum length is 0 characters. The value must match regular expression /(([^:\/?#]+):)?(\/\/([^\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$/.
endpointInternal String
(String) URL to function that is only visible within the project.

  • Constraints: The maximum length is 2048 characters. The minimum length is 0 characters. The value must match regular expression /(([^:\/?#]+):)?(\/\/([^\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$/.
entityTag 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 is 1 character. The value must match regular expression /^[\\*\\-a-z0-9]+$/.
functionId String
(String) The identifier of the resource.

  • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$/.
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 is 0 characters. The value must match regular expression /(([^:\/?#]+):)?(\/\/([^\/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?$/.
id String
The unique identifier of the code_engine_function.
managedDomainMappings String
(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.
name String
(String) The name of the environment variable.

  • Constraints: The maximum length is 253 characters. The minimum length is 1 character. The value must match regular expression /^[\\-._a-zA-Z0-9]+$/.
projectId 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'.
resourceType String
(String) The type of the function.

  • Constraints: Allowable values are: function_v2.
runEnvVariables List<Property Map>
(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 is 0 items. Nested schema for run_env_variables:
runtime String
(String) The managed runtime used to execute the injected code.

  • Constraints: The maximum length is 63 characters. The minimum length is 1 character. The value must match regular expression /^[a-z]*\\-[0-9]*(\\.[0-9]*)?$/.
scaleConcurrency 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 is 100. The minimum value is 1.
scaleCpuLimit String
(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 is 10 characters. The minimum length is 0 characters. The value must match regular expression /^([0-9.]+)([eEinumkKMGTPB]*)$/.
scaleDownDelay Number
(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 is 600. The minimum value is 0.
scaleMaxExecutionTime Number
(Integer) Timeout in secs after which the function is terminated.

  • Constraints: The default value is 60. The maximum value is 120. The minimum value is 1.
scaleMemoryLimit String
(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 is 10 characters. The minimum length is 0 characters. The value must match regular expression /^([0-9.]+)([eEinumkKMGTPB]*)$/.
status String
(String) The current status of the function.

  • Constraints: Allowable values are: offline, deploying, ready, failed.
statusDetails List<Property Map>
(List) The detailed status of the function. Nested schema for status_details:

Supporting Types

GetCodeEngineFunctionComputedEnvVariable

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

GetCodeEngineFunctionRunEnvVariable

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

GetCodeEngineFunctionStatusDetail

Reason This property is required. 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.
Reason This property is required. 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.
reason This property is required. 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.
reason This property is required. 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.
reason This property is required. 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.
reason This property is required. 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.

Package Details

Repository
ibm ibm-cloud/terraform-provider-ibm
License
Notes
This Pulumi package is based on the ibm Terraform Provider.