CreateSandboxDetails¶

class oci.generative_ai_sandbox.models.CreateSandboxDetails(**kwargs)¶

Bases: object

Request body used to create a sandbox.

Methods

__init__(**kwargs) Initializes a new CreateSandboxDetails object with values from keyword arguments.

Attributes

`credential_profile_label`	Gets the credential_profile_label of this CreateSandboxDetails.
`display_name`	Gets the display_name of this CreateSandboxDetails.
`environment_variables`	Gets the environment_variables of this CreateSandboxDetails.
`expiration_duration`	Gets the expiration_duration of this CreateSandboxDetails.
`expires_in_minutes`	Gets the expires_in_minutes of this CreateSandboxDetails.
`publish_ports`	Gets the publish_ports of this CreateSandboxDetails.
`published_port_auth_mode`	Gets the published_port_auth_mode of this CreateSandboxDetails.
`runtime`	Gets the runtime of this CreateSandboxDetails.
`shape`	Gets the shape of this CreateSandboxDetails.
`source`	Gets the source of this CreateSandboxDetails.
`warmpool_name`	Gets the warmpool_name of this CreateSandboxDetails.

__init__(**kwargs)¶

Initializes a new CreateSandboxDetails object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

warmpool_name (str) – The value to assign to the warmpool_name property of this CreateSandboxDetails.
source (oci.generative_ai_sandbox.models.SandboxSource) – The value to assign to the source property of this CreateSandboxDetails.
display_name (str) – The value to assign to the display_name property of this CreateSandboxDetails.
runtime (str) – The value to assign to the runtime property of this CreateSandboxDetails.
shape (str) – The value to assign to the shape property of this CreateSandboxDetails.
published_port_auth_mode (str) – The value to assign to the published_port_auth_mode property of this CreateSandboxDetails.
publish_ports (list[str]) – The value to assign to the publish_ports property of this CreateSandboxDetails.
expires_in_minutes (int) – The value to assign to the expires_in_minutes property of this CreateSandboxDetails.
expiration_duration (str) – The value to assign to the expiration_duration property of this CreateSandboxDetails.
environment_variables (list[oci.generative_ai_sandbox.models.EnvironmentVariable]) – The value to assign to the environment_variables property of this CreateSandboxDetails.
credential_profile_label (str) – The value to assign to the credential_profile_label property of this CreateSandboxDetails.

credential_profile_label¶

Gets the credential_profile_label of this CreateSandboxDetails. The Project credential profile selected for this Sandbox. Omit this field to select no credential profile. The selection and its configuration snapshot are immutable for the lifetime of the Sandbox; later Project profile updates apply only to subsequently created Sandboxes after configuration propagation.

Returns:	The credential_profile_label of this CreateSandboxDetails.
Return type:	str

display_name¶

Gets the display_name of this CreateSandboxDetails. User-provided display name for the sandbox.

Returns:	The display_name of this CreateSandboxDetails.
Return type:	str

environment_variables¶

Gets the environment_variables of this CreateSandboxDetails. Environment variables to inject into the sandbox runtime.

Returns:	The environment_variables of this CreateSandboxDetails.
Return type:	list[oci.generative_ai_sandbox.models.EnvironmentVariable]

expiration_duration¶

Gets the expiration_duration of this CreateSandboxDetails. Deprecated. Use expiresInMinutes instead. Existing clients may pass -1 to disable automatic expiration.

Returns:	The expiration_duration of this CreateSandboxDetails.
Return type:	str

expires_in_minutes¶

Gets the expires_in_minutes of this CreateSandboxDetails. Number of minutes from creation until automatic sandbox expiration. Use -1 to disable automatic expiration.

Returns:	The expires_in_minutes of this CreateSandboxDetails.
Return type:	int

publish_ports¶

Gets the publish_ports of this CreateSandboxDetails. Published ports to expose for the sandbox.

Returns:	The publish_ports of this CreateSandboxDetails.
Return type:	list[str]

published_port_auth_mode¶

Gets the published_port_auth_mode of this CreateSandboxDetails. Authorization for all published-port HTTP requests and WebSocket handshakes. OCI_IAM requires Sandbox use and project read permission on the owning project. Omission defaults to OCI_IAM for new sandboxes with published ports in enabled tenancies; elsewhere omission retains legacy behavior. Explicit OCI_IAM outside the rollout, null, unsupported values, or a mode without published ports are rejected. The effective mode is immutable and is preserved when restoring protected snapshots.

Returns:	The published_port_auth_mode of this CreateSandboxDetails.
Return type:	str

runtime¶

Gets the runtime of this CreateSandboxDetails. Runtime identifier for the sandbox, either a built-in runtime such as python-3.11 or a same-region Oracle Cloud Infrastructure Registry customer image reference.

Returns:	The runtime of this CreateSandboxDetails.
Return type:	str

shape¶

Gets the shape of this CreateSandboxDetails. Compute shape for the sandbox.

Returns:	The shape of this CreateSandboxDetails.
Return type:	str

source¶

Gets the source of this CreateSandboxDetails.

Returns:	The source of this CreateSandboxDetails.
Return type:	oci.generative_ai_sandbox.models.SandboxSource

warmpool_name¶

Gets the warmpool_name of this CreateSandboxDetails. Name of a MANAGED or CUSTOM warm pool in the owning project. Runtime and shape are derived from the pool; explicit values must match. Deleting pools cannot be used. Snapshot restore, credential brokerage, and nested resource principals are not supported with named pools. An empty pool may cold-create using its same template, including when desired capacity is zero. Zero capacity stops idle prewarming; it does not prevent creation from an available applied template. When warmpoolName is omitted, a built-in runtime can automatically select an eligible named MANAGED pool in the same project matching its runtime and shape. Omitted runtime defaults to python-3.11 and omitted shape defaults to SMALL for automatic matching. A digest-pinned customer image can automatically select an eligible CUSTOM pool in the same project matching its canonical registry host, repository, digest and shape. Tag-based customer images are not automatically matched. Matching pools are considered in name order; the first with a valid applied template is selected without reading ready counts. Empty pools and zero desired or applied capacity still allow cold creation through the selected template. If no eligible pool is found or automatic lookup is unavailable, built-in runtimes use the existing managed runtime path, and customer images use the ordinary direct customer-image path with its existing validation. Automatic matching does not apply when source is supplied, including snapshot restore, or when credential brokerage or nested resource principals are used. Explicit names retain strict validation and do not fall back to automatic matching or another creation path. Retries preserve the original persisted pool binding or the original managed or direct customer-image route, even when matching pools change. Sandbox and SandboxSummary report an automatically selected pool in warmpoolName.

Returns:	The warmpool_name of this CreateSandboxDetails.
Return type:	str