1. Packages
  2. OpenStack
  3. API Docs
  4. images
  5. Image
OpenStack v3.15.1 published on Thursday, Feb 1, 2024 by Pulumi

openstack.images.Image

Explore with Pulumi AI

openstack logo
OpenStack v3.15.1 published on Thursday, Feb 1, 2024 by Pulumi

    Manages a V2 Image resource within OpenStack Glance.

    Note: All arguments including the source image URL password will be stored in the raw state as plain-text. Read more about sensitive data in state.

    Notes

    Properties

    This resource supports the ability to add properties to a resource during creation as well as add, update, and delete properties during an update of this resource.

    Newer versions of OpenStack are adding some read-only properties to each image. These properties start with the prefix os_. If these properties are detected, this resource will automatically reconcile these with the user-provided properties.

    In addition, the direct_url and stores properties are also automatically reconciled if the Image Service set it.

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using OpenStack = Pulumi.OpenStack;
    
    return await Deployment.RunAsync(() => 
    {
        var rancheros = new OpenStack.Images.Image("rancheros", new()
        {
            ContainerFormat = "bare",
            DiskFormat = "qcow2",
            ImageSourceUrl = "https://releases.rancher.com/os/latest/rancheros-openstack.img",
            Properties = 
            {
                { "key", "value" },
            },
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-openstack/sdk/v3/go/openstack/images"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := images.NewImage(ctx, "rancheros", &images.ImageArgs{
    			ContainerFormat: pulumi.String("bare"),
    			DiskFormat:      pulumi.String("qcow2"),
    			ImageSourceUrl:  pulumi.String("https://releases.rancher.com/os/latest/rancheros-openstack.img"),
    			Properties: pulumi.Map{
    				"key": pulumi.Any("value"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.openstack.images.Image;
    import com.pulumi.openstack.images.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 rancheros = new Image("rancheros", ImageArgs.builder()        
                .containerFormat("bare")
                .diskFormat("qcow2")
                .imageSourceUrl("https://releases.rancher.com/os/latest/rancheros-openstack.img")
                .properties(Map.of("key", "value"))
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_openstack as openstack
    
    rancheros = openstack.images.Image("rancheros",
        container_format="bare",
        disk_format="qcow2",
        image_source_url="https://releases.rancher.com/os/latest/rancheros-openstack.img",
        properties={
            "key": "value",
        })
    
    import * as pulumi from "@pulumi/pulumi";
    import * as openstack from "@pulumi/openstack";
    
    const rancheros = new openstack.images.Image("rancheros", {
        containerFormat: "bare",
        diskFormat: "qcow2",
        imageSourceUrl: "https://releases.rancher.com/os/latest/rancheros-openstack.img",
        properties: {
            key: "value",
        },
    });
    
    resources:
      rancheros:
        type: openstack:images:Image
        properties:
          containerFormat: bare
          diskFormat: qcow2
          imageSourceUrl: https://releases.rancher.com/os/latest/rancheros-openstack.img
          properties:
            key: value
    

    Create Image Resource

    new Image(name: string, args: ImageArgs, opts?: CustomResourceOptions);
    @overload
    def Image(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              container_format: Optional[str] = None,
              decompress: Optional[bool] = None,
              disk_format: Optional[str] = None,
              hidden: Optional[bool] = None,
              image_cache_path: Optional[str] = None,
              image_id: Optional[str] = None,
              image_source_password: Optional[str] = None,
              image_source_url: Optional[str] = None,
              image_source_username: Optional[str] = None,
              local_file_path: Optional[str] = None,
              min_disk_gb: Optional[int] = None,
              min_ram_mb: Optional[int] = None,
              name: Optional[str] = None,
              properties: Optional[Mapping[str, Any]] = None,
              protected: Optional[bool] = None,
              region: Optional[str] = None,
              tags: Optional[Sequence[str]] = None,
              verify_checksum: Optional[bool] = None,
              visibility: Optional[str] = None,
              web_download: Optional[bool] = None)
    @overload
    def Image(resource_name: str,
              args: ImageArgs,
              opts: Optional[ResourceOptions] = None)
    func NewImage(ctx *Context, name string, args ImageArgs, opts ...ResourceOption) (*Image, error)
    public Image(string name, ImageArgs args, CustomResourceOptions? opts = null)
    public Image(String name, ImageArgs args)
    public Image(String name, ImageArgs args, CustomResourceOptions options)
    
    type: openstack:images:Image
    properties: # The arguments to resource properties.
    options: # 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.
    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.

    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

    The Image resource accepts the following input properties:

    ContainerFormat string
    The container format. Must be one of "ami", "ari", "aki", "bare", "ovf".
    DiskFormat string
    The disk format. Must be one of "ami", "ari", "aki", "vhd", "vmdk", "raw", "qcow2", "vdi", "iso".
    Decompress bool
    If true, this provider will decompress downloaded image before uploading it to OpenStack. Decompression algorithm is chosen by checking "Content-Type" header, supported algorithm are: gzip, bzip2 and xz. Defaults to false. Changing this creates a new Image.
    Hidden bool
    If true, image will be hidden from public list. Defaults to false.
    ImageCachePath string
    ImageId string
    Unique ID (valid UUID) of image to create. Changing this creates a new image.
    ImageSourcePassword string
    The password of basic auth to download image_source_url.
    ImageSourceUrl string
    This is the url of the raw image. If web_download is not used, then the image will be downloaded in the image_cache_path before being uploaded to Glance. Conflicts with local_file_path.
    ImageSourceUsername string
    The username of basic auth to download image_source_url.
    LocalFilePath string
    This is the filepath of the raw image file that will be uploaded to Glance. Conflicts with image_source_url and web_download.
    MinDiskGb int
    Amount of disk space (in GB) required to boot image. Defaults to 0.
    MinRamMb int
    Amount of ram (in MB) required to boot image. Defauts to 0.
    Name string
    The name of the image.
    Properties Dictionary<string, object>
    A map of key/value pairs to set freeform information about an image. See the "Notes" section for further information about properties.
    Protected bool
    If true, image will not be deletable. Defaults to false.
    Region string
    The region in which to obtain the V2 Glance client. A Glance client is needed to create an Image that can be used with a compute instance. If omitted, the region argument of the provider is used. Changing this creates a new Image.
    Tags List<string>
    The tags of the image. It must be a list of strings. At this time, it is not possible to delete all tags of an image.
    VerifyChecksum bool
    If false, the checksum will not be verified once the image is finished uploading. Conflicts with web_download. Defaults to true when not using web_download.
    Visibility string
    The visibility of the image. Must be one of "public", "private", "community", or "shared". The ability to set the visibility depends upon the configuration of the OpenStack cloud.
    WebDownload bool
    If true, the "web-download" import method will be used to let Openstack download the image directly from the remote source. Conflicts with local_file_path. Defaults to false.
    ContainerFormat string
    The container format. Must be one of "ami", "ari", "aki", "bare", "ovf".
    DiskFormat string
    The disk format. Must be one of "ami", "ari", "aki", "vhd", "vmdk", "raw", "qcow2", "vdi", "iso".
    Decompress bool
    If true, this provider will decompress downloaded image before uploading it to OpenStack. Decompression algorithm is chosen by checking "Content-Type" header, supported algorithm are: gzip, bzip2 and xz. Defaults to false. Changing this creates a new Image.
    Hidden bool
    If true, image will be hidden from public list. Defaults to false.
    ImageCachePath string
    ImageId string
    Unique ID (valid UUID) of image to create. Changing this creates a new image.
    ImageSourcePassword string
    The password of basic auth to download image_source_url.
    ImageSourceUrl string
    This is the url of the raw image. If web_download is not used, then the image will be downloaded in the image_cache_path before being uploaded to Glance. Conflicts with local_file_path.
    ImageSourceUsername string
    The username of basic auth to download image_source_url.
    LocalFilePath string
    This is the filepath of the raw image file that will be uploaded to Glance. Conflicts with image_source_url and web_download.
    MinDiskGb int
    Amount of disk space (in GB) required to boot image. Defaults to 0.
    MinRamMb int
    Amount of ram (in MB) required to boot image. Defauts to 0.
    Name string
    The name of the image.
    Properties map[string]interface{}
    A map of key/value pairs to set freeform information about an image. See the "Notes" section for further information about properties.
    Protected bool
    If true, image will not be deletable. Defaults to false.
    Region string
    The region in which to obtain the V2 Glance client. A Glance client is needed to create an Image that can be used with a compute instance. If omitted, the region argument of the provider is used. Changing this creates a new Image.
    Tags []string
    The tags of the image. It must be a list of strings. At this time, it is not possible to delete all tags of an image.
    VerifyChecksum bool
    If false, the checksum will not be verified once the image is finished uploading. Conflicts with web_download. Defaults to true when not using web_download.
    Visibility string
    The visibility of the image. Must be one of "public", "private", "community", or "shared". The ability to set the visibility depends upon the configuration of the OpenStack cloud.
    WebDownload bool
    If true, the "web-download" import method will be used to let Openstack download the image directly from the remote source. Conflicts with local_file_path. Defaults to false.
    containerFormat String
    The container format. Must be one of "ami", "ari", "aki", "bare", "ovf".
    diskFormat String
    The disk format. Must be one of "ami", "ari", "aki", "vhd", "vmdk", "raw", "qcow2", "vdi", "iso".
    decompress Boolean
    If true, this provider will decompress downloaded image before uploading it to OpenStack. Decompression algorithm is chosen by checking "Content-Type" header, supported algorithm are: gzip, bzip2 and xz. Defaults to false. Changing this creates a new Image.
    hidden Boolean
    If true, image will be hidden from public list. Defaults to false.
    imageCachePath String
    imageId String
    Unique ID (valid UUID) of image to create. Changing this creates a new image.
    imageSourcePassword String
    The password of basic auth to download image_source_url.
    imageSourceUrl String
    This is the url of the raw image. If web_download is not used, then the image will be downloaded in the image_cache_path before being uploaded to Glance. Conflicts with local_file_path.
    imageSourceUsername String
    The username of basic auth to download image_source_url.
    localFilePath String
    This is the filepath of the raw image file that will be uploaded to Glance. Conflicts with image_source_url and web_download.
    minDiskGb Integer
    Amount of disk space (in GB) required to boot image. Defaults to 0.
    minRamMb Integer
    Amount of ram (in MB) required to boot image. Defauts to 0.
    name String
    The name of the image.
    properties Map<String,Object>
    A map of key/value pairs to set freeform information about an image. See the "Notes" section for further information about properties.
    protected_ Boolean
    If true, image will not be deletable. Defaults to false.
    region String
    The region in which to obtain the V2 Glance client. A Glance client is needed to create an Image that can be used with a compute instance. If omitted, the region argument of the provider is used. Changing this creates a new Image.
    tags List<String>
    The tags of the image. It must be a list of strings. At this time, it is not possible to delete all tags of an image.
    verifyChecksum Boolean
    If false, the checksum will not be verified once the image is finished uploading. Conflicts with web_download. Defaults to true when not using web_download.
    visibility String
    The visibility of the image. Must be one of "public", "private", "community", or "shared". The ability to set the visibility depends upon the configuration of the OpenStack cloud.
    webDownload Boolean
    If true, the "web-download" import method will be used to let Openstack download the image directly from the remote source. Conflicts with local_file_path. Defaults to false.
    containerFormat string
    The container format. Must be one of "ami", "ari", "aki", "bare", "ovf".
    diskFormat string
    The disk format. Must be one of "ami", "ari", "aki", "vhd", "vmdk", "raw", "qcow2", "vdi", "iso".
    decompress boolean
    If true, this provider will decompress downloaded image before uploading it to OpenStack. Decompression algorithm is chosen by checking "Content-Type" header, supported algorithm are: gzip, bzip2 and xz. Defaults to false. Changing this creates a new Image.
    hidden boolean
    If true, image will be hidden from public list. Defaults to false.
    imageCachePath string
    imageId string
    Unique ID (valid UUID) of image to create. Changing this creates a new image.
    imageSourcePassword string
    The password of basic auth to download image_source_url.
    imageSourceUrl string
    This is the url of the raw image. If web_download is not used, then the image will be downloaded in the image_cache_path before being uploaded to Glance. Conflicts with local_file_path.
    imageSourceUsername string
    The username of basic auth to download image_source_url.
    localFilePath string
    This is the filepath of the raw image file that will be uploaded to Glance. Conflicts with image_source_url and web_download.
    minDiskGb number
    Amount of disk space (in GB) required to boot image. Defaults to 0.
    minRamMb number
    Amount of ram (in MB) required to boot image. Defauts to 0.
    name string
    The name of the image.
    properties {[key: string]: any}
    A map of key/value pairs to set freeform information about an image. See the "Notes" section for further information about properties.
    protected boolean
    If true, image will not be deletable. Defaults to false.
    region string
    The region in which to obtain the V2 Glance client. A Glance client is needed to create an Image that can be used with a compute instance. If omitted, the region argument of the provider is used. Changing this creates a new Image.
    tags string[]
    The tags of the image. It must be a list of strings. At this time, it is not possible to delete all tags of an image.
    verifyChecksum boolean
    If false, the checksum will not be verified once the image is finished uploading. Conflicts with web_download. Defaults to true when not using web_download.
    visibility string
    The visibility of the image. Must be one of "public", "private", "community", or "shared". The ability to set the visibility depends upon the configuration of the OpenStack cloud.
    webDownload boolean
    If true, the "web-download" import method will be used to let Openstack download the image directly from the remote source. Conflicts with local_file_path. Defaults to false.
    container_format str
    The container format. Must be one of "ami", "ari", "aki", "bare", "ovf".
    disk_format str
    The disk format. Must be one of "ami", "ari", "aki", "vhd", "vmdk", "raw", "qcow2", "vdi", "iso".
    decompress bool
    If true, this provider will decompress downloaded image before uploading it to OpenStack. Decompression algorithm is chosen by checking "Content-Type" header, supported algorithm are: gzip, bzip2 and xz. Defaults to false. Changing this creates a new Image.
    hidden bool
    If true, image will be hidden from public list. Defaults to false.
    image_cache_path str
    image_id str
    Unique ID (valid UUID) of image to create. Changing this creates a new image.
    image_source_password str
    The password of basic auth to download image_source_url.
    image_source_url str
    This is the url of the raw image. If web_download is not used, then the image will be downloaded in the image_cache_path before being uploaded to Glance. Conflicts with local_file_path.
    image_source_username str
    The username of basic auth to download image_source_url.
    local_file_path str
    This is the filepath of the raw image file that will be uploaded to Glance. Conflicts with image_source_url and web_download.
    min_disk_gb int
    Amount of disk space (in GB) required to boot image. Defaults to 0.
    min_ram_mb int
    Amount of ram (in MB) required to boot image. Defauts to 0.
    name str
    The name of the image.
    properties Mapping[str, Any]
    A map of key/value pairs to set freeform information about an image. See the "Notes" section for further information about properties.
    protected bool
    If true, image will not be deletable. Defaults to false.
    region str
    The region in which to obtain the V2 Glance client. A Glance client is needed to create an Image that can be used with a compute instance. If omitted, the region argument of the provider is used. Changing this creates a new Image.
    tags Sequence[str]
    The tags of the image. It must be a list of strings. At this time, it is not possible to delete all tags of an image.
    verify_checksum bool
    If false, the checksum will not be verified once the image is finished uploading. Conflicts with web_download. Defaults to true when not using web_download.
    visibility str
    The visibility of the image. Must be one of "public", "private", "community", or "shared". The ability to set the visibility depends upon the configuration of the OpenStack cloud.
    web_download bool
    If true, the "web-download" import method will be used to let Openstack download the image directly from the remote source. Conflicts with local_file_path. Defaults to false.
    containerFormat String
    The container format. Must be one of "ami", "ari", "aki", "bare", "ovf".
    diskFormat String
    The disk format. Must be one of "ami", "ari", "aki", "vhd", "vmdk", "raw", "qcow2", "vdi", "iso".
    decompress Boolean
    If true, this provider will decompress downloaded image before uploading it to OpenStack. Decompression algorithm is chosen by checking "Content-Type" header, supported algorithm are: gzip, bzip2 and xz. Defaults to false. Changing this creates a new Image.
    hidden Boolean
    If true, image will be hidden from public list. Defaults to false.
    imageCachePath String
    imageId String
    Unique ID (valid UUID) of image to create. Changing this creates a new image.
    imageSourcePassword String
    The password of basic auth to download image_source_url.
    imageSourceUrl String
    This is the url of the raw image. If web_download is not used, then the image will be downloaded in the image_cache_path before being uploaded to Glance. Conflicts with local_file_path.
    imageSourceUsername String
    The username of basic auth to download image_source_url.
    localFilePath String
    This is the filepath of the raw image file that will be uploaded to Glance. Conflicts with image_source_url and web_download.
    minDiskGb Number
    Amount of disk space (in GB) required to boot image. Defaults to 0.
    minRamMb Number
    Amount of ram (in MB) required to boot image. Defauts to 0.
    name String
    The name of the image.
    properties Map<Any>
    A map of key/value pairs to set freeform information about an image. See the "Notes" section for further information about properties.
    protected Boolean
    If true, image will not be deletable. Defaults to false.
    region String
    The region in which to obtain the V2 Glance client. A Glance client is needed to create an Image that can be used with a compute instance. If omitted, the region argument of the provider is used. Changing this creates a new Image.
    tags List<String>
    The tags of the image. It must be a list of strings. At this time, it is not possible to delete all tags of an image.
    verifyChecksum Boolean
    If false, the checksum will not be verified once the image is finished uploading. Conflicts with web_download. Defaults to true when not using web_download.
    visibility String
    The visibility of the image. Must be one of "public", "private", "community", or "shared". The ability to set the visibility depends upon the configuration of the OpenStack cloud.
    webDownload Boolean
    If true, the "web-download" import method will be used to let Openstack download the image directly from the remote source. Conflicts with local_file_path. Defaults to false.

    Outputs

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

    Checksum string
    The checksum of the data associated with the image.
    CreatedAt string
    The date the image was created.
    File string
    the trailing path after the glance endpoint that represent the location of the image or the path to retrieve it.
    Id string
    The provider-assigned unique ID for this managed resource.
    Metadata Dictionary<string, object>
    The metadata associated with the image. Image metadata allow for meaningfully define the image properties and tags. See https://docs.openstack.org/glance/latest/user/metadefs-concepts.html.
    Owner string
    The id of the openstack user who owns the image.
    Schema string
    The path to the JSON-schema that represent the image or image
    SizeBytes int
    The size in bytes of the data associated with the image.
    Status string
    The status of the image. It can be "queued", "active" or "saving".
    UpdateAt string
    (Deprecated - use updated_at instead)

    Deprecated:Use updated_at instead

    UpdatedAt string
    The date the image was last updated.
    Checksum string
    The checksum of the data associated with the image.
    CreatedAt string
    The date the image was created.
    File string
    the trailing path after the glance endpoint that represent the location of the image or the path to retrieve it.
    Id string
    The provider-assigned unique ID for this managed resource.
    Metadata map[string]interface{}
    The metadata associated with the image. Image metadata allow for meaningfully define the image properties and tags. See https://docs.openstack.org/glance/latest/user/metadefs-concepts.html.
    Owner string
    The id of the openstack user who owns the image.
    Schema string
    The path to the JSON-schema that represent the image or image
    SizeBytes int
    The size in bytes of the data associated with the image.
    Status string
    The status of the image. It can be "queued", "active" or "saving".
    UpdateAt string
    (Deprecated - use updated_at instead)

    Deprecated:Use updated_at instead

    UpdatedAt string
    The date the image was last updated.
    checksum String
    The checksum of the data associated with the image.
    createdAt String
    The date the image was created.
    file String
    the trailing path after the glance endpoint that represent the location of the image or the path to retrieve it.
    id String
    The provider-assigned unique ID for this managed resource.
    metadata Map<String,Object>
    The metadata associated with the image. Image metadata allow for meaningfully define the image properties and tags. See https://docs.openstack.org/glance/latest/user/metadefs-concepts.html.
    owner String
    The id of the openstack user who owns the image.
    schema String
    The path to the JSON-schema that represent the image or image
    sizeBytes Integer
    The size in bytes of the data associated with the image.
    status String
    The status of the image. It can be "queued", "active" or "saving".
    updateAt String
    (Deprecated - use updated_at instead)

    Deprecated:Use updated_at instead

    updatedAt String
    The date the image was last updated.
    checksum string
    The checksum of the data associated with the image.
    createdAt string
    The date the image was created.
    file string
    the trailing path after the glance endpoint that represent the location of the image or the path to retrieve it.
    id string
    The provider-assigned unique ID for this managed resource.
    metadata {[key: string]: any}
    The metadata associated with the image. Image metadata allow for meaningfully define the image properties and tags. See https://docs.openstack.org/glance/latest/user/metadefs-concepts.html.
    owner string
    The id of the openstack user who owns the image.
    schema string
    The path to the JSON-schema that represent the image or image
    sizeBytes number
    The size in bytes of the data associated with the image.
    status string
    The status of the image. It can be "queued", "active" or "saving".
    updateAt string
    (Deprecated - use updated_at instead)

    Deprecated:Use updated_at instead

    updatedAt string
    The date the image was last updated.
    checksum str
    The checksum of the data associated with the image.
    created_at str
    The date the image was created.
    file str
    the trailing path after the glance endpoint that represent the location of the image or the path to retrieve it.
    id str
    The provider-assigned unique ID for this managed resource.
    metadata Mapping[str, Any]
    The metadata associated with the image. Image metadata allow for meaningfully define the image properties and tags. See https://docs.openstack.org/glance/latest/user/metadefs-concepts.html.
    owner str
    The id of the openstack user who owns the image.
    schema str
    The path to the JSON-schema that represent the image or image
    size_bytes int
    The size in bytes of the data associated with the image.
    status str
    The status of the image. It can be "queued", "active" or "saving".
    update_at str
    (Deprecated - use updated_at instead)

    Deprecated:Use updated_at instead

    updated_at str
    The date the image was last updated.
    checksum String
    The checksum of the data associated with the image.
    createdAt String
    The date the image was created.
    file String
    the trailing path after the glance endpoint that represent the location of the image or the path to retrieve it.
    id String
    The provider-assigned unique ID for this managed resource.
    metadata Map<Any>
    The metadata associated with the image. Image metadata allow for meaningfully define the image properties and tags. See https://docs.openstack.org/glance/latest/user/metadefs-concepts.html.
    owner String
    The id of the openstack user who owns the image.
    schema String
    The path to the JSON-schema that represent the image or image
    sizeBytes Number
    The size in bytes of the data associated with the image.
    status String
    The status of the image. It can be "queued", "active" or "saving".
    updateAt String
    (Deprecated - use updated_at instead)

    Deprecated:Use updated_at instead

    updatedAt String
    The date the image was last updated.

    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,
            checksum: Optional[str] = None,
            container_format: Optional[str] = None,
            created_at: Optional[str] = None,
            decompress: Optional[bool] = None,
            disk_format: Optional[str] = None,
            file: Optional[str] = None,
            hidden: Optional[bool] = None,
            image_cache_path: Optional[str] = None,
            image_id: Optional[str] = None,
            image_source_password: Optional[str] = None,
            image_source_url: Optional[str] = None,
            image_source_username: Optional[str] = None,
            local_file_path: Optional[str] = None,
            metadata: Optional[Mapping[str, Any]] = None,
            min_disk_gb: Optional[int] = None,
            min_ram_mb: Optional[int] = None,
            name: Optional[str] = None,
            owner: Optional[str] = None,
            properties: Optional[Mapping[str, Any]] = None,
            protected: Optional[bool] = None,
            region: Optional[str] = None,
            schema: Optional[str] = None,
            size_bytes: Optional[int] = None,
            status: Optional[str] = None,
            tags: Optional[Sequence[str]] = None,
            update_at: Optional[str] = None,
            updated_at: Optional[str] = None,
            verify_checksum: Optional[bool] = None,
            visibility: Optional[str] = None,
            web_download: Optional[bool] = None) -> Image
    func 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)
    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:
    Checksum string
    The checksum of the data associated with the image.
    ContainerFormat string
    The container format. Must be one of "ami", "ari", "aki", "bare", "ovf".
    CreatedAt string
    The date the image was created.
    Decompress bool
    If true, this provider will decompress downloaded image before uploading it to OpenStack. Decompression algorithm is chosen by checking "Content-Type" header, supported algorithm are: gzip, bzip2 and xz. Defaults to false. Changing this creates a new Image.
    DiskFormat string
    The disk format. Must be one of "ami", "ari", "aki", "vhd", "vmdk", "raw", "qcow2", "vdi", "iso".
    File string
    the trailing path after the glance endpoint that represent the location of the image or the path to retrieve it.
    Hidden bool
    If true, image will be hidden from public list. Defaults to false.
    ImageCachePath string
    ImageId string
    Unique ID (valid UUID) of image to create. Changing this creates a new image.
    ImageSourcePassword string
    The password of basic auth to download image_source_url.
    ImageSourceUrl string
    This is the url of the raw image. If web_download is not used, then the image will be downloaded in the image_cache_path before being uploaded to Glance. Conflicts with local_file_path.
    ImageSourceUsername string
    The username of basic auth to download image_source_url.
    LocalFilePath string
    This is the filepath of the raw image file that will be uploaded to Glance. Conflicts with image_source_url and web_download.
    Metadata Dictionary<string, object>
    The metadata associated with the image. Image metadata allow for meaningfully define the image properties and tags. See https://docs.openstack.org/glance/latest/user/metadefs-concepts.html.
    MinDiskGb int
    Amount of disk space (in GB) required to boot image. Defaults to 0.
    MinRamMb int
    Amount of ram (in MB) required to boot image. Defauts to 0.
    Name string
    The name of the image.
    Owner string
    The id of the openstack user who owns the image.
    Properties Dictionary<string, object>
    A map of key/value pairs to set freeform information about an image. See the "Notes" section for further information about properties.
    Protected bool
    If true, image will not be deletable. Defaults to false.
    Region string
    The region in which to obtain the V2 Glance client. A Glance client is needed to create an Image that can be used with a compute instance. If omitted, the region argument of the provider is used. Changing this creates a new Image.
    Schema string
    The path to the JSON-schema that represent the image or image
    SizeBytes int
    The size in bytes of the data associated with the image.
    Status string
    The status of the image. It can be "queued", "active" or "saving".
    Tags List<string>
    The tags of the image. It must be a list of strings. At this time, it is not possible to delete all tags of an image.
    UpdateAt string
    (Deprecated - use updated_at instead)

    Deprecated:Use updated_at instead

    UpdatedAt string
    The date the image was last updated.
    VerifyChecksum bool
    If false, the checksum will not be verified once the image is finished uploading. Conflicts with web_download. Defaults to true when not using web_download.
    Visibility string
    The visibility of the image. Must be one of "public", "private", "community", or "shared". The ability to set the visibility depends upon the configuration of the OpenStack cloud.
    WebDownload bool
    If true, the "web-download" import method will be used to let Openstack download the image directly from the remote source. Conflicts with local_file_path. Defaults to false.
    Checksum string
    The checksum of the data associated with the image.
    ContainerFormat string
    The container format. Must be one of "ami", "ari", "aki", "bare", "ovf".
    CreatedAt string
    The date the image was created.
    Decompress bool
    If true, this provider will decompress downloaded image before uploading it to OpenStack. Decompression algorithm is chosen by checking "Content-Type" header, supported algorithm are: gzip, bzip2 and xz. Defaults to false. Changing this creates a new Image.
    DiskFormat string
    The disk format. Must be one of "ami", "ari", "aki", "vhd", "vmdk", "raw", "qcow2", "vdi", "iso".
    File string
    the trailing path after the glance endpoint that represent the location of the image or the path to retrieve it.
    Hidden bool
    If true, image will be hidden from public list. Defaults to false.
    ImageCachePath string
    ImageId string
    Unique ID (valid UUID) of image to create. Changing this creates a new image.
    ImageSourcePassword string
    The password of basic auth to download image_source_url.
    ImageSourceUrl string
    This is the url of the raw image. If web_download is not used, then the image will be downloaded in the image_cache_path before being uploaded to Glance. Conflicts with local_file_path.
    ImageSourceUsername string
    The username of basic auth to download image_source_url.
    LocalFilePath string
    This is the filepath of the raw image file that will be uploaded to Glance. Conflicts with image_source_url and web_download.
    Metadata map[string]interface{}
    The metadata associated with the image. Image metadata allow for meaningfully define the image properties and tags. See https://docs.openstack.org/glance/latest/user/metadefs-concepts.html.
    MinDiskGb int
    Amount of disk space (in GB) required to boot image. Defaults to 0.
    MinRamMb int
    Amount of ram (in MB) required to boot image. Defauts to 0.
    Name string
    The name of the image.
    Owner string
    The id of the openstack user who owns the image.
    Properties map[string]interface{}
    A map of key/value pairs to set freeform information about an image. See the "Notes" section for further information about properties.
    Protected bool
    If true, image will not be deletable. Defaults to false.
    Region string
    The region in which to obtain the V2 Glance client. A Glance client is needed to create an Image that can be used with a compute instance. If omitted, the region argument of the provider is used. Changing this creates a new Image.
    Schema string
    The path to the JSON-schema that represent the image or image
    SizeBytes int
    The size in bytes of the data associated with the image.
    Status string
    The status of the image. It can be "queued", "active" or "saving".
    Tags []string
    The tags of the image. It must be a list of strings. At this time, it is not possible to delete all tags of an image.
    UpdateAt string
    (Deprecated - use updated_at instead)

    Deprecated:Use updated_at instead

    UpdatedAt string
    The date the image was last updated.
    VerifyChecksum bool
    If false, the checksum will not be verified once the image is finished uploading. Conflicts with web_download. Defaults to true when not using web_download.
    Visibility string
    The visibility of the image. Must be one of "public", "private", "community", or "shared". The ability to set the visibility depends upon the configuration of the OpenStack cloud.
    WebDownload bool
    If true, the "web-download" import method will be used to let Openstack download the image directly from the remote source. Conflicts with local_file_path. Defaults to false.
    checksum String
    The checksum of the data associated with the image.
    containerFormat String
    The container format. Must be one of "ami", "ari", "aki", "bare", "ovf".
    createdAt String
    The date the image was created.
    decompress Boolean
    If true, this provider will decompress downloaded image before uploading it to OpenStack. Decompression algorithm is chosen by checking "Content-Type" header, supported algorithm are: gzip, bzip2 and xz. Defaults to false. Changing this creates a new Image.
    diskFormat String
    The disk format. Must be one of "ami", "ari", "aki", "vhd", "vmdk", "raw", "qcow2", "vdi", "iso".
    file String
    the trailing path after the glance endpoint that represent the location of the image or the path to retrieve it.
    hidden Boolean
    If true, image will be hidden from public list. Defaults to false.
    imageCachePath String
    imageId String
    Unique ID (valid UUID) of image to create. Changing this creates a new image.
    imageSourcePassword String
    The password of basic auth to download image_source_url.
    imageSourceUrl String
    This is the url of the raw image. If web_download is not used, then the image will be downloaded in the image_cache_path before being uploaded to Glance. Conflicts with local_file_path.
    imageSourceUsername String
    The username of basic auth to download image_source_url.
    localFilePath String
    This is the filepath of the raw image file that will be uploaded to Glance. Conflicts with image_source_url and web_download.
    metadata Map<String,Object>
    The metadata associated with the image. Image metadata allow for meaningfully define the image properties and tags. See https://docs.openstack.org/glance/latest/user/metadefs-concepts.html.
    minDiskGb Integer
    Amount of disk space (in GB) required to boot image. Defaults to 0.
    minRamMb Integer
    Amount of ram (in MB) required to boot image. Defauts to 0.
    name String
    The name of the image.
    owner String
    The id of the openstack user who owns the image.
    properties Map<String,Object>
    A map of key/value pairs to set freeform information about an image. See the "Notes" section for further information about properties.
    protected_ Boolean
    If true, image will not be deletable. Defaults to false.
    region String
    The region in which to obtain the V2 Glance client. A Glance client is needed to create an Image that can be used with a compute instance. If omitted, the region argument of the provider is used. Changing this creates a new Image.
    schema String
    The path to the JSON-schema that represent the image or image
    sizeBytes Integer
    The size in bytes of the data associated with the image.
    status String
    The status of the image. It can be "queued", "active" or "saving".
    tags List<String>
    The tags of the image. It must be a list of strings. At this time, it is not possible to delete all tags of an image.
    updateAt String
    (Deprecated - use updated_at instead)

    Deprecated:Use updated_at instead

    updatedAt String
    The date the image was last updated.
    verifyChecksum Boolean
    If false, the checksum will not be verified once the image is finished uploading. Conflicts with web_download. Defaults to true when not using web_download.
    visibility String
    The visibility of the image. Must be one of "public", "private", "community", or "shared". The ability to set the visibility depends upon the configuration of the OpenStack cloud.
    webDownload Boolean
    If true, the "web-download" import method will be used to let Openstack download the image directly from the remote source. Conflicts with local_file_path. Defaults to false.
    checksum string
    The checksum of the data associated with the image.
    containerFormat string
    The container format. Must be one of "ami", "ari", "aki", "bare", "ovf".
    createdAt string
    The date the image was created.
    decompress boolean
    If true, this provider will decompress downloaded image before uploading it to OpenStack. Decompression algorithm is chosen by checking "Content-Type" header, supported algorithm are: gzip, bzip2 and xz. Defaults to false. Changing this creates a new Image.
    diskFormat string
    The disk format. Must be one of "ami", "ari", "aki", "vhd", "vmdk", "raw", "qcow2", "vdi", "iso".
    file string
    the trailing path after the glance endpoint that represent the location of the image or the path to retrieve it.
    hidden boolean
    If true, image will be hidden from public list. Defaults to false.
    imageCachePath string
    imageId string
    Unique ID (valid UUID) of image to create. Changing this creates a new image.
    imageSourcePassword string
    The password of basic auth to download image_source_url.
    imageSourceUrl string
    This is the url of the raw image. If web_download is not used, then the image will be downloaded in the image_cache_path before being uploaded to Glance. Conflicts with local_file_path.
    imageSourceUsername string
    The username of basic auth to download image_source_url.
    localFilePath string
    This is the filepath of the raw image file that will be uploaded to Glance. Conflicts with image_source_url and web_download.
    metadata {[key: string]: any}
    The metadata associated with the image. Image metadata allow for meaningfully define the image properties and tags. See https://docs.openstack.org/glance/latest/user/metadefs-concepts.html.
    minDiskGb number
    Amount of disk space (in GB) required to boot image. Defaults to 0.
    minRamMb number
    Amount of ram (in MB) required to boot image. Defauts to 0.
    name string
    The name of the image.
    owner string
    The id of the openstack user who owns the image.
    properties {[key: string]: any}
    A map of key/value pairs to set freeform information about an image. See the "Notes" section for further information about properties.
    protected boolean
    If true, image will not be deletable. Defaults to false.
    region string
    The region in which to obtain the V2 Glance client. A Glance client is needed to create an Image that can be used with a compute instance. If omitted, the region argument of the provider is used. Changing this creates a new Image.
    schema string
    The path to the JSON-schema that represent the image or image
    sizeBytes number
    The size in bytes of the data associated with the image.
    status string
    The status of the image. It can be "queued", "active" or "saving".
    tags string[]
    The tags of the image. It must be a list of strings. At this time, it is not possible to delete all tags of an image.
    updateAt string
    (Deprecated - use updated_at instead)

    Deprecated:Use updated_at instead

    updatedAt string
    The date the image was last updated.
    verifyChecksum boolean
    If false, the checksum will not be verified once the image is finished uploading. Conflicts with web_download. Defaults to true when not using web_download.
    visibility string
    The visibility of the image. Must be one of "public", "private", "community", or "shared". The ability to set the visibility depends upon the configuration of the OpenStack cloud.
    webDownload boolean
    If true, the "web-download" import method will be used to let Openstack download the image directly from the remote source. Conflicts with local_file_path. Defaults to false.
    checksum str
    The checksum of the data associated with the image.
    container_format str
    The container format. Must be one of "ami", "ari", "aki", "bare", "ovf".
    created_at str
    The date the image was created.
    decompress bool
    If true, this provider will decompress downloaded image before uploading it to OpenStack. Decompression algorithm is chosen by checking "Content-Type" header, supported algorithm are: gzip, bzip2 and xz. Defaults to false. Changing this creates a new Image.
    disk_format str
    The disk format. Must be one of "ami", "ari", "aki", "vhd", "vmdk", "raw", "qcow2", "vdi", "iso".
    file str
    the trailing path after the glance endpoint that represent the location of the image or the path to retrieve it.
    hidden bool
    If true, image will be hidden from public list. Defaults to false.
    image_cache_path str
    image_id str
    Unique ID (valid UUID) of image to create. Changing this creates a new image.
    image_source_password str
    The password of basic auth to download image_source_url.
    image_source_url str
    This is the url of the raw image. If web_download is not used, then the image will be downloaded in the image_cache_path before being uploaded to Glance. Conflicts with local_file_path.
    image_source_username str
    The username of basic auth to download image_source_url.
    local_file_path str
    This is the filepath of the raw image file that will be uploaded to Glance. Conflicts with image_source_url and web_download.
    metadata Mapping[str, Any]
    The metadata associated with the image. Image metadata allow for meaningfully define the image properties and tags. See https://docs.openstack.org/glance/latest/user/metadefs-concepts.html.
    min_disk_gb int
    Amount of disk space (in GB) required to boot image. Defaults to 0.
    min_ram_mb int
    Amount of ram (in MB) required to boot image. Defauts to 0.
    name str
    The name of the image.
    owner str
    The id of the openstack user who owns the image.
    properties Mapping[str, Any]
    A map of key/value pairs to set freeform information about an image. See the "Notes" section for further information about properties.
    protected bool
    If true, image will not be deletable. Defaults to false.
    region str
    The region in which to obtain the V2 Glance client. A Glance client is needed to create an Image that can be used with a compute instance. If omitted, the region argument of the provider is used. Changing this creates a new Image.
    schema str
    The path to the JSON-schema that represent the image or image
    size_bytes int
    The size in bytes of the data associated with the image.
    status str
    The status of the image. It can be "queued", "active" or "saving".
    tags Sequence[str]
    The tags of the image. It must be a list of strings. At this time, it is not possible to delete all tags of an image.
    update_at str
    (Deprecated - use updated_at instead)

    Deprecated:Use updated_at instead

    updated_at str
    The date the image was last updated.
    verify_checksum bool
    If false, the checksum will not be verified once the image is finished uploading. Conflicts with web_download. Defaults to true when not using web_download.
    visibility str
    The visibility of the image. Must be one of "public", "private", "community", or "shared". The ability to set the visibility depends upon the configuration of the OpenStack cloud.
    web_download bool
    If true, the "web-download" import method will be used to let Openstack download the image directly from the remote source. Conflicts with local_file_path. Defaults to false.
    checksum String
    The checksum of the data associated with the image.
    containerFormat String
    The container format. Must be one of "ami", "ari", "aki", "bare", "ovf".
    createdAt String
    The date the image was created.
    decompress Boolean
    If true, this provider will decompress downloaded image before uploading it to OpenStack. Decompression algorithm is chosen by checking "Content-Type" header, supported algorithm are: gzip, bzip2 and xz. Defaults to false. Changing this creates a new Image.
    diskFormat String
    The disk format. Must be one of "ami", "ari", "aki", "vhd", "vmdk", "raw", "qcow2", "vdi", "iso".
    file String
    the trailing path after the glance endpoint that represent the location of the image or the path to retrieve it.
    hidden Boolean
    If true, image will be hidden from public list. Defaults to false.
    imageCachePath String
    imageId String
    Unique ID (valid UUID) of image to create. Changing this creates a new image.
    imageSourcePassword String
    The password of basic auth to download image_source_url.
    imageSourceUrl String
    This is the url of the raw image. If web_download is not used, then the image will be downloaded in the image_cache_path before being uploaded to Glance. Conflicts with local_file_path.
    imageSourceUsername String
    The username of basic auth to download image_source_url.
    localFilePath String
    This is the filepath of the raw image file that will be uploaded to Glance. Conflicts with image_source_url and web_download.
    metadata Map<Any>
    The metadata associated with the image. Image metadata allow for meaningfully define the image properties and tags. See https://docs.openstack.org/glance/latest/user/metadefs-concepts.html.
    minDiskGb Number
    Amount of disk space (in GB) required to boot image. Defaults to 0.
    minRamMb Number
    Amount of ram (in MB) required to boot image. Defauts to 0.
    name String
    The name of the image.
    owner String
    The id of the openstack user who owns the image.
    properties Map<Any>
    A map of key/value pairs to set freeform information about an image. See the "Notes" section for further information about properties.
    protected Boolean
    If true, image will not be deletable. Defaults to false.
    region String
    The region in which to obtain the V2 Glance client. A Glance client is needed to create an Image that can be used with a compute instance. If omitted, the region argument of the provider is used. Changing this creates a new Image.
    schema String
    The path to the JSON-schema that represent the image or image
    sizeBytes Number
    The size in bytes of the data associated with the image.
    status String
    The status of the image. It can be "queued", "active" or "saving".
    tags List<String>
    The tags of the image. It must be a list of strings. At this time, it is not possible to delete all tags of an image.
    updateAt String
    (Deprecated - use updated_at instead)

    Deprecated:Use updated_at instead

    updatedAt String
    The date the image was last updated.
    verifyChecksum Boolean
    If false, the checksum will not be verified once the image is finished uploading. Conflicts with web_download. Defaults to true when not using web_download.
    visibility String
    The visibility of the image. Must be one of "public", "private", "community", or "shared". The ability to set the visibility depends upon the configuration of the OpenStack cloud.
    webDownload Boolean
    If true, the "web-download" import method will be used to let Openstack download the image directly from the remote source. Conflicts with local_file_path. Defaults to false.

    Import

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

     $ pulumi import openstack:images/image:Image rancheros 89c60255-9bd6-460c-822a-e2b959ede9d2
    

    Package Details

    Repository
    OpenStack pulumi/pulumi-openstack
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the openstack Terraform Provider.
    openstack logo
    OpenStack v3.15.1 published on Thursday, Feb 1, 2024 by Pulumi