File: //proc/self/root/lib/mysqlsh/lib/python3.8/site-packages/oci/core/models/launch_instance_details.py
# coding: utf-8
# Copyright (c) 2016, 2025, Oracle and/or its affiliates. All rights reserved.
# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20160918
from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401
from oci.decorators import init_model_state_from_kwargs
@init_model_state_from_kwargs
class LaunchInstanceDetails(object):
"""
Instance launch details.
Use the `sourceDetails` parameter to specify whether a boot volume or an image should be used to launch a new instance.
"""
def __init__(self, **kwargs):
"""
Initializes a new LaunchInstanceDetails object with values from keyword arguments.
The following keyword arguments are supported (corresponding to the getters/setters of this class):
:param availability_domain:
The value to assign to the availability_domain property of this LaunchInstanceDetails.
:type availability_domain: str
:param capacity_reservation_id:
The value to assign to the capacity_reservation_id property of this LaunchInstanceDetails.
:type capacity_reservation_id: str
:param compartment_id:
The value to assign to the compartment_id property of this LaunchInstanceDetails.
:type compartment_id: str
:param create_vnic_details:
The value to assign to the create_vnic_details property of this LaunchInstanceDetails.
:type create_vnic_details: oci.core.models.CreateVnicDetails
:param dedicated_vm_host_id:
The value to assign to the dedicated_vm_host_id property of this LaunchInstanceDetails.
:type dedicated_vm_host_id: str
:param defined_tags:
The value to assign to the defined_tags property of this LaunchInstanceDetails.
:type defined_tags: dict(str, dict(str, object))
:param security_attributes:
The value to assign to the security_attributes property of this LaunchInstanceDetails.
:type security_attributes: dict(str, dict(str, object))
:param display_name:
The value to assign to the display_name property of this LaunchInstanceDetails.
:type display_name: str
:param extended_metadata:
The value to assign to the extended_metadata property of this LaunchInstanceDetails.
:type extended_metadata: dict(str, object)
:param fault_domain:
The value to assign to the fault_domain property of this LaunchInstanceDetails.
:type fault_domain: str
:param cluster_placement_group_id:
The value to assign to the cluster_placement_group_id property of this LaunchInstanceDetails.
:type cluster_placement_group_id: str
:param freeform_tags:
The value to assign to the freeform_tags property of this LaunchInstanceDetails.
:type freeform_tags: dict(str, str)
:param compute_host_group_id:
The value to assign to the compute_host_group_id property of this LaunchInstanceDetails.
:type compute_host_group_id: str
:param compute_cluster_id:
The value to assign to the compute_cluster_id property of this LaunchInstanceDetails.
:type compute_cluster_id: str
:param hostname_label:
The value to assign to the hostname_label property of this LaunchInstanceDetails.
:type hostname_label: str
:param image_id:
The value to assign to the image_id property of this LaunchInstanceDetails.
:type image_id: str
:param ipxe_script:
The value to assign to the ipxe_script property of this LaunchInstanceDetails.
:type ipxe_script: str
:param launch_options:
The value to assign to the launch_options property of this LaunchInstanceDetails.
:type launch_options: oci.core.models.LaunchOptions
:param instance_options:
The value to assign to the instance_options property of this LaunchInstanceDetails.
:type instance_options: oci.core.models.InstanceOptions
:param availability_config:
The value to assign to the availability_config property of this LaunchInstanceDetails.
:type availability_config: oci.core.models.LaunchInstanceAvailabilityConfigDetails
:param preemptible_instance_config:
The value to assign to the preemptible_instance_config property of this LaunchInstanceDetails.
:type preemptible_instance_config: oci.core.models.PreemptibleInstanceConfigDetails
:param metadata:
The value to assign to the metadata property of this LaunchInstanceDetails.
:type metadata: dict(str, str)
:param agent_config:
The value to assign to the agent_config property of this LaunchInstanceDetails.
:type agent_config: oci.core.models.LaunchInstanceAgentConfigDetails
:param shape:
The value to assign to the shape property of this LaunchInstanceDetails.
:type shape: str
:param shape_config:
The value to assign to the shape_config property of this LaunchInstanceDetails.
:type shape_config: oci.core.models.LaunchInstanceShapeConfigDetails
:param source_details:
The value to assign to the source_details property of this LaunchInstanceDetails.
:type source_details: oci.core.models.InstanceSourceDetails
:param subnet_id:
The value to assign to the subnet_id property of this LaunchInstanceDetails.
:type subnet_id: str
:param launch_volume_attachments:
The value to assign to the launch_volume_attachments property of this LaunchInstanceDetails.
:type launch_volume_attachments: list[oci.core.models.LaunchAttachVolumeDetails]
:param is_pv_encryption_in_transit_enabled:
The value to assign to the is_pv_encryption_in_transit_enabled property of this LaunchInstanceDetails.
:type is_pv_encryption_in_transit_enabled: bool
:param platform_config:
The value to assign to the platform_config property of this LaunchInstanceDetails.
:type platform_config: oci.core.models.LaunchInstancePlatformConfig
:param placement_constraint_details:
The value to assign to the placement_constraint_details property of this LaunchInstanceDetails.
:type placement_constraint_details: oci.core.models.PlacementConstraintDetails
:param instance_configuration_id:
The value to assign to the instance_configuration_id property of this LaunchInstanceDetails.
:type instance_configuration_id: str
:param licensing_configs:
The value to assign to the licensing_configs property of this LaunchInstanceDetails.
:type licensing_configs: list[oci.core.models.LaunchInstanceLicensingConfig]
"""
self.swagger_types = {
'availability_domain': 'str',
'capacity_reservation_id': 'str',
'compartment_id': 'str',
'create_vnic_details': 'CreateVnicDetails',
'dedicated_vm_host_id': 'str',
'defined_tags': 'dict(str, dict(str, object))',
'security_attributes': 'dict(str, dict(str, object))',
'display_name': 'str',
'extended_metadata': 'dict(str, object)',
'fault_domain': 'str',
'cluster_placement_group_id': 'str',
'freeform_tags': 'dict(str, str)',
'compute_host_group_id': 'str',
'compute_cluster_id': 'str',
'hostname_label': 'str',
'image_id': 'str',
'ipxe_script': 'str',
'launch_options': 'LaunchOptions',
'instance_options': 'InstanceOptions',
'availability_config': 'LaunchInstanceAvailabilityConfigDetails',
'preemptible_instance_config': 'PreemptibleInstanceConfigDetails',
'metadata': 'dict(str, str)',
'agent_config': 'LaunchInstanceAgentConfigDetails',
'shape': 'str',
'shape_config': 'LaunchInstanceShapeConfigDetails',
'source_details': 'InstanceSourceDetails',
'subnet_id': 'str',
'launch_volume_attachments': 'list[LaunchAttachVolumeDetails]',
'is_pv_encryption_in_transit_enabled': 'bool',
'platform_config': 'LaunchInstancePlatformConfig',
'placement_constraint_details': 'PlacementConstraintDetails',
'instance_configuration_id': 'str',
'licensing_configs': 'list[LaunchInstanceLicensingConfig]'
}
self.attribute_map = {
'availability_domain': 'availabilityDomain',
'capacity_reservation_id': 'capacityReservationId',
'compartment_id': 'compartmentId',
'create_vnic_details': 'createVnicDetails',
'dedicated_vm_host_id': 'dedicatedVmHostId',
'defined_tags': 'definedTags',
'security_attributes': 'securityAttributes',
'display_name': 'displayName',
'extended_metadata': 'extendedMetadata',
'fault_domain': 'faultDomain',
'cluster_placement_group_id': 'clusterPlacementGroupId',
'freeform_tags': 'freeformTags',
'compute_host_group_id': 'computeHostGroupId',
'compute_cluster_id': 'computeClusterId',
'hostname_label': 'hostnameLabel',
'image_id': 'imageId',
'ipxe_script': 'ipxeScript',
'launch_options': 'launchOptions',
'instance_options': 'instanceOptions',
'availability_config': 'availabilityConfig',
'preemptible_instance_config': 'preemptibleInstanceConfig',
'metadata': 'metadata',
'agent_config': 'agentConfig',
'shape': 'shape',
'shape_config': 'shapeConfig',
'source_details': 'sourceDetails',
'subnet_id': 'subnetId',
'launch_volume_attachments': 'launchVolumeAttachments',
'is_pv_encryption_in_transit_enabled': 'isPvEncryptionInTransitEnabled',
'platform_config': 'platformConfig',
'placement_constraint_details': 'placementConstraintDetails',
'instance_configuration_id': 'instanceConfigurationId',
'licensing_configs': 'licensingConfigs'
}
self._availability_domain = None
self._capacity_reservation_id = None
self._compartment_id = None
self._create_vnic_details = None
self._dedicated_vm_host_id = None
self._defined_tags = None
self._security_attributes = None
self._display_name = None
self._extended_metadata = None
self._fault_domain = None
self._cluster_placement_group_id = None
self._freeform_tags = None
self._compute_host_group_id = None
self._compute_cluster_id = None
self._hostname_label = None
self._image_id = None
self._ipxe_script = None
self._launch_options = None
self._instance_options = None
self._availability_config = None
self._preemptible_instance_config = None
self._metadata = None
self._agent_config = None
self._shape = None
self._shape_config = None
self._source_details = None
self._subnet_id = None
self._launch_volume_attachments = None
self._is_pv_encryption_in_transit_enabled = None
self._platform_config = None
self._placement_constraint_details = None
self._instance_configuration_id = None
self._licensing_configs = None
@property
def availability_domain(self):
"""
**[Required]** Gets the availability_domain of this LaunchInstanceDetails.
The availability domain of the instance.
Example: `Uocm:PHX-AD-1`
:return: The availability_domain of this LaunchInstanceDetails.
:rtype: str
"""
return self._availability_domain
@availability_domain.setter
def availability_domain(self, availability_domain):
"""
Sets the availability_domain of this LaunchInstanceDetails.
The availability domain of the instance.
Example: `Uocm:PHX-AD-1`
:param availability_domain: The availability_domain of this LaunchInstanceDetails.
:type: str
"""
self._availability_domain = availability_domain
@property
def capacity_reservation_id(self):
"""
Gets the capacity_reservation_id of this LaunchInstanceDetails.
The OCID of the compute capacity reservation this instance is launched under.
You can opt out of all default reservations by specifying an empty string as input for this field.
For more information, see `Capacity Reservations`__.
__ https://docs.cloud.oracle.com/iaas/Content/Compute/Tasks/reserve-capacity.htm#default
:return: The capacity_reservation_id of this LaunchInstanceDetails.
:rtype: str
"""
return self._capacity_reservation_id
@capacity_reservation_id.setter
def capacity_reservation_id(self, capacity_reservation_id):
"""
Sets the capacity_reservation_id of this LaunchInstanceDetails.
The OCID of the compute capacity reservation this instance is launched under.
You can opt out of all default reservations by specifying an empty string as input for this field.
For more information, see `Capacity Reservations`__.
__ https://docs.cloud.oracle.com/iaas/Content/Compute/Tasks/reserve-capacity.htm#default
:param capacity_reservation_id: The capacity_reservation_id of this LaunchInstanceDetails.
:type: str
"""
self._capacity_reservation_id = capacity_reservation_id
@property
def compartment_id(self):
"""
**[Required]** Gets the compartment_id of this LaunchInstanceDetails.
The OCID of the compartment.
:return: The compartment_id of this LaunchInstanceDetails.
:rtype: str
"""
return self._compartment_id
@compartment_id.setter
def compartment_id(self, compartment_id):
"""
Sets the compartment_id of this LaunchInstanceDetails.
The OCID of the compartment.
:param compartment_id: The compartment_id of this LaunchInstanceDetails.
:type: str
"""
self._compartment_id = compartment_id
@property
def create_vnic_details(self):
"""
Gets the create_vnic_details of this LaunchInstanceDetails.
:return: The create_vnic_details of this LaunchInstanceDetails.
:rtype: oci.core.models.CreateVnicDetails
"""
return self._create_vnic_details
@create_vnic_details.setter
def create_vnic_details(self, create_vnic_details):
"""
Sets the create_vnic_details of this LaunchInstanceDetails.
:param create_vnic_details: The create_vnic_details of this LaunchInstanceDetails.
:type: oci.core.models.CreateVnicDetails
"""
self._create_vnic_details = create_vnic_details
@property
def dedicated_vm_host_id(self):
"""
Gets the dedicated_vm_host_id of this LaunchInstanceDetails.
The OCID of the dedicated virtual machine host to place the instance on.
:return: The dedicated_vm_host_id of this LaunchInstanceDetails.
:rtype: str
"""
return self._dedicated_vm_host_id
@dedicated_vm_host_id.setter
def dedicated_vm_host_id(self, dedicated_vm_host_id):
"""
Sets the dedicated_vm_host_id of this LaunchInstanceDetails.
The OCID of the dedicated virtual machine host to place the instance on.
:param dedicated_vm_host_id: The dedicated_vm_host_id of this LaunchInstanceDetails.
:type: str
"""
self._dedicated_vm_host_id = dedicated_vm_host_id
@property
def defined_tags(self):
"""
Gets the defined_tags of this LaunchInstanceDetails.
Defined tags for this resource. Each key is predefined and scoped to a
namespace. For more information, see `Resource Tags`__.
Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`
__ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm
:return: The defined_tags of this LaunchInstanceDetails.
:rtype: dict(str, dict(str, object))
"""
return self._defined_tags
@defined_tags.setter
def defined_tags(self, defined_tags):
"""
Sets the defined_tags of this LaunchInstanceDetails.
Defined tags for this resource. Each key is predefined and scoped to a
namespace. For more information, see `Resource Tags`__.
Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`
__ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm
:param defined_tags: The defined_tags of this LaunchInstanceDetails.
:type: dict(str, dict(str, object))
"""
self._defined_tags = defined_tags
@property
def security_attributes(self):
"""
Gets the security_attributes of this LaunchInstanceDetails.
`Security attributes`__ are labels
for a resource that can be referenced in a `Zero Trust Packet Routing`__
(ZPR) policy to control access to ZPR-supported resources.
Example: `{\"Oracle-DataSecurity-ZPR\": {\"MaxEgressCount\": {\"value\":\"42\",\"mode\":\"audit\"}}}`
__ https://docs.cloud.oracle.com/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attributes
__ https://docs.cloud.oracle.com/iaas/Content/zero-trust-packet-routing/overview.htm
:return: The security_attributes of this LaunchInstanceDetails.
:rtype: dict(str, dict(str, object))
"""
return self._security_attributes
@security_attributes.setter
def security_attributes(self, security_attributes):
"""
Sets the security_attributes of this LaunchInstanceDetails.
`Security attributes`__ are labels
for a resource that can be referenced in a `Zero Trust Packet Routing`__
(ZPR) policy to control access to ZPR-supported resources.
Example: `{\"Oracle-DataSecurity-ZPR\": {\"MaxEgressCount\": {\"value\":\"42\",\"mode\":\"audit\"}}}`
__ https://docs.cloud.oracle.com/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attributes
__ https://docs.cloud.oracle.com/iaas/Content/zero-trust-packet-routing/overview.htm
:param security_attributes: The security_attributes of this LaunchInstanceDetails.
:type: dict(str, dict(str, object))
"""
self._security_attributes = security_attributes
@property
def display_name(self):
"""
Gets the display_name of this LaunchInstanceDetails.
A user-friendly name. Does not have to be unique, and it's changeable.
Avoid entering confidential information.
:return: The display_name of this LaunchInstanceDetails.
:rtype: str
"""
return self._display_name
@display_name.setter
def display_name(self, display_name):
"""
Sets the display_name of this LaunchInstanceDetails.
A user-friendly name. Does not have to be unique, and it's changeable.
Avoid entering confidential information.
:param display_name: The display_name of this LaunchInstanceDetails.
:type: str
"""
self._display_name = display_name
@property
def extended_metadata(self):
"""
Gets the extended_metadata of this LaunchInstanceDetails.
Additional metadata key/value pairs that you provide. They serve the same purpose and
functionality as fields in the `metadata` object.
They are distinguished from `metadata` fields in that these can be nested JSON objects
(whereas `metadata` fields are string/string maps only).
The combined size of the `metadata` and `extendedMetadata` objects can be a maximum of
32,000 bytes.
:return: The extended_metadata of this LaunchInstanceDetails.
:rtype: dict(str, object)
"""
return self._extended_metadata
@extended_metadata.setter
def extended_metadata(self, extended_metadata):
"""
Sets the extended_metadata of this LaunchInstanceDetails.
Additional metadata key/value pairs that you provide. They serve the same purpose and
functionality as fields in the `metadata` object.
They are distinguished from `metadata` fields in that these can be nested JSON objects
(whereas `metadata` fields are string/string maps only).
The combined size of the `metadata` and `extendedMetadata` objects can be a maximum of
32,000 bytes.
:param extended_metadata: The extended_metadata of this LaunchInstanceDetails.
:type: dict(str, object)
"""
self._extended_metadata = extended_metadata
@property
def fault_domain(self):
"""
Gets the fault_domain of this LaunchInstanceDetails.
A fault domain is a grouping of hardware and infrastructure within an availability domain.
Each availability domain contains three fault domains. Fault domains let you distribute your
instances so that they are not on the same physical hardware within a single availability domain.
A hardware failure or Compute hardware maintenance that affects one fault domain does not affect
instances in other fault domains.
If you do not specify the fault domain, the system selects one for you.
To get a list of fault domains, use the
:func:`list_fault_domains` operation in the
Identity and Access Management Service API.
Example: `FAULT-DOMAIN-1`
:return: The fault_domain of this LaunchInstanceDetails.
:rtype: str
"""
return self._fault_domain
@fault_domain.setter
def fault_domain(self, fault_domain):
"""
Sets the fault_domain of this LaunchInstanceDetails.
A fault domain is a grouping of hardware and infrastructure within an availability domain.
Each availability domain contains three fault domains. Fault domains let you distribute your
instances so that they are not on the same physical hardware within a single availability domain.
A hardware failure or Compute hardware maintenance that affects one fault domain does not affect
instances in other fault domains.
If you do not specify the fault domain, the system selects one for you.
To get a list of fault domains, use the
:func:`list_fault_domains` operation in the
Identity and Access Management Service API.
Example: `FAULT-DOMAIN-1`
:param fault_domain: The fault_domain of this LaunchInstanceDetails.
:type: str
"""
self._fault_domain = fault_domain
@property
def cluster_placement_group_id(self):
"""
Gets the cluster_placement_group_id of this LaunchInstanceDetails.
The OCID of the cluster placement group of the instance.
:return: The cluster_placement_group_id of this LaunchInstanceDetails.
:rtype: str
"""
return self._cluster_placement_group_id
@cluster_placement_group_id.setter
def cluster_placement_group_id(self, cluster_placement_group_id):
"""
Sets the cluster_placement_group_id of this LaunchInstanceDetails.
The OCID of the cluster placement group of the instance.
:param cluster_placement_group_id: The cluster_placement_group_id of this LaunchInstanceDetails.
:type: str
"""
self._cluster_placement_group_id = cluster_placement_group_id
@property
def freeform_tags(self):
"""
Gets the freeform_tags of this LaunchInstanceDetails.
Free-form tags for this resource. Each tag is a simple key-value pair with no
predefined name, type, or namespace. For more information, see `Resource Tags`__.
Example: `{\"Department\": \"Finance\"}`
__ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm
:return: The freeform_tags of this LaunchInstanceDetails.
:rtype: dict(str, str)
"""
return self._freeform_tags
@freeform_tags.setter
def freeform_tags(self, freeform_tags):
"""
Sets the freeform_tags of this LaunchInstanceDetails.
Free-form tags for this resource. Each tag is a simple key-value pair with no
predefined name, type, or namespace. For more information, see `Resource Tags`__.
Example: `{\"Department\": \"Finance\"}`
__ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm
:param freeform_tags: The freeform_tags of this LaunchInstanceDetails.
:type: dict(str, str)
"""
self._freeform_tags = freeform_tags
@property
def compute_host_group_id(self):
"""
Gets the compute_host_group_id of this LaunchInstanceDetails.
The OCID of the compute host group attached to the host where the bare metal instance will be launched.
:return: The compute_host_group_id of this LaunchInstanceDetails.
:rtype: str
"""
return self._compute_host_group_id
@compute_host_group_id.setter
def compute_host_group_id(self, compute_host_group_id):
"""
Sets the compute_host_group_id of this LaunchInstanceDetails.
The OCID of the compute host group attached to the host where the bare metal instance will be launched.
:param compute_host_group_id: The compute_host_group_id of this LaunchInstanceDetails.
:type: str
"""
self._compute_host_group_id = compute_host_group_id
@property
def compute_cluster_id(self):
"""
Gets the compute_cluster_id of this LaunchInstanceDetails.
The `OCID`__ of the
`compute cluster`__ that the instance will be created in.
__ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm
__ https://docs.cloud.oracle.com/iaas/Content/Compute/Tasks/compute-clusters.htm
:return: The compute_cluster_id of this LaunchInstanceDetails.
:rtype: str
"""
return self._compute_cluster_id
@compute_cluster_id.setter
def compute_cluster_id(self, compute_cluster_id):
"""
Sets the compute_cluster_id of this LaunchInstanceDetails.
The `OCID`__ of the
`compute cluster`__ that the instance will be created in.
__ https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm
__ https://docs.cloud.oracle.com/iaas/Content/Compute/Tasks/compute-clusters.htm
:param compute_cluster_id: The compute_cluster_id of this LaunchInstanceDetails.
:type: str
"""
self._compute_cluster_id = compute_cluster_id
@property
def hostname_label(self):
"""
Gets the hostname_label of this LaunchInstanceDetails.
Deprecated. Instead use `hostnameLabel` in
:class:`CreateVnicDetails`.
If you provide both, the values must match.
:return: The hostname_label of this LaunchInstanceDetails.
:rtype: str
"""
return self._hostname_label
@hostname_label.setter
def hostname_label(self, hostname_label):
"""
Sets the hostname_label of this LaunchInstanceDetails.
Deprecated. Instead use `hostnameLabel` in
:class:`CreateVnicDetails`.
If you provide both, the values must match.
:param hostname_label: The hostname_label of this LaunchInstanceDetails.
:type: str
"""
self._hostname_label = hostname_label
@property
def image_id(self):
"""
Gets the image_id of this LaunchInstanceDetails.
Deprecated. Use `sourceDetails` with :func:`instance_source_via_image_details`
source type instead. If you specify values for both, the values must match.
:return: The image_id of this LaunchInstanceDetails.
:rtype: str
"""
return self._image_id
@image_id.setter
def image_id(self, image_id):
"""
Sets the image_id of this LaunchInstanceDetails.
Deprecated. Use `sourceDetails` with :func:`instance_source_via_image_details`
source type instead. If you specify values for both, the values must match.
:param image_id: The image_id of this LaunchInstanceDetails.
:type: str
"""
self._image_id = image_id
@property
def ipxe_script(self):
"""
Gets the ipxe_script of this LaunchInstanceDetails.
This is an advanced option.
When a bare metal or virtual machine
instance boots, the iPXE firmware that runs on the instance is
configured to run an iPXE script to continue the boot process.
If you want more control over the boot process, you can provide
your own custom iPXE script that will run when the instance boots.
Be aware that the same iPXE script will run
every time an instance boots, not only after the initial
LaunchInstance call.
The default iPXE script connects to the instance's local boot
volume over iSCSI and performs a network boot. If you use a custom iPXE
script and want to network-boot from the instance's local boot volume
over iSCSI the same way as the default iPXE script, use the
following iSCSI IP address: 169.254.0.2, and boot volume IQN:
iqn.2015-02.oracle.boot.
If your instance boot volume attachment type is paravirtualized,
the boot volume is attached to the instance through virtio-scsi and no iPXE script is used.
If your instance boot volume attachment type is paravirtualized
and you use custom iPXE to network boot into your instance,
the primary boot volume is attached as a data volume through virtio-scsi drive.
For more information about the Bring Your Own Image feature of
Oracle Cloud Infrastructure, see
`Bring Your Own Image`__.
For more information about iPXE, see http://ipxe.org.
__ https://docs.cloud.oracle.com/iaas/Content/Compute/References/bringyourownimage.htm
:return: The ipxe_script of this LaunchInstanceDetails.
:rtype: str
"""
return self._ipxe_script
@ipxe_script.setter
def ipxe_script(self, ipxe_script):
"""
Sets the ipxe_script of this LaunchInstanceDetails.
This is an advanced option.
When a bare metal or virtual machine
instance boots, the iPXE firmware that runs on the instance is
configured to run an iPXE script to continue the boot process.
If you want more control over the boot process, you can provide
your own custom iPXE script that will run when the instance boots.
Be aware that the same iPXE script will run
every time an instance boots, not only after the initial
LaunchInstance call.
The default iPXE script connects to the instance's local boot
volume over iSCSI and performs a network boot. If you use a custom iPXE
script and want to network-boot from the instance's local boot volume
over iSCSI the same way as the default iPXE script, use the
following iSCSI IP address: 169.254.0.2, and boot volume IQN:
iqn.2015-02.oracle.boot.
If your instance boot volume attachment type is paravirtualized,
the boot volume is attached to the instance through virtio-scsi and no iPXE script is used.
If your instance boot volume attachment type is paravirtualized
and you use custom iPXE to network boot into your instance,
the primary boot volume is attached as a data volume through virtio-scsi drive.
For more information about the Bring Your Own Image feature of
Oracle Cloud Infrastructure, see
`Bring Your Own Image`__.
For more information about iPXE, see http://ipxe.org.
__ https://docs.cloud.oracle.com/iaas/Content/Compute/References/bringyourownimage.htm
:param ipxe_script: The ipxe_script of this LaunchInstanceDetails.
:type: str
"""
self._ipxe_script = ipxe_script
@property
def launch_options(self):
"""
Gets the launch_options of this LaunchInstanceDetails.
:return: The launch_options of this LaunchInstanceDetails.
:rtype: oci.core.models.LaunchOptions
"""
return self._launch_options
@launch_options.setter
def launch_options(self, launch_options):
"""
Sets the launch_options of this LaunchInstanceDetails.
:param launch_options: The launch_options of this LaunchInstanceDetails.
:type: oci.core.models.LaunchOptions
"""
self._launch_options = launch_options
@property
def instance_options(self):
"""
Gets the instance_options of this LaunchInstanceDetails.
:return: The instance_options of this LaunchInstanceDetails.
:rtype: oci.core.models.InstanceOptions
"""
return self._instance_options
@instance_options.setter
def instance_options(self, instance_options):
"""
Sets the instance_options of this LaunchInstanceDetails.
:param instance_options: The instance_options of this LaunchInstanceDetails.
:type: oci.core.models.InstanceOptions
"""
self._instance_options = instance_options
@property
def availability_config(self):
"""
Gets the availability_config of this LaunchInstanceDetails.
:return: The availability_config of this LaunchInstanceDetails.
:rtype: oci.core.models.LaunchInstanceAvailabilityConfigDetails
"""
return self._availability_config
@availability_config.setter
def availability_config(self, availability_config):
"""
Sets the availability_config of this LaunchInstanceDetails.
:param availability_config: The availability_config of this LaunchInstanceDetails.
:type: oci.core.models.LaunchInstanceAvailabilityConfigDetails
"""
self._availability_config = availability_config
@property
def preemptible_instance_config(self):
"""
Gets the preemptible_instance_config of this LaunchInstanceDetails.
:return: The preemptible_instance_config of this LaunchInstanceDetails.
:rtype: oci.core.models.PreemptibleInstanceConfigDetails
"""
return self._preemptible_instance_config
@preemptible_instance_config.setter
def preemptible_instance_config(self, preemptible_instance_config):
"""
Sets the preemptible_instance_config of this LaunchInstanceDetails.
:param preemptible_instance_config: The preemptible_instance_config of this LaunchInstanceDetails.
:type: oci.core.models.PreemptibleInstanceConfigDetails
"""
self._preemptible_instance_config = preemptible_instance_config
@property
def metadata(self):
"""
Gets the metadata of this LaunchInstanceDetails.
Custom metadata key/value pairs that you provide, such as the SSH public key
required to connect to the instance.
A metadata service runs on every launched instance. The service is an HTTP
endpoint listening on 169.254.169.254. You can use the service to:
* Provide information to `Cloud-Init`__
to be used for various system initialization tasks.
* Get information about the instance, including the custom metadata that you
provide when you launch the instance.
**Providing Cloud-Init Metadata**
You can use the following metadata key names to provide information to
Cloud-Init:
**\"ssh_authorized_keys\"** - Provide one or more public SSH keys to be
included in the `~/.ssh/authorized_keys` file for the default user on the
instance. Use a newline character to separate multiple keys. The SSH
keys must be in the format necessary for the `authorized_keys` file, as shown
in the example below.
**\"user_data\"** - Provide your own base64-encoded data to be used by
Cloud-Init to run custom scripts or provide custom Cloud-Init configuration. For
information about how to take advantage of user data, see the
`Cloud-Init Documentation`__.
**Metadata Example**
\"metadata\" : {
\"quake_bot_level\" : \"Severe\",
\"ssh_authorized_keys\" : \"ssh-rsa <your_public_SSH_key>== rsa-key-20160227\",
\"user_data\" : \"<your_public_SSH_key>==\"
}
**Getting Metadata on the Instance**
To get information about your instance, connect to the instance using SSH and issue any of the
following GET requests:
curl -H \"Authorization: Bearer Oracle\" http://169.254.169.254/opc/v2/instance/
curl -H \"Authorization: Bearer Oracle\" http://169.254.169.254/opc/v2/instance/metadata/
curl -H \"Authorization: Bearer Oracle\" http://169.254.169.254/opc/v2/instance/metadata/<any-key-name>
You'll get back a response that includes all the instance information; only the metadata information; or
the metadata information for the specified key name, respectively.
The combined size of the `metadata` and `extendedMetadata` objects can be a maximum of 32,000 bytes.
__ https://cloudinit.readthedocs.org/en/latest/
__ http://cloudinit.readthedocs.org/en/latest/topics/format.html
:return: The metadata of this LaunchInstanceDetails.
:rtype: dict(str, str)
"""
return self._metadata
@metadata.setter
def metadata(self, metadata):
"""
Sets the metadata of this LaunchInstanceDetails.
Custom metadata key/value pairs that you provide, such as the SSH public key
required to connect to the instance.
A metadata service runs on every launched instance. The service is an HTTP
endpoint listening on 169.254.169.254. You can use the service to:
* Provide information to `Cloud-Init`__
to be used for various system initialization tasks.
* Get information about the instance, including the custom metadata that you
provide when you launch the instance.
**Providing Cloud-Init Metadata**
You can use the following metadata key names to provide information to
Cloud-Init:
**\"ssh_authorized_keys\"** - Provide one or more public SSH keys to be
included in the `~/.ssh/authorized_keys` file for the default user on the
instance. Use a newline character to separate multiple keys. The SSH
keys must be in the format necessary for the `authorized_keys` file, as shown
in the example below.
**\"user_data\"** - Provide your own base64-encoded data to be used by
Cloud-Init to run custom scripts or provide custom Cloud-Init configuration. For
information about how to take advantage of user data, see the
`Cloud-Init Documentation`__.
**Metadata Example**
\"metadata\" : {
\"quake_bot_level\" : \"Severe\",
\"ssh_authorized_keys\" : \"ssh-rsa <your_public_SSH_key>== rsa-key-20160227\",
\"user_data\" : \"<your_public_SSH_key>==\"
}
**Getting Metadata on the Instance**
To get information about your instance, connect to the instance using SSH and issue any of the
following GET requests:
curl -H \"Authorization: Bearer Oracle\" http://169.254.169.254/opc/v2/instance/
curl -H \"Authorization: Bearer Oracle\" http://169.254.169.254/opc/v2/instance/metadata/
curl -H \"Authorization: Bearer Oracle\" http://169.254.169.254/opc/v2/instance/metadata/<any-key-name>
You'll get back a response that includes all the instance information; only the metadata information; or
the metadata information for the specified key name, respectively.
The combined size of the `metadata` and `extendedMetadata` objects can be a maximum of 32,000 bytes.
__ https://cloudinit.readthedocs.org/en/latest/
__ http://cloudinit.readthedocs.org/en/latest/topics/format.html
:param metadata: The metadata of this LaunchInstanceDetails.
:type: dict(str, str)
"""
self._metadata = metadata
@property
def agent_config(self):
"""
Gets the agent_config of this LaunchInstanceDetails.
:return: The agent_config of this LaunchInstanceDetails.
:rtype: oci.core.models.LaunchInstanceAgentConfigDetails
"""
return self._agent_config
@agent_config.setter
def agent_config(self, agent_config):
"""
Sets the agent_config of this LaunchInstanceDetails.
:param agent_config: The agent_config of this LaunchInstanceDetails.
:type: oci.core.models.LaunchInstanceAgentConfigDetails
"""
self._agent_config = agent_config
@property
def shape(self):
"""
Gets the shape of this LaunchInstanceDetails.
The shape of an instance. The shape determines the number of CPUs, amount of memory,
and other resources allocated to the instance.
You can enumerate all available shapes by calling :func:`list_shapes`.
:return: The shape of this LaunchInstanceDetails.
:rtype: str
"""
return self._shape
@shape.setter
def shape(self, shape):
"""
Sets the shape of this LaunchInstanceDetails.
The shape of an instance. The shape determines the number of CPUs, amount of memory,
and other resources allocated to the instance.
You can enumerate all available shapes by calling :func:`list_shapes`.
:param shape: The shape of this LaunchInstanceDetails.
:type: str
"""
self._shape = shape
@property
def shape_config(self):
"""
Gets the shape_config of this LaunchInstanceDetails.
:return: The shape_config of this LaunchInstanceDetails.
:rtype: oci.core.models.LaunchInstanceShapeConfigDetails
"""
return self._shape_config
@shape_config.setter
def shape_config(self, shape_config):
"""
Sets the shape_config of this LaunchInstanceDetails.
:param shape_config: The shape_config of this LaunchInstanceDetails.
:type: oci.core.models.LaunchInstanceShapeConfigDetails
"""
self._shape_config = shape_config
@property
def source_details(self):
"""
Gets the source_details of this LaunchInstanceDetails.
:return: The source_details of this LaunchInstanceDetails.
:rtype: oci.core.models.InstanceSourceDetails
"""
return self._source_details
@source_details.setter
def source_details(self, source_details):
"""
Sets the source_details of this LaunchInstanceDetails.
:param source_details: The source_details of this LaunchInstanceDetails.
:type: oci.core.models.InstanceSourceDetails
"""
self._source_details = source_details
@property
def subnet_id(self):
"""
Gets the subnet_id of this LaunchInstanceDetails.
Deprecated. Instead use `subnetId` in
:class:`CreateVnicDetails`.
At least one of them is required; if you provide both, the values must match.
:return: The subnet_id of this LaunchInstanceDetails.
:rtype: str
"""
return self._subnet_id
@subnet_id.setter
def subnet_id(self, subnet_id):
"""
Sets the subnet_id of this LaunchInstanceDetails.
Deprecated. Instead use `subnetId` in
:class:`CreateVnicDetails`.
At least one of them is required; if you provide both, the values must match.
:param subnet_id: The subnet_id of this LaunchInstanceDetails.
:type: str
"""
self._subnet_id = subnet_id
@property
def launch_volume_attachments(self):
"""
Gets the launch_volume_attachments of this LaunchInstanceDetails.
Volume attachments to create as part of the launch instance operation.
:return: The launch_volume_attachments of this LaunchInstanceDetails.
:rtype: list[oci.core.models.LaunchAttachVolumeDetails]
"""
return self._launch_volume_attachments
@launch_volume_attachments.setter
def launch_volume_attachments(self, launch_volume_attachments):
"""
Sets the launch_volume_attachments of this LaunchInstanceDetails.
Volume attachments to create as part of the launch instance operation.
:param launch_volume_attachments: The launch_volume_attachments of this LaunchInstanceDetails.
:type: list[oci.core.models.LaunchAttachVolumeDetails]
"""
self._launch_volume_attachments = launch_volume_attachments
@property
def is_pv_encryption_in_transit_enabled(self):
"""
Gets the is_pv_encryption_in_transit_enabled of this LaunchInstanceDetails.
Whether to enable in-transit encryption for the data volume's paravirtualized attachment. This field applies to both block volumes and boot volumes. The default value is false.
:return: The is_pv_encryption_in_transit_enabled of this LaunchInstanceDetails.
:rtype: bool
"""
return self._is_pv_encryption_in_transit_enabled
@is_pv_encryption_in_transit_enabled.setter
def is_pv_encryption_in_transit_enabled(self, is_pv_encryption_in_transit_enabled):
"""
Sets the is_pv_encryption_in_transit_enabled of this LaunchInstanceDetails.
Whether to enable in-transit encryption for the data volume's paravirtualized attachment. This field applies to both block volumes and boot volumes. The default value is false.
:param is_pv_encryption_in_transit_enabled: The is_pv_encryption_in_transit_enabled of this LaunchInstanceDetails.
:type: bool
"""
self._is_pv_encryption_in_transit_enabled = is_pv_encryption_in_transit_enabled
@property
def platform_config(self):
"""
Gets the platform_config of this LaunchInstanceDetails.
:return: The platform_config of this LaunchInstanceDetails.
:rtype: oci.core.models.LaunchInstancePlatformConfig
"""
return self._platform_config
@platform_config.setter
def platform_config(self, platform_config):
"""
Sets the platform_config of this LaunchInstanceDetails.
:param platform_config: The platform_config of this LaunchInstanceDetails.
:type: oci.core.models.LaunchInstancePlatformConfig
"""
self._platform_config = platform_config
@property
def placement_constraint_details(self):
"""
Gets the placement_constraint_details of this LaunchInstanceDetails.
:return: The placement_constraint_details of this LaunchInstanceDetails.
:rtype: oci.core.models.PlacementConstraintDetails
"""
return self._placement_constraint_details
@placement_constraint_details.setter
def placement_constraint_details(self, placement_constraint_details):
"""
Sets the placement_constraint_details of this LaunchInstanceDetails.
:param placement_constraint_details: The placement_constraint_details of this LaunchInstanceDetails.
:type: oci.core.models.PlacementConstraintDetails
"""
self._placement_constraint_details = placement_constraint_details
@property
def instance_configuration_id(self):
"""
Gets the instance_configuration_id of this LaunchInstanceDetails.
The OCID of the Instance Configuration containing instance launch details. Any other fields supplied in this instance launch request will override the details stored in the Instance Configuration for this instance launch.
:return: The instance_configuration_id of this LaunchInstanceDetails.
:rtype: str
"""
return self._instance_configuration_id
@instance_configuration_id.setter
def instance_configuration_id(self, instance_configuration_id):
"""
Sets the instance_configuration_id of this LaunchInstanceDetails.
The OCID of the Instance Configuration containing instance launch details. Any other fields supplied in this instance launch request will override the details stored in the Instance Configuration for this instance launch.
:param instance_configuration_id: The instance_configuration_id of this LaunchInstanceDetails.
:type: str
"""
self._instance_configuration_id = instance_configuration_id
@property
def licensing_configs(self):
"""
Gets the licensing_configs of this LaunchInstanceDetails.
List of licensing configurations associated with target launch values.
:return: The licensing_configs of this LaunchInstanceDetails.
:rtype: list[oci.core.models.LaunchInstanceLicensingConfig]
"""
return self._licensing_configs
@licensing_configs.setter
def licensing_configs(self, licensing_configs):
"""
Sets the licensing_configs of this LaunchInstanceDetails.
List of licensing configurations associated with target launch values.
:param licensing_configs: The licensing_configs of this LaunchInstanceDetails.
:type: list[oci.core.models.LaunchInstanceLicensingConfig]
"""
self._licensing_configs = licensing_configs
def __repr__(self):
return formatted_flat_dict(self)
def __eq__(self, other):
if other is None:
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
return not self == other