SandboxConfig¶

class oci.generative_ai.models.SandboxConfig(**kwargs)¶

Bases: object

Sandbox configuration under a project. Use sandboxOutboundNetworkingConfig to choose whether sandbox outbound traffic originates from an Oracle-managed network or from a customer subnet. The warmPoolConfig field is a read-only projection of reserved MANAGED default-pool capacities. Project create and update requests must omit warmPoolConfig; supplying it, including null or an empty object, is rejected. Newly enabled projects start with zero default-pool capacity. Use the named warm-pool APIs to change capacities or manage CUSTOM pools. On Project Update, omit sandboxConfig to retain the existing configuration. When supplying sandboxConfig, include isEnabled. Sandbox can be enabled after project creation but cannot be disabled after it is enabled. After enablement, isPersistenceEnabled and custom outbound networking cannot change; managed network policy can be updated. Omitted isPersistenceEnabled retains its current value. Credential profiles require unique labels and can be added, removed, or changed on Project Update. Omit credentialProfiles to retain them, or supply the complete desired list; an empty array removes all profiles from the Project. When credentialProfiles is supplied, omitting sandboxOutboundNetworkingConfig retains the current outbound networking configuration. Updates apply to subsequently created Sandboxes after Project configuration propagation. Existing Sandboxes retain their selected profile snapshot, including when that profile is changed or removed from the Project. Updating a secret’s CURRENT version in Vault does not change the Project configuration and remains visible to existing Sandboxes that reference that secret.

Methods:

__init__(**kwargs)

Initializes a new SandboxConfig object with values from keyword arguments.

Attributes:

`credential_profiles`	Gets the credential_profiles of this SandboxConfig.
`is_enabled`	[Required] Gets the is_enabled of this SandboxConfig.
`is_persistence_enabled`	Gets the is_persistence_enabled of this SandboxConfig.
`sandbox_outbound_networking_config`	Gets the sandbox_outbound_networking_config of this SandboxConfig.
`warm_pool_config`	Gets the warm_pool_config of this SandboxConfig.

__init__(**kwargs)¶

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

Parameters

is_enabled (bool) – The value to assign to the is_enabled property of this SandboxConfig.
is_persistence_enabled (bool) – The value to assign to the is_persistence_enabled property of this SandboxConfig.
warm_pool_config (oci.generative_ai.models.SandboxWarmPoolConfig) – The value to assign to the warm_pool_config property of this SandboxConfig.
sandbox_outbound_networking_config (oci.generative_ai.models.SandboxOutboundNetworkingConfig) – The value to assign to the sandbox_outbound_networking_config property of this SandboxConfig.
credential_profiles (list[oci.generative_ai.models.SandboxCredentialProfile]) – The value to assign to the credential_profiles property of this SandboxConfig.

property credential_profiles¶

Gets the credential_profiles of this SandboxConfig. Named credential profiles available for Sandbox creation. A Sandbox can explicitly select one profile using credentialProfileLabel; omitting that selector selects none. On Project Update, omission retains existing profiles and a supplied list replaces the complete list. An empty array removes all profiles from the Project. Adding, removing, or changing profiles affects subsequently created Sandboxes after configuration propagation. Existing Sandboxes retain their selected configuration snapshot.

Returns: The credential_profiles of this SandboxConfig.
Return type: list[oci.generative_ai.models.SandboxCredentialProfile]

property is_enabled¶

[Required] Gets the is_enabled of this SandboxConfig. Indicates whether sandbox config is enabled.

Returns: The is_enabled of this SandboxConfig.
Return type: bool

property is_persistence_enabled¶

Gets the is_persistence_enabled of this SandboxConfig. Indicates whether persistent block volume storage is enabled for sandbox workspaces in this project. When omitted, the service-defined default is used.

Returns: The is_persistence_enabled of this SandboxConfig.
Return type: bool

property sandbox_outbound_networking_config¶

Gets the sandbox_outbound_networking_config of this SandboxConfig.

Returns: The sandbox_outbound_networking_config of this SandboxConfig.
Return type: oci.generative_ai.models.SandboxOutboundNetworkingConfig

property warm_pool_config¶

Gets the warm_pool_config of this SandboxConfig.

Returns: The warm_pool_config of this SandboxConfig.
Return type: oci.generative_ai.models.SandboxWarmPoolConfig