Shape¶

class oci.core.models.Shape(**kwargs)¶

Bases: object

A compute instance shape that can be used in launch_instance(). For more information, see Overview of the Compute Service and Compute Shapes.

Attributes

`BASELINE_OCPU_UTILIZATIONS_BASELINE_1_1`	A constant which can be used with the baseline_ocpu_utilizations property of a Shape.
`BASELINE_OCPU_UTILIZATIONS_BASELINE_1_2`	A constant which can be used with the baseline_ocpu_utilizations property of a Shape.
`BASELINE_OCPU_UTILIZATIONS_BASELINE_1_8`	A constant which can be used with the baseline_ocpu_utilizations property of a Shape.
`BILLING_TYPE_ALWAYS_FREE`	A constant which can be used with the billing_type property of a Shape.
`BILLING_TYPE_LIMITED_FREE`	A constant which can be used with the billing_type property of a Shape.
`BILLING_TYPE_PAID`	A constant which can be used with the billing_type property of a Shape.
`baseline_ocpu_utilizations`	Gets the baseline_ocpu_utilizations of this Shape.
`billing_type`	Gets the billing_type of this Shape.
`gpu_description`	Gets the gpu_description of this Shape.
`gpus`	Gets the gpus of this Shape.
`is_billed_for_stopped_instance`	Gets the is_billed_for_stopped_instance of this Shape.
`is_flexible`	Gets the is_flexible of this Shape.
`is_live_migration_supported`	Gets the is_live_migration_supported of this Shape.
`is_subcore`	Gets the is_subcore of this Shape.
`local_disk_description`	Gets the local_disk_description of this Shape.
`local_disks`	Gets the local_disks of this Shape.
`local_disks_total_size_in_gbs`	Gets the local_disks_total_size_in_gbs of this Shape.
`max_vnic_attachment_options`	Gets the max_vnic_attachment_options of this Shape.
`max_vnic_attachments`	Gets the max_vnic_attachments of this Shape.
`memory_in_gbs`	Gets the memory_in_gbs of this Shape.
`memory_options`	Gets the memory_options of this Shape.
`min_total_baseline_ocpus_required`	Gets the min_total_baseline_ocpus_required of this Shape.
`network_ports`	Gets the network_ports of this Shape.
`networking_bandwidth_in_gbps`	Gets the networking_bandwidth_in_gbps of this Shape.
`networking_bandwidth_options`	Gets the networking_bandwidth_options of this Shape.
`ocpu_options`	Gets the ocpu_options of this Shape.
`ocpus`	Gets the ocpus of this Shape.
`platform_config_options`	Gets the platform_config_options of this Shape.
`processor_description`	Gets the processor_description of this Shape.
`quota_names`	Gets the quota_names of this Shape.
`rdma_bandwidth_in_gbps`	Gets the rdma_bandwidth_in_gbps of this Shape.
`rdma_ports`	Gets the rdma_ports of this Shape.
`recommended_alternatives`	Gets the recommended_alternatives of this Shape.
`resize_compatible_shapes`	Gets the resize_compatible_shapes of this Shape.
`shape`	[Required] Gets the shape of this Shape.

Methods

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

BASELINE_OCPU_UTILIZATIONS_BASELINE_1_1 = 'BASELINE_1_1'¶: A constant which can be used with the baseline_ocpu_utilizations property of a Shape. This constant has a value of “BASELINE_1_1”

BASELINE_OCPU_UTILIZATIONS_BASELINE_1_2 = 'BASELINE_1_2'¶: A constant which can be used with the baseline_ocpu_utilizations property of a Shape. This constant has a value of “BASELINE_1_2”

BASELINE_OCPU_UTILIZATIONS_BASELINE_1_8 = 'BASELINE_1_8'¶: A constant which can be used with the baseline_ocpu_utilizations property of a Shape. This constant has a value of “BASELINE_1_8”

BILLING_TYPE_ALWAYS_FREE = 'ALWAYS_FREE'¶: A constant which can be used with the billing_type property of a Shape. This constant has a value of “ALWAYS_FREE”

BILLING_TYPE_LIMITED_FREE = 'LIMITED_FREE'¶: A constant which can be used with the billing_type property of a Shape. This constant has a value of “LIMITED_FREE”

BILLING_TYPE_PAID = 'PAID'¶: A constant which can be used with the billing_type property of a Shape. This constant has a value of “PAID”

__init__(**kwargs)¶

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

Parameters:

baseline_ocpu_utilizations (list[str]) – The value to assign to the baseline_ocpu_utilizations property of this Shape. Allowed values for items in this list are: “BASELINE_1_8”, “BASELINE_1_2”, “BASELINE_1_1”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
min_total_baseline_ocpus_required (float) – The value to assign to the min_total_baseline_ocpus_required property of this Shape.
shape (str) – The value to assign to the shape property of this Shape.
processor_description (str) – The value to assign to the processor_description property of this Shape.
ocpus (float) – The value to assign to the ocpus property of this Shape.
memory_in_gbs (float) – The value to assign to the memory_in_gbs property of this Shape.
network_ports (int) – The value to assign to the network_ports property of this Shape.
networking_bandwidth_in_gbps (float) – The value to assign to the networking_bandwidth_in_gbps property of this Shape.
max_vnic_attachments (int) – The value to assign to the max_vnic_attachments property of this Shape.
gpus (int) – The value to assign to the gpus property of this Shape.
gpu_description (str) – The value to assign to the gpu_description property of this Shape.
local_disks (int) – The value to assign to the local_disks property of this Shape.
local_disks_total_size_in_gbs (float) – The value to assign to the local_disks_total_size_in_gbs property of this Shape.
local_disk_description (str) – The value to assign to the local_disk_description property of this Shape.
rdma_ports (int) – The value to assign to the rdma_ports property of this Shape.
rdma_bandwidth_in_gbps (int) – The value to assign to the rdma_bandwidth_in_gbps property of this Shape.
is_live_migration_supported (bool) – The value to assign to the is_live_migration_supported property of this Shape.
ocpu_options (oci.core.models.ShapeOcpuOptions) – The value to assign to the ocpu_options property of this Shape.
memory_options (oci.core.models.ShapeMemoryOptions) – The value to assign to the memory_options property of this Shape.
networking_bandwidth_options (oci.core.models.ShapeNetworkingBandwidthOptions) – The value to assign to the networking_bandwidth_options property of this Shape.
max_vnic_attachment_options (oci.core.models.ShapeMaxVnicAttachmentOptions) – The value to assign to the max_vnic_attachment_options property of this Shape.
platform_config_options (oci.core.models.ShapePlatformConfigOptions) – The value to assign to the platform_config_options property of this Shape.
is_billed_for_stopped_instance (bool) – The value to assign to the is_billed_for_stopped_instance property of this Shape.
billing_type (str) – The value to assign to the billing_type property of this Shape. Allowed values for this property are: “ALWAYS_FREE”, “LIMITED_FREE”, “PAID”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
quota_names (list[str]) – The value to assign to the quota_names property of this Shape.
is_subcore (bool) – The value to assign to the is_subcore property of this Shape.
is_flexible (bool) – The value to assign to the is_flexible property of this Shape.
resize_compatible_shapes (list[str]) – The value to assign to the resize_compatible_shapes property of this Shape.
recommended_alternatives (list[oci.core.models.ShapeAlternativeObject]) – The value to assign to the recommended_alternatives property of this Shape.

baseline_ocpu_utilizations¶

Gets the baseline_ocpu_utilizations of this Shape. For a subcore burstable VM, the supported baseline OCPU utilization for instances that use this shape.

Allowed values for items in this list are: “BASELINE_1_8”, “BASELINE_1_2”, “BASELINE_1_1”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The baseline_ocpu_utilizations of this Shape.
Return type:	list[str]

billing_type¶

Gets the billing_type of this Shape. How instances that use this shape are charged.

Allowed values for this property are: “ALWAYS_FREE”, “LIMITED_FREE”, “PAID”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The billing_type of this Shape.
Return type:	str

gpu_description¶

Gets the gpu_description of this Shape. A short description of the graphics processing unit (GPU) available for this shape.

If the shape does not have any GPUs, this field is null.

Returns:	The gpu_description of this Shape.
Return type:	str

gpus¶

Gets the gpus of this Shape. The number of GPUs available for this shape.

Returns:	The gpus of this Shape.
Return type:	int

is_billed_for_stopped_instance¶

Gets the is_billed_for_stopped_instance of this Shape. Whether billing continues when the instances that use this shape are in the stopped state.

Returns:	The is_billed_for_stopped_instance of this Shape.
Return type:	bool

is_flexible¶

Gets the is_flexible of this Shape. Whether the shape supports creating flexible instances. A flexible shape is a shape that lets you customize the number of OCPUs and the amount of memory when launching or resizing your instance.

Returns:	The is_flexible of this Shape.
Return type:	bool

is_live_migration_supported¶

Gets the is_live_migration_supported of this Shape. Whether live migration is supported for this shape.

Returns:	The is_live_migration_supported of this Shape.
Return type:	bool

is_subcore¶

Gets the is_subcore of this Shape. Whether the shape supports creating subcore or burstable instances. A burstable instance is a virtual machine (VM) instance that provides a baseline level of CPU performance with the ability to burst to a higher level to support occasional spikes in usage.

Returns:	The is_subcore of this Shape.
Return type:	bool

local_disk_description¶

Gets the local_disk_description of this Shape. A short description of the local disks available for this shape.

If the shape does not have any local disks, this field is null.

Returns:	The local_disk_description of this Shape.
Return type:	str

local_disks¶

Gets the local_disks of this Shape. The number of local disks available for this shape.

Returns:	The local_disks of this Shape.
Return type:	int

local_disks_total_size_in_gbs¶

Gets the local_disks_total_size_in_gbs of this Shape. The aggregate size of the local disks available for this shape, in gigabytes.

If the shape does not have any local disks, this field is null.

Returns:	The local_disks_total_size_in_gbs of this Shape.
Return type:	float

max_vnic_attachment_options¶

Gets the max_vnic_attachment_options of this Shape.

Returns:	The max_vnic_attachment_options of this Shape.
Return type:	oci.core.models.ShapeMaxVnicAttachmentOptions

max_vnic_attachments¶

Gets the max_vnic_attachments of this Shape. The maximum number of VNIC attachments available for this shape.

Returns:	The max_vnic_attachments of this Shape.
Return type:	int

memory_in_gbs¶

Gets the memory_in_gbs of this Shape. The default amount of memory available for this shape, in gigabytes.

Returns:	The memory_in_gbs of this Shape.
Return type:	float

memory_options¶

Gets the memory_options of this Shape.

Returns:	The memory_options of this Shape.
Return type:	oci.core.models.ShapeMemoryOptions

min_total_baseline_ocpus_required¶

Gets the min_total_baseline_ocpus_required of this Shape. For a subcore burstable VM, the minimum total baseline OCPUs required. The total baseline OCPUs is equal to baselineOcpuUtilization chosen multiplied by the number of OCPUs chosen.

Returns:	The min_total_baseline_ocpus_required of this Shape.
Return type:	float

network_ports¶

Gets the network_ports of this Shape. The number of physical network interface card (NIC) ports available for this shape.

Returns:	The network_ports of this Shape.
Return type:	int

networking_bandwidth_in_gbps¶

Gets the networking_bandwidth_in_gbps of this Shape. The networking bandwidth available for this shape, in gigabits per second.

Returns:	The networking_bandwidth_in_gbps of this Shape.
Return type:	float

networking_bandwidth_options¶

Gets the networking_bandwidth_options of this Shape.

Returns:	The networking_bandwidth_options of this Shape.
Return type:	oci.core.models.ShapeNetworkingBandwidthOptions

ocpu_options¶

Gets the ocpu_options of this Shape.

Returns:	The ocpu_options of this Shape.
Return type:	oci.core.models.ShapeOcpuOptions

ocpus¶

Gets the ocpus of this Shape. The default number of OCPUs available for this shape.

Returns:	The ocpus of this Shape.
Return type:	float

platform_config_options¶

Gets the platform_config_options of this Shape.

Returns:	The platform_config_options of this Shape.
Return type:	oci.core.models.ShapePlatformConfigOptions

processor_description¶

Gets the processor_description of this Shape. A short description of the shape’s processor (CPU).

Returns:	The processor_description of this Shape.
Return type:	str

quota_names¶

Gets the quota_names of this Shape. The list of of compartment quotas for the shape.

Returns:	The quota_names of this Shape.
Return type:	list[str]

rdma_bandwidth_in_gbps¶

Gets the rdma_bandwidth_in_gbps of this Shape. The networking bandwidth available for the remote direct memory access (RDMA) network for this shape, in gigabits per second.

Returns:	The rdma_bandwidth_in_gbps of this Shape.
Return type:	int

rdma_ports¶

Gets the rdma_ports of this Shape. The number of networking ports available for the remote direct memory access (RDMA) network between nodes in a high performance computing (HPC) cluster network. If the shape does not support cluster networks, this value is 0.

Returns:	The rdma_ports of this Shape.
Return type:	int

recommended_alternatives¶

Gets the recommended_alternatives of this Shape. The list of shapes and shape details (if applicable) that Oracle recommends that you use as an alternative to the current shape.

Returns:	The recommended_alternatives of this Shape.
Return type:	list[oci.core.models.ShapeAlternativeObject]

resize_compatible_shapes¶

Gets the resize_compatible_shapes of this Shape. The list of compatible shapes that this shape can be changed to. For more information, see Changing the Shape of an Instance.

Returns:	The resize_compatible_shapes of this Shape.
Return type:	list[str]

shape¶

[Required] Gets the shape of this Shape. The name of the shape. You can enumerate all available shapes by calling list_shapes().

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