@Generated(value="OracleSDKGenerator", comments="API Version: 20160918") public final class LaunchInstanceDetails extends 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.
LaunchInstanceDetails.Builder. This model distinguishes fields
that are null because they are unset from fields that are explicitly set to null. This is done in
the setter methods of the LaunchInstanceDetails.Builder, which maintain a set of all explicitly set fields called
__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take
__explicitlySet__ into account. The constructor, on the other hand, does not set __explicitlySet__
(since the constructor cannot distinguish explicit null from unset null).| Modifier and Type | Class and Description |
|---|---|
static class |
LaunchInstanceDetails.Builder |
| Constructor and Description |
|---|
LaunchInstanceDetails(String availabilityDomain,
String compartmentId,
CreateVnicDetails createVnicDetails,
String dedicatedVmHostId,
Map<String,Map<String,Object>> definedTags,
String displayName,
Map<String,Object> extendedMetadata,
String faultDomain,
Map<String,String> freeformTags,
String hostnameLabel,
String imageId,
String ipxeScript,
LaunchOptions launchOptions,
InstanceOptions instanceOptions,
LaunchInstanceAvailabilityConfigDetails availabilityConfig,
Map<String,String> metadata,
LaunchInstanceAgentConfigDetails agentConfig,
String shape,
LaunchInstanceShapeConfigDetails shapeConfig,
InstanceSourceDetails sourceDetails,
String subnetId,
Boolean isPvEncryptionInTransitEnabled,
LaunchInstancePlatformConfig platformConfig)
Deprecated.
|
@ConstructorProperties(value={"availabilityDomain","compartmentId","createVnicDetails","dedicatedVmHostId","definedTags","displayName","extendedMetadata","faultDomain","freeformTags","hostnameLabel","imageId","ipxeScript","launchOptions","instanceOptions","availabilityConfig","metadata","agentConfig","shape","shapeConfig","sourceDetails","subnetId","isPvEncryptionInTransitEnabled","platformConfig"}) @Deprecated public LaunchInstanceDetails(String availabilityDomain, String compartmentId, CreateVnicDetails createVnicDetails, String dedicatedVmHostId, Map<String,Map<String,Object>> definedTags, String displayName, Map<String,Object> extendedMetadata, String faultDomain, Map<String,String> freeformTags, String hostnameLabel, String imageId, String ipxeScript, LaunchOptions launchOptions, InstanceOptions instanceOptions, LaunchInstanceAvailabilityConfigDetails availabilityConfig, Map<String,String> metadata, LaunchInstanceAgentConfigDetails agentConfig, String shape, LaunchInstanceShapeConfigDetails shapeConfig, InstanceSourceDetails sourceDetails, String subnetId, Boolean isPvEncryptionInTransitEnabled, LaunchInstancePlatformConfig platformConfig)
public static LaunchInstanceDetails.Builder builder()
Create a new builder.
public LaunchInstanceDetails.Builder toBuilder()
public String getAvailabilityDomain()
The availability domain of the instance.
Example: `Uocm:PHX-AD-1`
public String getCompartmentId()
The OCID of the compartment.
public CreateVnicDetails getCreateVnicDetails()
public String getDedicatedVmHostId()
The OCID of the dedicated VM host.
public Map<String,Map<String,Object>> getDefinedTags()
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`
public String getDisplayName()
A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
Example: `My bare metal instance`
public Map<String,Object> getExtendedMetadata()
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.
public String getFaultDomain()
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`
public Map<String,String> getFreeformTags()
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\"}`
public String getHostnameLabel()
Deprecated. Instead use hostnameLabel in
CreateVnicDetails.
If you provide both, the values must match.
public String getImageId()
Deprecated. Use sourceDetails with instanceSourceViaImageDetails
source type instead. If you specify values for both, the values must match.
public String getIpxeScript()
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.cloud.oracle.com/Content/Compute/References/bringyourownimage.htm).
For more information about iPXE, see http://ipxe.org.
public LaunchOptions getLaunchOptions()
public InstanceOptions getInstanceOptions()
public LaunchInstanceAvailabilityConfigDetails getAvailabilityConfig()
public Map<String,String> getMetadata()
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
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.
public LaunchInstanceAgentConfigDetails getAgentConfig()
public String getShape()
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.
public LaunchInstanceShapeConfigDetails getShapeConfig()
public InstanceSourceDetails getSourceDetails()
public String getSubnetId()
Deprecated. Instead use subnetId in
CreateVnicDetails.
At least one of them is required; if you provide both, the values must match.
public Boolean getIsPvEncryptionInTransitEnabled()
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.
public LaunchInstancePlatformConfig getPlatformConfig()
Copyright © 2016–2021. All rights reserved.