Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. Bytepluscc Provider
  4. API Docs
  5. vefaas
  6. Sandbox
Viewing docs for bytepluscc v0.0.43
published on Monday, Jul 27, 2026 by Byteplus
Schema (JSON)
byteplus-sdk/pulumi-bytepluscc

bytepluscc.vefaas.Sandbox

bytepluscc logo
Viewing docs for bytepluscc v0.0.43
published on Monday, Jul 27, 2026 by Byteplus
Schema (JSON)
byteplus-sdk/pulumi-bytepluscc

    A sandbox instance is a secure and isolated container runtime environment that actually runs the sandbox image in the cloud sandbox

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as bytepluscc from "@byteplus/pulumi-bytepluscc";

const vefaasSandboxDemo = new bytepluscc.vefaas.Sandbox("VefaasSandboxDemo", {
    functionId: "n5hcs3y5****",
    timeout: 50,
    memoryMb: 2048,
    cpuMilli: 1000,
    requestTimeout: 30,
    maxConcurrency: 100,
    metadatas: [{
        key: "env",
        value: "test",
    }],
    instanceImageInfo: {
        image: "enterprise-public-cn-beijing.cr.volces.com/xxxxxx/all-in-one-sandbox:xxxxxx",
        command: "/opt/gem/run.sh",
        port: 8080,
        image_id: "3ewzg8x5h1***",
    },
    instanceTosMountConfig: {
        enable: true,
        tos_mount_points: [{
            bucketPath: "/mnt/tos",
            localMountPath: "/mnt/tos",
        }],
    },
    envs: [{
        key: "env",
        value: "test",
    }],
});

    import pulumi
import pulumi_bytepluscc as bytepluscc

vefaas_sandbox_demo = bytepluscc.vefaas.Sandbox("VefaasSandboxDemo",
    function_id="n5hcs3y5****",
    timeout=50,
    memory_mb=2048,
    cpu_milli=1000,
    request_timeout=30,
    max_concurrency=100,
    metadatas=[{
        "key": "env",
        "value": "test",
    }],
    instance_image_info={
        "image": "enterprise-public-cn-beijing.cr.volces.com/xxxxxx/all-in-one-sandbox:xxxxxx",
        "command": "/opt/gem/run.sh",
        "port": 8080,
        "image_id": "3ewzg8x5h1***",
    },
    instance_tos_mount_config={
        "enable": True,
        "tos_mount_points": [{
            "bucketPath": "/mnt/tos",
            "localMountPath": "/mnt/tos",
        }],
    },
    envs=[{
        "key": "env",
        "value": "test",
    }])

    package main

import (
	"github.com/byteplus-sdk/pulumi-bytepluscc/sdk/go/bytepluscc/vefaas"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := vefaas.NewSandbox(ctx, "VefaasSandboxDemo", &vefaas.SandboxArgs{
			FunctionId:     pulumi.String("n5hcs3y5****"),
			Timeout:        pulumi.Int(50),
			MemoryMb:       pulumi.Int(2048),
			CpuMilli:       pulumi.Int(1000),
			RequestTimeout: pulumi.Int(30),
			MaxConcurrency: pulumi.Int(100),
			Metadatas: vefaas.SandboxMetadataArray{
				&vefaas.SandboxMetadataArgs{
					Key:   pulumi.String("env"),
					Value: pulumi.String("test"),
				},
			},
			InstanceImageInfo: &vefaas.SandboxInstanceImageInfoArgs{
				Image:    pulumi.String("enterprise-public-cn-beijing.cr.volces.com/xxxxxx/all-in-one-sandbox:xxxxxx"),
				Command:  pulumi.String("/opt/gem/run.sh"),
				Port:     pulumi.Int(8080),
				Image_id: "3ewzg8x5h1***",
			},
			InstanceTosMountConfig: &vefaas.SandboxInstanceTosMountConfigArgs{
				Enable: pulumi.Bool(true),
				Tos_mount_points: []map[string]interface{}{
					map[string]interface{}{
						"bucketPath":     "/mnt/tos",
						"localMountPath": "/mnt/tos",
					},
				},
			},
			Envs: vefaas.SandboxEnvArray{
				&vefaas.SandboxEnvArgs{
					Key:   pulumi.String("env"),
					Value: pulumi.String("test"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Bytepluscc = Byteplus.Pulumi.Bytepluscc;

return await Deployment.RunAsync(() => 
{
    var vefaasSandboxDemo = new Bytepluscc.Vefaas.Sandbox("VefaasSandboxDemo", new()
    {
        FunctionId = "n5hcs3y5****",
        Timeout = 50,
        MemoryMb = 2048,
        CpuMilli = 1000,
        RequestTimeout = 30,
        MaxConcurrency = 100,
        Metadatas = new[]
        {
            new Bytepluscc.Vefaas.Inputs.SandboxMetadataArgs
            {
                Key = "env",
                Value = "test",
            },
        },
        InstanceImageInfo = new Bytepluscc.Vefaas.Inputs.SandboxInstanceImageInfoArgs
        {
            Image = "enterprise-public-cn-beijing.cr.volces.com/xxxxxx/all-in-one-sandbox:xxxxxx",
            Command = "/opt/gem/run.sh",
            Port = 8080,
            Image_id = "3ewzg8x5h1***",
        },
        InstanceTosMountConfig = new Bytepluscc.Vefaas.Inputs.SandboxInstanceTosMountConfigArgs
        {
            Enable = true,
            Tos_mount_points = new[]
            {
                
                {
                    { "bucketPath", "/mnt/tos" },
                    { "localMountPath", "/mnt/tos" },
                },
            },
        },
        Envs = new[]
        {
            new Bytepluscc.Vefaas.Inputs.SandboxEnvArgs
            {
                Key = "env",
                Value = "test",
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.byteplus.bytepluscc.vefaas.Sandbox;
import com.byteplus.bytepluscc.vefaas.SandboxArgs;
import com.pulumi.bytepluscc.vefaas.inputs.SandboxMetadataArgs;
import com.pulumi.bytepluscc.vefaas.inputs.SandboxInstanceImageInfoArgs;
import com.pulumi.bytepluscc.vefaas.inputs.SandboxInstanceTosMountConfigArgs;
import com.pulumi.bytepluscc.vefaas.inputs.SandboxEnvArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var vefaasSandboxDemo = new Sandbox("vefaasSandboxDemo", SandboxArgs.builder()
            .functionId("n5hcs3y5****")
            .timeout(50)
            .memoryMb(2048)
            .cpuMilli(1000)
            .requestTimeout(30)
            .maxConcurrency(100)
            .metadatas(SandboxMetadataArgs.builder()
                .key("env")
                .value("test")
                .build())
            .instanceImageInfo(SandboxInstanceImageInfoArgs.builder()
                .image("enterprise-public-cn-beijing.cr.volces.com/xxxxxx/all-in-one-sandbox:xxxxxx")
                .command("/opt/gem/run.sh")
                .port(8080)
                .image_id("3ewzg8x5h1***")
                .build())
            .instanceTosMountConfig(SandboxInstanceTosMountConfigArgs.builder()
                .enable(true)
                .tos_mount_points(Arrays.asList(Map.ofEntries(
                    Map.entry("bucketPath", "/mnt/tos"),
                    Map.entry("localMountPath", "/mnt/tos")
                )))
                .build())
            .envs(SandboxEnvArgs.builder()
                .key("env")
                .value("test")
                .build())
            .build());

    }
}

    resources:
  vefaasSandboxDemo:
    type: bytepluscc:vefaas:Sandbox
    name: VefaasSandboxDemo
    properties:
      functionId: n5hcs3y5****
      timeout: 50
      memoryMb: 2048
      cpuMilli: 1000
      requestTimeout: 30
      maxConcurrency: 100
      metadatas:
        - key: env
          value: test
      instanceImageInfo:
        image: enterprise-public-cn-beijing.cr.volces.com/xxxxxx/all-in-one-sandbox:xxxxxx
        command: /opt/gem/run.sh
        port: 8080
        image_id: 3ewzg8x5h1***
      instanceTosMountConfig:
        enable: true
        tos_mount_points:
          - bucketPath: /mnt/tos
            localMountPath: /mnt/tos
      envs:
        - key: env
          value: test

    pulumi {
  required_providers {
    bytepluscc = {
      source = "pulumi/bytepluscc"
    }
  }
}

resource "bytepluscc_vefaas_sandbox" "VefaasSandboxDemo" {
  function_id     = "n5hcs3y5****"
  timeout         = 50
  memory_mb       = 2048
  cpu_milli       = 1000
  request_timeout = 30
  max_concurrency = 100
  metadatas {
    key   = "env"
    value = "test"
  }
  instance_image_info = {
    image    = "enterprise-public-cn-beijing.cr.volces.com/xxxxxx/all-in-one-sandbox:xxxxxx"
    command  = "/opt/gem/run.sh"
    port     = 8080
    image_id = "3ewzg8x5h1***"
  }
  instance_tos_mount_config = {
    enable = true
    tos_mount_points = [{
      "bucketPath"     = "/mnt/tos"
      "localMountPath" = "/mnt/tos"
    }]
  }
  envs {
    key   = "env"
    value = "test"
  }
}

    Create Sandbox Resource

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

    Constructor syntax

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

@overload
def Sandbox(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            function_id: Optional[str] = None,
            cpu_milli: Optional[int] = None,
            envs: Optional[Sequence[SandboxEnvArgs]] = None,
            instance_image_info: Optional[SandboxInstanceImageInfoArgs] = None,
            instance_tos_mount_config: Optional[SandboxInstanceTosMountConfigArgs] = None,
            max_concurrency: Optional[int] = None,
            memory_mb: Optional[int] = None,
            metadatas: Optional[Sequence[SandboxMetadataArgs]] = None,
            request_timeout: Optional[int] = None,
            timeout: Optional[int] = None)
    func NewSandbox(ctx *Context, name string, args SandboxArgs, opts ...ResourceOption) (*Sandbox, error)
    public Sandbox(string name, SandboxArgs args, CustomResourceOptions? opts = null)
    public Sandbox(String name, SandboxArgs args)
public Sandbox(String name, SandboxArgs args, CustomResourceOptions options)

    type: bytepluscc:vefaas:Sandbox
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "bytepluscc_vefaas_sandbox" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args SandboxArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args SandboxArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args SandboxArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SandboxArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SandboxArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var sandboxResource = new Bytepluscc.Vefaas.Sandbox("sandboxResource", new()
{
    FunctionId = "string",
    CpuMilli = 0,
    Envs = new[]
    {
        new Bytepluscc.Vefaas.Inputs.SandboxEnvArgs
        {
            Key = "string",
            Value = "string",
        },
    },
    InstanceImageInfo = new Bytepluscc.Vefaas.Inputs.SandboxInstanceImageInfoArgs
    {
        Command = "string",
        Image = "string",
        ImageId = "string",
        Port = 0,
    },
    InstanceTosMountConfig = new Bytepluscc.Vefaas.Inputs.SandboxInstanceTosMountConfigArgs
    {
        Enable = false,
        TosMountPoints = new[]
        {
            new Bytepluscc.Vefaas.Inputs.SandboxInstanceTosMountConfigTosMountPointArgs
            {
                BucketPath = "string",
                LocalMountPath = "string",
            },
        },
    },
    MaxConcurrency = 0,
    MemoryMb = 0,
    Metadatas = new[]
    {
        new Bytepluscc.Vefaas.Inputs.SandboxMetadataArgs
        {
            Key = "string",
            Value = "string",
        },
    },
    RequestTimeout = 0,
    Timeout = 0,
});

    example, err := vefaas.NewSandbox(ctx, "sandboxResource", &vefaas.SandboxArgs{
	FunctionId: pulumi.String("string"),
	CpuMilli:   pulumi.Int(0),
	Envs: vefaas.SandboxEnvArray{
		&vefaas.SandboxEnvArgs{
			Key:   pulumi.String("string"),
			Value: pulumi.String("string"),
		},
	},
	InstanceImageInfo: &vefaas.SandboxInstanceImageInfoArgs{
		Command: pulumi.String("string"),
		Image:   pulumi.String("string"),
		ImageId: pulumi.String("string"),
		Port:    pulumi.Int(0),
	},
	InstanceTosMountConfig: &vefaas.SandboxInstanceTosMountConfigArgs{
		Enable: pulumi.Bool(false),
		TosMountPoints: vefaas.SandboxInstanceTosMountConfigTosMountPointArray{
			&vefaas.SandboxInstanceTosMountConfigTosMountPointArgs{
				BucketPath:     pulumi.String("string"),
				LocalMountPath: pulumi.String("string"),
			},
		},
	},
	MaxConcurrency: pulumi.Int(0),
	MemoryMb:       pulumi.Int(0),
	Metadatas: vefaas.SandboxMetadataArray{
		&vefaas.SandboxMetadataArgs{
			Key:   pulumi.String("string"),
			Value: pulumi.String("string"),
		},
	},
	RequestTimeout: pulumi.Int(0),
	Timeout:        pulumi.Int(0),
})

    resource "bytepluscc_vefaas_sandbox" "sandboxResource" {
  lifecycle {
    create_before_destroy = true
  }
  function_id = "string"
  cpu_milli   = 0
  envs {
    key   = "string"
    value = "string"
  }
  instance_image_info = {
    command  = "string"
    image    = "string"
    image_id = "string"
    port     = 0
  }
  instance_tos_mount_config = {
    enable = false
    tos_mount_points = [{
      bucket_path      = "string"
      local_mount_path = "string"
    }]
  }
  max_concurrency = 0
  memory_mb       = 0
  metadatas {
    key   = "string"
    value = "string"
  }
  request_timeout = 0
  timeout         = 0
}

    var sandboxResource = new Sandbox("sandboxResource", SandboxArgs.builder()
    .functionId("string")
    .cpuMilli(0)
    .envs(SandboxEnvArgs.builder()
        .key("string")
        .value("string")
        .build())
    .instanceImageInfo(SandboxInstanceImageInfoArgs.builder()
        .command("string")
        .image("string")
        .imageId("string")
        .port(0)
        .build())
    .instanceTosMountConfig(SandboxInstanceTosMountConfigArgs.builder()
        .enable(false)
        .tosMountPoints(SandboxInstanceTosMountConfigTosMountPointArgs.builder()
            .bucketPath("string")
            .localMountPath("string")
            .build())
        .build())
    .maxConcurrency(0)
    .memoryMb(0)
    .metadatas(SandboxMetadataArgs.builder()
        .key("string")
        .value("string")
        .build())
    .requestTimeout(0)
    .timeout(0)
    .build());

    sandbox_resource = bytepluscc.vefaas.Sandbox("sandboxResource",
    function_id="string",
    cpu_milli=0,
    envs=[{
        "key": "string",
        "value": "string",
    }],
    instance_image_info={
        "command": "string",
        "image": "string",
        "image_id": "string",
        "port": 0,
    },
    instance_tos_mount_config={
        "enable": False,
        "tos_mount_points": [{
            "bucket_path": "string",
            "local_mount_path": "string",
        }],
    },
    max_concurrency=0,
    memory_mb=0,
    metadatas=[{
        "key": "string",
        "value": "string",
    }],
    request_timeout=0,
    timeout=0)

    const sandboxResource = new bytepluscc.vefaas.Sandbox("sandboxResource", {
    functionId: "string",
    cpuMilli: 0,
    envs: [{
        key: "string",
        value: "string",
    }],
    instanceImageInfo: {
        command: "string",
        image: "string",
        imageId: "string",
        port: 0,
    },
    instanceTosMountConfig: {
        enable: false,
        tosMountPoints: [{
            bucketPath: "string",
            localMountPath: "string",
        }],
    },
    maxConcurrency: 0,
    memoryMb: 0,
    metadatas: [{
        key: "string",
        value: "string",
    }],
    requestTimeout: 0,
    timeout: 0,
});

    type: bytepluscc:vefaas:Sandbox
properties:
    cpuMilli: 0
    envs:
        - key: string
          value: string
    functionId: string
    instanceImageInfo:
        command: string
        image: string
        imageId: string
        port: 0
    instanceTosMountConfig:
        enable: false
        tosMountPoints:
            - bucketPath: string
              localMountPath: string
    maxConcurrency: 0
    memoryMb: 0
    metadatas:
        - key: string
          value: string
    requestTimeout: 0
    timeout: 0

    Sandbox Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Sandbox resource accepts the following input properties:

    FunctionId string
    Sandbox application ID to which the sandbox instance belongs
    CpuMilli int
    Sandbox instance CPU specification: Unit: milli CPU, range: 250~16000, default: 1000
    Envs List<Byteplus.SandboxEnv>
    Sandbox instance environment variables Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    InstanceImageInfo Byteplus.SandboxInstanceImageInfo
    Sandbox instance image information, including image address, startup command, and listening port.
    InstanceTosMountConfig Byteplus.SandboxInstanceTosMountConfig
    Instance-level object storage (TOS) mount configuration for the sandbox instance
    MaxConcurrency int
    Maximum concurrent requests per instance: range: 10~1000, default: 100
    MemoryMb int
    Sandbox instance memory specification: Unit: MiB, range: 512~131072, default: 2048
    Metadatas List<Byteplus.SandboxMetadata>
    Sandbox instance label metadata used to tag and filter instances. Format: <"key":"value"> Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    RequestTimeout int
    Request timeout: Unit: seconds, range: 1~900, positive integer. Default: 30
    Timeout int
    Sandbox instance lifespan: Unit: minutes, range: 3~1440, default: 60
    FunctionId string
    Sandbox application ID to which the sandbox instance belongs
    CpuMilli int
    Sandbox instance CPU specification: Unit: milli CPU, range: 250~16000, default: 1000
    Envs []SandboxEnvArgs
    Sandbox instance environment variables Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    InstanceImageInfo SandboxInstanceImageInfoArgs
    Sandbox instance image information, including image address, startup command, and listening port.
    InstanceTosMountConfig SandboxInstanceTosMountConfigArgs
    Instance-level object storage (TOS) mount configuration for the sandbox instance
    MaxConcurrency int
    Maximum concurrent requests per instance: range: 10~1000, default: 100
    MemoryMb int
    Sandbox instance memory specification: Unit: MiB, range: 512~131072, default: 2048
    Metadatas []SandboxMetadataArgs
    Sandbox instance label metadata used to tag and filter instances. Format: <"key":"value"> Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    RequestTimeout int
    Request timeout: Unit: seconds, range: 1~900, positive integer. Default: 30
    Timeout int
    Sandbox instance lifespan: Unit: minutes, range: 3~1440, default: 60
    function_id string
    Sandbox application ID to which the sandbox instance belongs
    cpu_milli number
    Sandbox instance CPU specification: Unit: milli CPU, range: 250~16000, default: 1000
    envs list(object)
    Sandbox instance environment variables Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    instance_image_info object
    Sandbox instance image information, including image address, startup command, and listening port.
    instance_tos_mount_config object
    Instance-level object storage (TOS) mount configuration for the sandbox instance
    max_concurrency number
    Maximum concurrent requests per instance: range: 10~1000, default: 100
    memory_mb number
    Sandbox instance memory specification: Unit: MiB, range: 512~131072, default: 2048
    metadatas list(object)
    Sandbox instance label metadata used to tag and filter instances. Format: <"key":"value"> Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    request_timeout number
    Request timeout: Unit: seconds, range: 1~900, positive integer. Default: 30
    timeout number
    Sandbox instance lifespan: Unit: minutes, range: 3~1440, default: 60
    functionId String
    Sandbox application ID to which the sandbox instance belongs
    cpuMilli Integer
    Sandbox instance CPU specification: Unit: milli CPU, range: 250~16000, default: 1000
    envs List<SandboxEnv>
    Sandbox instance environment variables Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    instanceImageInfo SandboxInstanceImageInfo
    Sandbox instance image information, including image address, startup command, and listening port.
    instanceTosMountConfig SandboxInstanceTosMountConfig
    Instance-level object storage (TOS) mount configuration for the sandbox instance
    maxConcurrency Integer
    Maximum concurrent requests per instance: range: 10~1000, default: 100
    memoryMb Integer
    Sandbox instance memory specification: Unit: MiB, range: 512~131072, default: 2048
    metadatas List<SandboxMetadata>
    Sandbox instance label metadata used to tag and filter instances. Format: <"key":"value"> Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    requestTimeout Integer
    Request timeout: Unit: seconds, range: 1~900, positive integer. Default: 30
    timeout Integer
    Sandbox instance lifespan: Unit: minutes, range: 3~1440, default: 60
    functionId string
    Sandbox application ID to which the sandbox instance belongs
    cpuMilli number
    Sandbox instance CPU specification: Unit: milli CPU, range: 250~16000, default: 1000
    envs SandboxEnv[]
    Sandbox instance environment variables Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    instanceImageInfo SandboxInstanceImageInfo
    Sandbox instance image information, including image address, startup command, and listening port.
    instanceTosMountConfig SandboxInstanceTosMountConfig
    Instance-level object storage (TOS) mount configuration for the sandbox instance
    maxConcurrency number
    Maximum concurrent requests per instance: range: 10~1000, default: 100
    memoryMb number
    Sandbox instance memory specification: Unit: MiB, range: 512~131072, default: 2048
    metadatas SandboxMetadata[]
    Sandbox instance label metadata used to tag and filter instances. Format: <"key":"value"> Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    requestTimeout number
    Request timeout: Unit: seconds, range: 1~900, positive integer. Default: 30
    timeout number
    Sandbox instance lifespan: Unit: minutes, range: 3~1440, default: 60
    function_id str
    Sandbox application ID to which the sandbox instance belongs
    cpu_milli int
    Sandbox instance CPU specification: Unit: milli CPU, range: 250~16000, default: 1000
    envs Sequence[SandboxEnvArgs]
    Sandbox instance environment variables Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    instance_image_info SandboxInstanceImageInfoArgs
    Sandbox instance image information, including image address, startup command, and listening port.
    instance_tos_mount_config SandboxInstanceTosMountConfigArgs
    Instance-level object storage (TOS) mount configuration for the sandbox instance
    max_concurrency int
    Maximum concurrent requests per instance: range: 10~1000, default: 100
    memory_mb int
    Sandbox instance memory specification: Unit: MiB, range: 512~131072, default: 2048
    metadatas Sequence[SandboxMetadataArgs]
    Sandbox instance label metadata used to tag and filter instances. Format: <"key":"value"> Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    request_timeout int
    Request timeout: Unit: seconds, range: 1~900, positive integer. Default: 30
    timeout int
    Sandbox instance lifespan: Unit: minutes, range: 3~1440, default: 60
    functionId String
    Sandbox application ID to which the sandbox instance belongs
    cpuMilli Number
    Sandbox instance CPU specification: Unit: milli CPU, range: 250~16000, default: 1000
    envs List<Property Map>
    Sandbox instance environment variables Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    instanceImageInfo Property Map
    Sandbox instance image information, including image address, startup command, and listening port.
    instanceTosMountConfig Property Map
    Instance-level object storage (TOS) mount configuration for the sandbox instance
    maxConcurrency Number
    Maximum concurrent requests per instance: range: 10~1000, default: 100
    memoryMb Number
    Sandbox instance memory specification: Unit: MiB, range: 512~131072, default: 2048
    metadatas List<Property Map>
    Sandbox instance label metadata used to tag and filter instances. Format: <"key":"value"> Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    requestTimeout Number
    Request timeout: Unit: seconds, range: 1~900, positive integer. Default: 30
    timeout Number
    Sandbox instance lifespan: Unit: minutes, range: 3~1440, default: 60

    Outputs

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

    AvailabilityZone string
    Availability zone ID of the sandbox instance
    CreatedTime string
    Sandbox instance creation time.
    ErrorCode string
    Sandbox instance startup failure error code. Parameter description: internalloadrequesterror: internal system error, functioninitializefailed: business process initialization error, functionhealthcheckfailed: health check error, route_terminating: route deletion in progress. This field is empty when the sandbox instance starts normally
    ErrorMessage string
    Details of the error code when the sandbox instance fails to start. This field is empty when the sandbox instance starts normally.
    ExpireAt string
    Sandbox instance uptime.
    Id string
    The provider-assigned unique ID for this managed resource.
    InstanceType string
    Sandbox instance type. Parameter description: elastic: elastic instance, frozen: frozen instance, activated: activated instance, reserved: reserved instance
    Pending bool
    Whether the sandbox instance is in Pending status. Parameter description: true: yes, false: no
    RevisionNumber int
    Function instance version number
    SandboxId string
    Sandbox instance ID
    Status string
    Sandbox instance status. Parameter description: Starting: starting, Ready: startup completed, Failed: startup failed, Terminating: terminating
    AvailabilityZone string
    Availability zone ID of the sandbox instance
    CreatedTime string
    Sandbox instance creation time.
    ErrorCode string
    Sandbox instance startup failure error code. Parameter description: internalloadrequesterror: internal system error, functioninitializefailed: business process initialization error, functionhealthcheckfailed: health check error, route_terminating: route deletion in progress. This field is empty when the sandbox instance starts normally
    ErrorMessage string
    Details of the error code when the sandbox instance fails to start. This field is empty when the sandbox instance starts normally.
    ExpireAt string
    Sandbox instance uptime.
    Id string
    The provider-assigned unique ID for this managed resource.
    InstanceType string
    Sandbox instance type. Parameter description: elastic: elastic instance, frozen: frozen instance, activated: activated instance, reserved: reserved instance
    Pending bool
    Whether the sandbox instance is in Pending status. Parameter description: true: yes, false: no
    RevisionNumber int
    Function instance version number
    SandboxId string
    Sandbox instance ID
    Status string
    Sandbox instance status. Parameter description: Starting: starting, Ready: startup completed, Failed: startup failed, Terminating: terminating
    availability_zone string
    Availability zone ID of the sandbox instance
    created_time string
    Sandbox instance creation time.
    error_code string
    Sandbox instance startup failure error code. Parameter description: internalloadrequesterror: internal system error, functioninitializefailed: business process initialization error, functionhealthcheckfailed: health check error, route_terminating: route deletion in progress. This field is empty when the sandbox instance starts normally
    error_message string
    Details of the error code when the sandbox instance fails to start. This field is empty when the sandbox instance starts normally.
    expire_at string
    Sandbox instance uptime.
    id string
    The provider-assigned unique ID for this managed resource.
    instance_type string
    Sandbox instance type. Parameter description: elastic: elastic instance, frozen: frozen instance, activated: activated instance, reserved: reserved instance
    pending bool
    Whether the sandbox instance is in Pending status. Parameter description: true: yes, false: no
    revision_number number
    Function instance version number
    sandbox_id string
    Sandbox instance ID
    status string
    Sandbox instance status. Parameter description: Starting: starting, Ready: startup completed, Failed: startup failed, Terminating: terminating
    availabilityZone String
    Availability zone ID of the sandbox instance
    createdTime String
    Sandbox instance creation time.
    errorCode String
    Sandbox instance startup failure error code. Parameter description: internalloadrequesterror: internal system error, functioninitializefailed: business process initialization error, functionhealthcheckfailed: health check error, route_terminating: route deletion in progress. This field is empty when the sandbox instance starts normally
    errorMessage String
    Details of the error code when the sandbox instance fails to start. This field is empty when the sandbox instance starts normally.
    expireAt String
    Sandbox instance uptime.
    id String
    The provider-assigned unique ID for this managed resource.
    instanceType String
    Sandbox instance type. Parameter description: elastic: elastic instance, frozen: frozen instance, activated: activated instance, reserved: reserved instance
    pending Boolean
    Whether the sandbox instance is in Pending status. Parameter description: true: yes, false: no
    revisionNumber Integer
    Function instance version number
    sandboxId String
    Sandbox instance ID
    status String
    Sandbox instance status. Parameter description: Starting: starting, Ready: startup completed, Failed: startup failed, Terminating: terminating
    availabilityZone string
    Availability zone ID of the sandbox instance
    createdTime string
    Sandbox instance creation time.
    errorCode string
    Sandbox instance startup failure error code. Parameter description: internalloadrequesterror: internal system error, functioninitializefailed: business process initialization error, functionhealthcheckfailed: health check error, route_terminating: route deletion in progress. This field is empty when the sandbox instance starts normally
    errorMessage string
    Details of the error code when the sandbox instance fails to start. This field is empty when the sandbox instance starts normally.
    expireAt string
    Sandbox instance uptime.
    id string
    The provider-assigned unique ID for this managed resource.
    instanceType string
    Sandbox instance type. Parameter description: elastic: elastic instance, frozen: frozen instance, activated: activated instance, reserved: reserved instance
    pending boolean
    Whether the sandbox instance is in Pending status. Parameter description: true: yes, false: no
    revisionNumber number
    Function instance version number
    sandboxId string
    Sandbox instance ID
    status string
    Sandbox instance status. Parameter description: Starting: starting, Ready: startup completed, Failed: startup failed, Terminating: terminating
    availability_zone str
    Availability zone ID of the sandbox instance
    created_time str
    Sandbox instance creation time.
    error_code str
    Sandbox instance startup failure error code. Parameter description: internalloadrequesterror: internal system error, functioninitializefailed: business process initialization error, functionhealthcheckfailed: health check error, route_terminating: route deletion in progress. This field is empty when the sandbox instance starts normally
    error_message str
    Details of the error code when the sandbox instance fails to start. This field is empty when the sandbox instance starts normally.
    expire_at str
    Sandbox instance uptime.
    id str
    The provider-assigned unique ID for this managed resource.
    instance_type str
    Sandbox instance type. Parameter description: elastic: elastic instance, frozen: frozen instance, activated: activated instance, reserved: reserved instance
    pending bool
    Whether the sandbox instance is in Pending status. Parameter description: true: yes, false: no
    revision_number int
    Function instance version number
    sandbox_id str
    Sandbox instance ID
    status str
    Sandbox instance status. Parameter description: Starting: starting, Ready: startup completed, Failed: startup failed, Terminating: terminating
    availabilityZone String
    Availability zone ID of the sandbox instance
    createdTime String
    Sandbox instance creation time.
    errorCode String
    Sandbox instance startup failure error code. Parameter description: internalloadrequesterror: internal system error, functioninitializefailed: business process initialization error, functionhealthcheckfailed: health check error, route_terminating: route deletion in progress. This field is empty when the sandbox instance starts normally
    errorMessage String
    Details of the error code when the sandbox instance fails to start. This field is empty when the sandbox instance starts normally.
    expireAt String
    Sandbox instance uptime.
    id String
    The provider-assigned unique ID for this managed resource.
    instanceType String
    Sandbox instance type. Parameter description: elastic: elastic instance, frozen: frozen instance, activated: activated instance, reserved: reserved instance
    pending Boolean
    Whether the sandbox instance is in Pending status. Parameter description: true: yes, false: no
    revisionNumber Number
    Function instance version number
    sandboxId String
    Sandbox instance ID
    status String
    Sandbox instance status. Parameter description: Starting: starting, Ready: startup completed, Failed: startup failed, Terminating: terminating

    Look up Existing Sandbox Resource

    Get an existing Sandbox resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: SandboxState, opts?: CustomResourceOptions): Sandbox
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        availability_zone: Optional[str] = None,
        cpu_milli: Optional[int] = None,
        created_time: Optional[str] = None,
        envs: Optional[Sequence[SandboxEnvArgs]] = None,
        error_code: Optional[str] = None,
        error_message: Optional[str] = None,
        expire_at: Optional[str] = None,
        function_id: Optional[str] = None,
        instance_image_info: Optional[SandboxInstanceImageInfoArgs] = None,
        instance_tos_mount_config: Optional[SandboxInstanceTosMountConfigArgs] = None,
        instance_type: Optional[str] = None,
        max_concurrency: Optional[int] = None,
        memory_mb: Optional[int] = None,
        metadatas: Optional[Sequence[SandboxMetadataArgs]] = None,
        pending: Optional[bool] = None,
        request_timeout: Optional[int] = None,
        revision_number: Optional[int] = None,
        sandbox_id: Optional[str] = None,
        status: Optional[str] = None,
        timeout: Optional[int] = None) -> Sandbox
    func GetSandbox(ctx *Context, name string, id IDInput, state *SandboxState, opts ...ResourceOption) (*Sandbox, error)
    public static Sandbox Get(string name, Input<string> id, SandboxState? state, CustomResourceOptions? opts = null)
    public static Sandbox get(String name, Output<String> id, SandboxState state, CustomResourceOptions options)
    resources:  _:    type: bytepluscc:vefaas:Sandbox    get:      id: ${id}
    import {
  to = bytepluscc_vefaas_sandbox.example
  id = "${id}"
}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AvailabilityZone string
    Availability zone ID of the sandbox instance
    CpuMilli int
    Sandbox instance CPU specification: Unit: milli CPU, range: 250~16000, default: 1000
    CreatedTime string
    Sandbox instance creation time.
    Envs List<Byteplus.SandboxEnv>
    Sandbox instance environment variables Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    ErrorCode string
    Sandbox instance startup failure error code. Parameter description: internalloadrequesterror: internal system error, functioninitializefailed: business process initialization error, functionhealthcheckfailed: health check error, route_terminating: route deletion in progress. This field is empty when the sandbox instance starts normally
    ErrorMessage string
    Details of the error code when the sandbox instance fails to start. This field is empty when the sandbox instance starts normally.
    ExpireAt string
    Sandbox instance uptime.
    FunctionId string
    Sandbox application ID to which the sandbox instance belongs
    InstanceImageInfo Byteplus.SandboxInstanceImageInfo
    Sandbox instance image information, including image address, startup command, and listening port.
    InstanceTosMountConfig Byteplus.SandboxInstanceTosMountConfig
    Instance-level object storage (TOS) mount configuration for the sandbox instance
    InstanceType string
    Sandbox instance type. Parameter description: elastic: elastic instance, frozen: frozen instance, activated: activated instance, reserved: reserved instance
    MaxConcurrency int
    Maximum concurrent requests per instance: range: 10~1000, default: 100
    MemoryMb int
    Sandbox instance memory specification: Unit: MiB, range: 512~131072, default: 2048
    Metadatas List<Byteplus.SandboxMetadata>
    Sandbox instance label metadata used to tag and filter instances. Format: <"key":"value"> Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    Pending bool
    Whether the sandbox instance is in Pending status. Parameter description: true: yes, false: no
    RequestTimeout int
    Request timeout: Unit: seconds, range: 1~900, positive integer. Default: 30
    RevisionNumber int
    Function instance version number
    SandboxId string
    Sandbox instance ID
    Status string
    Sandbox instance status. Parameter description: Starting: starting, Ready: startup completed, Failed: startup failed, Terminating: terminating
    Timeout int
    Sandbox instance lifespan: Unit: minutes, range: 3~1440, default: 60
    AvailabilityZone string
    Availability zone ID of the sandbox instance
    CpuMilli int
    Sandbox instance CPU specification: Unit: milli CPU, range: 250~16000, default: 1000
    CreatedTime string
    Sandbox instance creation time.
    Envs []SandboxEnvArgs
    Sandbox instance environment variables Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    ErrorCode string
    Sandbox instance startup failure error code. Parameter description: internalloadrequesterror: internal system error, functioninitializefailed: business process initialization error, functionhealthcheckfailed: health check error, route_terminating: route deletion in progress. This field is empty when the sandbox instance starts normally
    ErrorMessage string
    Details of the error code when the sandbox instance fails to start. This field is empty when the sandbox instance starts normally.
    ExpireAt string
    Sandbox instance uptime.
    FunctionId string
    Sandbox application ID to which the sandbox instance belongs
    InstanceImageInfo SandboxInstanceImageInfoArgs
    Sandbox instance image information, including image address, startup command, and listening port.
    InstanceTosMountConfig SandboxInstanceTosMountConfigArgs
    Instance-level object storage (TOS) mount configuration for the sandbox instance
    InstanceType string
    Sandbox instance type. Parameter description: elastic: elastic instance, frozen: frozen instance, activated: activated instance, reserved: reserved instance
    MaxConcurrency int
    Maximum concurrent requests per instance: range: 10~1000, default: 100
    MemoryMb int
    Sandbox instance memory specification: Unit: MiB, range: 512~131072, default: 2048
    Metadatas []SandboxMetadataArgs
    Sandbox instance label metadata used to tag and filter instances. Format: <"key":"value"> Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    Pending bool
    Whether the sandbox instance is in Pending status. Parameter description: true: yes, false: no
    RequestTimeout int
    Request timeout: Unit: seconds, range: 1~900, positive integer. Default: 30
    RevisionNumber int
    Function instance version number
    SandboxId string
    Sandbox instance ID
    Status string
    Sandbox instance status. Parameter description: Starting: starting, Ready: startup completed, Failed: startup failed, Terminating: terminating
    Timeout int
    Sandbox instance lifespan: Unit: minutes, range: 3~1440, default: 60
    availability_zone string
    Availability zone ID of the sandbox instance
    cpu_milli number
    Sandbox instance CPU specification: Unit: milli CPU, range: 250~16000, default: 1000
    created_time string
    Sandbox instance creation time.
    envs list(object)
    Sandbox instance environment variables Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    error_code string
    Sandbox instance startup failure error code. Parameter description: internalloadrequesterror: internal system error, functioninitializefailed: business process initialization error, functionhealthcheckfailed: health check error, route_terminating: route deletion in progress. This field is empty when the sandbox instance starts normally
    error_message string
    Details of the error code when the sandbox instance fails to start. This field is empty when the sandbox instance starts normally.
    expire_at string
    Sandbox instance uptime.
    function_id string
    Sandbox application ID to which the sandbox instance belongs
    instance_image_info object
    Sandbox instance image information, including image address, startup command, and listening port.
    instance_tos_mount_config object
    Instance-level object storage (TOS) mount configuration for the sandbox instance
    instance_type string
    Sandbox instance type. Parameter description: elastic: elastic instance, frozen: frozen instance, activated: activated instance, reserved: reserved instance
    max_concurrency number
    Maximum concurrent requests per instance: range: 10~1000, default: 100
    memory_mb number
    Sandbox instance memory specification: Unit: MiB, range: 512~131072, default: 2048
    metadatas list(object)
    Sandbox instance label metadata used to tag and filter instances. Format: <"key":"value"> Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    pending bool
    Whether the sandbox instance is in Pending status. Parameter description: true: yes, false: no
    request_timeout number
    Request timeout: Unit: seconds, range: 1~900, positive integer. Default: 30
    revision_number number
    Function instance version number
    sandbox_id string
    Sandbox instance ID
    status string
    Sandbox instance status. Parameter description: Starting: starting, Ready: startup completed, Failed: startup failed, Terminating: terminating
    timeout number
    Sandbox instance lifespan: Unit: minutes, range: 3~1440, default: 60
    availabilityZone String
    Availability zone ID of the sandbox instance
    cpuMilli Integer
    Sandbox instance CPU specification: Unit: milli CPU, range: 250~16000, default: 1000
    createdTime String
    Sandbox instance creation time.
    envs List<SandboxEnv>
    Sandbox instance environment variables Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    errorCode String
    Sandbox instance startup failure error code. Parameter description: internalloadrequesterror: internal system error, functioninitializefailed: business process initialization error, functionhealthcheckfailed: health check error, route_terminating: route deletion in progress. This field is empty when the sandbox instance starts normally
    errorMessage String
    Details of the error code when the sandbox instance fails to start. This field is empty when the sandbox instance starts normally.
    expireAt String
    Sandbox instance uptime.
    functionId String
    Sandbox application ID to which the sandbox instance belongs
    instanceImageInfo SandboxInstanceImageInfo
    Sandbox instance image information, including image address, startup command, and listening port.
    instanceTosMountConfig SandboxInstanceTosMountConfig
    Instance-level object storage (TOS) mount configuration for the sandbox instance
    instanceType String
    Sandbox instance type. Parameter description: elastic: elastic instance, frozen: frozen instance, activated: activated instance, reserved: reserved instance
    maxConcurrency Integer
    Maximum concurrent requests per instance: range: 10~1000, default: 100
    memoryMb Integer
    Sandbox instance memory specification: Unit: MiB, range: 512~131072, default: 2048
    metadatas List<SandboxMetadata>
    Sandbox instance label metadata used to tag and filter instances. Format: <"key":"value"> Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    pending Boolean
    Whether the sandbox instance is in Pending status. Parameter description: true: yes, false: no
    requestTimeout Integer
    Request timeout: Unit: seconds, range: 1~900, positive integer. Default: 30
    revisionNumber Integer
    Function instance version number
    sandboxId String
    Sandbox instance ID
    status String
    Sandbox instance status. Parameter description: Starting: starting, Ready: startup completed, Failed: startup failed, Terminating: terminating
    timeout Integer
    Sandbox instance lifespan: Unit: minutes, range: 3~1440, default: 60
    availabilityZone string
    Availability zone ID of the sandbox instance
    cpuMilli number
    Sandbox instance CPU specification: Unit: milli CPU, range: 250~16000, default: 1000
    createdTime string
    Sandbox instance creation time.
    envs SandboxEnv[]
    Sandbox instance environment variables Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    errorCode string
    Sandbox instance startup failure error code. Parameter description: internalloadrequesterror: internal system error, functioninitializefailed: business process initialization error, functionhealthcheckfailed: health check error, route_terminating: route deletion in progress. This field is empty when the sandbox instance starts normally
    errorMessage string
    Details of the error code when the sandbox instance fails to start. This field is empty when the sandbox instance starts normally.
    expireAt string
    Sandbox instance uptime.
    functionId string
    Sandbox application ID to which the sandbox instance belongs
    instanceImageInfo SandboxInstanceImageInfo
    Sandbox instance image information, including image address, startup command, and listening port.
    instanceTosMountConfig SandboxInstanceTosMountConfig
    Instance-level object storage (TOS) mount configuration for the sandbox instance
    instanceType string
    Sandbox instance type. Parameter description: elastic: elastic instance, frozen: frozen instance, activated: activated instance, reserved: reserved instance
    maxConcurrency number
    Maximum concurrent requests per instance: range: 10~1000, default: 100
    memoryMb number
    Sandbox instance memory specification: Unit: MiB, range: 512~131072, default: 2048
    metadatas SandboxMetadata[]
    Sandbox instance label metadata used to tag and filter instances. Format: <"key":"value"> Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    pending boolean
    Whether the sandbox instance is in Pending status. Parameter description: true: yes, false: no
    requestTimeout number
    Request timeout: Unit: seconds, range: 1~900, positive integer. Default: 30
    revisionNumber number
    Function instance version number
    sandboxId string
    Sandbox instance ID
    status string
    Sandbox instance status. Parameter description: Starting: starting, Ready: startup completed, Failed: startup failed, Terminating: terminating
    timeout number
    Sandbox instance lifespan: Unit: minutes, range: 3~1440, default: 60
    availability_zone str
    Availability zone ID of the sandbox instance
    cpu_milli int
    Sandbox instance CPU specification: Unit: milli CPU, range: 250~16000, default: 1000
    created_time str
    Sandbox instance creation time.
    envs Sequence[SandboxEnvArgs]
    Sandbox instance environment variables Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    error_code str
    Sandbox instance startup failure error code. Parameter description: internalloadrequesterror: internal system error, functioninitializefailed: business process initialization error, functionhealthcheckfailed: health check error, route_terminating: route deletion in progress. This field is empty when the sandbox instance starts normally
    error_message str
    Details of the error code when the sandbox instance fails to start. This field is empty when the sandbox instance starts normally.
    expire_at str
    Sandbox instance uptime.
    function_id str
    Sandbox application ID to which the sandbox instance belongs
    instance_image_info SandboxInstanceImageInfoArgs
    Sandbox instance image information, including image address, startup command, and listening port.
    instance_tos_mount_config SandboxInstanceTosMountConfigArgs
    Instance-level object storage (TOS) mount configuration for the sandbox instance
    instance_type str
    Sandbox instance type. Parameter description: elastic: elastic instance, frozen: frozen instance, activated: activated instance, reserved: reserved instance
    max_concurrency int
    Maximum concurrent requests per instance: range: 10~1000, default: 100
    memory_mb int
    Sandbox instance memory specification: Unit: MiB, range: 512~131072, default: 2048
    metadatas Sequence[SandboxMetadataArgs]
    Sandbox instance label metadata used to tag and filter instances. Format: <"key":"value"> Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    pending bool
    Whether the sandbox instance is in Pending status. Parameter description: true: yes, false: no
    request_timeout int
    Request timeout: Unit: seconds, range: 1~900, positive integer. Default: 30
    revision_number int
    Function instance version number
    sandbox_id str
    Sandbox instance ID
    status str
    Sandbox instance status. Parameter description: Starting: starting, Ready: startup completed, Failed: startup failed, Terminating: terminating
    timeout int
    Sandbox instance lifespan: Unit: minutes, range: 3~1440, default: 60
    availabilityZone String
    Availability zone ID of the sandbox instance
    cpuMilli Number
    Sandbox instance CPU specification: Unit: milli CPU, range: 250~16000, default: 1000
    createdTime String
    Sandbox instance creation time.
    envs List<Property Map>
    Sandbox instance environment variables Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    errorCode String
    Sandbox instance startup failure error code. Parameter description: internalloadrequesterror: internal system error, functioninitializefailed: business process initialization error, functionhealthcheckfailed: health check error, route_terminating: route deletion in progress. This field is empty when the sandbox instance starts normally
    errorMessage String
    Details of the error code when the sandbox instance fails to start. This field is empty when the sandbox instance starts normally.
    expireAt String
    Sandbox instance uptime.
    functionId String
    Sandbox application ID to which the sandbox instance belongs
    instanceImageInfo Property Map
    Sandbox instance image information, including image address, startup command, and listening port.
    instanceTosMountConfig Property Map
    Instance-level object storage (TOS) mount configuration for the sandbox instance
    instanceType String
    Sandbox instance type. Parameter description: elastic: elastic instance, frozen: frozen instance, activated: activated instance, reserved: reserved instance
    maxConcurrency Number
    Maximum concurrent requests per instance: range: 10~1000, default: 100
    memoryMb Number
    Sandbox instance memory specification: Unit: MiB, range: 512~131072, default: 2048
    metadatas List<Property Map>
    Sandbox instance label metadata used to tag and filter instances. Format: <"key":"value"> Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    pending Boolean
    Whether the sandbox instance is in Pending status. Parameter description: true: yes, false: no
    requestTimeout Number
    Request timeout: Unit: seconds, range: 1~900, positive integer. Default: 30
    revisionNumber Number
    Function instance version number
    sandboxId String
    Sandbox instance ID
    status String
    Sandbox instance status. Parameter description: Starting: starting, Ready: startup completed, Failed: startup failed, Terminating: terminating
    timeout Number
    Sandbox instance lifespan: Unit: minutes, range: 3~1440, default: 60

    Supporting Types

    SandboxEnv, SandboxEnvArgs

    Key string
    Environment variable key
    Value string
    Environment variable value
    Key string
    Environment variable key
    Value string
    Environment variable value
    key string
    Environment variable key
    value string
    Environment variable value
    key String
    Environment variable key
    value String
    Environment variable value
    key string
    Environment variable key
    value string
    Environment variable value
    key str
    Environment variable key
    value str
    Environment variable value
    key String
    Environment variable key
    value String
    Environment variable value

    SandboxInstanceImageInfo, SandboxInstanceImageInfoArgs

    Command string
    Startup command for the sandbox instance program. To specify a script file, use an absolute path and ensure the script has executable permissions
    Image string
    Preheated image address used by the sandbox instance
    ImageId string
    Pre-warmed image ID used by the sandbox instance.
    Port int
    Listening port of the sandbox instance image.
    Command string
    Startup command for the sandbox instance program. To specify a script file, use an absolute path and ensure the script has executable permissions
    Image string
    Preheated image address used by the sandbox instance
    ImageId string
    Pre-warmed image ID used by the sandbox instance.
    Port int
    Listening port of the sandbox instance image.
    command string
    Startup command for the sandbox instance program. To specify a script file, use an absolute path and ensure the script has executable permissions
    image string
    Preheated image address used by the sandbox instance
    image_id string
    Pre-warmed image ID used by the sandbox instance.
    port number
    Listening port of the sandbox instance image.
    command String
    Startup command for the sandbox instance program. To specify a script file, use an absolute path and ensure the script has executable permissions
    image String
    Preheated image address used by the sandbox instance
    imageId String
    Pre-warmed image ID used by the sandbox instance.
    port Integer
    Listening port of the sandbox instance image.
    command string
    Startup command for the sandbox instance program. To specify a script file, use an absolute path and ensure the script has executable permissions
    image string
    Preheated image address used by the sandbox instance
    imageId string
    Pre-warmed image ID used by the sandbox instance.
    port number
    Listening port of the sandbox instance image.
    command str
    Startup command for the sandbox instance program. To specify a script file, use an absolute path and ensure the script has executable permissions
    image str
    Preheated image address used by the sandbox instance
    image_id str
    Pre-warmed image ID used by the sandbox instance.
    port int
    Listening port of the sandbox instance image.
    command String
    Startup command for the sandbox instance program. To specify a script file, use an absolute path and ensure the script has executable permissions
    image String
    Preheated image address used by the sandbox instance
    imageId String
    Pre-warmed image ID used by the sandbox instance.
    port Number
    Listening port of the sandbox instance image.

    SandboxInstanceTosMountConfig, SandboxInstanceTosMountConfigArgs

    Enable bool
    Whether instance-level TOS mount is enabled for the sandbox instance. Parameter description: true: yes, false: no
    TosMountPoints List<Byteplus.SandboxInstanceTosMountConfigTosMountPoint>
    Detailed TOS mount directory information for sandbox instances with instance-level TOS mount enabled Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    Enable bool
    Whether instance-level TOS mount is enabled for the sandbox instance. Parameter description: true: yes, false: no
    TosMountPoints []SandboxInstanceTosMountConfigTosMountPoint
    Detailed TOS mount directory information for sandbox instances with instance-level TOS mount enabled Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    enable bool
    Whether instance-level TOS mount is enabled for the sandbox instance. Parameter description: true: yes, false: no
    tos_mount_points list(object)
    Detailed TOS mount directory information for sandbox instances with instance-level TOS mount enabled Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    enable Boolean
    Whether instance-level TOS mount is enabled for the sandbox instance. Parameter description: true: yes, false: no
    tosMountPoints List<SandboxInstanceTosMountConfigTosMountPoint>
    Detailed TOS mount directory information for sandbox instances with instance-level TOS mount enabled Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    enable boolean
    Whether instance-level TOS mount is enabled for the sandbox instance. Parameter description: true: yes, false: no
    tosMountPoints SandboxInstanceTosMountConfigTosMountPoint[]
    Detailed TOS mount directory information for sandbox instances with instance-level TOS mount enabled Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    enable bool
    Whether instance-level TOS mount is enabled for the sandbox instance. Parameter description: true: yes, false: no
    tos_mount_points Sequence[SandboxInstanceTosMountConfigTosMountPoint]
    Detailed TOS mount directory information for sandbox instances with instance-level TOS mount enabled Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.
    enable Boolean
    Whether instance-level TOS mount is enabled for the sandbox instance. Parameter description: true: yes, false: no
    tosMountPoints List<Property Map>
    Detailed TOS mount directory information for sandbox instances with instance-level TOS mount enabled Important Note: When using SetNestedAttribute, you must fully define all attributes of its nested structure. Incomplete definitions may cause Terraform to detect unexpected differences during plan comparison, triggering unnecessary resource updates and affecting resource stability and predictability.

    SandboxInstanceTosMountConfigTosMountPoint, SandboxInstanceTosMountConfigTosMountPointArgs

    BucketPath string
    TOS remote directory mounted by the sandbox instance
    LocalMountPath string
    Local directory of the TOS bucket mounted by the sandbox instance. If this directory is the local directory configured for TOS storage mount in the sandbox application, the system modifies the corresponding TOS BucketPath based on the specified local directory
    BucketPath string
    TOS remote directory mounted by the sandbox instance
    LocalMountPath string
    Local directory of the TOS bucket mounted by the sandbox instance. If this directory is the local directory configured for TOS storage mount in the sandbox application, the system modifies the corresponding TOS BucketPath based on the specified local directory
    bucket_path string
    TOS remote directory mounted by the sandbox instance
    local_mount_path string
    Local directory of the TOS bucket mounted by the sandbox instance. If this directory is the local directory configured for TOS storage mount in the sandbox application, the system modifies the corresponding TOS BucketPath based on the specified local directory
    bucketPath String
    TOS remote directory mounted by the sandbox instance
    localMountPath String
    Local directory of the TOS bucket mounted by the sandbox instance. If this directory is the local directory configured for TOS storage mount in the sandbox application, the system modifies the corresponding TOS BucketPath based on the specified local directory
    bucketPath string
    TOS remote directory mounted by the sandbox instance
    localMountPath string
    Local directory of the TOS bucket mounted by the sandbox instance. If this directory is the local directory configured for TOS storage mount in the sandbox application, the system modifies the corresponding TOS BucketPath based on the specified local directory
    bucket_path str
    TOS remote directory mounted by the sandbox instance
    local_mount_path str
    Local directory of the TOS bucket mounted by the sandbox instance. If this directory is the local directory configured for TOS storage mount in the sandbox application, the system modifies the corresponding TOS BucketPath based on the specified local directory
    bucketPath String
    TOS remote directory mounted by the sandbox instance
    localMountPath String
    Local directory of the TOS bucket mounted by the sandbox instance. If this directory is the local directory configured for TOS storage mount in the sandbox application, the system modifies the corresponding TOS BucketPath based on the specified local directory

    SandboxMetadata, SandboxMetadataArgs

    Key string
    Tag key
    Value string
    Tag value
    Key string
    Tag key
    Value string
    Tag value
    key string
    Tag key
    value string
    Tag value
    key String
    Tag key
    value String
    Tag value
    key string
    Tag key
    value string
    Tag value
    key str
    Tag key
    value str
    Tag value
    key String
    Tag key
    value String
    Tag value

    Import

    $ pulumi import bytepluscc:vefaas/sandbox:Sandbox example "function_id|sandbox_id"

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    bytepluscc byteplus-sdk/pulumi-bytepluscc
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the bytepluscc Terraform Provider.
    bytepluscc logo
    Viewing docs for bytepluscc v0.0.43
    published on Monday, Jul 27, 2026 by Byteplus
    Schema (JSON)
    byteplus-sdk/pulumi-bytepluscc

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial