1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Core
  5. Instance
Oracle Cloud Infrastructure v1.29.0 published on Thursday, Mar 28, 2024 by Pulumi

oci.Core.Instance

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v1.29.0 published on Thursday, Mar 28, 2024 by Pulumi

    This resource provides the Instance resource in Oracle Cloud Infrastructure Core service.

    Creates a new instance in the specified compartment and the specified availability domain. For general information about instances, see Overview of the Compute Service.

    For information about access control and compartments, see Overview of the IAM Service.

    For information about availability domains, see Regions and Availability Domains. To get a list of availability domains, use the ListAvailabilityDomains operation in the Identity and Access Management Service API.

    All Oracle Cloud Infrastructure resources, including instances, get an Oracle-assigned, unique ID called an Oracle Cloud Identifier (OCID). When you create a resource, you can find its OCID in the response. You can also retrieve a resource’s OCID by using a List API operation on that resource type, or by viewing the resource in the Console.

    To launch an instance using an image or a boot volume use the sourceDetails parameter in LaunchInstanceDetails.

    When you launch an instance, it is automatically attached to a virtual network interface card (VNIC), called the primary VNIC. The VNIC has a private IP address from the subnet’s CIDR. You can either assign a private IP address of your choice or let Oracle automatically assign one. You can choose whether the instance has a public IP address. To retrieve the addresses, use the ListVnicAttachments operation to get the VNIC ID for the instance, and then call GetVnic with the VNIC ID.

    You can later add secondary VNICs to an instance. For more information, see Virtual Network Interface Cards (VNICs).

    To launch an instance from a Marketplace image listing, you must provide the image ID of the listing resource version that you want, but you also must subscribe to the listing before you try to launch the instance. To subscribe to the listing, use the GetAppCatalogListingAgreements operation to get the signature for the terms of use agreement for the desired listing resource version. Then, call CreateAppCatalogSubscription with the signature. To get the image ID for the LaunchInstance operation, call GetAppCatalogListingResourceVersion.

    To determine whether capacity is available for a specific shape before you create an instance, use the CreateComputeCapacityReport operation.

    Create Instance Resource

    new Instance(name: string, args: InstanceArgs, opts?: CustomResourceOptions);
    @overload
    def Instance(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 agent_config: Optional[_core.InstanceAgentConfigArgs] = None,
                 async_: Optional[bool] = None,
                 availability_config: Optional[_core.InstanceAvailabilityConfigArgs] = None,
                 availability_domain: Optional[str] = None,
                 capacity_reservation_id: Optional[str] = None,
                 compartment_id: Optional[str] = None,
                 compute_cluster_id: Optional[str] = None,
                 create_vnic_details: Optional[_core.InstanceCreateVnicDetailsArgs] = None,
                 dedicated_vm_host_id: Optional[str] = None,
                 defined_tags: Optional[Mapping[str, Any]] = None,
                 display_name: Optional[str] = None,
                 extended_metadata: Optional[Mapping[str, Any]] = None,
                 fault_domain: Optional[str] = None,
                 freeform_tags: Optional[Mapping[str, Any]] = None,
                 hostname_label: Optional[str] = None,
                 image: Optional[str] = None,
                 instance_configuration_id: Optional[str] = None,
                 instance_options: Optional[_core.InstanceInstanceOptionsArgs] = None,
                 ipxe_script: Optional[str] = None,
                 is_pv_encryption_in_transit_enabled: Optional[bool] = None,
                 launch_options: Optional[_core.InstanceLaunchOptionsArgs] = None,
                 launch_volume_attachments: Optional[Sequence[_core.InstanceLaunchVolumeAttachmentArgs]] = None,
                 metadata: Optional[Mapping[str, Any]] = None,
                 platform_config: Optional[_core.InstancePlatformConfigArgs] = None,
                 preemptible_instance_config: Optional[_core.InstancePreemptibleInstanceConfigArgs] = None,
                 preserve_boot_volume: Optional[bool] = None,
                 preserve_data_volumes_created_at_launch: Optional[bool] = None,
                 shape: Optional[str] = None,
                 shape_config: Optional[_core.InstanceShapeConfigArgs] = None,
                 source_details: Optional[_core.InstanceSourceDetailsArgs] = None,
                 state: Optional[str] = None,
                 subnet_id: Optional[str] = None,
                 update_operation_constraint: Optional[str] = None)
    @overload
    def Instance(resource_name: str,
                 args: InstanceArgs,
                 opts: Optional[ResourceOptions] = None)
    func NewInstance(ctx *Context, name string, args InstanceArgs, opts ...ResourceOption) (*Instance, error)
    public Instance(string name, InstanceArgs args, CustomResourceOptions? opts = null)
    public Instance(String name, InstanceArgs args)
    public Instance(String name, InstanceArgs args, CustomResourceOptions options)
    
    type: oci:Core:Instance
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args InstanceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args InstanceArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args InstanceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args InstanceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args InstanceArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Instance Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Instance resource accepts the following input properties:

    AvailabilityDomain string
    The availability domain of the instance. Example: Uocm:PHX-AD-1
    CompartmentId string
    (Updatable) The OCID of the compartment containing images to search
    AgentConfig InstanceAgentConfig
    (Updatable) Configuration options for the Oracle Cloud Agent software running on the instance.
    Async bool
    AvailabilityConfig InstanceAvailabilityConfig
    (Updatable) Options for VM migration during infrastructure maintenance events and for defining the availability of a VM instance after a maintenance event that impacts the underlying hardware.
    CapacityReservationId string
    (Updatable) 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.
    ComputeClusterId string
    The OCID of the compute cluster that the instance will be created in.
    CreateVnicDetails InstanceCreateVnicDetails
    (Updatable) Contains properties for a VNIC. You use this object when creating the primary VNIC during instance launch or when creating a secondary VNIC. For more information about VNICs, see Virtual Network Interface Cards (VNICs).
    DedicatedVmHostId string
    (Updatable) The OCID of the dedicated virtual machine host to place the instance on.
    DefinedTags Dictionary<string, object>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    DisplayName string
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    ExtendedMetadata Dictionary<string, object>
    FaultDomain string

    (Updatable) 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

    FreeformTags Dictionary<string, object>
    (Updatable) 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"}
    HostnameLabel string
    Deprecated. Instead use hostnameLabel in CreateVnicDetails. If you provide both, the values must match.

    Deprecated:The 'hostname_label' field has been deprecated. Please use 'hostname_label under create_vnic_details' instead.

    Image string
    Deprecated. Use sourceDetails with InstanceSourceViaImageDetails source type instead. If you specify values for both, the values must match.

    Deprecated:The 'image' field has been deprecated. Please use 'source_details' instead. If both fields are specified, then 'source_details' will be used.

    InstanceConfigurationId string
    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.
    InstanceOptions InstanceInstanceOptions
    (Updatable) Optional mutable instance options
    IpxeScript string

    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.

    IsPvEncryptionInTransitEnabled bool
    (Updatable) Use this for update operation only. This field is Deprecated during create. For create use isPvEncryptionInTransitEnabled in LaunchInstanceDetails.
    LaunchOptions InstanceLaunchOptions
    (Updatable) Options for tuning the compatibility and performance of VM shapes. The values that you specify override any default values.
    LaunchVolumeAttachments List<InstanceLaunchVolumeAttachment>

    Volume attachments to create as part of the launch instance operation.

    Note: This property is used for initial instance provisioning only. Updates to this property will not be supported. To update volume attachments, user should use oci.Core.VolumeAttachment. To update volume details, user should use oci.Core.Volume

    Metadata Dictionary<string, object>

    (Updatable) 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

    PlatformConfig InstancePlatformConfig

    (Updatable only for VM's) The platform configuration requested for the instance.

    If you provide the parameter, the instance is created with the platform configuration that you specify. For any values that you omit, the instance uses the default configuration values for the shape that you specify. If you don't provide the parameter, the default values for the shape are used.

    Each shape only supports certain configurable values. If the values that you provide are not valid for the specified shape, an error is returned.

    For more information about shielded instances, see Shielded Instances.

    For more information about BIOS settings for bare metal instances, see BIOS Settings for Bare Metal Instances.

    PreemptibleInstanceConfig InstancePreemptibleInstanceConfig
    Configuration options for preemptible instances.
    PreserveBootVolume bool
    Whether to preserve the boot volume that was used to launch the preemptible instance when the instance is terminated. Defaults to false if not specified.
    PreserveDataVolumesCreatedAtLaunch bool
    Shape string

    (Updatable) 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.

    ShapeConfig InstanceShapeConfig

    (Updatable) The shape configuration requested for the instance.

    If the parameter is provided, the instance is created with the resources that you specify. If some properties are missing or the entire parameter is not provided, the instance is created with the default configuration values for the shape that you specify.

    Each shape only supports certain configurable values. If the values that you provide are not valid for the specified shape, an error is returned.

    SourceDetails InstanceSourceDetails
    (Updatable)
    State string

    (Updatable) The target state for the instance. Could be set to RUNNING or STOPPED.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    SubnetId string
    Deprecated. Instead use subnetId in CreateVnicDetails. At least one of them is required; if you provide both, the values must match.

    Deprecated:The 'subnet_id' field has been deprecated. Please use 'subnet_id under create_vnic_details' instead.

    UpdateOperationConstraint string
    AvailabilityDomain string
    The availability domain of the instance. Example: Uocm:PHX-AD-1
    CompartmentId string
    (Updatable) The OCID of the compartment containing images to search
    AgentConfig InstanceAgentConfigArgs
    (Updatable) Configuration options for the Oracle Cloud Agent software running on the instance.
    Async bool
    AvailabilityConfig InstanceAvailabilityConfigArgs
    (Updatable) Options for VM migration during infrastructure maintenance events and for defining the availability of a VM instance after a maintenance event that impacts the underlying hardware.
    CapacityReservationId string
    (Updatable) 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.
    ComputeClusterId string
    The OCID of the compute cluster that the instance will be created in.
    CreateVnicDetails InstanceCreateVnicDetailsArgs
    (Updatable) Contains properties for a VNIC. You use this object when creating the primary VNIC during instance launch or when creating a secondary VNIC. For more information about VNICs, see Virtual Network Interface Cards (VNICs).
    DedicatedVmHostId string
    (Updatable) The OCID of the dedicated virtual machine host to place the instance on.
    DefinedTags map[string]interface{}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    DisplayName string
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    ExtendedMetadata map[string]interface{}
    FaultDomain string

    (Updatable) 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

    FreeformTags map[string]interface{}
    (Updatable) 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"}
    HostnameLabel string
    Deprecated. Instead use hostnameLabel in CreateVnicDetails. If you provide both, the values must match.

    Deprecated:The 'hostname_label' field has been deprecated. Please use 'hostname_label under create_vnic_details' instead.

    Image string
    Deprecated. Use sourceDetails with InstanceSourceViaImageDetails source type instead. If you specify values for both, the values must match.

    Deprecated:The 'image' field has been deprecated. Please use 'source_details' instead. If both fields are specified, then 'source_details' will be used.

    InstanceConfigurationId string
    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.
    InstanceOptions InstanceInstanceOptionsArgs
    (Updatable) Optional mutable instance options
    IpxeScript string

    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.

    IsPvEncryptionInTransitEnabled bool
    (Updatable) Use this for update operation only. This field is Deprecated during create. For create use isPvEncryptionInTransitEnabled in LaunchInstanceDetails.
    LaunchOptions InstanceLaunchOptionsArgs
    (Updatable) Options for tuning the compatibility and performance of VM shapes. The values that you specify override any default values.
    LaunchVolumeAttachments []InstanceLaunchVolumeAttachmentArgs

    Volume attachments to create as part of the launch instance operation.

    Note: This property is used for initial instance provisioning only. Updates to this property will not be supported. To update volume attachments, user should use oci.Core.VolumeAttachment. To update volume details, user should use oci.Core.Volume

    Metadata map[string]interface{}

    (Updatable) 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

    PlatformConfig InstancePlatformConfigArgs

    (Updatable only for VM's) The platform configuration requested for the instance.

    If you provide the parameter, the instance is created with the platform configuration that you specify. For any values that you omit, the instance uses the default configuration values for the shape that you specify. If you don't provide the parameter, the default values for the shape are used.

    Each shape only supports certain configurable values. If the values that you provide are not valid for the specified shape, an error is returned.

    For more information about shielded instances, see Shielded Instances.

    For more information about BIOS settings for bare metal instances, see BIOS Settings for Bare Metal Instances.

    PreemptibleInstanceConfig InstancePreemptibleInstanceConfigArgs
    Configuration options for preemptible instances.
    PreserveBootVolume bool
    Whether to preserve the boot volume that was used to launch the preemptible instance when the instance is terminated. Defaults to false if not specified.
    PreserveDataVolumesCreatedAtLaunch bool
    Shape string

    (Updatable) 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.

    ShapeConfig InstanceShapeConfigArgs

    (Updatable) The shape configuration requested for the instance.

    If the parameter is provided, the instance is created with the resources that you specify. If some properties are missing or the entire parameter is not provided, the instance is created with the default configuration values for the shape that you specify.

    Each shape only supports certain configurable values. If the values that you provide are not valid for the specified shape, an error is returned.

    SourceDetails InstanceSourceDetailsArgs
    (Updatable)
    State string

    (Updatable) The target state for the instance. Could be set to RUNNING or STOPPED.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    SubnetId string
    Deprecated. Instead use subnetId in CreateVnicDetails. At least one of them is required; if you provide both, the values must match.

    Deprecated:The 'subnet_id' field has been deprecated. Please use 'subnet_id under create_vnic_details' instead.

    UpdateOperationConstraint string
    availabilityDomain String
    The availability domain of the instance. Example: Uocm:PHX-AD-1
    compartmentId String
    (Updatable) The OCID of the compartment containing images to search
    agentConfig InstanceAgentConfig
    (Updatable) Configuration options for the Oracle Cloud Agent software running on the instance.
    async Boolean
    availabilityConfig InstanceAvailabilityConfig
    (Updatable) Options for VM migration during infrastructure maintenance events and for defining the availability of a VM instance after a maintenance event that impacts the underlying hardware.
    capacityReservationId String
    (Updatable) 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.
    computeClusterId String
    The OCID of the compute cluster that the instance will be created in.
    createVnicDetails InstanceCreateVnicDetails
    (Updatable) Contains properties for a VNIC. You use this object when creating the primary VNIC during instance launch or when creating a secondary VNIC. For more information about VNICs, see Virtual Network Interface Cards (VNICs).
    dedicatedVmHostId String
    (Updatable) The OCID of the dedicated virtual machine host to place the instance on.
    definedTags Map<String,Object>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    displayName String
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    extendedMetadata Map<String,Object>
    faultDomain String

    (Updatable) 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

    freeformTags Map<String,Object>
    (Updatable) 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"}
    hostnameLabel String
    Deprecated. Instead use hostnameLabel in CreateVnicDetails. If you provide both, the values must match.

    Deprecated:The 'hostname_label' field has been deprecated. Please use 'hostname_label under create_vnic_details' instead.

    image String
    Deprecated. Use sourceDetails with InstanceSourceViaImageDetails source type instead. If you specify values for both, the values must match.

    Deprecated:The 'image' field has been deprecated. Please use 'source_details' instead. If both fields are specified, then 'source_details' will be used.

    instanceConfigurationId String
    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.
    instanceOptions InstanceInstanceOptions
    (Updatable) Optional mutable instance options
    ipxeScript String

    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.

    isPvEncryptionInTransitEnabled Boolean
    (Updatable) Use this for update operation only. This field is Deprecated during create. For create use isPvEncryptionInTransitEnabled in LaunchInstanceDetails.
    launchOptions InstanceLaunchOptions
    (Updatable) Options for tuning the compatibility and performance of VM shapes. The values that you specify override any default values.
    launchVolumeAttachments List<InstanceLaunchVolumeAttachment>

    Volume attachments to create as part of the launch instance operation.

    Note: This property is used for initial instance provisioning only. Updates to this property will not be supported. To update volume attachments, user should use oci.Core.VolumeAttachment. To update volume details, user should use oci.Core.Volume

    metadata Map<String,Object>

    (Updatable) 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

    platformConfig InstancePlatformConfig

    (Updatable only for VM's) The platform configuration requested for the instance.

    If you provide the parameter, the instance is created with the platform configuration that you specify. For any values that you omit, the instance uses the default configuration values for the shape that you specify. If you don't provide the parameter, the default values for the shape are used.

    Each shape only supports certain configurable values. If the values that you provide are not valid for the specified shape, an error is returned.

    For more information about shielded instances, see Shielded Instances.

    For more information about BIOS settings for bare metal instances, see BIOS Settings for Bare Metal Instances.

    preemptibleInstanceConfig InstancePreemptibleInstanceConfig
    Configuration options for preemptible instances.
    preserveBootVolume Boolean
    Whether to preserve the boot volume that was used to launch the preemptible instance when the instance is terminated. Defaults to false if not specified.
    preserveDataVolumesCreatedAtLaunch Boolean
    shape String

    (Updatable) 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.

    shapeConfig InstanceShapeConfig

    (Updatable) The shape configuration requested for the instance.

    If the parameter is provided, the instance is created with the resources that you specify. If some properties are missing or the entire parameter is not provided, the instance is created with the default configuration values for the shape that you specify.

    Each shape only supports certain configurable values. If the values that you provide are not valid for the specified shape, an error is returned.

    sourceDetails InstanceSourceDetails
    (Updatable)
    state String

    (Updatable) The target state for the instance. Could be set to RUNNING or STOPPED.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    subnetId String
    Deprecated. Instead use subnetId in CreateVnicDetails. At least one of them is required; if you provide both, the values must match.

    Deprecated:The 'subnet_id' field has been deprecated. Please use 'subnet_id under create_vnic_details' instead.

    updateOperationConstraint String
    availabilityDomain string
    The availability domain of the instance. Example: Uocm:PHX-AD-1
    compartmentId string
    (Updatable) The OCID of the compartment containing images to search
    agentConfig InstanceAgentConfig
    (Updatable) Configuration options for the Oracle Cloud Agent software running on the instance.
    async boolean
    availabilityConfig InstanceAvailabilityConfig
    (Updatable) Options for VM migration during infrastructure maintenance events and for defining the availability of a VM instance after a maintenance event that impacts the underlying hardware.
    capacityReservationId string
    (Updatable) 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.
    computeClusterId string
    The OCID of the compute cluster that the instance will be created in.
    createVnicDetails InstanceCreateVnicDetails
    (Updatable) Contains properties for a VNIC. You use this object when creating the primary VNIC during instance launch or when creating a secondary VNIC. For more information about VNICs, see Virtual Network Interface Cards (VNICs).
    dedicatedVmHostId string
    (Updatable) The OCID of the dedicated virtual machine host to place the instance on.
    definedTags {[key: string]: any}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    displayName string
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    extendedMetadata {[key: string]: any}
    faultDomain string

    (Updatable) 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

    freeformTags {[key: string]: any}
    (Updatable) 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"}
    hostnameLabel string
    Deprecated. Instead use hostnameLabel in CreateVnicDetails. If you provide both, the values must match.

    Deprecated:The 'hostname_label' field has been deprecated. Please use 'hostname_label under create_vnic_details' instead.

    image string
    Deprecated. Use sourceDetails with InstanceSourceViaImageDetails source type instead. If you specify values for both, the values must match.

    Deprecated:The 'image' field has been deprecated. Please use 'source_details' instead. If both fields are specified, then 'source_details' will be used.

    instanceConfigurationId string
    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.
    instanceOptions InstanceInstanceOptions
    (Updatable) Optional mutable instance options
    ipxeScript string

    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.

    isPvEncryptionInTransitEnabled boolean
    (Updatable) Use this for update operation only. This field is Deprecated during create. For create use isPvEncryptionInTransitEnabled in LaunchInstanceDetails.
    launchOptions InstanceLaunchOptions
    (Updatable) Options for tuning the compatibility and performance of VM shapes. The values that you specify override any default values.
    launchVolumeAttachments InstanceLaunchVolumeAttachment[]

    Volume attachments to create as part of the launch instance operation.

    Note: This property is used for initial instance provisioning only. Updates to this property will not be supported. To update volume attachments, user should use oci.Core.VolumeAttachment. To update volume details, user should use oci.Core.Volume

    metadata {[key: string]: any}

    (Updatable) 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

    platformConfig InstancePlatformConfig

    (Updatable only for VM's) The platform configuration requested for the instance.

    If you provide the parameter, the instance is created with the platform configuration that you specify. For any values that you omit, the instance uses the default configuration values for the shape that you specify. If you don't provide the parameter, the default values for the shape are used.

    Each shape only supports certain configurable values. If the values that you provide are not valid for the specified shape, an error is returned.

    For more information about shielded instances, see Shielded Instances.

    For more information about BIOS settings for bare metal instances, see BIOS Settings for Bare Metal Instances.

    preemptibleInstanceConfig InstancePreemptibleInstanceConfig
    Configuration options for preemptible instances.
    preserveBootVolume boolean
    Whether to preserve the boot volume that was used to launch the preemptible instance when the instance is terminated. Defaults to false if not specified.
    preserveDataVolumesCreatedAtLaunch boolean
    shape string

    (Updatable) 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.

    shapeConfig InstanceShapeConfig

    (Updatable) The shape configuration requested for the instance.

    If the parameter is provided, the instance is created with the resources that you specify. If some properties are missing or the entire parameter is not provided, the instance is created with the default configuration values for the shape that you specify.

    Each shape only supports certain configurable values. If the values that you provide are not valid for the specified shape, an error is returned.

    sourceDetails InstanceSourceDetails
    (Updatable)
    state string

    (Updatable) The target state for the instance. Could be set to RUNNING or STOPPED.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    subnetId string
    Deprecated. Instead use subnetId in CreateVnicDetails. At least one of them is required; if you provide both, the values must match.

    Deprecated:The 'subnet_id' field has been deprecated. Please use 'subnet_id under create_vnic_details' instead.

    updateOperationConstraint string
    availability_domain str
    The availability domain of the instance. Example: Uocm:PHX-AD-1
    compartment_id str
    (Updatable) The OCID of the compartment containing images to search
    agent_config InstanceAgentConfigArgs
    (Updatable) Configuration options for the Oracle Cloud Agent software running on the instance.
    async_ bool
    availability_config InstanceAvailabilityConfigArgs
    (Updatable) Options for VM migration during infrastructure maintenance events and for defining the availability of a VM instance after a maintenance event that impacts the underlying hardware.
    capacity_reservation_id str
    (Updatable) 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.
    compute_cluster_id str
    The OCID of the compute cluster that the instance will be created in.
    create_vnic_details InstanceCreateVnicDetailsArgs
    (Updatable) Contains properties for a VNIC. You use this object when creating the primary VNIC during instance launch or when creating a secondary VNIC. For more information about VNICs, see Virtual Network Interface Cards (VNICs).
    dedicated_vm_host_id str
    (Updatable) The OCID of the dedicated virtual machine host to place the instance on.
    defined_tags Mapping[str, Any]
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    display_name str
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    extended_metadata Mapping[str, Any]
    fault_domain str

    (Updatable) 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

    freeform_tags Mapping[str, Any]
    (Updatable) 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"}
    hostname_label str
    Deprecated. Instead use hostnameLabel in CreateVnicDetails. If you provide both, the values must match.

    Deprecated:The 'hostname_label' field has been deprecated. Please use 'hostname_label under create_vnic_details' instead.

    image str
    Deprecated. Use sourceDetails with InstanceSourceViaImageDetails source type instead. If you specify values for both, the values must match.

    Deprecated:The 'image' field has been deprecated. Please use 'source_details' instead. If both fields are specified, then 'source_details' will be used.

    instance_configuration_id str
    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.
    instance_options InstanceInstanceOptionsArgs
    (Updatable) Optional mutable instance options
    ipxe_script str

    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.

    is_pv_encryption_in_transit_enabled bool
    (Updatable) Use this for update operation only. This field is Deprecated during create. For create use isPvEncryptionInTransitEnabled in LaunchInstanceDetails.
    launch_options InstanceLaunchOptionsArgs
    (Updatable) Options for tuning the compatibility and performance of VM shapes. The values that you specify override any default values.
    launch_volume_attachments InstanceLaunchVolumeAttachmentArgs]

    Volume attachments to create as part of the launch instance operation.

    Note: This property is used for initial instance provisioning only. Updates to this property will not be supported. To update volume attachments, user should use oci.Core.VolumeAttachment. To update volume details, user should use oci.Core.Volume

    metadata Mapping[str, Any]

    (Updatable) 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

    platform_config InstancePlatformConfigArgs

    (Updatable only for VM's) The platform configuration requested for the instance.

    If you provide the parameter, the instance is created with the platform configuration that you specify. For any values that you omit, the instance uses the default configuration values for the shape that you specify. If you don't provide the parameter, the default values for the shape are used.

    Each shape only supports certain configurable values. If the values that you provide are not valid for the specified shape, an error is returned.

    For more information about shielded instances, see Shielded Instances.

    For more information about BIOS settings for bare metal instances, see BIOS Settings for Bare Metal Instances.

    preemptible_instance_config InstancePreemptibleInstanceConfigArgs
    Configuration options for preemptible instances.
    preserve_boot_volume bool
    Whether to preserve the boot volume that was used to launch the preemptible instance when the instance is terminated. Defaults to false if not specified.
    preserve_data_volumes_created_at_launch bool
    shape str

    (Updatable) 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.

    shape_config InstanceShapeConfigArgs

    (Updatable) The shape configuration requested for the instance.

    If the parameter is provided, the instance is created with the resources that you specify. If some properties are missing or the entire parameter is not provided, the instance is created with the default configuration values for the shape that you specify.

    Each shape only supports certain configurable values. If the values that you provide are not valid for the specified shape, an error is returned.

    source_details InstanceSourceDetailsArgs
    (Updatable)
    state str

    (Updatable) The target state for the instance. Could be set to RUNNING or STOPPED.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    subnet_id str
    Deprecated. Instead use subnetId in CreateVnicDetails. At least one of them is required; if you provide both, the values must match.

    Deprecated:The 'subnet_id' field has been deprecated. Please use 'subnet_id under create_vnic_details' instead.

    update_operation_constraint str
    availabilityDomain String
    The availability domain of the instance. Example: Uocm:PHX-AD-1
    compartmentId String
    (Updatable) The OCID of the compartment containing images to search
    agentConfig Property Map
    (Updatable) Configuration options for the Oracle Cloud Agent software running on the instance.
    async Boolean
    availabilityConfig Property Map
    (Updatable) Options for VM migration during infrastructure maintenance events and for defining the availability of a VM instance after a maintenance event that impacts the underlying hardware.
    capacityReservationId String
    (Updatable) 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.
    computeClusterId String
    The OCID of the compute cluster that the instance will be created in.
    createVnicDetails Property Map
    (Updatable) Contains properties for a VNIC. You use this object when creating the primary VNIC during instance launch or when creating a secondary VNIC. For more information about VNICs, see Virtual Network Interface Cards (VNICs).
    dedicatedVmHostId String
    (Updatable) The OCID of the dedicated virtual machine host to place the instance on.
    definedTags Map<Any>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    displayName String
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    extendedMetadata Map<Any>
    faultDomain String

    (Updatable) 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

    freeformTags Map<Any>
    (Updatable) 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"}
    hostnameLabel String
    Deprecated. Instead use hostnameLabel in CreateVnicDetails. If you provide both, the values must match.

    Deprecated:The 'hostname_label' field has been deprecated. Please use 'hostname_label under create_vnic_details' instead.

    image String
    Deprecated. Use sourceDetails with InstanceSourceViaImageDetails source type instead. If you specify values for both, the values must match.

    Deprecated:The 'image' field has been deprecated. Please use 'source_details' instead. If both fields are specified, then 'source_details' will be used.

    instanceConfigurationId String
    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.
    instanceOptions Property Map
    (Updatable) Optional mutable instance options
    ipxeScript String

    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.

    isPvEncryptionInTransitEnabled Boolean
    (Updatable) Use this for update operation only. This field is Deprecated during create. For create use isPvEncryptionInTransitEnabled in LaunchInstanceDetails.
    launchOptions Property Map
    (Updatable) Options for tuning the compatibility and performance of VM shapes. The values that you specify override any default values.
    launchVolumeAttachments List<Property Map>

    Volume attachments to create as part of the launch instance operation.

    Note: This property is used for initial instance provisioning only. Updates to this property will not be supported. To update volume attachments, user should use oci.Core.VolumeAttachment. To update volume details, user should use oci.Core.Volume

    metadata Map<Any>

    (Updatable) 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

    platformConfig Property Map

    (Updatable only for VM's) The platform configuration requested for the instance.

    If you provide the parameter, the instance is created with the platform configuration that you specify. For any values that you omit, the instance uses the default configuration values for the shape that you specify. If you don't provide the parameter, the default values for the shape are used.

    Each shape only supports certain configurable values. If the values that you provide are not valid for the specified shape, an error is returned.

    For more information about shielded instances, see Shielded Instances.

    For more information about BIOS settings for bare metal instances, see BIOS Settings for Bare Metal Instances.

    preemptibleInstanceConfig Property Map
    Configuration options for preemptible instances.
    preserveBootVolume Boolean
    Whether to preserve the boot volume that was used to launch the preemptible instance when the instance is terminated. Defaults to false if not specified.
    preserveDataVolumesCreatedAtLaunch Boolean
    shape String

    (Updatable) 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.

    shapeConfig Property Map

    (Updatable) The shape configuration requested for the instance.

    If the parameter is provided, the instance is created with the resources that you specify. If some properties are missing or the entire parameter is not provided, the instance is created with the default configuration values for the shape that you specify.

    Each shape only supports certain configurable values. If the values that you provide are not valid for the specified shape, an error is returned.

    sourceDetails Property Map
    (Updatable)
    state String

    (Updatable) The target state for the instance. Could be set to RUNNING or STOPPED.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    subnetId String
    Deprecated. Instead use subnetId in CreateVnicDetails. At least one of them is required; if you provide both, the values must match.

    Deprecated:The 'subnet_id' field has been deprecated. Please use 'subnet_id under create_vnic_details' instead.

    updateOperationConstraint String

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Instance resource produces the following output properties:

    BootVolumeId string
    The OCID of the attached boot volume. If the source_type is bootVolume, this will be the same OCID as the source_id.
    Id string
    The provider-assigned unique ID for this managed resource.
    IsCrossNumaNode bool
    Whether the instance’s OCPUs and memory are distributed across multiple NUMA nodes.
    LaunchMode string
    Specifies the configuration mode for launching virtual machine (VM) instances. The configuration modes are:
    PrivateIp string

    A private IP address of your choice to assign to the VNIC. Must be an available IP address within the subnet's CIDR. If you don't specify a value, Oracle automatically assigns a private IP address from the subnet. This is the VNIC's primary private IP address. The value appears in the Vnic object and also the PrivateIp object returned by ListPrivateIps and GetPrivateIp.

    If you specify a vlanId, the privateIp cannot be specified. See Vlan.

    Example: 10.0.3.3

    PublicIp string
    The public IP address of instance VNIC (if enabled).
    Region string
    The region that contains the availability domain the instance is running in.
    SystemTags Dictionary<string, object>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    TimeCreated string
    The date and time the instance was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    TimeMaintenanceRebootDue string
    The date and time the instance is expected to be stopped / started, in the format defined by RFC3339. After that time if instance hasn't been rebooted, Oracle will reboot the instance within 24 hours of the due time. Regardless of how the instance was stopped, the flag will be reset to empty as soon as instance reaches Stopped state. Example: 2018-05-25T21:10:29.600Z
    BootVolumeId string
    The OCID of the attached boot volume. If the source_type is bootVolume, this will be the same OCID as the source_id.
    Id string
    The provider-assigned unique ID for this managed resource.
    IsCrossNumaNode bool
    Whether the instance’s OCPUs and memory are distributed across multiple NUMA nodes.
    LaunchMode string
    Specifies the configuration mode for launching virtual machine (VM) instances. The configuration modes are:
    PrivateIp string

    A private IP address of your choice to assign to the VNIC. Must be an available IP address within the subnet's CIDR. If you don't specify a value, Oracle automatically assigns a private IP address from the subnet. This is the VNIC's primary private IP address. The value appears in the Vnic object and also the PrivateIp object returned by ListPrivateIps and GetPrivateIp.

    If you specify a vlanId, the privateIp cannot be specified. See Vlan.

    Example: 10.0.3.3

    PublicIp string
    The public IP address of instance VNIC (if enabled).
    Region string
    The region that contains the availability domain the instance is running in.
    SystemTags map[string]interface{}
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    TimeCreated string
    The date and time the instance was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    TimeMaintenanceRebootDue string
    The date and time the instance is expected to be stopped / started, in the format defined by RFC3339. After that time if instance hasn't been rebooted, Oracle will reboot the instance within 24 hours of the due time. Regardless of how the instance was stopped, the flag will be reset to empty as soon as instance reaches Stopped state. Example: 2018-05-25T21:10:29.600Z
    bootVolumeId String
    The OCID of the attached boot volume. If the source_type is bootVolume, this will be the same OCID as the source_id.
    id String
    The provider-assigned unique ID for this managed resource.
    isCrossNumaNode Boolean
    Whether the instance’s OCPUs and memory are distributed across multiple NUMA nodes.
    launchMode String
    Specifies the configuration mode for launching virtual machine (VM) instances. The configuration modes are:
    privateIp String

    A private IP address of your choice to assign to the VNIC. Must be an available IP address within the subnet's CIDR. If you don't specify a value, Oracle automatically assigns a private IP address from the subnet. This is the VNIC's primary private IP address. The value appears in the Vnic object and also the PrivateIp object returned by ListPrivateIps and GetPrivateIp.

    If you specify a vlanId, the privateIp cannot be specified. See Vlan.

    Example: 10.0.3.3

    publicIp String
    The public IP address of instance VNIC (if enabled).
    region String
    The region that contains the availability domain the instance is running in.
    systemTags Map<String,Object>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    timeCreated String
    The date and time the instance was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    timeMaintenanceRebootDue String
    The date and time the instance is expected to be stopped / started, in the format defined by RFC3339. After that time if instance hasn't been rebooted, Oracle will reboot the instance within 24 hours of the due time. Regardless of how the instance was stopped, the flag will be reset to empty as soon as instance reaches Stopped state. Example: 2018-05-25T21:10:29.600Z
    bootVolumeId string
    The OCID of the attached boot volume. If the source_type is bootVolume, this will be the same OCID as the source_id.
    id string
    The provider-assigned unique ID for this managed resource.
    isCrossNumaNode boolean
    Whether the instance’s OCPUs and memory are distributed across multiple NUMA nodes.
    launchMode string
    Specifies the configuration mode for launching virtual machine (VM) instances. The configuration modes are:
    privateIp string

    A private IP address of your choice to assign to the VNIC. Must be an available IP address within the subnet's CIDR. If you don't specify a value, Oracle automatically assigns a private IP address from the subnet. This is the VNIC's primary private IP address. The value appears in the Vnic object and also the PrivateIp object returned by ListPrivateIps and GetPrivateIp.

    If you specify a vlanId, the privateIp cannot be specified. See Vlan.

    Example: 10.0.3.3

    publicIp string
    The public IP address of instance VNIC (if enabled).
    region string
    The region that contains the availability domain the instance is running in.
    systemTags {[key: string]: any}
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    timeCreated string
    The date and time the instance was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    timeMaintenanceRebootDue string
    The date and time the instance is expected to be stopped / started, in the format defined by RFC3339. After that time if instance hasn't been rebooted, Oracle will reboot the instance within 24 hours of the due time. Regardless of how the instance was stopped, the flag will be reset to empty as soon as instance reaches Stopped state. Example: 2018-05-25T21:10:29.600Z
    boot_volume_id str
    The OCID of the attached boot volume. If the source_type is bootVolume, this will be the same OCID as the source_id.
    id str
    The provider-assigned unique ID for this managed resource.
    is_cross_numa_node bool
    Whether the instance’s OCPUs and memory are distributed across multiple NUMA nodes.
    launch_mode str
    Specifies the configuration mode for launching virtual machine (VM) instances. The configuration modes are:
    private_ip str

    A private IP address of your choice to assign to the VNIC. Must be an available IP address within the subnet's CIDR. If you don't specify a value, Oracle automatically assigns a private IP address from the subnet. This is the VNIC's primary private IP address. The value appears in the Vnic object and also the PrivateIp object returned by ListPrivateIps and GetPrivateIp.

    If you specify a vlanId, the privateIp cannot be specified. See Vlan.

    Example: 10.0.3.3

    public_ip str
    The public IP address of instance VNIC (if enabled).
    region str
    The region that contains the availability domain the instance is running in.
    system_tags Mapping[str, Any]
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    time_created str
    The date and time the instance was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    time_maintenance_reboot_due str
    The date and time the instance is expected to be stopped / started, in the format defined by RFC3339. After that time if instance hasn't been rebooted, Oracle will reboot the instance within 24 hours of the due time. Regardless of how the instance was stopped, the flag will be reset to empty as soon as instance reaches Stopped state. Example: 2018-05-25T21:10:29.600Z
    bootVolumeId String
    The OCID of the attached boot volume. If the source_type is bootVolume, this will be the same OCID as the source_id.
    id String
    The provider-assigned unique ID for this managed resource.
    isCrossNumaNode Boolean
    Whether the instance’s OCPUs and memory are distributed across multiple NUMA nodes.
    launchMode String
    Specifies the configuration mode for launching virtual machine (VM) instances. The configuration modes are:
    privateIp String

    A private IP address of your choice to assign to the VNIC. Must be an available IP address within the subnet's CIDR. If you don't specify a value, Oracle automatically assigns a private IP address from the subnet. This is the VNIC's primary private IP address. The value appears in the Vnic object and also the PrivateIp object returned by ListPrivateIps and GetPrivateIp.

    If you specify a vlanId, the privateIp cannot be specified. See Vlan.

    Example: 10.0.3.3

    publicIp String
    The public IP address of instance VNIC (if enabled).
    region String
    The region that contains the availability domain the instance is running in.
    systemTags Map<Any>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    timeCreated String
    The date and time the instance was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    timeMaintenanceRebootDue String
    The date and time the instance is expected to be stopped / started, in the format defined by RFC3339. After that time if instance hasn't been rebooted, Oracle will reboot the instance within 24 hours of the due time. Regardless of how the instance was stopped, the flag will be reset to empty as soon as instance reaches Stopped state. Example: 2018-05-25T21:10:29.600Z

    Look up Existing Instance Resource

    Get an existing Instance resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: InstanceState, opts?: CustomResourceOptions): Instance
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            agent_config: Optional[_core.InstanceAgentConfigArgs] = None,
            async_: Optional[bool] = None,
            availability_config: Optional[_core.InstanceAvailabilityConfigArgs] = None,
            availability_domain: Optional[str] = None,
            boot_volume_id: Optional[str] = None,
            capacity_reservation_id: Optional[str] = None,
            compartment_id: Optional[str] = None,
            compute_cluster_id: Optional[str] = None,
            create_vnic_details: Optional[_core.InstanceCreateVnicDetailsArgs] = None,
            dedicated_vm_host_id: Optional[str] = None,
            defined_tags: Optional[Mapping[str, Any]] = None,
            display_name: Optional[str] = None,
            extended_metadata: Optional[Mapping[str, Any]] = None,
            fault_domain: Optional[str] = None,
            freeform_tags: Optional[Mapping[str, Any]] = None,
            hostname_label: Optional[str] = None,
            image: Optional[str] = None,
            instance_configuration_id: Optional[str] = None,
            instance_options: Optional[_core.InstanceInstanceOptionsArgs] = None,
            ipxe_script: Optional[str] = None,
            is_cross_numa_node: Optional[bool] = None,
            is_pv_encryption_in_transit_enabled: Optional[bool] = None,
            launch_mode: Optional[str] = None,
            launch_options: Optional[_core.InstanceLaunchOptionsArgs] = None,
            launch_volume_attachments: Optional[Sequence[_core.InstanceLaunchVolumeAttachmentArgs]] = None,
            metadata: Optional[Mapping[str, Any]] = None,
            platform_config: Optional[_core.InstancePlatformConfigArgs] = None,
            preemptible_instance_config: Optional[_core.InstancePreemptibleInstanceConfigArgs] = None,
            preserve_boot_volume: Optional[bool] = None,
            preserve_data_volumes_created_at_launch: Optional[bool] = None,
            private_ip: Optional[str] = None,
            public_ip: Optional[str] = None,
            region: Optional[str] = None,
            shape: Optional[str] = None,
            shape_config: Optional[_core.InstanceShapeConfigArgs] = None,
            source_details: Optional[_core.InstanceSourceDetailsArgs] = None,
            state: Optional[str] = None,
            subnet_id: Optional[str] = None,
            system_tags: Optional[Mapping[str, Any]] = None,
            time_created: Optional[str] = None,
            time_maintenance_reboot_due: Optional[str] = None,
            update_operation_constraint: Optional[str] = None) -> Instance
    func GetInstance(ctx *Context, name string, id IDInput, state *InstanceState, opts ...ResourceOption) (*Instance, error)
    public static Instance Get(string name, Input<string> id, InstanceState? state, CustomResourceOptions? opts = null)
    public static Instance get(String name, Output<String> id, InstanceState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AgentConfig InstanceAgentConfig
    (Updatable) Configuration options for the Oracle Cloud Agent software running on the instance.
    Async bool
    AvailabilityConfig InstanceAvailabilityConfig
    (Updatable) Options for VM migration during infrastructure maintenance events and for defining the availability of a VM instance after a maintenance event that impacts the underlying hardware.
    AvailabilityDomain string
    The availability domain of the instance. Example: Uocm:PHX-AD-1
    BootVolumeId string
    The OCID of the attached boot volume. If the source_type is bootVolume, this will be the same OCID as the source_id.
    CapacityReservationId string
    (Updatable) 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.
    CompartmentId string
    (Updatable) The OCID of the compartment containing images to search
    ComputeClusterId string
    The OCID of the compute cluster that the instance will be created in.
    CreateVnicDetails InstanceCreateVnicDetails
    (Updatable) Contains properties for a VNIC. You use this object when creating the primary VNIC during instance launch or when creating a secondary VNIC. For more information about VNICs, see Virtual Network Interface Cards (VNICs).
    DedicatedVmHostId string
    (Updatable) The OCID of the dedicated virtual machine host to place the instance on.
    DefinedTags Dictionary<string, object>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    DisplayName string
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    ExtendedMetadata Dictionary<string, object>
    FaultDomain string

    (Updatable) 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

    FreeformTags Dictionary<string, object>
    (Updatable) 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"}
    HostnameLabel string
    Deprecated. Instead use hostnameLabel in CreateVnicDetails. If you provide both, the values must match.

    Deprecated:The 'hostname_label' field has been deprecated. Please use 'hostname_label under create_vnic_details' instead.

    Image string
    Deprecated. Use sourceDetails with InstanceSourceViaImageDetails source type instead. If you specify values for both, the values must match.

    Deprecated:The 'image' field has been deprecated. Please use 'source_details' instead. If both fields are specified, then 'source_details' will be used.

    InstanceConfigurationId string
    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.
    InstanceOptions InstanceInstanceOptions
    (Updatable) Optional mutable instance options
    IpxeScript string

    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.

    IsCrossNumaNode bool
    Whether the instance’s OCPUs and memory are distributed across multiple NUMA nodes.
    IsPvEncryptionInTransitEnabled bool
    (Updatable) Use this for update operation only. This field is Deprecated during create. For create use isPvEncryptionInTransitEnabled in LaunchInstanceDetails.
    LaunchMode string
    Specifies the configuration mode for launching virtual machine (VM) instances. The configuration modes are:
    LaunchOptions InstanceLaunchOptions
    (Updatable) Options for tuning the compatibility and performance of VM shapes. The values that you specify override any default values.
    LaunchVolumeAttachments List<InstanceLaunchVolumeAttachment>

    Volume attachments to create as part of the launch instance operation.

    Note: This property is used for initial instance provisioning only. Updates to this property will not be supported. To update volume attachments, user should use oci.Core.VolumeAttachment. To update volume details, user should use oci.Core.Volume

    Metadata Dictionary<string, object>

    (Updatable) 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

    PlatformConfig InstancePlatformConfig

    (Updatable only for VM's) The platform configuration requested for the instance.

    If you provide the parameter, the instance is created with the platform configuration that you specify. For any values that you omit, the instance uses the default configuration values for the shape that you specify. If you don't provide the parameter, the default values for the shape are used.

    Each shape only supports certain configurable values. If the values that you provide are not valid for the specified shape, an error is returned.

    For more information about shielded instances, see Shielded Instances.

    For more information about BIOS settings for bare metal instances, see BIOS Settings for Bare Metal Instances.

    PreemptibleInstanceConfig InstancePreemptibleInstanceConfig
    Configuration options for preemptible instances.
    PreserveBootVolume bool
    Whether to preserve the boot volume that was used to launch the preemptible instance when the instance is terminated. Defaults to false if not specified.
    PreserveDataVolumesCreatedAtLaunch bool
    PrivateIp string

    A private IP address of your choice to assign to the VNIC. Must be an available IP address within the subnet's CIDR. If you don't specify a value, Oracle automatically assigns a private IP address from the subnet. This is the VNIC's primary private IP address. The value appears in the Vnic object and also the PrivateIp object returned by ListPrivateIps and GetPrivateIp.

    If you specify a vlanId, the privateIp cannot be specified. See Vlan.

    Example: 10.0.3.3

    PublicIp string
    The public IP address of instance VNIC (if enabled).
    Region string
    The region that contains the availability domain the instance is running in.
    Shape string

    (Updatable) 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.

    ShapeConfig InstanceShapeConfig

    (Updatable) The shape configuration requested for the instance.

    If the parameter is provided, the instance is created with the resources that you specify. If some properties are missing or the entire parameter is not provided, the instance is created with the default configuration values for the shape that you specify.

    Each shape only supports certain configurable values. If the values that you provide are not valid for the specified shape, an error is returned.

    SourceDetails InstanceSourceDetails
    (Updatable)
    State string

    (Updatable) The target state for the instance. Could be set to RUNNING or STOPPED.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    SubnetId string
    Deprecated. Instead use subnetId in CreateVnicDetails. At least one of them is required; if you provide both, the values must match.

    Deprecated:The 'subnet_id' field has been deprecated. Please use 'subnet_id under create_vnic_details' instead.

    SystemTags Dictionary<string, object>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    TimeCreated string
    The date and time the instance was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    TimeMaintenanceRebootDue string
    The date and time the instance is expected to be stopped / started, in the format defined by RFC3339. After that time if instance hasn't been rebooted, Oracle will reboot the instance within 24 hours of the due time. Regardless of how the instance was stopped, the flag will be reset to empty as soon as instance reaches Stopped state. Example: 2018-05-25T21:10:29.600Z
    UpdateOperationConstraint string
    AgentConfig InstanceAgentConfigArgs
    (Updatable) Configuration options for the Oracle Cloud Agent software running on the instance.
    Async bool
    AvailabilityConfig InstanceAvailabilityConfigArgs
    (Updatable) Options for VM migration during infrastructure maintenance events and for defining the availability of a VM instance after a maintenance event that impacts the underlying hardware.
    AvailabilityDomain string
    The availability domain of the instance. Example: Uocm:PHX-AD-1
    BootVolumeId string
    The OCID of the attached boot volume. If the source_type is bootVolume, this will be the same OCID as the source_id.
    CapacityReservationId string
    (Updatable) 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.
    CompartmentId string
    (Updatable) The OCID of the compartment containing images to search
    ComputeClusterId string
    The OCID of the compute cluster that the instance will be created in.
    CreateVnicDetails InstanceCreateVnicDetailsArgs
    (Updatable) Contains properties for a VNIC. You use this object when creating the primary VNIC during instance launch or when creating a secondary VNIC. For more information about VNICs, see Virtual Network Interface Cards (VNICs).
    DedicatedVmHostId string
    (Updatable) The OCID of the dedicated virtual machine host to place the instance on.
    DefinedTags map[string]interface{}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    DisplayName string
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    ExtendedMetadata map[string]interface{}
    FaultDomain string

    (Updatable) 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

    FreeformTags map[string]interface{}
    (Updatable) 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"}
    HostnameLabel string
    Deprecated. Instead use hostnameLabel in CreateVnicDetails. If you provide both, the values must match.

    Deprecated:The 'hostname_label' field has been deprecated. Please use 'hostname_label under create_vnic_details' instead.

    Image string
    Deprecated. Use sourceDetails with InstanceSourceViaImageDetails source type instead. If you specify values for both, the values must match.

    Deprecated:The 'image' field has been deprecated. Please use 'source_details' instead. If both fields are specified, then 'source_details' will be used.

    InstanceConfigurationId string
    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.
    InstanceOptions InstanceInstanceOptionsArgs
    (Updatable) Optional mutable instance options
    IpxeScript string

    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.

    IsCrossNumaNode bool
    Whether the instance’s OCPUs and memory are distributed across multiple NUMA nodes.
    IsPvEncryptionInTransitEnabled bool
    (Updatable) Use this for update operation only. This field is Deprecated during create. For create use isPvEncryptionInTransitEnabled in LaunchInstanceDetails.
    LaunchMode string
    Specifies the configuration mode for launching virtual machine (VM) instances. The configuration modes are:
    LaunchOptions InstanceLaunchOptionsArgs
    (Updatable) Options for tuning the compatibility and performance of VM shapes. The values that you specify override any default values.
    LaunchVolumeAttachments []InstanceLaunchVolumeAttachmentArgs

    Volume attachments to create as part of the launch instance operation.

    Note: This property is used for initial instance provisioning only. Updates to this property will not be supported. To update volume attachments, user should use oci.Core.VolumeAttachment. To update volume details, user should use oci.Core.Volume

    Metadata map[string]interface{}

    (Updatable) 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

    PlatformConfig InstancePlatformConfigArgs

    (Updatable only for VM's) The platform configuration requested for the instance.

    If you provide the parameter, the instance is created with the platform configuration that you specify. For any values that you omit, the instance uses the default configuration values for the shape that you specify. If you don't provide the parameter, the default values for the shape are used.

    Each shape only supports certain configurable values. If the values that you provide are not valid for the specified shape, an error is returned.

    For more information about shielded instances, see Shielded Instances.

    For more information about BIOS settings for bare metal instances, see BIOS Settings for Bare Metal Instances.

    PreemptibleInstanceConfig InstancePreemptibleInstanceConfigArgs
    Configuration options for preemptible instances.
    PreserveBootVolume bool
    Whether to preserve the boot volume that was used to launch the preemptible instance when the instance is terminated. Defaults to false if not specified.
    PreserveDataVolumesCreatedAtLaunch bool
    PrivateIp string

    A private IP address of your choice to assign to the VNIC. Must be an available IP address within the subnet's CIDR. If you don't specify a value, Oracle automatically assigns a private IP address from the subnet. This is the VNIC's primary private IP address. The value appears in the Vnic object and also the PrivateIp object returned by ListPrivateIps and GetPrivateIp.

    If you specify a vlanId, the privateIp cannot be specified. See Vlan.

    Example: 10.0.3.3

    PublicIp string
    The public IP address of instance VNIC (if enabled).
    Region string
    The region that contains the availability domain the instance is running in.
    Shape string

    (Updatable) 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.

    ShapeConfig InstanceShapeConfigArgs

    (Updatable) The shape configuration requested for the instance.

    If the parameter is provided, the instance is created with the resources that you specify. If some properties are missing or the entire parameter is not provided, the instance is created with the default configuration values for the shape that you specify.

    Each shape only supports certain configurable values. If the values that you provide are not valid for the specified shape, an error is returned.

    SourceDetails InstanceSourceDetailsArgs
    (Updatable)
    State string

    (Updatable) The target state for the instance. Could be set to RUNNING or STOPPED.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    SubnetId string
    Deprecated. Instead use subnetId in CreateVnicDetails. At least one of them is required; if you provide both, the values must match.

    Deprecated:The 'subnet_id' field has been deprecated. Please use 'subnet_id under create_vnic_details' instead.

    SystemTags map[string]interface{}
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    TimeCreated string
    The date and time the instance was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    TimeMaintenanceRebootDue string
    The date and time the instance is expected to be stopped / started, in the format defined by RFC3339. After that time if instance hasn't been rebooted, Oracle will reboot the instance within 24 hours of the due time. Regardless of how the instance was stopped, the flag will be reset to empty as soon as instance reaches Stopped state. Example: 2018-05-25T21:10:29.600Z
    UpdateOperationConstraint string
    agentConfig InstanceAgentConfig
    (Updatable) Configuration options for the Oracle Cloud Agent software running on the instance.
    async Boolean
    availabilityConfig InstanceAvailabilityConfig
    (Updatable) Options for VM migration during infrastructure maintenance events and for defining the availability of a VM instance after a maintenance event that impacts the underlying hardware.
    availabilityDomain String
    The availability domain of the instance. Example: Uocm:PHX-AD-1
    bootVolumeId String
    The OCID of the attached boot volume. If the source_type is bootVolume, this will be the same OCID as the source_id.
    capacityReservationId String
    (Updatable) 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.
    compartmentId String
    (Updatable) The OCID of the compartment containing images to search
    computeClusterId String
    The OCID of the compute cluster that the instance will be created in.
    createVnicDetails InstanceCreateVnicDetails
    (Updatable) Contains properties for a VNIC. You use this object when creating the primary VNIC during instance launch or when creating a secondary VNIC. For more information about VNICs, see Virtual Network Interface Cards (VNICs).
    dedicatedVmHostId String
    (Updatable) The OCID of the dedicated virtual machine host to place the instance on.
    definedTags Map<String,Object>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    displayName String
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    extendedMetadata Map<String,Object>
    faultDomain String

    (Updatable) 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

    freeformTags Map<String,Object>
    (Updatable) 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"}
    hostnameLabel String
    Deprecated. Instead use hostnameLabel in CreateVnicDetails. If you provide both, the values must match.

    Deprecated:The 'hostname_label' field has been deprecated. Please use 'hostname_label under create_vnic_details' instead.

    image String
    Deprecated. Use sourceDetails with InstanceSourceViaImageDetails source type instead. If you specify values for both, the values must match.

    Deprecated:The 'image' field has been deprecated. Please use 'source_details' instead. If both fields are specified, then 'source_details' will be used.

    instanceConfigurationId String
    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.
    instanceOptions InstanceInstanceOptions
    (Updatable) Optional mutable instance options
    ipxeScript String

    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.

    isCrossNumaNode Boolean
    Whether the instance’s OCPUs and memory are distributed across multiple NUMA nodes.
    isPvEncryptionInTransitEnabled Boolean
    (Updatable) Use this for update operation only. This field is Deprecated during create. For create use isPvEncryptionInTransitEnabled in LaunchInstanceDetails.
    launchMode String
    Specifies the configuration mode for launching virtual machine (VM) instances. The configuration modes are:
    launchOptions InstanceLaunchOptions
    (Updatable) Options for tuning the compatibility and performance of VM shapes. The values that you specify override any default values.
    launchVolumeAttachments List<InstanceLaunchVolumeAttachment>

    Volume attachments to create as part of the launch instance operation.

    Note: This property is used for initial instance provisioning only. Updates to this property will not be supported. To update volume attachments, user should use oci.Core.VolumeAttachment. To update volume details, user should use oci.Core.Volume

    metadata Map<String,Object>

    (Updatable) 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

    platformConfig InstancePlatformConfig

    (Updatable only for VM's) The platform configuration requested for the instance.

    If you provide the parameter, the instance is created with the platform configuration that you specify. For any values that you omit, the instance uses the default configuration values for the shape that you specify. If you don't provide the parameter, the default values for the shape are used.

    Each shape only supports certain configurable values. If the values that you provide are not valid for the specified shape, an error is returned.

    For more information about shielded instances, see Shielded Instances.

    For more information about BIOS settings for bare metal instances, see BIOS Settings for Bare Metal Instances.

    preemptibleInstanceConfig InstancePreemptibleInstanceConfig
    Configuration options for preemptible instances.
    preserveBootVolume Boolean
    Whether to preserve the boot volume that was used to launch the preemptible instance when the instance is terminated. Defaults to false if not specified.
    preserveDataVolumesCreatedAtLaunch Boolean
    privateIp String

    A private IP address of your choice to assign to the VNIC. Must be an available IP address within the subnet's CIDR. If you don't specify a value, Oracle automatically assigns a private IP address from the subnet. This is the VNIC's primary private IP address. The value appears in the Vnic object and also the PrivateIp object returned by ListPrivateIps and GetPrivateIp.

    If you specify a vlanId, the privateIp cannot be specified. See Vlan.

    Example: 10.0.3.3

    publicIp String
    The public IP address of instance VNIC (if enabled).
    region String
    The region that contains the availability domain the instance is running in.
    shape String

    (Updatable) 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.

    shapeConfig InstanceShapeConfig

    (Updatable) The shape configuration requested for the instance.

    If the parameter is provided, the instance is created with the resources that you specify. If some properties are missing or the entire parameter is not provided, the instance is created with the default configuration values for the shape that you specify.

    Each shape only supports certain configurable values. If the values that you provide are not valid for the specified shape, an error is returned.

    sourceDetails InstanceSourceDetails
    (Updatable)
    state String

    (Updatable) The target state for the instance. Could be set to RUNNING or STOPPED.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    subnetId String
    Deprecated. Instead use subnetId in CreateVnicDetails. At least one of them is required; if you provide both, the values must match.

    Deprecated:The 'subnet_id' field has been deprecated. Please use 'subnet_id under create_vnic_details' instead.

    systemTags Map<String,Object>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    timeCreated String
    The date and time the instance was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    timeMaintenanceRebootDue String
    The date and time the instance is expected to be stopped / started, in the format defined by RFC3339. After that time if instance hasn't been rebooted, Oracle will reboot the instance within 24 hours of the due time. Regardless of how the instance was stopped, the flag will be reset to empty as soon as instance reaches Stopped state. Example: 2018-05-25T21:10:29.600Z
    updateOperationConstraint String
    agentConfig InstanceAgentConfig
    (Updatable) Configuration options for the Oracle Cloud Agent software running on the instance.
    async boolean
    availabilityConfig InstanceAvailabilityConfig
    (Updatable) Options for VM migration during infrastructure maintenance events and for defining the availability of a VM instance after a maintenance event that impacts the underlying hardware.
    availabilityDomain string
    The availability domain of the instance. Example: Uocm:PHX-AD-1
    bootVolumeId string
    The OCID of the attached boot volume. If the source_type is bootVolume, this will be the same OCID as the source_id.
    capacityReservationId string
    (Updatable) 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.
    compartmentId string
    (Updatable) The OCID of the compartment containing images to search
    computeClusterId string
    The OCID of the compute cluster that the instance will be created in.
    createVnicDetails InstanceCreateVnicDetails
    (Updatable) Contains properties for a VNIC. You use this object when creating the primary VNIC during instance launch or when creating a secondary VNIC. For more information about VNICs, see Virtual Network Interface Cards (VNICs).
    dedicatedVmHostId string
    (Updatable) The OCID of the dedicated virtual machine host to place the instance on.
    definedTags {[key: string]: any}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    displayName string
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    extendedMetadata {[key: string]: any}
    faultDomain string

    (Updatable) 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

    freeformTags {[key: string]: any}
    (Updatable) 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"}
    hostnameLabel string
    Deprecated. Instead use hostnameLabel in CreateVnicDetails. If you provide both, the values must match.

    Deprecated:The 'hostname_label' field has been deprecated. Please use 'hostname_label under create_vnic_details' instead.

    image string
    Deprecated. Use sourceDetails with InstanceSourceViaImageDetails source type instead. If you specify values for both, the values must match.

    Deprecated:The 'image' field has been deprecated. Please use 'source_details' instead. If both fields are specified, then 'source_details' will be used.

    instanceConfigurationId string
    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.
    instanceOptions InstanceInstanceOptions
    (Updatable) Optional mutable instance options
    ipxeScript string

    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.

    isCrossNumaNode boolean
    Whether the instance’s OCPUs and memory are distributed across multiple NUMA nodes.
    isPvEncryptionInTransitEnabled boolean
    (Updatable) Use this for update operation only. This field is Deprecated during create. For create use isPvEncryptionInTransitEnabled in LaunchInstanceDetails.
    launchMode string
    Specifies the configuration mode for launching virtual machine (VM) instances. The configuration modes are:
    launchOptions InstanceLaunchOptions
    (Updatable) Options for tuning the compatibility and performance of VM shapes. The values that you specify override any default values.
    launchVolumeAttachments InstanceLaunchVolumeAttachment[]

    Volume attachments to create as part of the launch instance operation.

    Note: This property is used for initial instance provisioning only. Updates to this property will not be supported. To update volume attachments, user should use oci.Core.VolumeAttachment. To update volume details, user should use oci.Core.Volume

    metadata {[key: string]: any}

    (Updatable) 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

    platformConfig InstancePlatformConfig

    (Updatable only for VM's) The platform configuration requested for the instance.

    If you provide the parameter, the instance is created with the platform configuration that you specify. For any values that you omit, the instance uses the default configuration values for the shape that you specify. If you don't provide the parameter, the default values for the shape are used.

    Each shape only supports certain configurable values. If the values that you provide are not valid for the specified shape, an error is returned.

    For more information about shielded instances, see Shielded Instances.

    For more information about BIOS settings for bare metal instances, see BIOS Settings for Bare Metal Instances.

    preemptibleInstanceConfig InstancePreemptibleInstanceConfig
    Configuration options for preemptible instances.
    preserveBootVolume boolean
    Whether to preserve the boot volume that was used to launch the preemptible instance when the instance is terminated. Defaults to false if not specified.
    preserveDataVolumesCreatedAtLaunch boolean
    privateIp string

    A private IP address of your choice to assign to the VNIC. Must be an available IP address within the subnet's CIDR. If you don't specify a value, Oracle automatically assigns a private IP address from the subnet. This is the VNIC's primary private IP address. The value appears in the Vnic object and also the PrivateIp object returned by ListPrivateIps and GetPrivateIp.

    If you specify a vlanId, the privateIp cannot be specified. See Vlan.

    Example: 10.0.3.3

    publicIp string
    The public IP address of instance VNIC (if enabled).
    region string
    The region that contains the availability domain the instance is running in.
    shape string

    (Updatable) 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.

    shapeConfig InstanceShapeConfig

    (Updatable) The shape configuration requested for the instance.

    If the parameter is provided, the instance is created with the resources that you specify. If some properties are missing or the entire parameter is not provided, the instance is created with the default configuration values for the shape that you specify.

    Each shape only supports certain configurable values. If the values that you provide are not valid for the specified shape, an error is returned.

    sourceDetails InstanceSourceDetails
    (Updatable)
    state string

    (Updatable) The target state for the instance. Could be set to RUNNING or STOPPED.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    subnetId string
    Deprecated. Instead use subnetId in CreateVnicDetails. At least one of them is required; if you provide both, the values must match.

    Deprecated:The 'subnet_id' field has been deprecated. Please use 'subnet_id under create_vnic_details' instead.

    systemTags {[key: string]: any}
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    timeCreated string
    The date and time the instance was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    timeMaintenanceRebootDue string
    The date and time the instance is expected to be stopped / started, in the format defined by RFC3339. After that time if instance hasn't been rebooted, Oracle will reboot the instance within 24 hours of the due time. Regardless of how the instance was stopped, the flag will be reset to empty as soon as instance reaches Stopped state. Example: 2018-05-25T21:10:29.600Z
    updateOperationConstraint string
    agent_config InstanceAgentConfigArgs
    (Updatable) Configuration options for the Oracle Cloud Agent software running on the instance.
    async_ bool
    availability_config InstanceAvailabilityConfigArgs
    (Updatable) Options for VM migration during infrastructure maintenance events and for defining the availability of a VM instance after a maintenance event that impacts the underlying hardware.
    availability_domain str
    The availability domain of the instance. Example: Uocm:PHX-AD-1
    boot_volume_id str
    The OCID of the attached boot volume. If the source_type is bootVolume, this will be the same OCID as the source_id.
    capacity_reservation_id str
    (Updatable) 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.
    compartment_id str
    (Updatable) The OCID of the compartment containing images to search
    compute_cluster_id str
    The OCID of the compute cluster that the instance will be created in.
    create_vnic_details InstanceCreateVnicDetailsArgs
    (Updatable) Contains properties for a VNIC. You use this object when creating the primary VNIC during instance launch or when creating a secondary VNIC. For more information about VNICs, see Virtual Network Interface Cards (VNICs).
    dedicated_vm_host_id str
    (Updatable) The OCID of the dedicated virtual machine host to place the instance on.
    defined_tags Mapping[str, Any]
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    display_name str
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    extended_metadata Mapping[str, Any]
    fault_domain str

    (Updatable) 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

    freeform_tags Mapping[str, Any]
    (Updatable) 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"}
    hostname_label str
    Deprecated. Instead use hostnameLabel in CreateVnicDetails. If you provide both, the values must match.

    Deprecated:The 'hostname_label' field has been deprecated. Please use 'hostname_label under create_vnic_details' instead.

    image str
    Deprecated. Use sourceDetails with InstanceSourceViaImageDetails source type instead. If you specify values for both, the values must match.

    Deprecated:The 'image' field has been deprecated. Please use 'source_details' instead. If both fields are specified, then 'source_details' will be used.

    instance_configuration_id str
    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.
    instance_options InstanceInstanceOptionsArgs
    (Updatable) Optional mutable instance options
    ipxe_script str

    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.

    is_cross_numa_node bool
    Whether the instance’s OCPUs and memory are distributed across multiple NUMA nodes.
    is_pv_encryption_in_transit_enabled bool
    (Updatable) Use this for update operation only. This field is Deprecated during create. For create use isPvEncryptionInTransitEnabled in LaunchInstanceDetails.
    launch_mode str
    Specifies the configuration mode for launching virtual machine (VM) instances. The configuration modes are:
    launch_options InstanceLaunchOptionsArgs
    (Updatable) Options for tuning the compatibility and performance of VM shapes. The values that you specify override any default values.
    launch_volume_attachments InstanceLaunchVolumeAttachmentArgs]

    Volume attachments to create as part of the launch instance operation.

    Note: This property is used for initial instance provisioning only. Updates to this property will not be supported. To update volume attachments, user should use oci.Core.VolumeAttachment. To update volume details, user should use oci.Core.Volume

    metadata Mapping[str, Any]

    (Updatable) 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

    platform_config InstancePlatformConfigArgs

    (Updatable only for VM's) The platform configuration requested for the instance.

    If you provide the parameter, the instance is created with the platform configuration that you specify. For any values that you omit, the instance uses the default configuration values for the shape that you specify. If you don't provide the parameter, the default values for the shape are used.

    Each shape only supports certain configurable values. If the values that you provide are not valid for the specified shape, an error is returned.

    For more information about shielded instances, see Shielded Instances.

    For more information about BIOS settings for bare metal instances, see BIOS Settings for Bare Metal Instances.

    preemptible_instance_config InstancePreemptibleInstanceConfigArgs
    Configuration options for preemptible instances.
    preserve_boot_volume bool
    Whether to preserve the boot volume that was used to launch the preemptible instance when the instance is terminated. Defaults to false if not specified.
    preserve_data_volumes_created_at_launch bool
    private_ip str

    A private IP address of your choice to assign to the VNIC. Must be an available IP address within the subnet's CIDR. If you don't specify a value, Oracle automatically assigns a private IP address from the subnet. This is the VNIC's primary private IP address. The value appears in the Vnic object and also the PrivateIp object returned by ListPrivateIps and GetPrivateIp.

    If you specify a vlanId, the privateIp cannot be specified. See Vlan.

    Example: 10.0.3.3

    public_ip str
    The public IP address of instance VNIC (if enabled).
    region str
    The region that contains the availability domain the instance is running in.
    shape str

    (Updatable) 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.

    shape_config InstanceShapeConfigArgs

    (Updatable) The shape configuration requested for the instance.

    If the parameter is provided, the instance is created with the resources that you specify. If some properties are missing or the entire parameter is not provided, the instance is created with the default configuration values for the shape that you specify.

    Each shape only supports certain configurable values. If the values that you provide are not valid for the specified shape, an error is returned.

    source_details InstanceSourceDetailsArgs
    (Updatable)
    state str

    (Updatable) The target state for the instance. Could be set to RUNNING or STOPPED.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    subnet_id str
    Deprecated. Instead use subnetId in CreateVnicDetails. At least one of them is required; if you provide both, the values must match.

    Deprecated:The 'subnet_id' field has been deprecated. Please use 'subnet_id under create_vnic_details' instead.

    system_tags Mapping[str, Any]
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    time_created str
    The date and time the instance was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    time_maintenance_reboot_due str
    The date and time the instance is expected to be stopped / started, in the format defined by RFC3339. After that time if instance hasn't been rebooted, Oracle will reboot the instance within 24 hours of the due time. Regardless of how the instance was stopped, the flag will be reset to empty as soon as instance reaches Stopped state. Example: 2018-05-25T21:10:29.600Z
    update_operation_constraint str
    agentConfig Property Map
    (Updatable) Configuration options for the Oracle Cloud Agent software running on the instance.
    async Boolean
    availabilityConfig Property Map
    (Updatable) Options for VM migration during infrastructure maintenance events and for defining the availability of a VM instance after a maintenance event that impacts the underlying hardware.
    availabilityDomain String
    The availability domain of the instance. Example: Uocm:PHX-AD-1
    bootVolumeId String
    The OCID of the attached boot volume. If the source_type is bootVolume, this will be the same OCID as the source_id.
    capacityReservationId String
    (Updatable) 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.
    compartmentId String
    (Updatable) The OCID of the compartment containing images to search
    computeClusterId String
    The OCID of the compute cluster that the instance will be created in.
    createVnicDetails Property Map
    (Updatable) Contains properties for a VNIC. You use this object when creating the primary VNIC during instance launch or when creating a secondary VNIC. For more information about VNICs, see Virtual Network Interface Cards (VNICs).
    dedicatedVmHostId String
    (Updatable) The OCID of the dedicated virtual machine host to place the instance on.
    definedTags Map<Any>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    displayName String
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    extendedMetadata Map<Any>
    faultDomain String

    (Updatable) 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

    freeformTags Map<Any>
    (Updatable) 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"}
    hostnameLabel String
    Deprecated. Instead use hostnameLabel in CreateVnicDetails. If you provide both, the values must match.

    Deprecated:The 'hostname_label' field has been deprecated. Please use 'hostname_label under create_vnic_details' instead.

    image String
    Deprecated. Use sourceDetails with InstanceSourceViaImageDetails source type instead. If you specify values for both, the values must match.

    Deprecated:The 'image' field has been deprecated. Please use 'source_details' instead. If both fields are specified, then 'source_details' will be used.

    instanceConfigurationId String
    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.
    instanceOptions Property Map
    (Updatable) Optional mutable instance options
    ipxeScript String

    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.

    isCrossNumaNode Boolean
    Whether the instance’s OCPUs and memory are distributed across multiple NUMA nodes.
    isPvEncryptionInTransitEnabled Boolean
    (Updatable) Use this for update operation only. This field is Deprecated during create. For create use isPvEncryptionInTransitEnabled in LaunchInstanceDetails.
    launchMode String
    Specifies the configuration mode for launching virtual machine (VM) instances. The configuration modes are:
    launchOptions Property Map
    (Updatable) Options for tuning the compatibility and performance of VM shapes. The values that you specify override any default values.
    launchVolumeAttachments List<Property Map>

    Volume attachments to create as part of the launch instance operation.

    Note: This property is used for initial instance provisioning only. Updates to this property will not be supported. To update volume attachments, user should use oci.Core.VolumeAttachment. To update volume details, user should use oci.Core.Volume

    metadata Map<Any>

    (Updatable) 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

    platformConfig Property Map

    (Updatable only for VM's) The platform configuration requested for the instance.

    If you provide the parameter, the instance is created with the platform configuration that you specify. For any values that you omit, the instance uses the default configuration values for the shape that you specify. If you don't provide the parameter, the default values for the shape are used.

    Each shape only supports certain configurable values. If the values that you provide are not valid for the specified shape, an error is returned.

    For more information about shielded instances, see Shielded Instances.

    For more information about BIOS settings for bare metal instances, see BIOS Settings for Bare Metal Instances.

    preemptibleInstanceConfig Property Map
    Configuration options for preemptible instances.
    preserveBootVolume Boolean
    Whether to preserve the boot volume that was used to launch the preemptible instance when the instance is terminated. Defaults to false if not specified.
    preserveDataVolumesCreatedAtLaunch Boolean
    privateIp String

    A private IP address of your choice to assign to the VNIC. Must be an available IP address within the subnet's CIDR. If you don't specify a value, Oracle automatically assigns a private IP address from the subnet. This is the VNIC's primary private IP address. The value appears in the Vnic object and also the PrivateIp object returned by ListPrivateIps and GetPrivateIp.

    If you specify a vlanId, the privateIp cannot be specified. See Vlan.

    Example: 10.0.3.3

    publicIp String
    The public IP address of instance VNIC (if enabled).
    region String
    The region that contains the availability domain the instance is running in.
    shape String

    (Updatable) 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.

    shapeConfig Property Map

    (Updatable) The shape configuration requested for the instance.

    If the parameter is provided, the instance is created with the resources that you specify. If some properties are missing or the entire parameter is not provided, the instance is created with the default configuration values for the shape that you specify.

    Each shape only supports certain configurable values. If the values that you provide are not valid for the specified shape, an error is returned.

    sourceDetails Property Map
    (Updatable)
    state String

    (Updatable) The target state for the instance. Could be set to RUNNING or STOPPED.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    subnetId String
    Deprecated. Instead use subnetId in CreateVnicDetails. At least one of them is required; if you provide both, the values must match.

    Deprecated:The 'subnet_id' field has been deprecated. Please use 'subnet_id under create_vnic_details' instead.

    systemTags Map<Any>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    timeCreated String
    The date and time the instance was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    timeMaintenanceRebootDue String
    The date and time the instance is expected to be stopped / started, in the format defined by RFC3339. After that time if instance hasn't been rebooted, Oracle will reboot the instance within 24 hours of the due time. Regardless of how the instance was stopped, the flag will be reset to empty as soon as instance reaches Stopped state. Example: 2018-05-25T21:10:29.600Z
    updateOperationConstraint String

    Supporting Types

    InstanceAgentConfig, InstanceAgentConfigArgs

    AreAllPluginsDisabled bool

    (Updatable) Whether Oracle Cloud Agent can run all the available plugins. This includes the management and monitoring plugins.

    To get a list of available plugins, use the ListInstanceagentAvailablePlugins operation in the Oracle Cloud Agent API. For more information about the available plugins, see Managing Plugins with Oracle Cloud Agent.

    IsManagementDisabled bool

    (Updatable) Whether Oracle Cloud Agent can run all the available management plugins. Default value is false (management plugins are enabled).

    These are the management plugins: OS Management Service Agent and Compute Instance Run Command.

    The management plugins are controlled by this parameter and by the per-plugin configuration in the pluginsConfig object.

    • If isManagementDisabled is true, all of the management plugins are disabled, regardless of the per-plugin configuration.
    • If isManagementDisabled is false, all of the management plugins are enabled. You can optionally disable individual management plugins by providing a value in the pluginsConfig object.
    IsMonitoringDisabled bool

    (Updatable) Whether Oracle Cloud Agent can gather performance metrics and monitor the instance using the monitoring plugins. Default value is false (monitoring plugins are enabled).

    These are the monitoring plugins: Compute Instance Monitoring and Custom Logs Monitoring.

    The monitoring plugins are controlled by this parameter and by the per-plugin configuration in the pluginsConfig object.

    • If isMonitoringDisabled is true, all of the monitoring plugins are disabled, regardless of the per-plugin configuration.
    • If isMonitoringDisabled is false, all of the monitoring plugins are enabled. You can optionally disable individual monitoring plugins by providing a value in the pluginsConfig object.
    PluginsConfigs List<InstanceAgentConfigPluginsConfig>
    (Updatable) The configuration of plugins associated with this instance.
    AreAllPluginsDisabled bool

    (Updatable) Whether Oracle Cloud Agent can run all the available plugins. This includes the management and monitoring plugins.

    To get a list of available plugins, use the ListInstanceagentAvailablePlugins operation in the Oracle Cloud Agent API. For more information about the available plugins, see Managing Plugins with Oracle Cloud Agent.

    IsManagementDisabled bool

    (Updatable) Whether Oracle Cloud Agent can run all the available management plugins. Default value is false (management plugins are enabled).

    These are the management plugins: OS Management Service Agent and Compute Instance Run Command.

    The management plugins are controlled by this parameter and by the per-plugin configuration in the pluginsConfig object.

    • If isManagementDisabled is true, all of the management plugins are disabled, regardless of the per-plugin configuration.
    • If isManagementDisabled is false, all of the management plugins are enabled. You can optionally disable individual management plugins by providing a value in the pluginsConfig object.
    IsMonitoringDisabled bool

    (Updatable) Whether Oracle Cloud Agent can gather performance metrics and monitor the instance using the monitoring plugins. Default value is false (monitoring plugins are enabled).

    These are the monitoring plugins: Compute Instance Monitoring and Custom Logs Monitoring.

    The monitoring plugins are controlled by this parameter and by the per-plugin configuration in the pluginsConfig object.

    • If isMonitoringDisabled is true, all of the monitoring plugins are disabled, regardless of the per-plugin configuration.
    • If isMonitoringDisabled is false, all of the monitoring plugins are enabled. You can optionally disable individual monitoring plugins by providing a value in the pluginsConfig object.
    PluginsConfigs []InstanceAgentConfigPluginsConfig
    (Updatable) The configuration of plugins associated with this instance.
    areAllPluginsDisabled Boolean

    (Updatable) Whether Oracle Cloud Agent can run all the available plugins. This includes the management and monitoring plugins.

    To get a list of available plugins, use the ListInstanceagentAvailablePlugins operation in the Oracle Cloud Agent API. For more information about the available plugins, see Managing Plugins with Oracle Cloud Agent.

    isManagementDisabled Boolean

    (Updatable) Whether Oracle Cloud Agent can run all the available management plugins. Default value is false (management plugins are enabled).

    These are the management plugins: OS Management Service Agent and Compute Instance Run Command.

    The management plugins are controlled by this parameter and by the per-plugin configuration in the pluginsConfig object.

    • If isManagementDisabled is true, all of the management plugins are disabled, regardless of the per-plugin configuration.
    • If isManagementDisabled is false, all of the management plugins are enabled. You can optionally disable individual management plugins by providing a value in the pluginsConfig object.
    isMonitoringDisabled Boolean

    (Updatable) Whether Oracle Cloud Agent can gather performance metrics and monitor the instance using the monitoring plugins. Default value is false (monitoring plugins are enabled).

    These are the monitoring plugins: Compute Instance Monitoring and Custom Logs Monitoring.

    The monitoring plugins are controlled by this parameter and by the per-plugin configuration in the pluginsConfig object.

    • If isMonitoringDisabled is true, all of the monitoring plugins are disabled, regardless of the per-plugin configuration.
    • If isMonitoringDisabled is false, all of the monitoring plugins are enabled. You can optionally disable individual monitoring plugins by providing a value in the pluginsConfig object.
    pluginsConfigs List<InstanceAgentConfigPluginsConfig>
    (Updatable) The configuration of plugins associated with this instance.
    areAllPluginsDisabled boolean

    (Updatable) Whether Oracle Cloud Agent can run all the available plugins. This includes the management and monitoring plugins.

    To get a list of available plugins, use the ListInstanceagentAvailablePlugins operation in the Oracle Cloud Agent API. For more information about the available plugins, see Managing Plugins with Oracle Cloud Agent.

    isManagementDisabled boolean

    (Updatable) Whether Oracle Cloud Agent can run all the available management plugins. Default value is false (management plugins are enabled).

    These are the management plugins: OS Management Service Agent and Compute Instance Run Command.

    The management plugins are controlled by this parameter and by the per-plugin configuration in the pluginsConfig object.

    • If isManagementDisabled is true, all of the management plugins are disabled, regardless of the per-plugin configuration.
    • If isManagementDisabled is false, all of the management plugins are enabled. You can optionally disable individual management plugins by providing a value in the pluginsConfig object.
    isMonitoringDisabled boolean

    (Updatable) Whether Oracle Cloud Agent can gather performance metrics and monitor the instance using the monitoring plugins. Default value is false (monitoring plugins are enabled).

    These are the monitoring plugins: Compute Instance Monitoring and Custom Logs Monitoring.

    The monitoring plugins are controlled by this parameter and by the per-plugin configuration in the pluginsConfig object.

    • If isMonitoringDisabled is true, all of the monitoring plugins are disabled, regardless of the per-plugin configuration.
    • If isMonitoringDisabled is false, all of the monitoring plugins are enabled. You can optionally disable individual monitoring plugins by providing a value in the pluginsConfig object.
    pluginsConfigs InstanceAgentConfigPluginsConfig[]
    (Updatable) The configuration of plugins associated with this instance.
    are_all_plugins_disabled bool

    (Updatable) Whether Oracle Cloud Agent can run all the available plugins. This includes the management and monitoring plugins.

    To get a list of available plugins, use the ListInstanceagentAvailablePlugins operation in the Oracle Cloud Agent API. For more information about the available plugins, see Managing Plugins with Oracle Cloud Agent.

    is_management_disabled bool

    (Updatable) Whether Oracle Cloud Agent can run all the available management plugins. Default value is false (management plugins are enabled).

    These are the management plugins: OS Management Service Agent and Compute Instance Run Command.

    The management plugins are controlled by this parameter and by the per-plugin configuration in the pluginsConfig object.

    • If isManagementDisabled is true, all of the management plugins are disabled, regardless of the per-plugin configuration.
    • If isManagementDisabled is false, all of the management plugins are enabled. You can optionally disable individual management plugins by providing a value in the pluginsConfig object.
    is_monitoring_disabled bool

    (Updatable) Whether Oracle Cloud Agent can gather performance metrics and monitor the instance using the monitoring plugins. Default value is false (monitoring plugins are enabled).

    These are the monitoring plugins: Compute Instance Monitoring and Custom Logs Monitoring.

    The monitoring plugins are controlled by this parameter and by the per-plugin configuration in the pluginsConfig object.

    • If isMonitoringDisabled is true, all of the monitoring plugins are disabled, regardless of the per-plugin configuration.
    • If isMonitoringDisabled is false, all of the monitoring plugins are enabled. You can optionally disable individual monitoring plugins by providing a value in the pluginsConfig object.
    plugins_configs InstanceAgentConfigPluginsConfig]
    (Updatable) The configuration of plugins associated with this instance.
    areAllPluginsDisabled Boolean

    (Updatable) Whether Oracle Cloud Agent can run all the available plugins. This includes the management and monitoring plugins.

    To get a list of available plugins, use the ListInstanceagentAvailablePlugins operation in the Oracle Cloud Agent API. For more information about the available plugins, see Managing Plugins with Oracle Cloud Agent.

    isManagementDisabled Boolean

    (Updatable) Whether Oracle Cloud Agent can run all the available management plugins. Default value is false (management plugins are enabled).

    These are the management plugins: OS Management Service Agent and Compute Instance Run Command.

    The management plugins are controlled by this parameter and by the per-plugin configuration in the pluginsConfig object.

    • If isManagementDisabled is true, all of the management plugins are disabled, regardless of the per-plugin configuration.
    • If isManagementDisabled is false, all of the management plugins are enabled. You can optionally disable individual management plugins by providing a value in the pluginsConfig object.
    isMonitoringDisabled Boolean

    (Updatable) Whether Oracle Cloud Agent can gather performance metrics and monitor the instance using the monitoring plugins. Default value is false (monitoring plugins are enabled).

    These are the monitoring plugins: Compute Instance Monitoring and Custom Logs Monitoring.

    The monitoring plugins are controlled by this parameter and by the per-plugin configuration in the pluginsConfig object.

    • If isMonitoringDisabled is true, all of the monitoring plugins are disabled, regardless of the per-plugin configuration.
    • If isMonitoringDisabled is false, all of the monitoring plugins are enabled. You can optionally disable individual monitoring plugins by providing a value in the pluginsConfig object.
    pluginsConfigs List<Property Map>
    (Updatable) The configuration of plugins associated with this instance.

    InstanceAgentConfigPluginsConfig, InstanceAgentConfigPluginsConfigArgs

    DesiredState string

    (Updatable) Whether the plugin should be enabled or disabled.

    To enable the monitoring and management plugins, the isMonitoringDisabled and isManagementDisabled attributes must also be set to false.

    Name string
    (Updatable) The plugin name. To get a list of available plugins, use the ListInstanceagentAvailablePlugins operation in the Oracle Cloud Agent API. For more information about the available plugins, see Managing Plugins with Oracle Cloud Agent.
    DesiredState string

    (Updatable) Whether the plugin should be enabled or disabled.

    To enable the monitoring and management plugins, the isMonitoringDisabled and isManagementDisabled attributes must also be set to false.

    Name string
    (Updatable) The plugin name. To get a list of available plugins, use the ListInstanceagentAvailablePlugins operation in the Oracle Cloud Agent API. For more information about the available plugins, see Managing Plugins with Oracle Cloud Agent.
    desiredState String

    (Updatable) Whether the plugin should be enabled or disabled.

    To enable the monitoring and management plugins, the isMonitoringDisabled and isManagementDisabled attributes must also be set to false.

    name String
    (Updatable) The plugin name. To get a list of available plugins, use the ListInstanceagentAvailablePlugins operation in the Oracle Cloud Agent API. For more information about the available plugins, see Managing Plugins with Oracle Cloud Agent.
    desiredState string

    (Updatable) Whether the plugin should be enabled or disabled.

    To enable the monitoring and management plugins, the isMonitoringDisabled and isManagementDisabled attributes must also be set to false.

    name string
    (Updatable) The plugin name. To get a list of available plugins, use the ListInstanceagentAvailablePlugins operation in the Oracle Cloud Agent API. For more information about the available plugins, see Managing Plugins with Oracle Cloud Agent.
    desired_state str

    (Updatable) Whether the plugin should be enabled or disabled.

    To enable the monitoring and management plugins, the isMonitoringDisabled and isManagementDisabled attributes must also be set to false.

    name str
    (Updatable) The plugin name. To get a list of available plugins, use the ListInstanceagentAvailablePlugins operation in the Oracle Cloud Agent API. For more information about the available plugins, see Managing Plugins with Oracle Cloud Agent.
    desiredState String

    (Updatable) Whether the plugin should be enabled or disabled.

    To enable the monitoring and management plugins, the isMonitoringDisabled and isManagementDisabled attributes must also be set to false.

    name String
    (Updatable) The plugin name. To get a list of available plugins, use the ListInstanceagentAvailablePlugins operation in the Oracle Cloud Agent API. For more information about the available plugins, see Managing Plugins with Oracle Cloud Agent.

    InstanceAvailabilityConfig, InstanceAvailabilityConfigArgs

    IsLiveMigrationPreferred bool
    (Updatable) Whether to live migrate supported VM instances to a healthy physical VM host without disrupting running instances during infrastructure maintenance events. If null, Oracle chooses the best option for migrating the VM during infrastructure maintenance events.
    RecoveryAction string
    (Updatable) The lifecycle state for an instance when it is recovered after infrastructure maintenance.
    IsLiveMigrationPreferred bool
    (Updatable) Whether to live migrate supported VM instances to a healthy physical VM host without disrupting running instances during infrastructure maintenance events. If null, Oracle chooses the best option for migrating the VM during infrastructure maintenance events.
    RecoveryAction string
    (Updatable) The lifecycle state for an instance when it is recovered after infrastructure maintenance.
    isLiveMigrationPreferred Boolean
    (Updatable) Whether to live migrate supported VM instances to a healthy physical VM host without disrupting running instances during infrastructure maintenance events. If null, Oracle chooses the best option for migrating the VM during infrastructure maintenance events.
    recoveryAction String
    (Updatable) The lifecycle state for an instance when it is recovered after infrastructure maintenance.
    isLiveMigrationPreferred boolean
    (Updatable) Whether to live migrate supported VM instances to a healthy physical VM host without disrupting running instances during infrastructure maintenance events. If null, Oracle chooses the best option for migrating the VM during infrastructure maintenance events.
    recoveryAction string
    (Updatable) The lifecycle state for an instance when it is recovered after infrastructure maintenance.
    is_live_migration_preferred bool
    (Updatable) Whether to live migrate supported VM instances to a healthy physical VM host without disrupting running instances during infrastructure maintenance events. If null, Oracle chooses the best option for migrating the VM during infrastructure maintenance events.
    recovery_action str
    (Updatable) The lifecycle state for an instance when it is recovered after infrastructure maintenance.
    isLiveMigrationPreferred Boolean
    (Updatable) Whether to live migrate supported VM instances to a healthy physical VM host without disrupting running instances during infrastructure maintenance events. If null, Oracle chooses the best option for migrating the VM during infrastructure maintenance events.
    recoveryAction String
    (Updatable) The lifecycle state for an instance when it is recovered after infrastructure maintenance.

    InstanceCreateVnicDetails, InstanceCreateVnicDetailsArgs

    AssignIpv6ip bool
    Whether to allocate an IPv6 address at instance and VNIC creation from an IPv6 enabled subnet. Default: False. When provided you may optionally provide an IPv6 prefix (ipv6SubnetCidr) of your choice to assign the IPv6 address from. If ipv6SubnetCidr is not provided then an IPv6 prefix is chosen for you.
    AssignPrivateDnsRecord bool
    Whether the VNIC should be assigned a DNS record. If set to false, there will be no DNS record registration for the VNIC. If set to true, the DNS record will be registered. The default value is true. If you specify a hostnameLabel, the assignPrivateDnsRecord is require to be set to true.
    AssignPublicIp string

    (Updatable) Whether the VNIC should be assigned a public IP address. Defaults to whether the subnet is public or private. If not set and the VNIC is being created in a private subnet (that is, where prohibitPublicIpOnVnic = true in the Subnet), then no public IP address is assigned. If not set and the subnet is public (prohibitPublicIpOnVnic = false), then a public IP address is assigned. If set to true and prohibitPublicIpOnVnic = true, an error is returned.

    Note: This public IP address is associated with the primary private IP on the VNIC. For more information, see IP Addresses.

    Note: There's a limit to the number of public IPs a VNIC or instance can have. If you try to create a secondary VNIC with an assigned public IP for an instance that has already reached its public IP limit, an error is returned. For information about the public IP limits, see Public IP Addresses.

    Example: false

    If you specify a vlanId, then assignPublicIp must be set to false. See Vlan.

    DefinedTags Dictionary<string, object>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    DisplayName string
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    FreeformTags Dictionary<string, object>
    (Updatable) 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"}
    HostnameLabel string
    Deprecated. Instead use hostnameLabel in CreateVnicDetails. If you provide both, the values must match.
    Ipv6addressIpv6subnetCidrPairDetails List<InstanceCreateVnicDetailsIpv6addressIpv6subnetCidrPairDetail>
    A list of IPv6 prefix ranges from which the VNIC should be assigned an IPv6 address. You can provide only the prefix ranges from which Oracle Cloud Infrastructure will select an available address from the range. You can optionally choose to leave the prefix range empty and instead provide the specific IPv6 address that should be used from within that range.
    NsgIds List<string>

    (Updatable) A list of the OCIDs of the network security groups (NSGs) to add the VNIC to. For more information about NSGs, see NetworkSecurityGroup.

    If a vlanId is specified, the nsgIds cannot be specified. The vlanId indicates that the VNIC will belong to a VLAN instead of a subnet. With VLANs, all VNICs in the VLAN belong to the NSGs that are associated with the VLAN. See Vlan.

    PrivateIp string

    A private IP address of your choice to assign to the VNIC. Must be an available IP address within the subnet's CIDR. If you don't specify a value, Oracle automatically assigns a private IP address from the subnet. This is the VNIC's primary private IP address. The value appears in the Vnic object and also the PrivateIp object returned by ListPrivateIps and GetPrivateIp.

    If you specify a vlanId, the privateIp cannot be specified. See Vlan.

    Example: 10.0.3.3

    SkipSourceDestCheck bool

    (Updatable) Whether the source/destination check is disabled on the VNIC. Defaults to false, which means the check is performed. For information about why you would skip the source/destination check, see Using a Private IP as a Route Target.

    If you specify a vlanId, the skipSourceDestCheck cannot be specified because the source/destination check is always disabled for VNICs in a VLAN. See Vlan.

    Example: true

    SubnetId string
    Deprecated. Instead use subnetId in CreateVnicDetails. At least one of them is required; if you provide both, the values must match.
    VlanId string

    Provide this attribute only if you are an Oracle Cloud VMware Solution customer and creating a secondary VNIC in a VLAN. The value is the OCID of the VLAN. See Vlan.

    Provide a vlanId instead of a subnetId. If you provide both a vlanId and subnetId, the request fails.

    AssignIpv6ip bool
    Whether to allocate an IPv6 address at instance and VNIC creation from an IPv6 enabled subnet. Default: False. When provided you may optionally provide an IPv6 prefix (ipv6SubnetCidr) of your choice to assign the IPv6 address from. If ipv6SubnetCidr is not provided then an IPv6 prefix is chosen for you.
    AssignPrivateDnsRecord bool
    Whether the VNIC should be assigned a DNS record. If set to false, there will be no DNS record registration for the VNIC. If set to true, the DNS record will be registered. The default value is true. If you specify a hostnameLabel, the assignPrivateDnsRecord is require to be set to true.
    AssignPublicIp string

    (Updatable) Whether the VNIC should be assigned a public IP address. Defaults to whether the subnet is public or private. If not set and the VNIC is being created in a private subnet (that is, where prohibitPublicIpOnVnic = true in the Subnet), then no public IP address is assigned. If not set and the subnet is public (prohibitPublicIpOnVnic = false), then a public IP address is assigned. If set to true and prohibitPublicIpOnVnic = true, an error is returned.

    Note: This public IP address is associated with the primary private IP on the VNIC. For more information, see IP Addresses.

    Note: There's a limit to the number of public IPs a VNIC or instance can have. If you try to create a secondary VNIC with an assigned public IP for an instance that has already reached its public IP limit, an error is returned. For information about the public IP limits, see Public IP Addresses.

    Example: false

    If you specify a vlanId, then assignPublicIp must be set to false. See Vlan.

    DefinedTags map[string]interface{}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    DisplayName string
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    FreeformTags map[string]interface{}
    (Updatable) 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"}
    HostnameLabel string
    Deprecated. Instead use hostnameLabel in CreateVnicDetails. If you provide both, the values must match.
    Ipv6addressIpv6subnetCidrPairDetails []InstanceCreateVnicDetailsIpv6addressIpv6subnetCidrPairDetail
    A list of IPv6 prefix ranges from which the VNIC should be assigned an IPv6 address. You can provide only the prefix ranges from which Oracle Cloud Infrastructure will select an available address from the range. You can optionally choose to leave the prefix range empty and instead provide the specific IPv6 address that should be used from within that range.
    NsgIds []string

    (Updatable) A list of the OCIDs of the network security groups (NSGs) to add the VNIC to. For more information about NSGs, see NetworkSecurityGroup.

    If a vlanId is specified, the nsgIds cannot be specified. The vlanId indicates that the VNIC will belong to a VLAN instead of a subnet. With VLANs, all VNICs in the VLAN belong to the NSGs that are associated with the VLAN. See Vlan.

    PrivateIp string

    A private IP address of your choice to assign to the VNIC. Must be an available IP address within the subnet's CIDR. If you don't specify a value, Oracle automatically assigns a private IP address from the subnet. This is the VNIC's primary private IP address. The value appears in the Vnic object and also the PrivateIp object returned by ListPrivateIps and GetPrivateIp.

    If you specify a vlanId, the privateIp cannot be specified. See Vlan.

    Example: 10.0.3.3

    SkipSourceDestCheck bool

    (Updatable) Whether the source/destination check is disabled on the VNIC. Defaults to false, which means the check is performed. For information about why you would skip the source/destination check, see Using a Private IP as a Route Target.

    If you specify a vlanId, the skipSourceDestCheck cannot be specified because the source/destination check is always disabled for VNICs in a VLAN. See Vlan.

    Example: true

    SubnetId string
    Deprecated. Instead use subnetId in CreateVnicDetails. At least one of them is required; if you provide both, the values must match.
    VlanId string

    Provide this attribute only if you are an Oracle Cloud VMware Solution customer and creating a secondary VNIC in a VLAN. The value is the OCID of the VLAN. See Vlan.

    Provide a vlanId instead of a subnetId. If you provide both a vlanId and subnetId, the request fails.

    assignIpv6ip Boolean
    Whether to allocate an IPv6 address at instance and VNIC creation from an IPv6 enabled subnet. Default: False. When provided you may optionally provide an IPv6 prefix (ipv6SubnetCidr) of your choice to assign the IPv6 address from. If ipv6SubnetCidr is not provided then an IPv6 prefix is chosen for you.
    assignPrivateDnsRecord Boolean
    Whether the VNIC should be assigned a DNS record. If set to false, there will be no DNS record registration for the VNIC. If set to true, the DNS record will be registered. The default value is true. If you specify a hostnameLabel, the assignPrivateDnsRecord is require to be set to true.
    assignPublicIp String

    (Updatable) Whether the VNIC should be assigned a public IP address. Defaults to whether the subnet is public or private. If not set and the VNIC is being created in a private subnet (that is, where prohibitPublicIpOnVnic = true in the Subnet), then no public IP address is assigned. If not set and the subnet is public (prohibitPublicIpOnVnic = false), then a public IP address is assigned. If set to true and prohibitPublicIpOnVnic = true, an error is returned.

    Note: This public IP address is associated with the primary private IP on the VNIC. For more information, see IP Addresses.

    Note: There's a limit to the number of public IPs a VNIC or instance can have. If you try to create a secondary VNIC with an assigned public IP for an instance that has already reached its public IP limit, an error is returned. For information about the public IP limits, see Public IP Addresses.

    Example: false

    If you specify a vlanId, then assignPublicIp must be set to false. See Vlan.

    definedTags Map<String,Object>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    displayName String
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    freeformTags Map<String,Object>
    (Updatable) 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"}
    hostnameLabel String
    Deprecated. Instead use hostnameLabel in CreateVnicDetails. If you provide both, the values must match.
    ipv6addressIpv6subnetCidrPairDetails List<InstanceCreateVnicDetailsIpv6addressIpv6subnetCidrPairDetail>
    A list of IPv6 prefix ranges from which the VNIC should be assigned an IPv6 address. You can provide only the prefix ranges from which Oracle Cloud Infrastructure will select an available address from the range. You can optionally choose to leave the prefix range empty and instead provide the specific IPv6 address that should be used from within that range.
    nsgIds List<String>

    (Updatable) A list of the OCIDs of the network security groups (NSGs) to add the VNIC to. For more information about NSGs, see NetworkSecurityGroup.

    If a vlanId is specified, the nsgIds cannot be specified. The vlanId indicates that the VNIC will belong to a VLAN instead of a subnet. With VLANs, all VNICs in the VLAN belong to the NSGs that are associated with the VLAN. See Vlan.

    privateIp String

    A private IP address of your choice to assign to the VNIC. Must be an available IP address within the subnet's CIDR. If you don't specify a value, Oracle automatically assigns a private IP address from the subnet. This is the VNIC's primary private IP address. The value appears in the Vnic object and also the PrivateIp object returned by ListPrivateIps and GetPrivateIp.

    If you specify a vlanId, the privateIp cannot be specified. See Vlan.

    Example: 10.0.3.3

    skipSourceDestCheck Boolean

    (Updatable) Whether the source/destination check is disabled on the VNIC. Defaults to false, which means the check is performed. For information about why you would skip the source/destination check, see Using a Private IP as a Route Target.

    If you specify a vlanId, the skipSourceDestCheck cannot be specified because the source/destination check is always disabled for VNICs in a VLAN. See Vlan.

    Example: true

    subnetId String
    Deprecated. Instead use subnetId in CreateVnicDetails. At least one of them is required; if you provide both, the values must match.
    vlanId String

    Provide this attribute only if you are an Oracle Cloud VMware Solution customer and creating a secondary VNIC in a VLAN. The value is the OCID of the VLAN. See Vlan.

    Provide a vlanId instead of a subnetId. If you provide both a vlanId and subnetId, the request fails.

    assignIpv6ip boolean
    Whether to allocate an IPv6 address at instance and VNIC creation from an IPv6 enabled subnet. Default: False. When provided you may optionally provide an IPv6 prefix (ipv6SubnetCidr) of your choice to assign the IPv6 address from. If ipv6SubnetCidr is not provided then an IPv6 prefix is chosen for you.
    assignPrivateDnsRecord boolean
    Whether the VNIC should be assigned a DNS record. If set to false, there will be no DNS record registration for the VNIC. If set to true, the DNS record will be registered. The default value is true. If you specify a hostnameLabel, the assignPrivateDnsRecord is require to be set to true.
    assignPublicIp string

    (Updatable) Whether the VNIC should be assigned a public IP address. Defaults to whether the subnet is public or private. If not set and the VNIC is being created in a private subnet (that is, where prohibitPublicIpOnVnic = true in the Subnet), then no public IP address is assigned. If not set and the subnet is public (prohibitPublicIpOnVnic = false), then a public IP address is assigned. If set to true and prohibitPublicIpOnVnic = true, an error is returned.

    Note: This public IP address is associated with the primary private IP on the VNIC. For more information, see IP Addresses.

    Note: There's a limit to the number of public IPs a VNIC or instance can have. If you try to create a secondary VNIC with an assigned public IP for an instance that has already reached its public IP limit, an error is returned. For information about the public IP limits, see Public IP Addresses.

    Example: false

    If you specify a vlanId, then assignPublicIp must be set to false. See Vlan.

    definedTags {[key: string]: any}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    displayName string
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    freeformTags {[key: string]: any}
    (Updatable) 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"}
    hostnameLabel string
    Deprecated. Instead use hostnameLabel in CreateVnicDetails. If you provide both, the values must match.
    ipv6addressIpv6subnetCidrPairDetails InstanceCreateVnicDetailsIpv6addressIpv6subnetCidrPairDetail[]
    A list of IPv6 prefix ranges from which the VNIC should be assigned an IPv6 address. You can provide only the prefix ranges from which Oracle Cloud Infrastructure will select an available address from the range. You can optionally choose to leave the prefix range empty and instead provide the specific IPv6 address that should be used from within that range.
    nsgIds string[]

    (Updatable) A list of the OCIDs of the network security groups (NSGs) to add the VNIC to. For more information about NSGs, see NetworkSecurityGroup.

    If a vlanId is specified, the nsgIds cannot be specified. The vlanId indicates that the VNIC will belong to a VLAN instead of a subnet. With VLANs, all VNICs in the VLAN belong to the NSGs that are associated with the VLAN. See Vlan.

    privateIp string

    A private IP address of your choice to assign to the VNIC. Must be an available IP address within the subnet's CIDR. If you don't specify a value, Oracle automatically assigns a private IP address from the subnet. This is the VNIC's primary private IP address. The value appears in the Vnic object and also the PrivateIp object returned by ListPrivateIps and GetPrivateIp.

    If you specify a vlanId, the privateIp cannot be specified. See Vlan.

    Example: 10.0.3.3

    skipSourceDestCheck boolean

    (Updatable) Whether the source/destination check is disabled on the VNIC. Defaults to false, which means the check is performed. For information about why you would skip the source/destination check, see Using a Private IP as a Route Target.

    If you specify a vlanId, the skipSourceDestCheck cannot be specified because the source/destination check is always disabled for VNICs in a VLAN. See Vlan.

    Example: true

    subnetId string
    Deprecated. Instead use subnetId in CreateVnicDetails. At least one of them is required; if you provide both, the values must match.
    vlanId string

    Provide this attribute only if you are an Oracle Cloud VMware Solution customer and creating a secondary VNIC in a VLAN. The value is the OCID of the VLAN. See Vlan.

    Provide a vlanId instead of a subnetId. If you provide both a vlanId and subnetId, the request fails.

    assign_ipv6ip bool
    Whether to allocate an IPv6 address at instance and VNIC creation from an IPv6 enabled subnet. Default: False. When provided you may optionally provide an IPv6 prefix (ipv6SubnetCidr) of your choice to assign the IPv6 address from. If ipv6SubnetCidr is not provided then an IPv6 prefix is chosen for you.
    assign_private_dns_record bool
    Whether the VNIC should be assigned a DNS record. If set to false, there will be no DNS record registration for the VNIC. If set to true, the DNS record will be registered. The default value is true. If you specify a hostnameLabel, the assignPrivateDnsRecord is require to be set to true.
    assign_public_ip str

    (Updatable) Whether the VNIC should be assigned a public IP address. Defaults to whether the subnet is public or private. If not set and the VNIC is being created in a private subnet (that is, where prohibitPublicIpOnVnic = true in the Subnet), then no public IP address is assigned. If not set and the subnet is public (prohibitPublicIpOnVnic = false), then a public IP address is assigned. If set to true and prohibitPublicIpOnVnic = true, an error is returned.

    Note: This public IP address is associated with the primary private IP on the VNIC. For more information, see IP Addresses.

    Note: There's a limit to the number of public IPs a VNIC or instance can have. If you try to create a secondary VNIC with an assigned public IP for an instance that has already reached its public IP limit, an error is returned. For information about the public IP limits, see Public IP Addresses.

    Example: false

    If you specify a vlanId, then assignPublicIp must be set to false. See Vlan.

    defined_tags Mapping[str, Any]
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    display_name str
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    freeform_tags Mapping[str, Any]
    (Updatable) 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"}
    hostname_label str
    Deprecated. Instead use hostnameLabel in CreateVnicDetails. If you provide both, the values must match.
    ipv6address_ipv6subnet_cidr_pair_details InstanceCreateVnicDetailsIpv6addressIpv6subnetCidrPairDetail]
    A list of IPv6 prefix ranges from which the VNIC should be assigned an IPv6 address. You can provide only the prefix ranges from which Oracle Cloud Infrastructure will select an available address from the range. You can optionally choose to leave the prefix range empty and instead provide the specific IPv6 address that should be used from within that range.
    nsg_ids Sequence[str]

    (Updatable) A list of the OCIDs of the network security groups (NSGs) to add the VNIC to. For more information about NSGs, see NetworkSecurityGroup.

    If a vlanId is specified, the nsgIds cannot be specified. The vlanId indicates that the VNIC will belong to a VLAN instead of a subnet. With VLANs, all VNICs in the VLAN belong to the NSGs that are associated with the VLAN. See Vlan.

    private_ip str

    A private IP address of your choice to assign to the VNIC. Must be an available IP address within the subnet's CIDR. If you don't specify a value, Oracle automatically assigns a private IP address from the subnet. This is the VNIC's primary private IP address. The value appears in the Vnic object and also the PrivateIp object returned by ListPrivateIps and GetPrivateIp.

    If you specify a vlanId, the privateIp cannot be specified. See Vlan.

    Example: 10.0.3.3

    skip_source_dest_check bool

    (Updatable) Whether the source/destination check is disabled on the VNIC. Defaults to false, which means the check is performed. For information about why you would skip the source/destination check, see Using a Private IP as a Route Target.

    If you specify a vlanId, the skipSourceDestCheck cannot be specified because the source/destination check is always disabled for VNICs in a VLAN. See Vlan.

    Example: true

    subnet_id str
    Deprecated. Instead use subnetId in CreateVnicDetails. At least one of them is required; if you provide both, the values must match.
    vlan_id str

    Provide this attribute only if you are an Oracle Cloud VMware Solution customer and creating a secondary VNIC in a VLAN. The value is the OCID of the VLAN. See Vlan.

    Provide a vlanId instead of a subnetId. If you provide both a vlanId and subnetId, the request fails.

    assignIpv6ip Boolean
    Whether to allocate an IPv6 address at instance and VNIC creation from an IPv6 enabled subnet. Default: False. When provided you may optionally provide an IPv6 prefix (ipv6SubnetCidr) of your choice to assign the IPv6 address from. If ipv6SubnetCidr is not provided then an IPv6 prefix is chosen for you.
    assignPrivateDnsRecord Boolean
    Whether the VNIC should be assigned a DNS record. If set to false, there will be no DNS record registration for the VNIC. If set to true, the DNS record will be registered. The default value is true. If you specify a hostnameLabel, the assignPrivateDnsRecord is require to be set to true.
    assignPublicIp String

    (Updatable) Whether the VNIC should be assigned a public IP address. Defaults to whether the subnet is public or private. If not set and the VNIC is being created in a private subnet (that is, where prohibitPublicIpOnVnic = true in the Subnet), then no public IP address is assigned. If not set and the subnet is public (prohibitPublicIpOnVnic = false), then a public IP address is assigned. If set to true and prohibitPublicIpOnVnic = true, an error is returned.

    Note: This public IP address is associated with the primary private IP on the VNIC. For more information, see IP Addresses.

    Note: There's a limit to the number of public IPs a VNIC or instance can have. If you try to create a secondary VNIC with an assigned public IP for an instance that has already reached its public IP limit, an error is returned. For information about the public IP limits, see Public IP Addresses.

    Example: false

    If you specify a vlanId, then assignPublicIp must be set to false. See Vlan.

    definedTags Map<Any>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    displayName String
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    freeformTags Map<Any>
    (Updatable) 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"}
    hostnameLabel String
    Deprecated. Instead use hostnameLabel in CreateVnicDetails. If you provide both, the values must match.
    ipv6addressIpv6subnetCidrPairDetails List<Property Map>
    A list of IPv6 prefix ranges from which the VNIC should be assigned an IPv6 address. You can provide only the prefix ranges from which Oracle Cloud Infrastructure will select an available address from the range. You can optionally choose to leave the prefix range empty and instead provide the specific IPv6 address that should be used from within that range.
    nsgIds List<String>

    (Updatable) A list of the OCIDs of the network security groups (NSGs) to add the VNIC to. For more information about NSGs, see NetworkSecurityGroup.

    If a vlanId is specified, the nsgIds cannot be specified. The vlanId indicates that the VNIC will belong to a VLAN instead of a subnet. With VLANs, all VNICs in the VLAN belong to the NSGs that are associated with the VLAN. See Vlan.

    privateIp String

    A private IP address of your choice to assign to the VNIC. Must be an available IP address within the subnet's CIDR. If you don't specify a value, Oracle automatically assigns a private IP address from the subnet. This is the VNIC's primary private IP address. The value appears in the Vnic object and also the PrivateIp object returned by ListPrivateIps and GetPrivateIp.

    If you specify a vlanId, the privateIp cannot be specified. See Vlan.

    Example: 10.0.3.3

    skipSourceDestCheck Boolean

    (Updatable) Whether the source/destination check is disabled on the VNIC. Defaults to false, which means the check is performed. For information about why you would skip the source/destination check, see Using a Private IP as a Route Target.

    If you specify a vlanId, the skipSourceDestCheck cannot be specified because the source/destination check is always disabled for VNICs in a VLAN. See Vlan.

    Example: true

    subnetId String
    Deprecated. Instead use subnetId in CreateVnicDetails. At least one of them is required; if you provide both, the values must match.
    vlanId String

    Provide this attribute only if you are an Oracle Cloud VMware Solution customer and creating a secondary VNIC in a VLAN. The value is the OCID of the VLAN. See Vlan.

    Provide a vlanId instead of a subnetId. If you provide both a vlanId and subnetId, the request fails.

    InstanceCreateVnicDetailsIpv6addressIpv6subnetCidrPairDetail, InstanceCreateVnicDetailsIpv6addressIpv6subnetCidrPairDetailArgs

    InstanceInstanceOptions, InstanceInstanceOptionsArgs

    AreLegacyImdsEndpointsDisabled bool
    (Updatable) Whether to disable the legacy (/v1) instance metadata service endpoints. Customers who have migrated to /v2 should set this to true for added security. Default is false.
    AreLegacyImdsEndpointsDisabled bool
    (Updatable) Whether to disable the legacy (/v1) instance metadata service endpoints. Customers who have migrated to /v2 should set this to true for added security. Default is false.
    areLegacyImdsEndpointsDisabled Boolean
    (Updatable) Whether to disable the legacy (/v1) instance metadata service endpoints. Customers who have migrated to /v2 should set this to true for added security. Default is false.
    areLegacyImdsEndpointsDisabled boolean
    (Updatable) Whether to disable the legacy (/v1) instance metadata service endpoints. Customers who have migrated to /v2 should set this to true for added security. Default is false.
    are_legacy_imds_endpoints_disabled bool
    (Updatable) Whether to disable the legacy (/v1) instance metadata service endpoints. Customers who have migrated to /v2 should set this to true for added security. Default is false.
    areLegacyImdsEndpointsDisabled Boolean
    (Updatable) Whether to disable the legacy (/v1) instance metadata service endpoints. Customers who have migrated to /v2 should set this to true for added security. Default is false.

    InstanceLaunchOptions, InstanceLaunchOptionsArgs

    BootVolumeType string
    (Updatable) Emulation type for the boot volume.
    Firmware string
    Firmware used to boot VM. Select the option that matches your operating system.
    IsConsistentVolumeNamingEnabled bool
    Whether to enable consistent volume naming feature. Defaults to false.
    IsPvEncryptionInTransitEnabled bool
    (Updatable) Use this for update operation only. This field is Deprecated during create. For create use isPvEncryptionInTransitEnabled in LaunchInstanceDetails.
    NetworkType string
    (Updatable) Emulation type for the physical network interface card (NIC).
    RemoteDataVolumeType string
    Emulation type for volume.
    BootVolumeType string
    (Updatable) Emulation type for the boot volume.
    Firmware string
    Firmware used to boot VM. Select the option that matches your operating system.
    IsConsistentVolumeNamingEnabled bool
    Whether to enable consistent volume naming feature. Defaults to false.
    IsPvEncryptionInTransitEnabled bool
    (Updatable) Use this for update operation only. This field is Deprecated during create. For create use isPvEncryptionInTransitEnabled in LaunchInstanceDetails.
    NetworkType string
    (Updatable) Emulation type for the physical network interface card (NIC).
    RemoteDataVolumeType string
    Emulation type for volume.
    bootVolumeType String
    (Updatable) Emulation type for the boot volume.
    firmware String
    Firmware used to boot VM. Select the option that matches your operating system.
    isConsistentVolumeNamingEnabled Boolean
    Whether to enable consistent volume naming feature. Defaults to false.
    isPvEncryptionInTransitEnabled Boolean
    (Updatable) Use this for update operation only. This field is Deprecated during create. For create use isPvEncryptionInTransitEnabled in LaunchInstanceDetails.
    networkType String
    (Updatable) Emulation type for the physical network interface card (NIC).
    remoteDataVolumeType String
    Emulation type for volume.
    bootVolumeType string
    (Updatable) Emulation type for the boot volume.
    firmware string
    Firmware used to boot VM. Select the option that matches your operating system.
    isConsistentVolumeNamingEnabled boolean
    Whether to enable consistent volume naming feature. Defaults to false.
    isPvEncryptionInTransitEnabled boolean
    (Updatable) Use this for update operation only. This field is Deprecated during create. For create use isPvEncryptionInTransitEnabled in LaunchInstanceDetails.
    networkType string
    (Updatable) Emulation type for the physical network interface card (NIC).
    remoteDataVolumeType string
    Emulation type for volume.
    boot_volume_type str
    (Updatable) Emulation type for the boot volume.
    firmware str
    Firmware used to boot VM. Select the option that matches your operating system.
    is_consistent_volume_naming_enabled bool
    Whether to enable consistent volume naming feature. Defaults to false.
    is_pv_encryption_in_transit_enabled bool
    (Updatable) Use this for update operation only. This field is Deprecated during create. For create use isPvEncryptionInTransitEnabled in LaunchInstanceDetails.
    network_type str
    (Updatable) Emulation type for the physical network interface card (NIC).
    remote_data_volume_type str
    Emulation type for volume.
    bootVolumeType String
    (Updatable) Emulation type for the boot volume.
    firmware String
    Firmware used to boot VM. Select the option that matches your operating system.
    isConsistentVolumeNamingEnabled Boolean
    Whether to enable consistent volume naming feature. Defaults to false.
    isPvEncryptionInTransitEnabled Boolean
    (Updatable) Use this for update operation only. This field is Deprecated during create. For create use isPvEncryptionInTransitEnabled in LaunchInstanceDetails.
    networkType String
    (Updatable) Emulation type for the physical network interface card (NIC).
    remoteDataVolumeType String
    Emulation type for volume.

    InstanceLaunchVolumeAttachment, InstanceLaunchVolumeAttachmentArgs

    Type string
    The type of action to run when the instance is interrupted for eviction.
    Device string
    The device name. To retrieve a list of devices for a given instance, see ListInstanceDevices.
    DisplayName string
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    EncryptionInTransitType string
    Refer the top-level definition of encryptionInTransitType. The default value is NONE.
    IsAgentAutoIscsiLoginEnabled bool
    Whether to enable Oracle Cloud Agent to perform the iSCSI login and logout commands after the volume attach or detach operations for non multipath-enabled iSCSI attachments.
    IsReadOnly bool
    Whether the attachment was created in read-only mode.
    IsShareable bool
    Whether the attachment should be created in shareable mode. If an attachment is created in shareable mode, then other instances can attach the same volume, provided that they also create their attachments in shareable mode. Only certain volume types can be attached in shareable mode. Defaults to false if not specified.
    LaunchCreateVolumeDetails InstanceLaunchVolumeAttachmentLaunchCreateVolumeDetails
    Define a volume that will be created and attached or attached to an instance on creation.
    UseChap bool
    Whether to use CHAP authentication for the volume attachment. Defaults to false.
    VolumeId string
    The OCID of the volume. If CreateVolumeDetails is specified, this field must be omitted from the request.
    Type string
    The type of action to run when the instance is interrupted for eviction.
    Device string
    The device name. To retrieve a list of devices for a given instance, see ListInstanceDevices.
    DisplayName string
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    EncryptionInTransitType string
    Refer the top-level definition of encryptionInTransitType. The default value is NONE.
    IsAgentAutoIscsiLoginEnabled bool
    Whether to enable Oracle Cloud Agent to perform the iSCSI login and logout commands after the volume attach or detach operations for non multipath-enabled iSCSI attachments.
    IsReadOnly bool
    Whether the attachment was created in read-only mode.
    IsShareable bool
    Whether the attachment should be created in shareable mode. If an attachment is created in shareable mode, then other instances can attach the same volume, provided that they also create their attachments in shareable mode. Only certain volume types can be attached in shareable mode. Defaults to false if not specified.
    LaunchCreateVolumeDetails InstanceLaunchVolumeAttachmentLaunchCreateVolumeDetails
    Define a volume that will be created and attached or attached to an instance on creation.
    UseChap bool
    Whether to use CHAP authentication for the volume attachment. Defaults to false.
    VolumeId string
    The OCID of the volume. If CreateVolumeDetails is specified, this field must be omitted from the request.
    type String
    The type of action to run when the instance is interrupted for eviction.
    device String
    The device name. To retrieve a list of devices for a given instance, see ListInstanceDevices.
    displayName String
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    encryptionInTransitType String
    Refer the top-level definition of encryptionInTransitType. The default value is NONE.
    isAgentAutoIscsiLoginEnabled Boolean
    Whether to enable Oracle Cloud Agent to perform the iSCSI login and logout commands after the volume attach or detach operations for non multipath-enabled iSCSI attachments.
    isReadOnly Boolean
    Whether the attachment was created in read-only mode.
    isShareable Boolean
    Whether the attachment should be created in shareable mode. If an attachment is created in shareable mode, then other instances can attach the same volume, provided that they also create their attachments in shareable mode. Only certain volume types can be attached in shareable mode. Defaults to false if not specified.
    launchCreateVolumeDetails InstanceLaunchVolumeAttachmentLaunchCreateVolumeDetails
    Define a volume that will be created and attached or attached to an instance on creation.
    useChap Boolean
    Whether to use CHAP authentication for the volume attachment. Defaults to false.
    volumeId String
    The OCID of the volume. If CreateVolumeDetails is specified, this field must be omitted from the request.
    type string
    The type of action to run when the instance is interrupted for eviction.
    device string
    The device name. To retrieve a list of devices for a given instance, see ListInstanceDevices.
    displayName string
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    encryptionInTransitType string
    Refer the top-level definition of encryptionInTransitType. The default value is NONE.
    isAgentAutoIscsiLoginEnabled boolean
    Whether to enable Oracle Cloud Agent to perform the iSCSI login and logout commands after the volume attach or detach operations for non multipath-enabled iSCSI attachments.
    isReadOnly boolean
    Whether the attachment was created in read-only mode.
    isShareable boolean
    Whether the attachment should be created in shareable mode. If an attachment is created in shareable mode, then other instances can attach the same volume, provided that they also create their attachments in shareable mode. Only certain volume types can be attached in shareable mode. Defaults to false if not specified.
    launchCreateVolumeDetails InstanceLaunchVolumeAttachmentLaunchCreateVolumeDetails
    Define a volume that will be created and attached or attached to an instance on creation.
    useChap boolean
    Whether to use CHAP authentication for the volume attachment. Defaults to false.
    volumeId string
    The OCID of the volume. If CreateVolumeDetails is specified, this field must be omitted from the request.
    type str
    The type of action to run when the instance is interrupted for eviction.
    device str
    The device name. To retrieve a list of devices for a given instance, see ListInstanceDevices.
    display_name str
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    encryption_in_transit_type str
    Refer the top-level definition of encryptionInTransitType. The default value is NONE.
    is_agent_auto_iscsi_login_enabled bool
    Whether to enable Oracle Cloud Agent to perform the iSCSI login and logout commands after the volume attach or detach operations for non multipath-enabled iSCSI attachments.
    is_read_only bool
    Whether the attachment was created in read-only mode.
    is_shareable bool
    Whether the attachment should be created in shareable mode. If an attachment is created in shareable mode, then other instances can attach the same volume, provided that they also create their attachments in shareable mode. Only certain volume types can be attached in shareable mode. Defaults to false if not specified.
    launch_create_volume_details InstanceLaunchVolumeAttachmentLaunchCreateVolumeDetails
    Define a volume that will be created and attached or attached to an instance on creation.
    use_chap bool
    Whether to use CHAP authentication for the volume attachment. Defaults to false.
    volume_id str
    The OCID of the volume. If CreateVolumeDetails is specified, this field must be omitted from the request.
    type String
    The type of action to run when the instance is interrupted for eviction.
    device String
    The device name. To retrieve a list of devices for a given instance, see ListInstanceDevices.
    displayName String
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    encryptionInTransitType String
    Refer the top-level definition of encryptionInTransitType. The default value is NONE.
    isAgentAutoIscsiLoginEnabled Boolean
    Whether to enable Oracle Cloud Agent to perform the iSCSI login and logout commands after the volume attach or detach operations for non multipath-enabled iSCSI attachments.
    isReadOnly Boolean
    Whether the attachment was created in read-only mode.
    isShareable Boolean
    Whether the attachment should be created in shareable mode. If an attachment is created in shareable mode, then other instances can attach the same volume, provided that they also create their attachments in shareable mode. Only certain volume types can be attached in shareable mode. Defaults to false if not specified.
    launchCreateVolumeDetails Property Map
    Define a volume that will be created and attached or attached to an instance on creation.
    useChap Boolean
    Whether to use CHAP authentication for the volume attachment. Defaults to false.
    volumeId String
    The OCID of the volume. If CreateVolumeDetails is specified, this field must be omitted from the request.

    InstanceLaunchVolumeAttachmentLaunchCreateVolumeDetails, InstanceLaunchVolumeAttachmentLaunchCreateVolumeDetailsArgs

    SizeInGbs string
    The size of the volume in GBs.
    VolumeCreationType string
    Specifies the method for volume creation.
    CompartmentId string
    (Updatable) The OCID of the compartment containing images to search
    DisplayName string
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    KmsKeyId string
    The OCID of the Vault service key to assign as the master encryption key for the boot volume.
    VpusPerGb string

    The number of volume performance units (VPUs) that will be applied to this volume per GB, representing the Block Volume service's elastic performance options. See Block Volume Performance Levels for more information.

    Allowed values:

    SizeInGbs string
    The size of the volume in GBs.
    VolumeCreationType string
    Specifies the method for volume creation.
    CompartmentId string
    (Updatable) The OCID of the compartment containing images to search
    DisplayName string
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    KmsKeyId string
    The OCID of the Vault service key to assign as the master encryption key for the boot volume.
    VpusPerGb string

    The number of volume performance units (VPUs) that will be applied to this volume per GB, representing the Block Volume service's elastic performance options. See Block Volume Performance Levels for more information.

    Allowed values:

    sizeInGbs String
    The size of the volume in GBs.
    volumeCreationType String
    Specifies the method for volume creation.
    compartmentId String
    (Updatable) The OCID of the compartment containing images to search
    displayName String
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    kmsKeyId String
    The OCID of the Vault service key to assign as the master encryption key for the boot volume.
    vpusPerGb String

    The number of volume performance units (VPUs) that will be applied to this volume per GB, representing the Block Volume service's elastic performance options. See Block Volume Performance Levels for more information.

    Allowed values:

    sizeInGbs string
    The size of the volume in GBs.
    volumeCreationType string
    Specifies the method for volume creation.
    compartmentId string
    (Updatable) The OCID of the compartment containing images to search
    displayName string
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    kmsKeyId string
    The OCID of the Vault service key to assign as the master encryption key for the boot volume.
    vpusPerGb string

    The number of volume performance units (VPUs) that will be applied to this volume per GB, representing the Block Volume service's elastic performance options. See Block Volume Performance Levels for more information.

    Allowed values:

    size_in_gbs str
    The size of the volume in GBs.
    volume_creation_type str
    Specifies the method for volume creation.
    compartment_id str
    (Updatable) The OCID of the compartment containing images to search
    display_name str
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    kms_key_id str
    The OCID of the Vault service key to assign as the master encryption key for the boot volume.
    vpus_per_gb str

    The number of volume performance units (VPUs) that will be applied to this volume per GB, representing the Block Volume service's elastic performance options. See Block Volume Performance Levels for more information.

    Allowed values:

    sizeInGbs String
    The size of the volume in GBs.
    volumeCreationType String
    Specifies the method for volume creation.
    compartmentId String
    (Updatable) The OCID of the compartment containing images to search
    displayName String
    A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    kmsKeyId String
    The OCID of the Vault service key to assign as the master encryption key for the boot volume.
    vpusPerGb String

    The number of volume performance units (VPUs) that will be applied to this volume per GB, representing the Block Volume service's elastic performance options. See Block Volume Performance Levels for more information.

    Allowed values:

    InstancePlatformConfig, InstancePlatformConfigArgs

    Type string
    The type of action to run when the instance is interrupted for eviction.
    AreVirtualInstructionsEnabled bool
    Whether virtualization instructions are available. For example, Secure Virtual Machine for AMD shapes or VT-x for Intel shapes.
    ConfigMap Dictionary<string, object>
    Instance Platform Configuration Configuration Map for flexible setting input.
    IsAccessControlServiceEnabled bool
    Whether the Access Control Service is enabled on the instance. When enabled, the platform can enforce PCIe device isolation, required for VFIO device pass-through.
    IsInputOutputMemoryManagementUnitEnabled bool
    Whether the input-output memory management unit is enabled.
    IsMeasuredBootEnabled bool
    Whether the Measured Boot feature is enabled on the instance.
    IsMemoryEncryptionEnabled bool
    Whether the instance is a confidential instance. If this value is true, the instance is a confidential instance. The default value is false.
    IsSecureBootEnabled bool
    Whether Secure Boot is enabled on the instance.
    IsSymmetricMultiThreadingEnabled bool

    (Updatable only for INTEL_VM and AMD_VM) Whether symmetric multithreading is enabled on the instance. Symmetric multithreading is also called simultaneous multithreading (SMT) or Intel Hyper-Threading.

    Intel and AMD processors have two hardware execution threads per core (OCPU). SMT permits multiple independent threads of execution, to better use the resources and increase the efficiency of the CPU. When multithreading is disabled, only one thread is permitted to run on each core, which can provide higher or more predictable performance for some workloads.

    IsTrustedPlatformModuleEnabled bool
    Whether the Trusted Platform Module (TPM) is enabled on the instance.
    NumaNodesPerSocket string
    The number of NUMA nodes per socket (NPS).
    PercentageOfCoresEnabled int

    The percentage of cores enabled. Value must be a multiple of 25%! (MISSING)If the requested percentage results in a fractional number of cores, the system rounds up the number of cores across processors and provisions an instance with a whole number of cores.

    If the applications that you run on the instance use a core-based licensing model and need fewer cores than the full size of the shape, you can disable cores to reduce your licensing costs. The instance itself is billed for the full shape, regardless of whether all cores are enabled.

    Type string
    The type of action to run when the instance is interrupted for eviction.
    AreVirtualInstructionsEnabled bool
    Whether virtualization instructions are available. For example, Secure Virtual Machine for AMD shapes or VT-x for Intel shapes.
    ConfigMap map[string]interface{}
    Instance Platform Configuration Configuration Map for flexible setting input.
    IsAccessControlServiceEnabled bool
    Whether the Access Control Service is enabled on the instance. When enabled, the platform can enforce PCIe device isolation, required for VFIO device pass-through.
    IsInputOutputMemoryManagementUnitEnabled bool
    Whether the input-output memory management unit is enabled.
    IsMeasuredBootEnabled bool
    Whether the Measured Boot feature is enabled on the instance.
    IsMemoryEncryptionEnabled bool
    Whether the instance is a confidential instance. If this value is true, the instance is a confidential instance. The default value is false.
    IsSecureBootEnabled bool
    Whether Secure Boot is enabled on the instance.
    IsSymmetricMultiThreadingEnabled bool

    (Updatable only for INTEL_VM and AMD_VM) Whether symmetric multithreading is enabled on the instance. Symmetric multithreading is also called simultaneous multithreading (SMT) or Intel Hyper-Threading.

    Intel and AMD processors have two hardware execution threads per core (OCPU). SMT permits multiple independent threads of execution, to better use the resources and increase the efficiency of the CPU. When multithreading is disabled, only one thread is permitted to run on each core, which can provide higher or more predictable performance for some workloads.

    IsTrustedPlatformModuleEnabled bool
    Whether the Trusted Platform Module (TPM) is enabled on the instance.
    NumaNodesPerSocket string
    The number of NUMA nodes per socket (NPS).
    PercentageOfCoresEnabled int

    The percentage of cores enabled. Value must be a multiple of 25%! (MISSING)If the requested percentage results in a fractional number of cores, the system rounds up the number of cores across processors and provisions an instance with a whole number of cores.

    If the applications that you run on the instance use a core-based licensing model and need fewer cores than the full size of the shape, you can disable cores to reduce your licensing costs. The instance itself is billed for the full shape, regardless of whether all cores are enabled.

    type String
    The type of action to run when the instance is interrupted for eviction.
    areVirtualInstructionsEnabled Boolean
    Whether virtualization instructions are available. For example, Secure Virtual Machine for AMD shapes or VT-x for Intel shapes.
    configMap Map<String,Object>
    Instance Platform Configuration Configuration Map for flexible setting input.
    isAccessControlServiceEnabled Boolean
    Whether the Access Control Service is enabled on the instance. When enabled, the platform can enforce PCIe device isolation, required for VFIO device pass-through.
    isInputOutputMemoryManagementUnitEnabled Boolean
    Whether the input-output memory management unit is enabled.
    isMeasuredBootEnabled Boolean
    Whether the Measured Boot feature is enabled on the instance.
    isMemoryEncryptionEnabled Boolean
    Whether the instance is a confidential instance. If this value is true, the instance is a confidential instance. The default value is false.
    isSecureBootEnabled Boolean
    Whether Secure Boot is enabled on the instance.
    isSymmetricMultiThreadingEnabled Boolean

    (Updatable only for INTEL_VM and AMD_VM) Whether symmetric multithreading is enabled on the instance. Symmetric multithreading is also called simultaneous multithreading (SMT) or Intel Hyper-Threading.

    Intel and AMD processors have two hardware execution threads per core (OCPU). SMT permits multiple independent threads of execution, to better use the resources and increase the efficiency of the CPU. When multithreading is disabled, only one thread is permitted to run on each core, which can provide higher or more predictable performance for some workloads.

    isTrustedPlatformModuleEnabled Boolean
    Whether the Trusted Platform Module (TPM) is enabled on the instance.
    numaNodesPerSocket String
    The number of NUMA nodes per socket (NPS).
    percentageOfCoresEnabled Integer

    The percentage of cores enabled. Value must be a multiple of 25%! (MISSING)If the requested percentage results in a fractional number of cores, the system rounds up the number of cores across processors and provisions an instance with a whole number of cores.

    If the applications that you run on the instance use a core-based licensing model and need fewer cores than the full size of the shape, you can disable cores to reduce your licensing costs. The instance itself is billed for the full shape, regardless of whether all cores are enabled.

    type string
    The type of action to run when the instance is interrupted for eviction.
    areVirtualInstructionsEnabled boolean
    Whether virtualization instructions are available. For example, Secure Virtual Machine for AMD shapes or VT-x for Intel shapes.
    configMap {[key: string]: any}
    Instance Platform Configuration Configuration Map for flexible setting input.
    isAccessControlServiceEnabled boolean
    Whether the Access Control Service is enabled on the instance. When enabled, the platform can enforce PCIe device isolation, required for VFIO device pass-through.
    isInputOutputMemoryManagementUnitEnabled boolean
    Whether the input-output memory management unit is enabled.
    isMeasuredBootEnabled boolean
    Whether the Measured Boot feature is enabled on the instance.
    isMemoryEncryptionEnabled boolean
    Whether the instance is a confidential instance. If this value is true, the instance is a confidential instance. The default value is false.
    isSecureBootEnabled boolean
    Whether Secure Boot is enabled on the instance.
    isSymmetricMultiThreadingEnabled boolean

    (Updatable only for INTEL_VM and AMD_VM) Whether symmetric multithreading is enabled on the instance. Symmetric multithreading is also called simultaneous multithreading (SMT) or Intel Hyper-Threading.

    Intel and AMD processors have two hardware execution threads per core (OCPU). SMT permits multiple independent threads of execution, to better use the resources and increase the efficiency of the CPU. When multithreading is disabled, only one thread is permitted to run on each core, which can provide higher or more predictable performance for some workloads.

    isTrustedPlatformModuleEnabled boolean
    Whether the Trusted Platform Module (TPM) is enabled on the instance.
    numaNodesPerSocket string
    The number of NUMA nodes per socket (NPS).
    percentageOfCoresEnabled number

    The percentage of cores enabled. Value must be a multiple of 25%! (MISSING)If the requested percentage results in a fractional number of cores, the system rounds up the number of cores across processors and provisions an instance with a whole number of cores.

    If the applications that you run on the instance use a core-based licensing model and need fewer cores than the full size of the shape, you can disable cores to reduce your licensing costs. The instance itself is billed for the full shape, regardless of whether all cores are enabled.

    type str
    The type of action to run when the instance is interrupted for eviction.
    are_virtual_instructions_enabled bool
    Whether virtualization instructions are available. For example, Secure Virtual Machine for AMD shapes or VT-x for Intel shapes.
    config_map Mapping[str, Any]
    Instance Platform Configuration Configuration Map for flexible setting input.
    is_access_control_service_enabled bool
    Whether the Access Control Service is enabled on the instance. When enabled, the platform can enforce PCIe device isolation, required for VFIO device pass-through.
    is_input_output_memory_management_unit_enabled bool
    Whether the input-output memory management unit is enabled.
    is_measured_boot_enabled bool
    Whether the Measured Boot feature is enabled on the instance.
    is_memory_encryption_enabled bool
    Whether the instance is a confidential instance. If this value is true, the instance is a confidential instance. The default value is false.
    is_secure_boot_enabled bool
    Whether Secure Boot is enabled on the instance.
    is_symmetric_multi_threading_enabled bool

    (Updatable only for INTEL_VM and AMD_VM) Whether symmetric multithreading is enabled on the instance. Symmetric multithreading is also called simultaneous multithreading (SMT) or Intel Hyper-Threading.

    Intel and AMD processors have two hardware execution threads per core (OCPU). SMT permits multiple independent threads of execution, to better use the resources and increase the efficiency of the CPU. When multithreading is disabled, only one thread is permitted to run on each core, which can provide higher or more predictable performance for some workloads.

    is_trusted_platform_module_enabled bool
    Whether the Trusted Platform Module (TPM) is enabled on the instance.
    numa_nodes_per_socket str
    The number of NUMA nodes per socket (NPS).
    percentage_of_cores_enabled int

    The percentage of cores enabled. Value must be a multiple of 25%! (MISSING)If the requested percentage results in a fractional number of cores, the system rounds up the number of cores across processors and provisions an instance with a whole number of cores.

    If the applications that you run on the instance use a core-based licensing model and need fewer cores than the full size of the shape, you can disable cores to reduce your licensing costs. The instance itself is billed for the full shape, regardless of whether all cores are enabled.

    type String
    The type of action to run when the instance is interrupted for eviction.
    areVirtualInstructionsEnabled Boolean
    Whether virtualization instructions are available. For example, Secure Virtual Machine for AMD shapes or VT-x for Intel shapes.
    configMap Map<Any>
    Instance Platform Configuration Configuration Map for flexible setting input.
    isAccessControlServiceEnabled Boolean
    Whether the Access Control Service is enabled on the instance. When enabled, the platform can enforce PCIe device isolation, required for VFIO device pass-through.
    isInputOutputMemoryManagementUnitEnabled Boolean
    Whether the input-output memory management unit is enabled.
    isMeasuredBootEnabled Boolean
    Whether the Measured Boot feature is enabled on the instance.
    isMemoryEncryptionEnabled Boolean
    Whether the instance is a confidential instance. If this value is true, the instance is a confidential instance. The default value is false.
    isSecureBootEnabled Boolean
    Whether Secure Boot is enabled on the instance.
    isSymmetricMultiThreadingEnabled Boolean

    (Updatable only for INTEL_VM and AMD_VM) Whether symmetric multithreading is enabled on the instance. Symmetric multithreading is also called simultaneous multithreading (SMT) or Intel Hyper-Threading.

    Intel and AMD processors have two hardware execution threads per core (OCPU). SMT permits multiple independent threads of execution, to better use the resources and increase the efficiency of the CPU. When multithreading is disabled, only one thread is permitted to run on each core, which can provide higher or more predictable performance for some workloads.

    isTrustedPlatformModuleEnabled Boolean
    Whether the Trusted Platform Module (TPM) is enabled on the instance.
    numaNodesPerSocket String
    The number of NUMA nodes per socket (NPS).
    percentageOfCoresEnabled Number

    The percentage of cores enabled. Value must be a multiple of 25%! (MISSING)If the requested percentage results in a fractional number of cores, the system rounds up the number of cores across processors and provisions an instance with a whole number of cores.

    If the applications that you run on the instance use a core-based licensing model and need fewer cores than the full size of the shape, you can disable cores to reduce your licensing costs. The instance itself is billed for the full shape, regardless of whether all cores are enabled.

    InstancePreemptibleInstanceConfig, InstancePreemptibleInstanceConfigArgs

    PreemptionAction InstancePreemptibleInstanceConfigPreemptionAction
    The action to run when the preemptible instance is interrupted for eviction.
    PreemptionAction InstancePreemptibleInstanceConfigPreemptionAction
    The action to run when the preemptible instance is interrupted for eviction.
    preemptionAction InstancePreemptibleInstanceConfigPreemptionAction
    The action to run when the preemptible instance is interrupted for eviction.
    preemptionAction InstancePreemptibleInstanceConfigPreemptionAction
    The action to run when the preemptible instance is interrupted for eviction.
    preemption_action InstancePreemptibleInstanceConfigPreemptionAction
    The action to run when the preemptible instance is interrupted for eviction.
    preemptionAction Property Map
    The action to run when the preemptible instance is interrupted for eviction.

    InstancePreemptibleInstanceConfigPreemptionAction, InstancePreemptibleInstanceConfigPreemptionActionArgs

    Type string
    The type of action to run when the instance is interrupted for eviction.
    PreserveBootVolume bool
    Whether to preserve the boot volume that was used to launch the preemptible instance when the instance is terminated. Defaults to false if not specified.
    Type string
    The type of action to run when the instance is interrupted for eviction.
    PreserveBootVolume bool
    Whether to preserve the boot volume that was used to launch the preemptible instance when the instance is terminated. Defaults to false if not specified.
    type String
    The type of action to run when the instance is interrupted for eviction.
    preserveBootVolume Boolean
    Whether to preserve the boot volume that was used to launch the preemptible instance when the instance is terminated. Defaults to false if not specified.
    type string
    The type of action to run when the instance is interrupted for eviction.
    preserveBootVolume boolean
    Whether to preserve the boot volume that was used to launch the preemptible instance when the instance is terminated. Defaults to false if not specified.
    type str
    The type of action to run when the instance is interrupted for eviction.
    preserve_boot_volume bool
    Whether to preserve the boot volume that was used to launch the preemptible instance when the instance is terminated. Defaults to false if not specified.
    type String
    The type of action to run when the instance is interrupted for eviction.
    preserveBootVolume Boolean
    Whether to preserve the boot volume that was used to launch the preemptible instance when the instance is terminated. Defaults to false if not specified.

    InstanceShapeConfig, InstanceShapeConfigArgs

    BaselineOcpuUtilization string

    (Updatable) The baseline OCPU utilization for a subcore burstable VM instance. Leave this attribute blank for a non-burstable instance, or explicitly specify non-burstable with BASELINE_1_1.

    The following values are supported:

    GpuDescription string
    A short description of the instance's graphics processing unit (GPU).
    Gpus int
    The number of GPUs available to the instance.
    LocalDiskDescription string
    A short description of the local disks available to this instance.
    LocalDisks int
    The number of local disks available to the instance.
    LocalDisksTotalSizeInGbs double
    The aggregate size of all local disks, in gigabytes.
    MaxVnicAttachments int
    The maximum number of VNIC attachments for the instance.
    MemoryInGbs double
    (Updatable) The total amount of memory available to the instance, in gigabytes.
    NetworkingBandwidthInGbps double
    The networking bandwidth available to the instance, in gigabits per second.
    Nvmes int
    (Updatable) The number of NVMe drives to be used for storage. A single drive has 6.8 TB available.
    Ocpus double
    (Updatable) The total number of OCPUs available to the instance.
    ProcessorDescription string
    A short description of the instance's processor (CPU).
    Vcpus int
    (Updatable) The total number of VCPUs available to the instance. This can be used instead of OCPUs, in which case the actual number of OCPUs will be calculated based on this value and the actual hardware. This must be a multiple of 2.
    BaselineOcpuUtilization string

    (Updatable) The baseline OCPU utilization for a subcore burstable VM instance. Leave this attribute blank for a non-burstable instance, or explicitly specify non-burstable with BASELINE_1_1.

    The following values are supported:

    GpuDescription string
    A short description of the instance's graphics processing unit (GPU).
    Gpus int
    The number of GPUs available to the instance.
    LocalDiskDescription string
    A short description of the local disks available to this instance.
    LocalDisks int
    The number of local disks available to the instance.
    LocalDisksTotalSizeInGbs float64
    The aggregate size of all local disks, in gigabytes.
    MaxVnicAttachments int
    The maximum number of VNIC attachments for the instance.
    MemoryInGbs float64
    (Updatable) The total amount of memory available to the instance, in gigabytes.
    NetworkingBandwidthInGbps float64
    The networking bandwidth available to the instance, in gigabits per second.
    Nvmes int
    (Updatable) The number of NVMe drives to be used for storage. A single drive has 6.8 TB available.
    Ocpus float64
    (Updatable) The total number of OCPUs available to the instance.
    ProcessorDescription string
    A short description of the instance's processor (CPU).
    Vcpus int
    (Updatable) The total number of VCPUs available to the instance. This can be used instead of OCPUs, in which case the actual number of OCPUs will be calculated based on this value and the actual hardware. This must be a multiple of 2.
    baselineOcpuUtilization String

    (Updatable) The baseline OCPU utilization for a subcore burstable VM instance. Leave this attribute blank for a non-burstable instance, or explicitly specify non-burstable with BASELINE_1_1.

    The following values are supported:

    gpuDescription String
    A short description of the instance's graphics processing unit (GPU).
    gpus Integer
    The number of GPUs available to the instance.
    localDiskDescription String
    A short description of the local disks available to this instance.
    localDisks Integer
    The number of local disks available to the instance.
    localDisksTotalSizeInGbs Double
    The aggregate size of all local disks, in gigabytes.
    maxVnicAttachments Integer
    The maximum number of VNIC attachments for the instance.
    memoryInGbs Double
    (Updatable) The total amount of memory available to the instance, in gigabytes.
    networkingBandwidthInGbps Double
    The networking bandwidth available to the instance, in gigabits per second.
    nvmes Integer
    (Updatable) The number of NVMe drives to be used for storage. A single drive has 6.8 TB available.
    ocpus Double
    (Updatable) The total number of OCPUs available to the instance.
    processorDescription String
    A short description of the instance's processor (CPU).
    vcpus Integer
    (Updatable) The total number of VCPUs available to the instance. This can be used instead of OCPUs, in which case the actual number of OCPUs will be calculated based on this value and the actual hardware. This must be a multiple of 2.
    baselineOcpuUtilization string

    (Updatable) The baseline OCPU utilization for a subcore burstable VM instance. Leave this attribute blank for a non-burstable instance, or explicitly specify non-burstable with BASELINE_1_1.

    The following values are supported:

    gpuDescription string
    A short description of the instance's graphics processing unit (GPU).
    gpus number
    The number of GPUs available to the instance.
    localDiskDescription string
    A short description of the local disks available to this instance.
    localDisks number
    The number of local disks available to the instance.
    localDisksTotalSizeInGbs number
    The aggregate size of all local disks, in gigabytes.
    maxVnicAttachments number
    The maximum number of VNIC attachments for the instance.
    memoryInGbs number
    (Updatable) The total amount of memory available to the instance, in gigabytes.
    networkingBandwidthInGbps number
    The networking bandwidth available to the instance, in gigabits per second.
    nvmes number
    (Updatable) The number of NVMe drives to be used for storage. A single drive has 6.8 TB available.
    ocpus number
    (Updatable) The total number of OCPUs available to the instance.
    processorDescription string
    A short description of the instance's processor (CPU).
    vcpus number
    (Updatable) The total number of VCPUs available to the instance. This can be used instead of OCPUs, in which case the actual number of OCPUs will be calculated based on this value and the actual hardware. This must be a multiple of 2.
    baseline_ocpu_utilization str

    (Updatable) The baseline OCPU utilization for a subcore burstable VM instance. Leave this attribute blank for a non-burstable instance, or explicitly specify non-burstable with BASELINE_1_1.

    The following values are supported:

    gpu_description str
    A short description of the instance's graphics processing unit (GPU).
    gpus int
    The number of GPUs available to the instance.
    local_disk_description str
    A short description of the local disks available to this instance.
    local_disks int
    The number of local disks available to the instance.
    local_disks_total_size_in_gbs float
    The aggregate size of all local disks, in gigabytes.
    max_vnic_attachments int
    The maximum number of VNIC attachments for the instance.
    memory_in_gbs float
    (Updatable) The total amount of memory available to the instance, in gigabytes.
    networking_bandwidth_in_gbps float
    The networking bandwidth available to the instance, in gigabits per second.
    nvmes int
    (Updatable) The number of NVMe drives to be used for storage. A single drive has 6.8 TB available.
    ocpus float
    (Updatable) The total number of OCPUs available to the instance.
    processor_description str
    A short description of the instance's processor (CPU).
    vcpus int
    (Updatable) The total number of VCPUs available to the instance. This can be used instead of OCPUs, in which case the actual number of OCPUs will be calculated based on this value and the actual hardware. This must be a multiple of 2.
    baselineOcpuUtilization String

    (Updatable) The baseline OCPU utilization for a subcore burstable VM instance. Leave this attribute blank for a non-burstable instance, or explicitly specify non-burstable with BASELINE_1_1.

    The following values are supported:

    gpuDescription String
    A short description of the instance's graphics processing unit (GPU).
    gpus Number
    The number of GPUs available to the instance.
    localDiskDescription String
    A short description of the local disks available to this instance.
    localDisks Number
    The number of local disks available to the instance.
    localDisksTotalSizeInGbs Number
    The aggregate size of all local disks, in gigabytes.
    maxVnicAttachments Number
    The maximum number of VNIC attachments for the instance.
    memoryInGbs Number
    (Updatable) The total amount of memory available to the instance, in gigabytes.
    networkingBandwidthInGbps Number
    The networking bandwidth available to the instance, in gigabits per second.
    nvmes Number
    (Updatable) The number of NVMe drives to be used for storage. A single drive has 6.8 TB available.
    ocpus Number
    (Updatable) The total number of OCPUs available to the instance.
    processorDescription String
    A short description of the instance's processor (CPU).
    vcpus Number
    (Updatable) The total number of VCPUs available to the instance. This can be used instead of OCPUs, in which case the actual number of OCPUs will be calculated based on this value and the actual hardware. This must be a multiple of 2.

    InstanceSourceDetails, InstanceSourceDetailsArgs

    SourceType string
    The source type for the instance. Use image when specifying the image OCID. Use bootVolume when specifying the boot volume OCID.
    BootVolumeSizeInGbs string
    (Updatable) The size of the boot volume in GBs. Minimum value is 50 GB and maximum value is 32,768 GB (32 TB).
    BootVolumeVpusPerGb string

    The number of volume performance units (VPUs) that will be applied to this volume per GB, representing the Block Volume service's elastic performance options. See Block Volume Performance Levels for more information.

    Allowed values:

    InstanceSourceImageFilterDetails InstanceSourceDetailsInstanceSourceImageFilterDetails
    These are the criteria for selecting an image. This is required if imageId is not specified.
    KmsKeyId string
    The OCID of the Vault service key to assign as the master encryption key for the boot volume.
    SourceId string
    The OCID of an image or a boot volume to use, depending on the value of source_type.
    SourceType string
    The source type for the instance. Use image when specifying the image OCID. Use bootVolume when specifying the boot volume OCID.
    BootVolumeSizeInGbs string
    (Updatable) The size of the boot volume in GBs. Minimum value is 50 GB and maximum value is 32,768 GB (32 TB).
    BootVolumeVpusPerGb string

    The number of volume performance units (VPUs) that will be applied to this volume per GB, representing the Block Volume service's elastic performance options. See Block Volume Performance Levels for more information.

    Allowed values:

    InstanceSourceImageFilterDetails InstanceSourceDetailsInstanceSourceImageFilterDetails
    These are the criteria for selecting an image. This is required if imageId is not specified.
    KmsKeyId string
    The OCID of the Vault service key to assign as the master encryption key for the boot volume.
    SourceId string
    The OCID of an image or a boot volume to use, depending on the value of source_type.
    sourceType String
    The source type for the instance. Use image when specifying the image OCID. Use bootVolume when specifying the boot volume OCID.
    bootVolumeSizeInGbs String
    (Updatable) The size of the boot volume in GBs. Minimum value is 50 GB and maximum value is 32,768 GB (32 TB).
    bootVolumeVpusPerGb String

    The number of volume performance units (VPUs) that will be applied to this volume per GB, representing the Block Volume service's elastic performance options. See Block Volume Performance Levels for more information.

    Allowed values:

    instanceSourceImageFilterDetails InstanceSourceDetailsInstanceSourceImageFilterDetails
    These are the criteria for selecting an image. This is required if imageId is not specified.
    kmsKeyId String
    The OCID of the Vault service key to assign as the master encryption key for the boot volume.
    sourceId String
    The OCID of an image or a boot volume to use, depending on the value of source_type.
    sourceType string
    The source type for the instance. Use image when specifying the image OCID. Use bootVolume when specifying the boot volume OCID.
    bootVolumeSizeInGbs string
    (Updatable) The size of the boot volume in GBs. Minimum value is 50 GB and maximum value is 32,768 GB (32 TB).
    bootVolumeVpusPerGb string

    The number of volume performance units (VPUs) that will be applied to this volume per GB, representing the Block Volume service's elastic performance options. See Block Volume Performance Levels for more information.

    Allowed values:

    instanceSourceImageFilterDetails InstanceSourceDetailsInstanceSourceImageFilterDetails
    These are the criteria for selecting an image. This is required if imageId is not specified.
    kmsKeyId string
    The OCID of the Vault service key to assign as the master encryption key for the boot volume.
    sourceId string
    The OCID of an image or a boot volume to use, depending on the value of source_type.
    source_type str
    The source type for the instance. Use image when specifying the image OCID. Use bootVolume when specifying the boot volume OCID.
    boot_volume_size_in_gbs str
    (Updatable) The size of the boot volume in GBs. Minimum value is 50 GB and maximum value is 32,768 GB (32 TB).
    boot_volume_vpus_per_gb str

    The number of volume performance units (VPUs) that will be applied to this volume per GB, representing the Block Volume service's elastic performance options. See Block Volume Performance Levels for more information.

    Allowed values:

    instance_source_image_filter_details InstanceSourceDetailsInstanceSourceImageFilterDetails
    These are the criteria for selecting an image. This is required if imageId is not specified.
    kms_key_id str
    The OCID of the Vault service key to assign as the master encryption key for the boot volume.
    source_id str
    The OCID of an image or a boot volume to use, depending on the value of source_type.
    sourceType String
    The source type for the instance. Use image when specifying the image OCID. Use bootVolume when specifying the boot volume OCID.
    bootVolumeSizeInGbs String
    (Updatable) The size of the boot volume in GBs. Minimum value is 50 GB and maximum value is 32,768 GB (32 TB).
    bootVolumeVpusPerGb String

    The number of volume performance units (VPUs) that will be applied to this volume per GB, representing the Block Volume service's elastic performance options. See Block Volume Performance Levels for more information.

    Allowed values:

    instanceSourceImageFilterDetails Property Map
    These are the criteria for selecting an image. This is required if imageId is not specified.
    kmsKeyId String
    The OCID of the Vault service key to assign as the master encryption key for the boot volume.
    sourceId String
    The OCID of an image or a boot volume to use, depending on the value of source_type.

    InstanceSourceDetailsInstanceSourceImageFilterDetails, InstanceSourceDetailsInstanceSourceImageFilterDetailsArgs

    CompartmentId string
    (Updatable) The OCID of the compartment containing images to search
    DefinedTagsFilter Dictionary<string, object>
    Filter based on these defined tags. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
    OperatingSystem string
    The image's operating system. Example: Oracle Linux
    OperatingSystemVersion string
    The image's operating system version. Example: 7.2
    CompartmentId string
    (Updatable) The OCID of the compartment containing images to search
    DefinedTagsFilter map[string]interface{}
    Filter based on these defined tags. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
    OperatingSystem string
    The image's operating system. Example: Oracle Linux
    OperatingSystemVersion string
    The image's operating system version. Example: 7.2
    compartmentId String
    (Updatable) The OCID of the compartment containing images to search
    definedTagsFilter Map<String,Object>
    Filter based on these defined tags. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
    operatingSystem String
    The image's operating system. Example: Oracle Linux
    operatingSystemVersion String
    The image's operating system version. Example: 7.2
    compartmentId string
    (Updatable) The OCID of the compartment containing images to search
    definedTagsFilter {[key: string]: any}
    Filter based on these defined tags. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
    operatingSystem string
    The image's operating system. Example: Oracle Linux
    operatingSystemVersion string
    The image's operating system version. Example: 7.2
    compartment_id str
    (Updatable) The OCID of the compartment containing images to search
    defined_tags_filter Mapping[str, Any]
    Filter based on these defined tags. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
    operating_system str
    The image's operating system. Example: Oracle Linux
    operating_system_version str
    The image's operating system version. Example: 7.2
    compartmentId String
    (Updatable) The OCID of the compartment containing images to search
    definedTagsFilter Map<Any>
    Filter based on these defined tags. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
    operatingSystem String
    The image's operating system. Example: Oracle Linux
    operatingSystemVersion String
    The image's operating system version. Example: 7.2

    Import

    Instances can be imported using the id, e.g.

    $ pulumi import oci:Core/instance:Instance test_instance "id"
    

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v1.29.0 published on Thursday, Mar 28, 2024 by Pulumi