openstack.images.Image
Explore with Pulumi AI
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.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as openstack from "@pulumi/openstack";
const rancheros = new openstack.images.Image("rancheros", {
name: "RancherOS",
imageSourceUrl: "https://releases.rancher.com/os/latest/rancheros-openstack.img",
containerFormat: "bare",
diskFormat: "qcow2",
properties: {
key: "value",
},
});
import pulumi
import pulumi_openstack as openstack
rancheros = openstack.images.Image("rancheros",
name="RancherOS",
image_source_url="https://releases.rancher.com/os/latest/rancheros-openstack.img",
container_format="bare",
disk_format="qcow2",
properties={
"key": "value",
})
package main
import (
"github.com/pulumi/pulumi-openstack/sdk/v5/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{
Name: pulumi.String("RancherOS"),
ImageSourceUrl: pulumi.String("https://releases.rancher.com/os/latest/rancheros-openstack.img"),
ContainerFormat: pulumi.String("bare"),
DiskFormat: pulumi.String("qcow2"),
Properties: pulumi.StringMap{
"key": pulumi.String("value"),
},
})
if err != nil {
return err
}
return nil
})
}
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()
{
Name = "RancherOS",
ImageSourceUrl = "https://releases.rancher.com/os/latest/rancheros-openstack.img",
ContainerFormat = "bare",
DiskFormat = "qcow2",
Properties =
{
{ "key", "value" },
},
});
});
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()
.name("RancherOS")
.imageSourceUrl("https://releases.rancher.com/os/latest/rancheros-openstack.img")
.containerFormat("bare")
.diskFormat("qcow2")
.properties(Map.of("key", "value"))
.build());
}
}
resources:
rancheros:
type: openstack:images:Image
properties:
name: RancherOS
imageSourceUrl: https://releases.rancher.com/os/latest/rancheros-openstack.img
containerFormat: bare
diskFormat: qcow2
properties:
key: value
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.
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,
disk_format: Optional[str] = None,
container_format: Optional[str] = None,
min_disk_gb: Optional[int] = None,
min_ram_mb: Optional[int] = 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,
decompress: Optional[bool] = None,
hidden: Optional[bool] = None,
name: Optional[str] = None,
properties: Optional[Mapping[str, str]] = 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)
func NewImage(ctx *Context, name string, args ImageArgs, opts ...ResourceOption) (*Image, error)
public Image(string name, ImageArgs args, CustomResourceOptions? opts = null)
type: openstack:images: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 OpenStack.Images.Image("imageResource", new()
{
DiskFormat = "string",
ContainerFormat = "string",
MinDiskGb = 0,
MinRamMb = 0,
ImageCachePath = "string",
ImageId = "string",
ImageSourcePassword = "string",
ImageSourceUrl = "string",
ImageSourceUsername = "string",
LocalFilePath = "string",
Decompress = false,
Hidden = false,
Name = "string",
Properties =
{
{ "string", "string" },
},
Protected = false,
Region = "string",
Tags = new[]
{
"string",
},
VerifyChecksum = false,
Visibility = "string",
WebDownload = false,
});
example, err := images.NewImage(ctx, "imageResource", &images.ImageArgs{
DiskFormat: pulumi.String("string"),
ContainerFormat: pulumi.String("string"),
MinDiskGb: pulumi.Int(0),
MinRamMb: pulumi.Int(0),
ImageCachePath: pulumi.String("string"),
ImageId: pulumi.String("string"),
ImageSourcePassword: pulumi.String("string"),
ImageSourceUrl: pulumi.String("string"),
ImageSourceUsername: pulumi.String("string"),
LocalFilePath: pulumi.String("string"),
Decompress: pulumi.Bool(false),
Hidden: pulumi.Bool(false),
Name: pulumi.String("string"),
Properties: pulumi.StringMap{
"string": pulumi.String("string"),
},
Protected: pulumi.Bool(false),
Region: pulumi.String("string"),
Tags: pulumi.StringArray{
pulumi.String("string"),
},
VerifyChecksum: pulumi.Bool(false),
Visibility: pulumi.String("string"),
WebDownload: pulumi.Bool(false),
})
var imageResource = new Image("imageResource", ImageArgs.builder()
.diskFormat("string")
.containerFormat("string")
.minDiskGb(0)
.minRamMb(0)
.imageCachePath("string")
.imageId("string")
.imageSourcePassword("string")
.imageSourceUrl("string")
.imageSourceUsername("string")
.localFilePath("string")
.decompress(false)
.hidden(false)
.name("string")
.properties(Map.of("string", "string"))
.protected_(false)
.region("string")
.tags("string")
.verifyChecksum(false)
.visibility("string")
.webDownload(false)
.build());
image_resource = openstack.images.Image("imageResource",
disk_format="string",
container_format="string",
min_disk_gb=0,
min_ram_mb=0,
image_cache_path="string",
image_id="string",
image_source_password="string",
image_source_url="string",
image_source_username="string",
local_file_path="string",
decompress=False,
hidden=False,
name="string",
properties={
"string": "string",
},
protected=False,
region="string",
tags=["string"],
verify_checksum=False,
visibility="string",
web_download=False)
const imageResource = new openstack.images.Image("imageResource", {
diskFormat: "string",
containerFormat: "string",
minDiskGb: 0,
minRamMb: 0,
imageCachePath: "string",
imageId: "string",
imageSourcePassword: "string",
imageSourceUrl: "string",
imageSourceUsername: "string",
localFilePath: "string",
decompress: false,
hidden: false,
name: "string",
properties: {
string: "string",
},
"protected": false,
region: "string",
tags: ["string"],
verifyChecksum: false,
visibility: "string",
webDownload: false,
});
type: openstack:images:Image
properties:
containerFormat: string
decompress: false
diskFormat: string
hidden: false
imageCachePath: string
imageId: string
imageSourcePassword: string
imageSourceUrl: string
imageSourceUsername: string
localFilePath: string
minDiskGb: 0
minRamMb: 0
name: string
properties:
string: string
protected: false
region: string
tags:
- string
verifyChecksum: false
visibility: string
webDownload: false
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:
- Container
Format string - The container format. Must be one of "bare", "ovf", "aki", "ari", "ami", "ova", "docker", "compressed".
- Disk
Format string - The disk format. Must be one of "raw", "vhd", "vhdx", "vmdk", "vdi", "iso", "ploop", "qcow2", "aki", "ari", "ami"
- Decompress bool
- If true, this provider will decompress downloaded
image before uploading it to OpenStack. Decompression algorithm is chosen by
checking "Content-Type" or
Content-Disposition
header to detect the filename extension. Supported algorithms are: gzip, bzip2, xz and zst. Defaults to false. Changing this creates a new Image. - bool
- If true, image will be hidden from public list. Defaults to false.
- Image
Cache stringPath - Image
Id string - Unique ID (valid UUID) of image to create. Changing this creates a new image.
- Image
Source stringPassword - The password of basic auth to download
image_source_url
. - Image
Source stringUrl - This is the url of the raw image. If
web_download
is not used, then the image will be downloaded in theimage_cache_path
before being uploaded to Glance. Conflicts withlocal_file_path
. - Image
Source stringUsername - The username of basic auth to download
image_source_url
. - Local
File stringPath - This is the filepath of the raw image file
that will be uploaded to Glance. Conflicts with
image_source_url
andweb_download
. - Min
Disk intGb - Amount of disk space (in GB) required to boot image. Defaults to 0.
- Min
Ram intMb - Amount of ram (in MB) required to boot image. Defauts to 0.
- Name string
- The name of the image.
- Properties Dictionary<string, string>
- 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. - 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.
- 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 usingweb_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.
- 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.
- Container
Format string - The container format. Must be one of "bare", "ovf", "aki", "ari", "ami", "ova", "docker", "compressed".
- Disk
Format string - The disk format. Must be one of "raw", "vhd", "vhdx", "vmdk", "vdi", "iso", "ploop", "qcow2", "aki", "ari", "ami"
- Decompress bool
- If true, this provider will decompress downloaded
image before uploading it to OpenStack. Decompression algorithm is chosen by
checking "Content-Type" or
Content-Disposition
header to detect the filename extension. Supported algorithms are: gzip, bzip2, xz and zst. Defaults to false. Changing this creates a new Image. - bool
- If true, image will be hidden from public list. Defaults to false.
- Image
Cache stringPath - Image
Id string - Unique ID (valid UUID) of image to create. Changing this creates a new image.
- Image
Source stringPassword - The password of basic auth to download
image_source_url
. - Image
Source stringUrl - This is the url of the raw image. If
web_download
is not used, then the image will be downloaded in theimage_cache_path
before being uploaded to Glance. Conflicts withlocal_file_path
. - Image
Source stringUsername - The username of basic auth to download
image_source_url
. - Local
File stringPath - This is the filepath of the raw image file
that will be uploaded to Glance. Conflicts with
image_source_url
andweb_download
. - Min
Disk intGb - Amount of disk space (in GB) required to boot image. Defaults to 0.
- Min
Ram intMb - Amount of ram (in MB) required to boot image. Defauts to 0.
- Name string
- The name of the image.
- Properties map[string]string
- 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. - []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.
- 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 usingweb_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.
- 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.
- container
Format String - The container format. Must be one of "bare", "ovf", "aki", "ari", "ami", "ova", "docker", "compressed".
- disk
Format String - The disk format. Must be one of "raw", "vhd", "vhdx", "vmdk", "vdi", "iso", "ploop", "qcow2", "aki", "ari", "ami"
- decompress Boolean
- If true, this provider will decompress downloaded
image before uploading it to OpenStack. Decompression algorithm is chosen by
checking "Content-Type" or
Content-Disposition
header to detect the filename extension. Supported algorithms are: gzip, bzip2, xz and zst. Defaults to false. Changing this creates a new Image. - Boolean
- If true, image will be hidden from public list. Defaults to false.
- image
Cache StringPath - image
Id String - Unique ID (valid UUID) of image to create. Changing this creates a new image.
- image
Source StringPassword - The password of basic auth to download
image_source_url
. - image
Source StringUrl - This is the url of the raw image. If
web_download
is not used, then the image will be downloaded in theimage_cache_path
before being uploaded to Glance. Conflicts withlocal_file_path
. - image
Source StringUsername - The username of basic auth to download
image_source_url
. - local
File StringPath - This is the filepath of the raw image file
that will be uploaded to Glance. Conflicts with
image_source_url
andweb_download
. - min
Disk IntegerGb - Amount of disk space (in GB) required to boot image. Defaults to 0.
- min
Ram IntegerMb - Amount of ram (in MB) required to boot image. Defauts to 0.
- name String
- The name of the image.
- properties Map<String,String>
- 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. - 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.
- verify
Checksum Boolean - If false, the checksum will not be verified
once the image is finished uploading. Conflicts with
web_download
. Defaults to true when not usingweb_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.
- web
Download 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 string - The container format. Must be one of "bare", "ovf", "aki", "ari", "ami", "ova", "docker", "compressed".
- disk
Format string - The disk format. Must be one of "raw", "vhd", "vhdx", "vmdk", "vdi", "iso", "ploop", "qcow2", "aki", "ari", "ami"
- decompress boolean
- If true, this provider will decompress downloaded
image before uploading it to OpenStack. Decompression algorithm is chosen by
checking "Content-Type" or
Content-Disposition
header to detect the filename extension. Supported algorithms are: gzip, bzip2, xz and zst. Defaults to false. Changing this creates a new Image. - boolean
- If true, image will be hidden from public list. Defaults to false.
- image
Cache stringPath - image
Id string - Unique ID (valid UUID) of image to create. Changing this creates a new image.
- image
Source stringPassword - The password of basic auth to download
image_source_url
. - image
Source stringUrl - This is the url of the raw image. If
web_download
is not used, then the image will be downloaded in theimage_cache_path
before being uploaded to Glance. Conflicts withlocal_file_path
. - image
Source stringUsername - The username of basic auth to download
image_source_url
. - local
File stringPath - This is the filepath of the raw image file
that will be uploaded to Glance. Conflicts with
image_source_url
andweb_download
. - min
Disk numberGb - Amount of disk space (in GB) required to boot image. Defaults to 0.
- min
Ram numberMb - Amount of ram (in MB) required to boot image. Defauts to 0.
- name string
- The name of the image.
- properties {[key: string]: string}
- 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. - 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.
- verify
Checksum boolean - If false, the checksum will not be verified
once the image is finished uploading. Conflicts with
web_download
. Defaults to true when not usingweb_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.
- web
Download 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 "bare", "ovf", "aki", "ari", "ami", "ova", "docker", "compressed".
- disk_
format str - The disk format. Must be one of "raw", "vhd", "vhdx", "vmdk", "vdi", "iso", "ploop", "qcow2", "aki", "ari", "ami"
- decompress bool
- If true, this provider will decompress downloaded
image before uploading it to OpenStack. Decompression algorithm is chosen by
checking "Content-Type" or
Content-Disposition
header to detect the filename extension. Supported algorithms are: gzip, bzip2, xz and zst. Defaults to false. Changing this creates a new Image. - bool
- If true, image will be hidden from public list. Defaults to false.
- image_
cache_ strpath - image_
id str - Unique ID (valid UUID) of image to create. Changing this creates a new image.
- image_
source_ strpassword - The password of basic auth to download
image_source_url
. - image_
source_ strurl - This is the url of the raw image. If
web_download
is not used, then the image will be downloaded in theimage_cache_path
before being uploaded to Glance. Conflicts withlocal_file_path
. - image_
source_ strusername - The username of basic auth to download
image_source_url
. - local_
file_ strpath - This is the filepath of the raw image file
that will be uploaded to Glance. Conflicts with
image_source_url
andweb_download
. - min_
disk_ intgb - Amount of disk space (in GB) required to boot image. Defaults to 0.
- min_
ram_ intmb - Amount of ram (in MB) required to boot image. Defauts to 0.
- name str
- The name of the image.
- properties Mapping[str, str]
- 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. - 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 usingweb_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.
- container
Format String - The container format. Must be one of "bare", "ovf", "aki", "ari", "ami", "ova", "docker", "compressed".
- disk
Format String - The disk format. Must be one of "raw", "vhd", "vhdx", "vmdk", "vdi", "iso", "ploop", "qcow2", "aki", "ari", "ami"
- decompress Boolean
- If true, this provider will decompress downloaded
image before uploading it to OpenStack. Decompression algorithm is chosen by
checking "Content-Type" or
Content-Disposition
header to detect the filename extension. Supported algorithms are: gzip, bzip2, xz and zst. Defaults to false. Changing this creates a new Image. - Boolean
- If true, image will be hidden from public list. Defaults to false.
- image
Cache StringPath - image
Id String - Unique ID (valid UUID) of image to create. Changing this creates a new image.
- image
Source StringPassword - The password of basic auth to download
image_source_url
. - image
Source StringUrl - This is the url of the raw image. If
web_download
is not used, then the image will be downloaded in theimage_cache_path
before being uploaded to Glance. Conflicts withlocal_file_path
. - image
Source StringUsername - The username of basic auth to download
image_source_url
. - local
File StringPath - This is the filepath of the raw image file
that will be uploaded to Glance. Conflicts with
image_source_url
andweb_download
. - min
Disk NumberGb - Amount of disk space (in GB) required to boot image. Defaults to 0.
- min
Ram NumberMb - Amount of ram (in MB) required to boot image. Defauts to 0.
- name String
- The name of the image.
- properties Map<String>
- 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. - 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.
- verify
Checksum Boolean - If false, the checksum will not be verified
once the image is finished uploading. Conflicts with
web_download
. Defaults to true when not usingweb_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.
- web
Download 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.
- Created
At 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, string>
- 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
- Size
Bytes 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".
- Updated
At string - The date the image was last updated.
- Checksum string
- The checksum of the data associated with the image.
- Created
At 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]string
- 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
- Size
Bytes 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".
- Updated
At string - The date the image was last updated.
- checksum String
- The checksum of the data associated with the image.
- created
At 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,String>
- 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
- size
Bytes 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".
- updated
At String - The date the image was last updated.
- checksum string
- The checksum of the data associated with the image.
- created
At 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]: string}
- 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
- size
Bytes 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".
- updated
At 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, str]
- 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".
- updated_
at str - The date the image was last updated.
- checksum String
- The checksum of the data associated with the image.
- created
At 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>
- 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
- size
Bytes 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".
- updated
At 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, str]] = 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, str]] = 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,
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.
- Checksum string
- The checksum of the data associated with the image.
- Container
Format string - The container format. Must be one of "bare", "ovf", "aki", "ari", "ami", "ova", "docker", "compressed".
- Created
At 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" or
Content-Disposition
header to detect the filename extension. Supported algorithms are: gzip, bzip2, xz and zst. Defaults to false. Changing this creates a new Image. - Disk
Format string - The disk format. Must be one of "raw", "vhd", "vhdx", "vmdk", "vdi", "iso", "ploop", "qcow2", "aki", "ari", "ami"
- File string
- the trailing path after the glance endpoint that represent the location of the image or the path to retrieve it.
- bool
- If true, image will be hidden from public list. Defaults to false.
- Image
Cache stringPath - Image
Id string - Unique ID (valid UUID) of image to create. Changing this creates a new image.
- Image
Source stringPassword - The password of basic auth to download
image_source_url
. - Image
Source stringUrl - This is the url of the raw image. If
web_download
is not used, then the image will be downloaded in theimage_cache_path
before being uploaded to Glance. Conflicts withlocal_file_path
. - Image
Source stringUsername - The username of basic auth to download
image_source_url
. - Local
File stringPath - This is the filepath of the raw image file
that will be uploaded to Glance. Conflicts with
image_source_url
andweb_download
. - Metadata Dictionary<string, string>
- 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 intGb - Amount of disk space (in GB) required to boot image. Defaults to 0.
- Min
Ram intMb - 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, string>
- 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
- Size
Bytes 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".
- 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.
- Updated
At string - 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 usingweb_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.
- 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.
- Container
Format string - The container format. Must be one of "bare", "ovf", "aki", "ari", "ami", "ova", "docker", "compressed".
- Created
At 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" or
Content-Disposition
header to detect the filename extension. Supported algorithms are: gzip, bzip2, xz and zst. Defaults to false. Changing this creates a new Image. - Disk
Format string - The disk format. Must be one of "raw", "vhd", "vhdx", "vmdk", "vdi", "iso", "ploop", "qcow2", "aki", "ari", "ami"
- File string
- the trailing path after the glance endpoint that represent the location of the image or the path to retrieve it.
- bool
- If true, image will be hidden from public list. Defaults to false.
- Image
Cache stringPath - Image
Id string - Unique ID (valid UUID) of image to create. Changing this creates a new image.
- Image
Source stringPassword - The password of basic auth to download
image_source_url
. - Image
Source stringUrl - This is the url of the raw image. If
web_download
is not used, then the image will be downloaded in theimage_cache_path
before being uploaded to Glance. Conflicts withlocal_file_path
. - Image
Source stringUsername - The username of basic auth to download
image_source_url
. - Local
File stringPath - This is the filepath of the raw image file
that will be uploaded to Glance. Conflicts with
image_source_url
andweb_download
. - Metadata map[string]string
- 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 intGb - Amount of disk space (in GB) required to boot image. Defaults to 0.
- Min
Ram intMb - 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]string
- 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
- Size
Bytes 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".
- []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.
- Updated
At string - 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 usingweb_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.
- 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.
- container
Format String - The container format. Must be one of "bare", "ovf", "aki", "ari", "ami", "ova", "docker", "compressed".
- created
At 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" or
Content-Disposition
header to detect the filename extension. Supported algorithms are: gzip, bzip2, xz and zst. Defaults to false. Changing this creates a new Image. - disk
Format String - The disk format. Must be one of "raw", "vhd", "vhdx", "vmdk", "vdi", "iso", "ploop", "qcow2", "aki", "ari", "ami"
- file String
- the trailing path after the glance endpoint that represent the location of the image or the path to retrieve it.
- Boolean
- If true, image will be hidden from public list. Defaults to false.
- image
Cache StringPath - image
Id String - Unique ID (valid UUID) of image to create. Changing this creates a new image.
- image
Source StringPassword - The password of basic auth to download
image_source_url
. - image
Source StringUrl - This is the url of the raw image. If
web_download
is not used, then the image will be downloaded in theimage_cache_path
before being uploaded to Glance. Conflicts withlocal_file_path
. - image
Source StringUsername - The username of basic auth to download
image_source_url
. - local
File StringPath - This is the filepath of the raw image file
that will be uploaded to Glance. Conflicts with
image_source_url
andweb_download
. - metadata Map<String,String>
- 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 IntegerGb - Amount of disk space (in GB) required to boot image. Defaults to 0.
- min
Ram IntegerMb - 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,String>
- 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
- size
Bytes 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".
- 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.
- updated
At String - The date the image was last updated.
- verify
Checksum Boolean - If false, the checksum will not be verified
once the image is finished uploading. Conflicts with
web_download
. Defaults to true when not usingweb_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.
- web
Download 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.
- container
Format string - The container format. Must be one of "bare", "ovf", "aki", "ari", "ami", "ova", "docker", "compressed".
- created
At 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" or
Content-Disposition
header to detect the filename extension. Supported algorithms are: gzip, bzip2, xz and zst. Defaults to false. Changing this creates a new Image. - disk
Format string - The disk format. Must be one of "raw", "vhd", "vhdx", "vmdk", "vdi", "iso", "ploop", "qcow2", "aki", "ari", "ami"
- file string
- the trailing path after the glance endpoint that represent the location of the image or the path to retrieve it.
- boolean
- If true, image will be hidden from public list. Defaults to false.
- image
Cache stringPath - image
Id string - Unique ID (valid UUID) of image to create. Changing this creates a new image.
- image
Source stringPassword - The password of basic auth to download
image_source_url
. - image
Source stringUrl - This is the url of the raw image. If
web_download
is not used, then the image will be downloaded in theimage_cache_path
before being uploaded to Glance. Conflicts withlocal_file_path
. - image
Source stringUsername - The username of basic auth to download
image_source_url
. - local
File stringPath - This is the filepath of the raw image file
that will be uploaded to Glance. Conflicts with
image_source_url
andweb_download
. - metadata {[key: string]: string}
- 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 numberGb - Amount of disk space (in GB) required to boot image. Defaults to 0.
- min
Ram numberMb - 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]: string}
- 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
- size
Bytes 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".
- 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.
- updated
At string - The date the image was last updated.
- verify
Checksum boolean - If false, the checksum will not be verified
once the image is finished uploading. Conflicts with
web_download
. Defaults to true when not usingweb_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.
- web
Download 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 "bare", "ovf", "aki", "ari", "ami", "ova", "docker", "compressed".
- 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" or
Content-Disposition
header to detect the filename extension. Supported algorithms are: gzip, bzip2, xz and zst. Defaults to false. Changing this creates a new Image. - disk_
format str - The disk format. Must be one of "raw", "vhd", "vhdx", "vmdk", "vdi", "iso", "ploop", "qcow2", "aki", "ari", "ami"
- file str
- the trailing path after the glance endpoint that represent the location of the image or the path to retrieve it.
- bool
- If true, image will be hidden from public list. Defaults to false.
- image_
cache_ strpath - image_
id str - Unique ID (valid UUID) of image to create. Changing this creates a new image.
- image_
source_ strpassword - The password of basic auth to download
image_source_url
. - image_
source_ strurl - This is the url of the raw image. If
web_download
is not used, then the image will be downloaded in theimage_cache_path
before being uploaded to Glance. Conflicts withlocal_file_path
. - image_
source_ strusername - The username of basic auth to download
image_source_url
. - local_
file_ strpath - This is the filepath of the raw image file
that will be uploaded to Glance. Conflicts with
image_source_url
andweb_download
. - metadata Mapping[str, str]
- 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_ intgb - Amount of disk space (in GB) required to boot image. Defaults to 0.
- min_
ram_ intmb - 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, str]
- 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".
- 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.
- 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 usingweb_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.
- container
Format String - The container format. Must be one of "bare", "ovf", "aki", "ari", "ami", "ova", "docker", "compressed".
- created
At 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" or
Content-Disposition
header to detect the filename extension. Supported algorithms are: gzip, bzip2, xz and zst. Defaults to false. Changing this creates a new Image. - disk
Format String - The disk format. Must be one of "raw", "vhd", "vhdx", "vmdk", "vdi", "iso", "ploop", "qcow2", "aki", "ari", "ami"
- file String
- the trailing path after the glance endpoint that represent the location of the image or the path to retrieve it.
- Boolean
- If true, image will be hidden from public list. Defaults to false.
- image
Cache StringPath - image
Id String - Unique ID (valid UUID) of image to create. Changing this creates a new image.
- image
Source StringPassword - The password of basic auth to download
image_source_url
. - image
Source StringUrl - This is the url of the raw image. If
web_download
is not used, then the image will be downloaded in theimage_cache_path
before being uploaded to Glance. Conflicts withlocal_file_path
. - image
Source StringUsername - The username of basic auth to download
image_source_url
. - local
File StringPath - This is the filepath of the raw image file
that will be uploaded to Glance. Conflicts with
image_source_url
andweb_download
. - metadata Map<String>
- 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 NumberGb - Amount of disk space (in GB) required to boot image. Defaults to 0.
- min
Ram NumberMb - 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>
- 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
- size
Bytes 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".
- 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.
- updated
At String - The date the image was last updated.
- verify
Checksum Boolean - If false, the checksum will not be verified
once the image is finished uploading. Conflicts with
web_download
. Defaults to true when not usingweb_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.
- web
Download 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
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- OpenStack pulumi/pulumi-openstack
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
openstack
Terraform Provider.