Package com.oracle.bmc.core.model

Class InstanceConfigurationLaunchInstanceDetails.Builder

    • Constructor Detail

      • Builder

        public Builder()

    • Method Detail

      • capacityReservationId

        public InstanceConfigurationLaunchInstanceDetails.Builder capacityReservationId​(String capacityReservationId)
        The OCID of the compute capacity reservation this instance is launched under.
        Parameters:
        capacityReservationId - the value to set
        Returns:
        this builder

      • compartmentId

        public InstanceConfigurationLaunchInstanceDetails.Builder compartmentId​(String compartmentId)
        The OCID of the compartment containing the instance.

        Instances created from instance configurations are placed in the same compartment as the instance that was used to create the instance configuration.

        Parameters:
        compartmentId - the value to set
        Returns:
        this builder

      • displayName

        public InstanceConfigurationLaunchInstanceDetails.Builder displayName​(String displayName)
        A user-friendly name.

        Does not have to be unique, and it’s changeable. Avoid entering confidential information.

        Parameters:
        displayName - the value to set
        Returns:
        this builder

      • extendedMetadata

        public InstanceConfigurationLaunchInstanceDetails.Builder extendedMetadata​(Map<String,​Object> extendedMetadata)
        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.

        Parameters:
        extendedMetadata - the value to set
        Returns:
        this builder

      • ipxeScript

        public InstanceConfigurationLaunchInstanceDetails.Builder ipxeScript​(String ipxeScript)
        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; however, you should 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, you should use the following iSCSI IP address: 169.254.0.2, and boot volume IQN: iqn.2015-02.oracle.boot.

        For more information about the Bring Your Own Image feature of Oracle Cloud Infrastructure, see [Bring Your Own Image](https://docs.oracle.com/iaas/Content/Compute/References/bringyourownimage.htm).

        For more information about iPXE, see http://ipxe.org.

        Parameters:
        ipxeScript - the value to set
        Returns:
        this builder

      • metadata

        public InstanceConfigurationLaunchInstanceDetails.Builder metadata​(Map<String,​String> metadata)
        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](https://cloudinit.readthedocs.org/en/latest/) 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](http://cloudinit.readthedocs.org/en/latest/topics/format.html).

        *Metadata Example**

        "metadata" : { "quake_bot_level" : "Severe", "ssh_authorized_keys" : "ssh-rsa == rsa-key-20160227", "user_data" : "==" } **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/

        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.

        Parameters:
        metadata - the value to set
        Returns:
        this builder

      • shape

        public InstanceConfigurationLaunchInstanceDetails.Builder shape​(String shape)
        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 listShapes.

        Parameters:
        shape - the value to set
        Returns:
        this builder

      • faultDomain

        public InstanceConfigurationLaunchInstanceDetails.Builder faultDomain​(String faultDomain)
        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 listFaultDomains operation in the Identity and Access Management Service API.

        Example: FAULT-DOMAIN-1

        Parameters:
        faultDomain - the value to set
        Returns:
        this builder

      • dedicatedVmHostId

        public InstanceConfigurationLaunchInstanceDetails.Builder dedicatedVmHostId​(String dedicatedVmHostId)
        The OCID of the dedicated virtual machine host to place the instance on.

        Dedicated VM hosts can be used when launching individual instances from an instance configuration. They cannot be used to launch instance pools.

        Parameters:
        dedicatedVmHostId - the value to set
        Returns:
        this builder

      • launchMode

        public InstanceConfigurationLaunchInstanceDetails.Builder launchMode​(InstanceConfigurationLaunchInstanceDetails.LaunchMode launchMode)
        Specifies the configuration mode for launching virtual machine (VM) instances.

        The configuration modes are: * NATIVE - VM instances launch with iSCSI boot and VFIO devices. The default value for platform images. * EMULATED - VM instances launch with emulated devices, such as the E1000 network driver and emulated SCSI disk controller. * PARAVIRTUALIZED - VM instances launch with paravirtualized devices using VirtIO drivers. * CUSTOM - VM instances launch with custom configuration settings specified in the LaunchOptions parameter.

        Parameters:
        launchMode - the value to set
        Returns:
        this builder

      • isPvEncryptionInTransitEnabled

        public InstanceConfigurationLaunchInstanceDetails.Builder isPvEncryptionInTransitEnabled​(Boolean isPvEncryptionInTransitEnabled)
        Whether to enable in-transit encryption for the data volume’s paravirtualized attachment.

        The default value is false.

        Parameters:
        isPvEncryptionInTransitEnabled - the value to set
        Returns:
        this builder