oci.Core.Image
This resource provides the Image resource in Oracle Cloud Infrastructure Core service.
Creates a boot disk image for the specified instance or imports an exported image from the Oracle Cloud Infrastructure Object Storage service.
When creating a new image, you must provide the OCID of the instance you want to use as the basis for the image, and the OCID of the compartment containing that instance. For more information about images, see Managing Custom Images.
When importing an exported image from Object Storage, you specify the source information in ImageSourceDetails.
When importing an image based on the namespace, bucket name, and object name, use ImageSourceViaObjectStorageTupleDetails.
When importing an image based on the Object Storage URL, use ImageSourceViaObjectStorageUriDetails. See Object Storage URLs and Using Pre-Authenticated Requests for constructing URLs for image import/export.
For more information about importing exported images, see Image Import/Export.
You may optionally specify a display name for the image, which is simply a friendly name or description. It does not have to be unique, and you can change it. See UpdateImage. Avoid entering confidential information.
Example Usage
Create image from instance in tenancy
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testImage = new oci.core.Image("test_image", {
    compartmentId: compartmentId,
    instanceId: testInstance.id,
    definedTags: {
        "Operations.CostCenter": "42",
    },
    displayName: imageDisplayName,
    launchMode: imageLaunchMode,
    freeformTags: {
        Department: "Finance",
    },
});
import pulumi
import pulumi_oci as oci
test_image = oci.core.Image("test_image",
    compartment_id=compartment_id,
    instance_id=test_instance["id"],
    defined_tags={
        "Operations.CostCenter": "42",
    },
    display_name=image_display_name,
    launch_mode=image_launch_mode,
    freeform_tags={
        "Department": "Finance",
    })
package main
import (
	"github.com/pulumi/pulumi-oci/sdk/v3/go/oci/core"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := core.NewImage(ctx, "test_image", &core.ImageArgs{
			CompartmentId: pulumi.Any(compartmentId),
			InstanceId:    pulumi.Any(testInstance.Id),
			DefinedTags: pulumi.StringMap{
				"Operations.CostCenter": pulumi.String("42"),
			},
			DisplayName: pulumi.Any(imageDisplayName),
			LaunchMode:  pulumi.Any(imageLaunchMode),
			FreeformTags: pulumi.StringMap{
				"Department": pulumi.String("Finance"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;
return await Deployment.RunAsync(() => 
{
    var testImage = new Oci.Core.Image("test_image", new()
    {
        CompartmentId = compartmentId,
        InstanceId = testInstance.Id,
        DefinedTags = 
        {
            { "Operations.CostCenter", "42" },
        },
        DisplayName = imageDisplayName,
        LaunchMode = imageLaunchMode,
        FreeformTags = 
        {
            { "Department", "Finance" },
        },
    });
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Core.Image;
import com.pulumi.oci.Core.ImageArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        var testImage = new Image("testImage", ImageArgs.builder()
            .compartmentId(compartmentId)
            .instanceId(testInstance.id())
            .definedTags(Map.of("Operations.CostCenter", "42"))
            .displayName(imageDisplayName)
            .launchMode(imageLaunchMode)
            .freeformTags(Map.of("Department", "Finance"))
            .build());
    }
}
resources:
  testImage:
    type: oci:Core:Image
    name: test_image
    properties:
      compartmentId: ${compartmentId}
      instanceId: ${testInstance.id}
      definedTags:
        Operations.CostCenter: '42'
      displayName: ${imageDisplayName}
      launchMode: ${imageLaunchMode}
      freeformTags:
        Department: Finance
Create image from exported image via direct access to object store
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testImage = new oci.core.Image("test_image", {
    compartmentId: compartmentId,
    displayName: imageDisplayName,
    launchMode: imageLaunchMode,
    imageSourceDetails: {
        sourceType: "objectStorageTuple",
        bucketName: bucketName,
        namespaceName: namespace,
        objectName: objectName,
        operatingSystem: imageImageSourceDetailsOperatingSystem,
        operatingSystemVersion: imageImageSourceDetailsOperatingSystemVersion,
        sourceImageType: sourceImageType,
    },
});
import pulumi
import pulumi_oci as oci
test_image = oci.core.Image("test_image",
    compartment_id=compartment_id,
    display_name=image_display_name,
    launch_mode=image_launch_mode,
    image_source_details={
        "source_type": "objectStorageTuple",
        "bucket_name": bucket_name,
        "namespace_name": namespace,
        "object_name": object_name,
        "operating_system": image_image_source_details_operating_system,
        "operating_system_version": image_image_source_details_operating_system_version,
        "source_image_type": source_image_type,
    })
package main
import (
	"github.com/pulumi/pulumi-oci/sdk/v3/go/oci/core"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := core.NewImage(ctx, "test_image", &core.ImageArgs{
			CompartmentId: pulumi.Any(compartmentId),
			DisplayName:   pulumi.Any(imageDisplayName),
			LaunchMode:    pulumi.Any(imageLaunchMode),
			ImageSourceDetails: &core.ImageImageSourceDetailsArgs{
				SourceType:             pulumi.String("objectStorageTuple"),
				BucketName:             pulumi.Any(bucketName),
				NamespaceName:          pulumi.Any(namespace),
				ObjectName:             pulumi.Any(objectName),
				OperatingSystem:        pulumi.Any(imageImageSourceDetailsOperatingSystem),
				OperatingSystemVersion: pulumi.Any(imageImageSourceDetailsOperatingSystemVersion),
				SourceImageType:        pulumi.Any(sourceImageType),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;
return await Deployment.RunAsync(() => 
{
    var testImage = new Oci.Core.Image("test_image", new()
    {
        CompartmentId = compartmentId,
        DisplayName = imageDisplayName,
        LaunchMode = imageLaunchMode,
        ImageSourceDetails = new Oci.Core.Inputs.ImageImageSourceDetailsArgs
        {
            SourceType = "objectStorageTuple",
            BucketName = bucketName,
            NamespaceName = @namespace,
            ObjectName = objectName,
            OperatingSystem = imageImageSourceDetailsOperatingSystem,
            OperatingSystemVersion = imageImageSourceDetailsOperatingSystemVersion,
            SourceImageType = sourceImageType,
        },
    });
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Core.Image;
import com.pulumi.oci.Core.ImageArgs;
import com.pulumi.oci.Core.inputs.ImageImageSourceDetailsArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        var testImage = new Image("testImage", ImageArgs.builder()
            .compartmentId(compartmentId)
            .displayName(imageDisplayName)
            .launchMode(imageLaunchMode)
            .imageSourceDetails(ImageImageSourceDetailsArgs.builder()
                .sourceType("objectStorageTuple")
                .bucketName(bucketName)
                .namespaceName(namespace)
                .objectName(objectName)
                .operatingSystem(imageImageSourceDetailsOperatingSystem)
                .operatingSystemVersion(imageImageSourceDetailsOperatingSystemVersion)
                .sourceImageType(sourceImageType)
                .build())
            .build());
    }
}
resources:
  testImage:
    type: oci:Core:Image
    name: test_image
    properties:
      compartmentId: ${compartmentId}
      displayName: ${imageDisplayName}
      launchMode: ${imageLaunchMode}
      imageSourceDetails:
        sourceType: objectStorageTuple
        bucketName: ${bucketName}
        namespaceName: ${namespace}
        objectName: ${objectName}
        operatingSystem: ${imageImageSourceDetailsOperatingSystem}
        operatingSystemVersion: ${imageImageSourceDetailsOperatingSystemVersion}
        sourceImageType: ${sourceImageType}
Create image from exported image at publicly accessible uri
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testImage = new oci.core.Image("test_image", {
    compartmentId: compartmentId,
    displayName: imageDisplayName,
    launchMode: imageLaunchMode,
    imageSourceDetails: {
        sourceType: "objectStorageUri",
        sourceUri: sourceUri,
        operatingSystem: imageImageSourceDetailsOperatingSystem,
        operatingSystemVersion: imageImageSourceDetailsOperatingSystemVersion,
        sourceImageType: sourceImageType,
    },
});
import pulumi
import pulumi_oci as oci
test_image = oci.core.Image("test_image",
    compartment_id=compartment_id,
    display_name=image_display_name,
    launch_mode=image_launch_mode,
    image_source_details={
        "source_type": "objectStorageUri",
        "source_uri": source_uri,
        "operating_system": image_image_source_details_operating_system,
        "operating_system_version": image_image_source_details_operating_system_version,
        "source_image_type": source_image_type,
    })
package main
import (
	"github.com/pulumi/pulumi-oci/sdk/v3/go/oci/core"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := core.NewImage(ctx, "test_image", &core.ImageArgs{
			CompartmentId: pulumi.Any(compartmentId),
			DisplayName:   pulumi.Any(imageDisplayName),
			LaunchMode:    pulumi.Any(imageLaunchMode),
			ImageSourceDetails: &core.ImageImageSourceDetailsArgs{
				SourceType:             pulumi.String("objectStorageUri"),
				SourceUri:              pulumi.Any(sourceUri),
				OperatingSystem:        pulumi.Any(imageImageSourceDetailsOperatingSystem),
				OperatingSystemVersion: pulumi.Any(imageImageSourceDetailsOperatingSystemVersion),
				SourceImageType:        pulumi.Any(sourceImageType),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;
return await Deployment.RunAsync(() => 
{
    var testImage = new Oci.Core.Image("test_image", new()
    {
        CompartmentId = compartmentId,
        DisplayName = imageDisplayName,
        LaunchMode = imageLaunchMode,
        ImageSourceDetails = new Oci.Core.Inputs.ImageImageSourceDetailsArgs
        {
            SourceType = "objectStorageUri",
            SourceUri = sourceUri,
            OperatingSystem = imageImageSourceDetailsOperatingSystem,
            OperatingSystemVersion = imageImageSourceDetailsOperatingSystemVersion,
            SourceImageType = sourceImageType,
        },
    });
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Core.Image;
import com.pulumi.oci.Core.ImageArgs;
import com.pulumi.oci.Core.inputs.ImageImageSourceDetailsArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        var testImage = new Image("testImage", ImageArgs.builder()
            .compartmentId(compartmentId)
            .displayName(imageDisplayName)
            .launchMode(imageLaunchMode)
            .imageSourceDetails(ImageImageSourceDetailsArgs.builder()
                .sourceType("objectStorageUri")
                .sourceUri(sourceUri)
                .operatingSystem(imageImageSourceDetailsOperatingSystem)
                .operatingSystemVersion(imageImageSourceDetailsOperatingSystemVersion)
                .sourceImageType(sourceImageType)
                .build())
            .build());
    }
}
resources:
  testImage:
    type: oci:Core:Image
    name: test_image
    properties:
      compartmentId: ${compartmentId}
      displayName: ${imageDisplayName}
      launchMode: ${imageLaunchMode}
      imageSourceDetails:
        sourceType: objectStorageUri
        sourceUri: ${sourceUri}
        operatingSystem: ${imageImageSourceDetailsOperatingSystem}
        operatingSystemVersion: ${imageImageSourceDetailsOperatingSystemVersion}
        sourceImageType: ${sourceImageType}
Create Image Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Image(name: string, args: ImageArgs, opts?: CustomResourceOptions);@overload
def Image(resource_name: str,
          args: ImageArgs,
          opts: Optional[ResourceOptions] = None)
@overload
def Image(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          compartment_id: Optional[str] = None,
          defined_tags: Optional[Mapping[str, str]] = None,
          display_name: Optional[str] = None,
          freeform_tags: Optional[Mapping[str, str]] = None,
          image_source_details: Optional[ImageImageSourceDetailsArgs] = None,
          instance_id: Optional[str] = None,
          launch_mode: Optional[str] = None)func NewImage(ctx *Context, name string, args ImageArgs, opts ...ResourceOption) (*Image, error)public Image(string name, ImageArgs args, CustomResourceOptions? opts = null)type: oci:Core:Image
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args ImageArgs
- 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 ImageArgs
- 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 ImageArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ImageArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ImageArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var imageResource = new Oci.Core.Image("imageResource", new()
{
    CompartmentId = "string",
    DefinedTags = 
    {
        { "string", "string" },
    },
    DisplayName = "string",
    FreeformTags = 
    {
        { "string", "string" },
    },
    ImageSourceDetails = new Oci.Core.Inputs.ImageImageSourceDetailsArgs
    {
        SourceType = "string",
        BucketName = "string",
        NamespaceName = "string",
        ObjectName = "string",
        OperatingSystem = "string",
        OperatingSystemVersion = "string",
        SourceImageType = "string",
        SourceUri = "string",
    },
    InstanceId = "string",
    LaunchMode = "string",
});
example, err := core.NewImage(ctx, "imageResource", &core.ImageArgs{
	CompartmentId: pulumi.String("string"),
	DefinedTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	DisplayName: pulumi.String("string"),
	FreeformTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	ImageSourceDetails: &core.ImageImageSourceDetailsArgs{
		SourceType:             pulumi.String("string"),
		BucketName:             pulumi.String("string"),
		NamespaceName:          pulumi.String("string"),
		ObjectName:             pulumi.String("string"),
		OperatingSystem:        pulumi.String("string"),
		OperatingSystemVersion: pulumi.String("string"),
		SourceImageType:        pulumi.String("string"),
		SourceUri:              pulumi.String("string"),
	},
	InstanceId: pulumi.String("string"),
	LaunchMode: pulumi.String("string"),
})
var imageResource = new Image("imageResource", ImageArgs.builder()
    .compartmentId("string")
    .definedTags(Map.of("string", "string"))
    .displayName("string")
    .freeformTags(Map.of("string", "string"))
    .imageSourceDetails(ImageImageSourceDetailsArgs.builder()
        .sourceType("string")
        .bucketName("string")
        .namespaceName("string")
        .objectName("string")
        .operatingSystem("string")
        .operatingSystemVersion("string")
        .sourceImageType("string")
        .sourceUri("string")
        .build())
    .instanceId("string")
    .launchMode("string")
    .build());
image_resource = oci.core.Image("imageResource",
    compartment_id="string",
    defined_tags={
        "string": "string",
    },
    display_name="string",
    freeform_tags={
        "string": "string",
    },
    image_source_details={
        "source_type": "string",
        "bucket_name": "string",
        "namespace_name": "string",
        "object_name": "string",
        "operating_system": "string",
        "operating_system_version": "string",
        "source_image_type": "string",
        "source_uri": "string",
    },
    instance_id="string",
    launch_mode="string")
const imageResource = new oci.core.Image("imageResource", {
    compartmentId: "string",
    definedTags: {
        string: "string",
    },
    displayName: "string",
    freeformTags: {
        string: "string",
    },
    imageSourceDetails: {
        sourceType: "string",
        bucketName: "string",
        namespaceName: "string",
        objectName: "string",
        operatingSystem: "string",
        operatingSystemVersion: "string",
        sourceImageType: "string",
        sourceUri: "string",
    },
    instanceId: "string",
    launchMode: "string",
});
type: oci:Core:Image
properties:
    compartmentId: string
    definedTags:
        string: string
    displayName: string
    freeformTags:
        string: string
    imageSourceDetails:
        bucketName: string
        namespaceName: string
        objectName: string
        operatingSystem: string
        operatingSystemVersion: string
        sourceImageType: string
        sourceType: string
        sourceUri: string
    instanceId: string
    launchMode: string
Image Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Image resource accepts the following input properties:
- CompartmentId string
- (Updatable) The OCID of the compartment you want the image to be created in.
- Dictionary<string, string>
- (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
- (Updatable) A user-friendly name for the image. It does not have to be unique, and it's changeable. Avoid entering confidential information. - You cannot use a platform image name as a custom image name. - Example: - My Oracle Linux image
- Dictionary<string, string>
- (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"}
- ImageSource ImageDetails Image Source Details 
- InstanceId string
- The OCID of the instance you want to use as the basis for the image.
- LaunchMode string
- Specifies the configuration mode for launching virtual machine (VM) instances. The configuration modes are: - NATIVE- VM instances launch with iSCSI boot and VFIO devices. The default value for platform images.
- EMULATED- VM instances launch with emulated devices, such as the E1000 network driver and emulated SCSI disk controller.
- PARAVIRTUALIZED- VM instances launch with paravirtualized devices using VirtIO drivers.
- CUSTOM- VM instances launch with custom configuration settings specified in the- LaunchOptionsparameter.
 - ** 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 
- CompartmentId string
- (Updatable) The OCID of the compartment you want the image to be created in.
- map[string]string
- (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
- (Updatable) A user-friendly name for the image. It does not have to be unique, and it's changeable. Avoid entering confidential information. - You cannot use a platform image name as a custom image name. - Example: - My Oracle Linux image
- map[string]string
- (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"}
- ImageSource ImageDetails Image Source Details Args 
- InstanceId string
- The OCID of the instance you want to use as the basis for the image.
- LaunchMode string
- Specifies the configuration mode for launching virtual machine (VM) instances. The configuration modes are: - NATIVE- VM instances launch with iSCSI boot and VFIO devices. The default value for platform images.
- EMULATED- VM instances launch with emulated devices, such as the E1000 network driver and emulated SCSI disk controller.
- PARAVIRTUALIZED- VM instances launch with paravirtualized devices using VirtIO drivers.
- CUSTOM- VM instances launch with custom configuration settings specified in the- LaunchOptionsparameter.
 - ** 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 
- compartmentId String
- (Updatable) The OCID of the compartment you want the image to be created in.
- Map<String,String>
- (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
- (Updatable) A user-friendly name for the image. It does not have to be unique, and it's changeable. Avoid entering confidential information. - You cannot use a platform image name as a custom image name. - Example: - My Oracle Linux image
- Map<String,String>
- (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"}
- imageSource ImageDetails Image Source Details 
- instanceId String
- The OCID of the instance you want to use as the basis for the image.
- launchMode String
- Specifies the configuration mode for launching virtual machine (VM) instances. The configuration modes are: - NATIVE- VM instances launch with iSCSI boot and VFIO devices. The default value for platform images.
- EMULATED- VM instances launch with emulated devices, such as the E1000 network driver and emulated SCSI disk controller.
- PARAVIRTUALIZED- VM instances launch with paravirtualized devices using VirtIO drivers.
- CUSTOM- VM instances launch with custom configuration settings specified in the- LaunchOptionsparameter.
 - ** 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 
- compartmentId string
- (Updatable) The OCID of the compartment you want the image to be created in.
- {[key: string]: string}
- (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
- (Updatable) A user-friendly name for the image. It does not have to be unique, and it's changeable. Avoid entering confidential information. - You cannot use a platform image name as a custom image name. - Example: - My Oracle Linux image
- {[key: string]: string}
- (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"}
- imageSource ImageDetails Image Source Details 
- instanceId string
- The OCID of the instance you want to use as the basis for the image.
- launchMode string
- Specifies the configuration mode for launching virtual machine (VM) instances. The configuration modes are: - NATIVE- VM instances launch with iSCSI boot and VFIO devices. The default value for platform images.
- EMULATED- VM instances launch with emulated devices, such as the E1000 network driver and emulated SCSI disk controller.
- PARAVIRTUALIZED- VM instances launch with paravirtualized devices using VirtIO drivers.
- CUSTOM- VM instances launch with custom configuration settings specified in the- LaunchOptionsparameter.
 - ** 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 
- compartment_id str
- (Updatable) The OCID of the compartment you want the image to be created in.
- Mapping[str, str]
- (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
- (Updatable) A user-friendly name for the image. It does not have to be unique, and it's changeable. Avoid entering confidential information. - You cannot use a platform image name as a custom image name. - Example: - My Oracle Linux image
- Mapping[str, str]
- (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"}
- image_source_ Imagedetails Image Source Details Args 
- instance_id str
- The OCID of the instance you want to use as the basis for the image.
- launch_mode str
- Specifies the configuration mode for launching virtual machine (VM) instances. The configuration modes are: - NATIVE- VM instances launch with iSCSI boot and VFIO devices. The default value for platform images.
- EMULATED- VM instances launch with emulated devices, such as the E1000 network driver and emulated SCSI disk controller.
- PARAVIRTUALIZED- VM instances launch with paravirtualized devices using VirtIO drivers.
- CUSTOM- VM instances launch with custom configuration settings specified in the- LaunchOptionsparameter.
 - ** 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 
- compartmentId String
- (Updatable) The OCID of the compartment you want the image to be created in.
- Map<String>
- (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
- (Updatable) A user-friendly name for the image. It does not have to be unique, and it's changeable. Avoid entering confidential information. - You cannot use a platform image name as a custom image name. - Example: - My Oracle Linux image
- Map<String>
- (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"}
- imageSource Property MapDetails 
- instanceId String
- The OCID of the instance you want to use as the basis for the image.
- launchMode String
- Specifies the configuration mode for launching virtual machine (VM) instances. The configuration modes are: - NATIVE- VM instances launch with iSCSI boot and VFIO devices. The default value for platform images.
- EMULATED- VM instances launch with emulated devices, such as the E1000 network driver and emulated SCSI disk controller.
- PARAVIRTUALIZED- VM instances launch with paravirtualized devices using VirtIO drivers.
- CUSTOM- VM instances launch with custom configuration settings specified in the- LaunchOptionsparameter.
 - ** 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 
Outputs
All input properties are implicitly available as output properties. Additionally, the Image resource produces the following output properties:
- AgentFeatures List<ImageAgent Feature> 
- Oracle Cloud Agent features supported on the image.
- BaseImage stringId 
- The OCID of the image originally used to launch the instance.
- BillableSize stringIn Gbs 
- The size of the internal storage for this image that is subject to billing (1 GB = 1,073,741,824 bytes). Example: 100
- CreateImage boolAllowed 
- Whether instances launched with this image can be used to create new images. For example, you cannot create an image of an Oracle Database instance. Example: true
- Id string
- The provider-assigned unique ID for this managed resource.
- LaunchOptions List<ImageLaunch Option> 
- Options for tuning the compatibility and performance of VM shapes. The values that you specify override any default values.
- ListingType string
- The listing type of the image. The default value is "NONE".
- OperatingSystem string
- The image's operating system. Example: Oracle Linux
- OperatingSystem stringVersion 
- The image's operating system version. Example: 7.2
- SizeIn stringMbs 
- The boot volume size for an instance launched from this image (1 MB = 1,048,576 bytes). Note this is not the same as the size of the image when it was exported or the actual size of the image. Example: 47694
- State string
- The current state of the image.
- TimeCreated string
- The date and time the image was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
- AgentFeatures []ImageAgent Feature 
- Oracle Cloud Agent features supported on the image.
- BaseImage stringId 
- The OCID of the image originally used to launch the instance.
- BillableSize stringIn Gbs 
- The size of the internal storage for this image that is subject to billing (1 GB = 1,073,741,824 bytes). Example: 100
- CreateImage boolAllowed 
- Whether instances launched with this image can be used to create new images. For example, you cannot create an image of an Oracle Database instance. Example: true
- Id string
- The provider-assigned unique ID for this managed resource.
- LaunchOptions []ImageLaunch Option 
- Options for tuning the compatibility and performance of VM shapes. The values that you specify override any default values.
- ListingType string
- The listing type of the image. The default value is "NONE".
- OperatingSystem string
- The image's operating system. Example: Oracle Linux
- OperatingSystem stringVersion 
- The image's operating system version. Example: 7.2
- SizeIn stringMbs 
- The boot volume size for an instance launched from this image (1 MB = 1,048,576 bytes). Note this is not the same as the size of the image when it was exported or the actual size of the image. Example: 47694
- State string
- The current state of the image.
- TimeCreated string
- The date and time the image was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
- agentFeatures List<ImageAgent Feature> 
- Oracle Cloud Agent features supported on the image.
- baseImage StringId 
- The OCID of the image originally used to launch the instance.
- billableSize StringIn Gbs 
- The size of the internal storage for this image that is subject to billing (1 GB = 1,073,741,824 bytes). Example: 100
- createImage BooleanAllowed 
- Whether instances launched with this image can be used to create new images. For example, you cannot create an image of an Oracle Database instance. Example: true
- id String
- The provider-assigned unique ID for this managed resource.
- launchOptions List<ImageLaunch Option> 
- Options for tuning the compatibility and performance of VM shapes. The values that you specify override any default values.
- listingType String
- The listing type of the image. The default value is "NONE".
- operatingSystem String
- The image's operating system. Example: Oracle Linux
- operatingSystem StringVersion 
- The image's operating system version. Example: 7.2
- sizeIn StringMbs 
- The boot volume size for an instance launched from this image (1 MB = 1,048,576 bytes). Note this is not the same as the size of the image when it was exported or the actual size of the image. Example: 47694
- state String
- The current state of the image.
- timeCreated String
- The date and time the image was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
- agentFeatures ImageAgent Feature[] 
- Oracle Cloud Agent features supported on the image.
- baseImage stringId 
- The OCID of the image originally used to launch the instance.
- billableSize stringIn Gbs 
- The size of the internal storage for this image that is subject to billing (1 GB = 1,073,741,824 bytes). Example: 100
- createImage booleanAllowed 
- Whether instances launched with this image can be used to create new images. For example, you cannot create an image of an Oracle Database instance. Example: true
- id string
- The provider-assigned unique ID for this managed resource.
- launchOptions ImageLaunch Option[] 
- Options for tuning the compatibility and performance of VM shapes. The values that you specify override any default values.
- listingType string
- The listing type of the image. The default value is "NONE".
- operatingSystem string
- The image's operating system. Example: Oracle Linux
- operatingSystem stringVersion 
- The image's operating system version. Example: 7.2
- sizeIn stringMbs 
- The boot volume size for an instance launched from this image (1 MB = 1,048,576 bytes). Note this is not the same as the size of the image when it was exported or the actual size of the image. Example: 47694
- state string
- The current state of the image.
- timeCreated string
- The date and time the image was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
- agent_features Sequence[ImageAgent Feature] 
- Oracle Cloud Agent features supported on the image.
- base_image_ strid 
- The OCID of the image originally used to launch the instance.
- billable_size_ strin_ gbs 
- The size of the internal storage for this image that is subject to billing (1 GB = 1,073,741,824 bytes). Example: 100
- create_image_ boolallowed 
- Whether instances launched with this image can be used to create new images. For example, you cannot create an image of an Oracle Database instance. Example: true
- id str
- The provider-assigned unique ID for this managed resource.
- launch_options Sequence[ImageLaunch Option] 
- Options for tuning the compatibility and performance of VM shapes. The values that you specify override any default values.
- listing_type str
- The listing type of the image. The default value is "NONE".
- operating_system str
- The image's operating system. Example: Oracle Linux
- operating_system_ strversion 
- The image's operating system version. Example: 7.2
- size_in_ strmbs 
- The boot volume size for an instance launched from this image (1 MB = 1,048,576 bytes). Note this is not the same as the size of the image when it was exported or the actual size of the image. Example: 47694
- state str
- The current state of the image.
- time_created str
- The date and time the image was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
- agentFeatures List<Property Map>
- Oracle Cloud Agent features supported on the image.
- baseImage StringId 
- The OCID of the image originally used to launch the instance.
- billableSize StringIn Gbs 
- The size of the internal storage for this image that is subject to billing (1 GB = 1,073,741,824 bytes). Example: 100
- createImage BooleanAllowed 
- Whether instances launched with this image can be used to create new images. For example, you cannot create an image of an Oracle Database instance. Example: true
- id String
- The provider-assigned unique ID for this managed resource.
- launchOptions List<Property Map>
- Options for tuning the compatibility and performance of VM shapes. The values that you specify override any default values.
- listingType String
- The listing type of the image. The default value is "NONE".
- operatingSystem String
- The image's operating system. Example: Oracle Linux
- operatingSystem StringVersion 
- The image's operating system version. Example: 7.2
- sizeIn StringMbs 
- The boot volume size for an instance launched from this image (1 MB = 1,048,576 bytes). Note this is not the same as the size of the image when it was exported or the actual size of the image. Example: 47694
- state String
- The current state of the image.
- timeCreated String
- The date and time the image was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
Look up Existing Image Resource
Get an existing Image 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?: ImageState, opts?: CustomResourceOptions): Image@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        agent_features: Optional[Sequence[ImageAgentFeatureArgs]] = None,
        base_image_id: Optional[str] = None,
        billable_size_in_gbs: Optional[str] = None,
        compartment_id: Optional[str] = None,
        create_image_allowed: Optional[bool] = None,
        defined_tags: Optional[Mapping[str, str]] = None,
        display_name: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, str]] = None,
        image_source_details: Optional[ImageImageSourceDetailsArgs] = None,
        instance_id: Optional[str] = None,
        launch_mode: Optional[str] = None,
        launch_options: Optional[Sequence[ImageLaunchOptionArgs]] = None,
        listing_type: Optional[str] = None,
        operating_system: Optional[str] = None,
        operating_system_version: Optional[str] = None,
        size_in_mbs: Optional[str] = None,
        state: Optional[str] = None,
        time_created: Optional[str] = None) -> Imagefunc GetImage(ctx *Context, name string, id IDInput, state *ImageState, opts ...ResourceOption) (*Image, error)public static Image Get(string name, Input<string> id, ImageState? state, CustomResourceOptions? opts = null)public static Image get(String name, Output<String> id, ImageState state, CustomResourceOptions options)resources:  _:    type: oci:Core:Image    get:      id: ${id}- 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.
- AgentFeatures List<ImageAgent Feature> 
- Oracle Cloud Agent features supported on the image.
- BaseImage stringId 
- The OCID of the image originally used to launch the instance.
- BillableSize stringIn Gbs 
- The size of the internal storage for this image that is subject to billing (1 GB = 1,073,741,824 bytes). Example: 100
- CompartmentId string
- (Updatable) The OCID of the compartment you want the image to be created in.
- CreateImage boolAllowed 
- Whether instances launched with this image can be used to create new images. For example, you cannot create an image of an Oracle Database instance. Example: true
- Dictionary<string, string>
- (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
- (Updatable) A user-friendly name for the image. It does not have to be unique, and it's changeable. Avoid entering confidential information. - You cannot use a platform image name as a custom image name. - Example: - My Oracle Linux image
- Dictionary<string, string>
- (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"}
- ImageSource ImageDetails Image Source Details 
- InstanceId string
- The OCID of the instance you want to use as the basis for the image.
- LaunchMode string
- Specifies the configuration mode for launching virtual machine (VM) instances. The configuration modes are: - NATIVE- VM instances launch with iSCSI boot and VFIO devices. The default value for platform images.
- EMULATED- VM instances launch with emulated devices, such as the E1000 network driver and emulated SCSI disk controller.
- PARAVIRTUALIZED- VM instances launch with paravirtualized devices using VirtIO drivers.
- CUSTOM- VM instances launch with custom configuration settings specified in the- LaunchOptionsparameter.
 - ** 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 
- LaunchOptions List<ImageLaunch Option> 
- Options for tuning the compatibility and performance of VM shapes. The values that you specify override any default values.
- ListingType string
- The listing type of the image. The default value is "NONE".
- OperatingSystem string
- The image's operating system. Example: Oracle Linux
- OperatingSystem stringVersion 
- The image's operating system version. Example: 7.2
- SizeIn stringMbs 
- The boot volume size for an instance launched from this image (1 MB = 1,048,576 bytes). Note this is not the same as the size of the image when it was exported or the actual size of the image. Example: 47694
- State string
- The current state of the image.
- TimeCreated string
- The date and time the image was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
- AgentFeatures []ImageAgent Feature Args 
- Oracle Cloud Agent features supported on the image.
- BaseImage stringId 
- The OCID of the image originally used to launch the instance.
- BillableSize stringIn Gbs 
- The size of the internal storage for this image that is subject to billing (1 GB = 1,073,741,824 bytes). Example: 100
- CompartmentId string
- (Updatable) The OCID of the compartment you want the image to be created in.
- CreateImage boolAllowed 
- Whether instances launched with this image can be used to create new images. For example, you cannot create an image of an Oracle Database instance. Example: true
- map[string]string
- (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
- (Updatable) A user-friendly name for the image. It does not have to be unique, and it's changeable. Avoid entering confidential information. - You cannot use a platform image name as a custom image name. - Example: - My Oracle Linux image
- map[string]string
- (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"}
- ImageSource ImageDetails Image Source Details Args 
- InstanceId string
- The OCID of the instance you want to use as the basis for the image.
- LaunchMode string
- Specifies the configuration mode for launching virtual machine (VM) instances. The configuration modes are: - NATIVE- VM instances launch with iSCSI boot and VFIO devices. The default value for platform images.
- EMULATED- VM instances launch with emulated devices, such as the E1000 network driver and emulated SCSI disk controller.
- PARAVIRTUALIZED- VM instances launch with paravirtualized devices using VirtIO drivers.
- CUSTOM- VM instances launch with custom configuration settings specified in the- LaunchOptionsparameter.
 - ** 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 
- LaunchOptions []ImageLaunch Option Args 
- Options for tuning the compatibility and performance of VM shapes. The values that you specify override any default values.
- ListingType string
- The listing type of the image. The default value is "NONE".
- OperatingSystem string
- The image's operating system. Example: Oracle Linux
- OperatingSystem stringVersion 
- The image's operating system version. Example: 7.2
- SizeIn stringMbs 
- The boot volume size for an instance launched from this image (1 MB = 1,048,576 bytes). Note this is not the same as the size of the image when it was exported or the actual size of the image. Example: 47694
- State string
- The current state of the image.
- TimeCreated string
- The date and time the image was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
- agentFeatures List<ImageAgent Feature> 
- Oracle Cloud Agent features supported on the image.
- baseImage StringId 
- The OCID of the image originally used to launch the instance.
- billableSize StringIn Gbs 
- The size of the internal storage for this image that is subject to billing (1 GB = 1,073,741,824 bytes). Example: 100
- compartmentId String
- (Updatable) The OCID of the compartment you want the image to be created in.
- createImage BooleanAllowed 
- Whether instances launched with this image can be used to create new images. For example, you cannot create an image of an Oracle Database instance. Example: true
- Map<String,String>
- (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
- (Updatable) A user-friendly name for the image. It does not have to be unique, and it's changeable. Avoid entering confidential information. - You cannot use a platform image name as a custom image name. - Example: - My Oracle Linux image
- Map<String,String>
- (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"}
- imageSource ImageDetails Image Source Details 
- instanceId String
- The OCID of the instance you want to use as the basis for the image.
- launchMode String
- Specifies the configuration mode for launching virtual machine (VM) instances. The configuration modes are: - NATIVE- VM instances launch with iSCSI boot and VFIO devices. The default value for platform images.
- EMULATED- VM instances launch with emulated devices, such as the E1000 network driver and emulated SCSI disk controller.
- PARAVIRTUALIZED- VM instances launch with paravirtualized devices using VirtIO drivers.
- CUSTOM- VM instances launch with custom configuration settings specified in the- LaunchOptionsparameter.
 - ** 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 
- launchOptions List<ImageLaunch Option> 
- Options for tuning the compatibility and performance of VM shapes. The values that you specify override any default values.
- listingType String
- The listing type of the image. The default value is "NONE".
- operatingSystem String
- The image's operating system. Example: Oracle Linux
- operatingSystem StringVersion 
- The image's operating system version. Example: 7.2
- sizeIn StringMbs 
- The boot volume size for an instance launched from this image (1 MB = 1,048,576 bytes). Note this is not the same as the size of the image when it was exported or the actual size of the image. Example: 47694
- state String
- The current state of the image.
- timeCreated String
- The date and time the image was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
- agentFeatures ImageAgent Feature[] 
- Oracle Cloud Agent features supported on the image.
- baseImage stringId 
- The OCID of the image originally used to launch the instance.
- billableSize stringIn Gbs 
- The size of the internal storage for this image that is subject to billing (1 GB = 1,073,741,824 bytes). Example: 100
- compartmentId string
- (Updatable) The OCID of the compartment you want the image to be created in.
- createImage booleanAllowed 
- Whether instances launched with this image can be used to create new images. For example, you cannot create an image of an Oracle Database instance. Example: true
- {[key: string]: string}
- (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
- (Updatable) A user-friendly name for the image. It does not have to be unique, and it's changeable. Avoid entering confidential information. - You cannot use a platform image name as a custom image name. - Example: - My Oracle Linux image
- {[key: string]: string}
- (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"}
- imageSource ImageDetails Image Source Details 
- instanceId string
- The OCID of the instance you want to use as the basis for the image.
- launchMode string
- Specifies the configuration mode for launching virtual machine (VM) instances. The configuration modes are: - NATIVE- VM instances launch with iSCSI boot and VFIO devices. The default value for platform images.
- EMULATED- VM instances launch with emulated devices, such as the E1000 network driver and emulated SCSI disk controller.
- PARAVIRTUALIZED- VM instances launch with paravirtualized devices using VirtIO drivers.
- CUSTOM- VM instances launch with custom configuration settings specified in the- LaunchOptionsparameter.
 - ** 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 
- launchOptions ImageLaunch Option[] 
- Options for tuning the compatibility and performance of VM shapes. The values that you specify override any default values.
- listingType string
- The listing type of the image. The default value is "NONE".
- operatingSystem string
- The image's operating system. Example: Oracle Linux
- operatingSystem stringVersion 
- The image's operating system version. Example: 7.2
- sizeIn stringMbs 
- The boot volume size for an instance launched from this image (1 MB = 1,048,576 bytes). Note this is not the same as the size of the image when it was exported or the actual size of the image. Example: 47694
- state string
- The current state of the image.
- timeCreated string
- The date and time the image was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
- agent_features Sequence[ImageAgent Feature Args] 
- Oracle Cloud Agent features supported on the image.
- base_image_ strid 
- The OCID of the image originally used to launch the instance.
- billable_size_ strin_ gbs 
- The size of the internal storage for this image that is subject to billing (1 GB = 1,073,741,824 bytes). Example: 100
- compartment_id str
- (Updatable) The OCID of the compartment you want the image to be created in.
- create_image_ boolallowed 
- Whether instances launched with this image can be used to create new images. For example, you cannot create an image of an Oracle Database instance. Example: true
- Mapping[str, str]
- (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
- (Updatable) A user-friendly name for the image. It does not have to be unique, and it's changeable. Avoid entering confidential information. - You cannot use a platform image name as a custom image name. - Example: - My Oracle Linux image
- Mapping[str, str]
- (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"}
- image_source_ Imagedetails Image Source Details Args 
- instance_id str
- The OCID of the instance you want to use as the basis for the image.
- launch_mode str
- Specifies the configuration mode for launching virtual machine (VM) instances. The configuration modes are: - NATIVE- VM instances launch with iSCSI boot and VFIO devices. The default value for platform images.
- EMULATED- VM instances launch with emulated devices, such as the E1000 network driver and emulated SCSI disk controller.
- PARAVIRTUALIZED- VM instances launch with paravirtualized devices using VirtIO drivers.
- CUSTOM- VM instances launch with custom configuration settings specified in the- LaunchOptionsparameter.
 - ** 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 
- launch_options Sequence[ImageLaunch Option Args] 
- Options for tuning the compatibility and performance of VM shapes. The values that you specify override any default values.
- listing_type str
- The listing type of the image. The default value is "NONE".
- operating_system str
- The image's operating system. Example: Oracle Linux
- operating_system_ strversion 
- The image's operating system version. Example: 7.2
- size_in_ strmbs 
- The boot volume size for an instance launched from this image (1 MB = 1,048,576 bytes). Note this is not the same as the size of the image when it was exported or the actual size of the image. Example: 47694
- state str
- The current state of the image.
- time_created str
- The date and time the image was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
- agentFeatures List<Property Map>
- Oracle Cloud Agent features supported on the image.
- baseImage StringId 
- The OCID of the image originally used to launch the instance.
- billableSize StringIn Gbs 
- The size of the internal storage for this image that is subject to billing (1 GB = 1,073,741,824 bytes). Example: 100
- compartmentId String
- (Updatable) The OCID of the compartment you want the image to be created in.
- createImage BooleanAllowed 
- Whether instances launched with this image can be used to create new images. For example, you cannot create an image of an Oracle Database instance. Example: true
- Map<String>
- (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
- (Updatable) A user-friendly name for the image. It does not have to be unique, and it's changeable. Avoid entering confidential information. - You cannot use a platform image name as a custom image name. - Example: - My Oracle Linux image
- Map<String>
- (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"}
- imageSource Property MapDetails 
- instanceId String
- The OCID of the instance you want to use as the basis for the image.
- launchMode String
- Specifies the configuration mode for launching virtual machine (VM) instances. The configuration modes are: - NATIVE- VM instances launch with iSCSI boot and VFIO devices. The default value for platform images.
- EMULATED- VM instances launch with emulated devices, such as the E1000 network driver and emulated SCSI disk controller.
- PARAVIRTUALIZED- VM instances launch with paravirtualized devices using VirtIO drivers.
- CUSTOM- VM instances launch with custom configuration settings specified in the- LaunchOptionsparameter.
 - ** 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 
- launchOptions List<Property Map>
- Options for tuning the compatibility and performance of VM shapes. The values that you specify override any default values.
- listingType String
- The listing type of the image. The default value is "NONE".
- operatingSystem String
- The image's operating system. Example: Oracle Linux
- operatingSystem StringVersion 
- The image's operating system version. Example: 7.2
- sizeIn StringMbs 
- The boot volume size for an instance launched from this image (1 MB = 1,048,576 bytes). Note this is not the same as the size of the image when it was exported or the actual size of the image. Example: 47694
- state String
- The current state of the image.
- timeCreated String
- The date and time the image was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
Supporting Types
ImageAgentFeature, ImageAgentFeatureArgs      
- IsManagement boolSupported 
- This attribute is not used.
- IsMonitoring boolSupported 
- This attribute is not used.
- IsManagement boolSupported 
- This attribute is not used.
- IsMonitoring boolSupported 
- This attribute is not used.
- isManagement BooleanSupported 
- This attribute is not used.
- isMonitoring BooleanSupported 
- This attribute is not used.
- isManagement booleanSupported 
- This attribute is not used.
- isMonitoring booleanSupported 
- This attribute is not used.
- is_management_ boolsupported 
- This attribute is not used.
- is_monitoring_ boolsupported 
- This attribute is not used.
- isManagement BooleanSupported 
- This attribute is not used.
- isMonitoring BooleanSupported 
- This attribute is not used.
ImageImageSourceDetails, ImageImageSourceDetailsArgs        
- SourceType string
- The source type for the image. Use objectStorageTuplewhen specifying the namespace, bucket name, and object name. UseobjectStorageUriwhen specifying the Object Storage URL.
- BucketName string
- The Object Storage bucket for the image.
- NamespaceName string
- The Object Storage namespace for the image.
- ObjectName string
- The Object Storage name for the image.
- OperatingSystem string
- The image's operating system. Example: Oracle Linux
- OperatingSystem stringVersion 
- The image's operating system version. Example: 7.2
- SourceImage stringType 
- The format of the image to be imported. Only monolithic images are supported. This attribute is not used for exported Oracle images with the Oracle Cloud Infrastructure image format. Allowed values are:- QCOW2
- VMDK
 
- SourceUri string
- The Object Storage URL for the image.
- SourceType string
- The source type for the image. Use objectStorageTuplewhen specifying the namespace, bucket name, and object name. UseobjectStorageUriwhen specifying the Object Storage URL.
- BucketName string
- The Object Storage bucket for the image.
- NamespaceName string
- The Object Storage namespace for the image.
- ObjectName string
- The Object Storage name for the image.
- OperatingSystem string
- The image's operating system. Example: Oracle Linux
- OperatingSystem stringVersion 
- The image's operating system version. Example: 7.2
- SourceImage stringType 
- The format of the image to be imported. Only monolithic images are supported. This attribute is not used for exported Oracle images with the Oracle Cloud Infrastructure image format. Allowed values are:- QCOW2
- VMDK
 
- SourceUri string
- The Object Storage URL for the image.
- sourceType String
- The source type for the image. Use objectStorageTuplewhen specifying the namespace, bucket name, and object name. UseobjectStorageUriwhen specifying the Object Storage URL.
- bucketName String
- The Object Storage bucket for the image.
- namespaceName String
- The Object Storage namespace for the image.
- objectName String
- The Object Storage name for the image.
- operatingSystem String
- The image's operating system. Example: Oracle Linux
- operatingSystem StringVersion 
- The image's operating system version. Example: 7.2
- sourceImage StringType 
- The format of the image to be imported. Only monolithic images are supported. This attribute is not used for exported Oracle images with the Oracle Cloud Infrastructure image format. Allowed values are:- QCOW2
- VMDK
 
- sourceUri String
- The Object Storage URL for the image.
- sourceType string
- The source type for the image. Use objectStorageTuplewhen specifying the namespace, bucket name, and object name. UseobjectStorageUriwhen specifying the Object Storage URL.
- bucketName string
- The Object Storage bucket for the image.
- namespaceName string
- The Object Storage namespace for the image.
- objectName string
- The Object Storage name for the image.
- operatingSystem string
- The image's operating system. Example: Oracle Linux
- operatingSystem stringVersion 
- The image's operating system version. Example: 7.2
- sourceImage stringType 
- The format of the image to be imported. Only monolithic images are supported. This attribute is not used for exported Oracle images with the Oracle Cloud Infrastructure image format. Allowed values are:- QCOW2
- VMDK
 
- sourceUri string
- The Object Storage URL for the image.
- source_type str
- The source type for the image. Use objectStorageTuplewhen specifying the namespace, bucket name, and object name. UseobjectStorageUriwhen specifying the Object Storage URL.
- bucket_name str
- The Object Storage bucket for the image.
- namespace_name str
- The Object Storage namespace for the image.
- object_name str
- The Object Storage name for the image.
- operating_system str
- The image's operating system. Example: Oracle Linux
- operating_system_ strversion 
- The image's operating system version. Example: 7.2
- source_image_ strtype 
- The format of the image to be imported. Only monolithic images are supported. This attribute is not used for exported Oracle images with the Oracle Cloud Infrastructure image format. Allowed values are:- QCOW2
- VMDK
 
- source_uri str
- The Object Storage URL for the image.
- sourceType String
- The source type for the image. Use objectStorageTuplewhen specifying the namespace, bucket name, and object name. UseobjectStorageUriwhen specifying the Object Storage URL.
- bucketName String
- The Object Storage bucket for the image.
- namespaceName String
- The Object Storage namespace for the image.
- objectName String
- The Object Storage name for the image.
- operatingSystem String
- The image's operating system. Example: Oracle Linux
- operatingSystem StringVersion 
- The image's operating system version. Example: 7.2
- sourceImage StringType 
- The format of the image to be imported. Only monolithic images are supported. This attribute is not used for exported Oracle images with the Oracle Cloud Infrastructure image format. Allowed values are:- QCOW2
- VMDK
 
- sourceUri String
- The Object Storage URL for the image.
ImageLaunchOption, ImageLaunchOptionArgs      
- BootVolume stringType 
- Emulation type for the boot volume.- ISCSI- ISCSI attached block storage device.
- SCSI- Emulated SCSI disk.
- IDE- Emulated IDE disk.
- VFIO- Direct attached Virtual Function storage. This is the default option for local data volumes on platform images.
- PARAVIRTUALIZED- Paravirtualized disk. This is the default for boot volumes and remote block storage volumes on platform images.
 
- Firmware string
- Firmware used to boot VM. Select the option that matches your operating system.- BIOS- Boot VM using BIOS style firmware. This is compatible with both 32 bit and 64 bit operating systems that boot using MBR style bootloaders.
- UEFI_64- Boot VM using UEFI style firmware compatible with 64 bit operating systems. This is the default for platform images.
 
- IsConsistent boolVolume Naming Enabled 
- Whether to enable consistent volume naming feature. Defaults to false.
- IsPv boolEncryption In Transit Enabled 
- Deprecated. Instead use isPvEncryptionInTransitEnabledin LaunchInstanceDetails.
- NetworkType string
- Emulation type for the physical network interface card (NIC).- E1000- Emulated Gigabit ethernet controller. Compatible with Linux e1000 network driver.
- VFIO- Direct attached Virtual Function network controller. This is the networking type when you launch an instance using hardware-assisted (SR-IOV) networking.
- PARAVIRTUALIZED- VM instances launch with paravirtualized devices using VirtIO drivers.
 
- RemoteData stringVolume Type 
- Emulation type for volume.- ISCSI- ISCSI attached block storage device.
- SCSI- Emulated SCSI disk.
- IDE- Emulated IDE disk.
- VFIO- Direct attached Virtual Function storage. This is the default option for local data volumes on platform images.
- PARAVIRTUALIZED- Paravirtualized disk. This is the default for boot volumes and remote block storage volumes on platform images.
 
- BootVolume stringType 
- Emulation type for the boot volume.- ISCSI- ISCSI attached block storage device.
- SCSI- Emulated SCSI disk.
- IDE- Emulated IDE disk.
- VFIO- Direct attached Virtual Function storage. This is the default option for local data volumes on platform images.
- PARAVIRTUALIZED- Paravirtualized disk. This is the default for boot volumes and remote block storage volumes on platform images.
 
- Firmware string
- Firmware used to boot VM. Select the option that matches your operating system.- BIOS- Boot VM using BIOS style firmware. This is compatible with both 32 bit and 64 bit operating systems that boot using MBR style bootloaders.
- UEFI_64- Boot VM using UEFI style firmware compatible with 64 bit operating systems. This is the default for platform images.
 
- IsConsistent boolVolume Naming Enabled 
- Whether to enable consistent volume naming feature. Defaults to false.
- IsPv boolEncryption In Transit Enabled 
- Deprecated. Instead use isPvEncryptionInTransitEnabledin LaunchInstanceDetails.
- NetworkType string
- Emulation type for the physical network interface card (NIC).- E1000- Emulated Gigabit ethernet controller. Compatible with Linux e1000 network driver.
- VFIO- Direct attached Virtual Function network controller. This is the networking type when you launch an instance using hardware-assisted (SR-IOV) networking.
- PARAVIRTUALIZED- VM instances launch with paravirtualized devices using VirtIO drivers.
 
- RemoteData stringVolume Type 
- Emulation type for volume.- ISCSI- ISCSI attached block storage device.
- SCSI- Emulated SCSI disk.
- IDE- Emulated IDE disk.
- VFIO- Direct attached Virtual Function storage. This is the default option for local data volumes on platform images.
- PARAVIRTUALIZED- Paravirtualized disk. This is the default for boot volumes and remote block storage volumes on platform images.
 
- bootVolume StringType 
- Emulation type for the boot volume.- ISCSI- ISCSI attached block storage device.
- SCSI- Emulated SCSI disk.
- IDE- Emulated IDE disk.
- VFIO- Direct attached Virtual Function storage. This is the default option for local data volumes on platform images.
- PARAVIRTUALIZED- Paravirtualized disk. This is the default for boot volumes and remote block storage volumes on platform images.
 
- firmware String
- Firmware used to boot VM. Select the option that matches your operating system.- BIOS- Boot VM using BIOS style firmware. This is compatible with both 32 bit and 64 bit operating systems that boot using MBR style bootloaders.
- UEFI_64- Boot VM using UEFI style firmware compatible with 64 bit operating systems. This is the default for platform images.
 
- isConsistent BooleanVolume Naming Enabled 
- Whether to enable consistent volume naming feature. Defaults to false.
- isPv BooleanEncryption In Transit Enabled 
- Deprecated. Instead use isPvEncryptionInTransitEnabledin LaunchInstanceDetails.
- networkType String
- Emulation type for the physical network interface card (NIC).- E1000- Emulated Gigabit ethernet controller. Compatible with Linux e1000 network driver.
- VFIO- Direct attached Virtual Function network controller. This is the networking type when you launch an instance using hardware-assisted (SR-IOV) networking.
- PARAVIRTUALIZED- VM instances launch with paravirtualized devices using VirtIO drivers.
 
- remoteData StringVolume Type 
- Emulation type for volume.- ISCSI- ISCSI attached block storage device.
- SCSI- Emulated SCSI disk.
- IDE- Emulated IDE disk.
- VFIO- Direct attached Virtual Function storage. This is the default option for local data volumes on platform images.
- PARAVIRTUALIZED- Paravirtualized disk. This is the default for boot volumes and remote block storage volumes on platform images.
 
- bootVolume stringType 
- Emulation type for the boot volume.- ISCSI- ISCSI attached block storage device.
- SCSI- Emulated SCSI disk.
- IDE- Emulated IDE disk.
- VFIO- Direct attached Virtual Function storage. This is the default option for local data volumes on platform images.
- PARAVIRTUALIZED- Paravirtualized disk. This is the default for boot volumes and remote block storage volumes on platform images.
 
- firmware string
- Firmware used to boot VM. Select the option that matches your operating system.- BIOS- Boot VM using BIOS style firmware. This is compatible with both 32 bit and 64 bit operating systems that boot using MBR style bootloaders.
- UEFI_64- Boot VM using UEFI style firmware compatible with 64 bit operating systems. This is the default for platform images.
 
- isConsistent booleanVolume Naming Enabled 
- Whether to enable consistent volume naming feature. Defaults to false.
- isPv booleanEncryption In Transit Enabled 
- Deprecated. Instead use isPvEncryptionInTransitEnabledin LaunchInstanceDetails.
- networkType string
- Emulation type for the physical network interface card (NIC).- E1000- Emulated Gigabit ethernet controller. Compatible with Linux e1000 network driver.
- VFIO- Direct attached Virtual Function network controller. This is the networking type when you launch an instance using hardware-assisted (SR-IOV) networking.
- PARAVIRTUALIZED- VM instances launch with paravirtualized devices using VirtIO drivers.
 
- remoteData stringVolume Type 
- Emulation type for volume.- ISCSI- ISCSI attached block storage device.
- SCSI- Emulated SCSI disk.
- IDE- Emulated IDE disk.
- VFIO- Direct attached Virtual Function storage. This is the default option for local data volumes on platform images.
- PARAVIRTUALIZED- Paravirtualized disk. This is the default for boot volumes and remote block storage volumes on platform images.
 
- boot_volume_ strtype 
- Emulation type for the boot volume.- ISCSI- ISCSI attached block storage device.
- SCSI- Emulated SCSI disk.
- IDE- Emulated IDE disk.
- VFIO- Direct attached Virtual Function storage. This is the default option for local data volumes on platform images.
- PARAVIRTUALIZED- Paravirtualized disk. This is the default for boot volumes and remote block storage volumes on platform images.
 
- firmware str
- Firmware used to boot VM. Select the option that matches your operating system.- BIOS- Boot VM using BIOS style firmware. This is compatible with both 32 bit and 64 bit operating systems that boot using MBR style bootloaders.
- UEFI_64- Boot VM using UEFI style firmware compatible with 64 bit operating systems. This is the default for platform images.
 
- is_consistent_ boolvolume_ naming_ enabled 
- Whether to enable consistent volume naming feature. Defaults to false.
- is_pv_ boolencryption_ in_ transit_ enabled 
- Deprecated. Instead use isPvEncryptionInTransitEnabledin LaunchInstanceDetails.
- network_type str
- Emulation type for the physical network interface card (NIC).- E1000- Emulated Gigabit ethernet controller. Compatible with Linux e1000 network driver.
- VFIO- Direct attached Virtual Function network controller. This is the networking type when you launch an instance using hardware-assisted (SR-IOV) networking.
- PARAVIRTUALIZED- VM instances launch with paravirtualized devices using VirtIO drivers.
 
- remote_data_ strvolume_ type 
- Emulation type for volume.- ISCSI- ISCSI attached block storage device.
- SCSI- Emulated SCSI disk.
- IDE- Emulated IDE disk.
- VFIO- Direct attached Virtual Function storage. This is the default option for local data volumes on platform images.
- PARAVIRTUALIZED- Paravirtualized disk. This is the default for boot volumes and remote block storage volumes on platform images.
 
- bootVolume StringType 
- Emulation type for the boot volume.- ISCSI- ISCSI attached block storage device.
- SCSI- Emulated SCSI disk.
- IDE- Emulated IDE disk.
- VFIO- Direct attached Virtual Function storage. This is the default option for local data volumes on platform images.
- PARAVIRTUALIZED- Paravirtualized disk. This is the default for boot volumes and remote block storage volumes on platform images.
 
- firmware String
- Firmware used to boot VM. Select the option that matches your operating system.- BIOS- Boot VM using BIOS style firmware. This is compatible with both 32 bit and 64 bit operating systems that boot using MBR style bootloaders.
- UEFI_64- Boot VM using UEFI style firmware compatible with 64 bit operating systems. This is the default for platform images.
 
- isConsistent BooleanVolume Naming Enabled 
- Whether to enable consistent volume naming feature. Defaults to false.
- isPv BooleanEncryption In Transit Enabled 
- Deprecated. Instead use isPvEncryptionInTransitEnabledin LaunchInstanceDetails.
- networkType String
- Emulation type for the physical network interface card (NIC).- E1000- Emulated Gigabit ethernet controller. Compatible with Linux e1000 network driver.
- VFIO- Direct attached Virtual Function network controller. This is the networking type when you launch an instance using hardware-assisted (SR-IOV) networking.
- PARAVIRTUALIZED- VM instances launch with paravirtualized devices using VirtIO drivers.
 
- remoteData StringVolume Type 
- Emulation type for volume.- ISCSI- ISCSI attached block storage device.
- SCSI- Emulated SCSI disk.
- IDE- Emulated IDE disk.
- VFIO- Direct attached Virtual Function storage. This is the default option for local data volumes on platform images.
- PARAVIRTUALIZED- Paravirtualized disk. This is the default for boot volumes and remote block storage volumes on platform images.
 
Import
Images can be imported using the id, e.g.
$ pulumi import oci:Core/image:Image test_image "id"
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the ociTerraform Provider.
