nebius.api.nebius.compute.v1.InstanceSpec

class documentation

class InstanceSpec(pb_classes.Message): (source)

Constructor: InstanceSpec(initial_message, service_account_id, resources, gpu_cluster, ...)

Undocumented

Method	`__dir__`	Undocumented
Method	`__init__`	Create a wrapper around a protobuf message instance.
Method	`boot_disk.setter`	Undocumented
Method	`cloud_init_user_data.setter`	Undocumented
Method	`filesystems.setter`	Undocumented
Method	`gpu_cluster.setter`	Undocumented
Method	`hostname.setter`	Undocumented
Method	`network_interfaces.setter`	Undocumented
Method	`preemptible.setter`	Undocumented
Method	`recovery_policy.setter`	Undocumented
Method	`reservation_policy.setter`	Undocumented
Method	`resources.setter`	Undocumented
Method	`secondary_disks.setter`	Undocumented
Method	`service_account_id.setter`	Undocumented
Method	`stopped.setter`	Undocumented
Constant	`__PB2_DESCRIPTOR__`	Undocumented
Constant	`__PY_TO_PB2__`	Undocumented
Class Variable	`__mask_functions__`	Undocumented
Property	`boot_disk`	Specified boot disk attached to the instance.
Property	`cloud_init_user_data`	Data in cloud-init format for customizing instance initialization. For details, see https://docs.nebius.com/compute/virtual-machines/manage#user-data
Property	`filesystems`	List of Shared Filesystems attached to the instance.
Property	`gpu_cluster`	If you want to interconnect several instances in a GPU cluster via NVIDIA InfiniBand, set the ID of an existing GPU cluster. You can only add the VM to the cluster when creating the VM. For details, see ...
Property	`hostname`	Instance's hostname. Used to generate default DNS record in format `<hostname>.<network_id>.compute.internal.` or `<instance_id>.<network_id>.compute.internal.` if hostname is not specified.
Property	`network_interfaces`	List of network interfaces attached to the instance.
Property	`preemptible`	Include these parameters to create a Preemptible VM and omit them to create a Regular VM For details, see https://docs.nebius.com/compute/virtual-machines/preemptible
Property	`recovery_policy`	Recovery policy defines how the instance will be treated in case of a failure. Common source of failure is a host failure, but it can be any other failure. Instance undergoing a guest shutdown (poweroff, etc...
Property	`reservation_policy`	Undocumented
Property	`resources`	Specification of compute resources allocated to the instance. For details, see https://docs.nebius.com/compute/virtual-machines/types
Property	`secondary_disks`	List of additional data disks attached to the instance beyond the boot disk.
Property	`service_account_id`	Unique identifier of the service account associated with this instance. For details, see https://docs.nebius.dev/en/iam/about-iam/concepts/service-accounts
Property	`stopped`	Indicates whether the instance should be stopped.

Inherited from Message:

Class Method	`get_descriptor`	Return the protobuf descriptor for this message class.
Class Method	`is_credentials`	Return True if the field contains credentials.
Class Method	`is_sensitive`	Return True if the field is marked as sensitive.
Method	`__repr__`	Return a human-readable representation of the message, sanitizing sensitive fields.
Method	`check_presence`	Check explicit presence for a field in the protobuf message.
Method	`get_full_update_reset_mask`	Build a reset mask for a full update of this message.
Method	`get_mask`	Return the tracked reset mask.
Method	`is_default`	Return True if a field equals its default value.
Method	`set_mask`	Replace the tracked reset mask.
Method	`which_field_in_oneof`	Return the set field name for a given oneof.
Instance Variable	`__PB2_CLASS__`	Protobuf message class associated with this wrapper.
Instance Variable	`__pb2_message__`	Underlying protobuf message instance.
Method	`_clear_field`	Clear a field and record it in the reset mask.
Method	`_get_field`	Return a field value with optional wrapping and presence handling.
Method	`_set_field`	Set a field value and update the reset mask.
Class Variable	`__credentials_fields`	Undocumented
Class Variable	`__default`	Undocumented
Class Variable	`__sensitive_fields`	Undocumented
Instance Variable	`__recorded_reset_mask`	Mask tracking fields cleared or set to default.

def __dir__(self) -> abc.Iterable[builtins.str]: (source) ¶

Undocumented

overrides nebius.base.protos.pb_classes.Message.__init__

Create a wrapper around a protobuf message instance.

Raises
`AttributeError`	If the wrapper is missing required class metadata.

@boot_disk.setter
def boot_disk(self, value: AttachedDiskSpec | instance_pb2.AttachedDiskSpec | None): (source) ¶

Undocumented

@cloud_init_user_data.setter
def cloud_init_user_data(self, value: builtins.str | None): (source) ¶

Undocumented

@filesystems.setter
def filesystems(self, value: abc.Iterable[AttachedFilesystemSpec] | None): (source) ¶

Undocumented

@gpu_cluster.setter
def gpu_cluster(self, value: InstanceGpuClusterSpec | instance_pb2.InstanceGpuClusterSpec | None): (source) ¶

Undocumented

@hostname.setter
def hostname(self, value: builtins.str | None): (source) ¶

Undocumented

@network_interfaces.setter
def network_interfaces(self, value: abc.Iterable[NetworkInterfaceSpec] | None): (source) ¶

Undocumented

@preemptible.setter
def preemptible(self, value: PreemptibleSpec | instance_pb2.PreemptibleSpec | None): (source) ¶

Undocumented

@recovery_policy.setter
def recovery_policy(self, value: InstanceRecoveryPolicy | instance_pb2.InstanceRecoveryPolicy | None): (source) ¶

Undocumented

@reservation_policy.setter
def reservation_policy(self, value: ReservationPolicy | instance_pb2.ReservationPolicy | None): (source) ¶

Undocumented

@resources.setter
def resources(self, value: ResourcesSpec | instance_pb2.ResourcesSpec | None): (source) ¶

Undocumented

@secondary_disks.setter
def secondary_disks(self, value: abc.Iterable[AttachedDiskSpec] | None): (source) ¶

Undocumented

@service_account_id.setter
def service_account_id(self, value: builtins.str | None): (source) ¶

Undocumented

@stopped.setter
def stopped(self, value: builtins.bool | None): (source) ¶

Undocumented

__PB2_DESCRIPTOR__ = (source) ¶

overrides nebius.base.protos.pb_classes.Message.__PB2_DESCRIPTOR__

Undocumented

Value

descriptor.DescriptorWrap[descriptor_1.Descriptor]('.nebius.compute.v1.InstanceS↵
pec',
                                                   instance_pb2.DESCRIPTOR,
                                                   descriptor_1.Descriptor)

__PY_TO_PB2__: builtins.dict[builtins.str, builtins.str] = (source) ¶

overrides nebius.base.protos.pb_classes.Message.__PY_TO_PB2__

Undocumented

Value

{'service_account_id': 'service_account_id',
 'resources': 'resources',
 'gpu_cluster': 'gpu_cluster',
 'network_interfaces': 'network_interfaces',
 'boot_disk': 'boot_disk',
 'secondary_disks': 'secondary_disks',
 'filesystems': 'filesystems',
...

__mask_functions__: dict = (source) ¶

overrides nebius.base.protos.pb_classes.Message.__mask_functions__

Undocumented

@builtins.property
boot_disk: AttachedDiskSpec = (source) ¶

Specified boot disk attached to the instance.

@builtins.property
cloud_init_user_data: builtins.str = (source) ¶

Data in cloud-init format for customizing instance initialization. For details, see https://docs.nebius.com/compute/virtual-machines/manage#user-data

@builtins.property
filesystems: abc.MutableSequence[AttachedFilesystemSpec] = (source) ¶

List of Shared Filesystems attached to the instance.

@builtins.property
gpu_cluster: InstanceGpuClusterSpec = (source) ¶

If you want to interconnect several instances in a GPU cluster via NVIDIA InfiniBand, set the ID of an existing GPU cluster. You can only add the VM to the cluster when creating the VM. For details, see https://docs.nebius.com/compute/clusters/gpu

@builtins.property
hostname: builtins.str = (source) ¶

Instance's hostname. Used to generate default DNS record in format <hostname>.<network_id>.compute.internal. or <instance_id>.<network_id>.compute.internal. if hostname is not specified.

@builtins.property
network_interfaces: abc.MutableSequence[NetworkInterfaceSpec] = (source) ¶

List of network interfaces attached to the instance.

@builtins.property
preemptible: PreemptibleSpec = (source) ¶

Include these parameters to create a Preemptible VM and omit them to create a Regular VM For details, see https://docs.nebius.com/compute/virtual-machines/preemptible

@builtins.property
recovery_policy: InstanceRecoveryPolicy = (source) ¶

Recovery policy defines how the instance will be treated in case of a failure. Common source of failure is a host failure, but it can be any other failure. Instance undergoing a guest shutdown (poweroff, etc.) will be subject to recovery policy, meaning that it could be restarted and billed accordingly. Stop instance via API or UI to stop it to avoid recovering.

If set to RECOVER, instance will be restarted, if possible. It could be restarted on the same host or on another host.
If set to FAIL, instance will be stopped and not restarted.

@builtins.property
reservation_policy: ReservationPolicy = (source) ¶

Undocumented

@builtins.property
resources: ResourcesSpec = (source) ¶

Specification of compute resources allocated to the instance. For details, see https://docs.nebius.com/compute/virtual-machines/types

@builtins.property
secondary_disks: abc.MutableSequence[AttachedDiskSpec] = (source) ¶

List of additional data disks attached to the instance beyond the boot disk.

@builtins.property
service_account_id: builtins.str = (source) ¶

Unique identifier of the service account associated with this instance. For details, see https://docs.nebius.dev/en/iam/about-iam/concepts/service-accounts

@builtins.property
stopped: builtins.bool = (source) ¶

Indicates whether the instance should be stopped.