Fork me on GitHub

Module images

@pulumi/openstack > images

Index

images/getImage.ts images/image.ts

class Image

Manages a V2 Image resource within OpenStack Glance.

constructor

new Image(name: string, args: ImageArgs, opts?: pulumi.CustomResourceOptions)

Create a Image resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ImageState): Image

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property checksum

public checksum: pulumi.Output<string>;

The checksum of the data associated with the image.

property containerFormat

public containerFormat: pulumi.Output<string>;

The container format. Must be one of “ami”, “ari”, “aki”, “bare”, “ovf”.

property createdAt

public createdAt: pulumi.Output<string>;

The date the image was created.

property diskFormat

public diskFormat: pulumi.Output<string>;

The disk format. Must be one of “ami”, “ari”, “aki”, “vhd”, “vmdk”, “raw”, “qcow2”, “vdi”, “iso”.

property file

public file: pulumi.Output<string>;

the trailing path after the glance endpoint that represent the location of the image or the path to retrieve it.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property imageCachePath

public imageCachePath: pulumi.Output<string | undefined>;

This is the directory where the images will be downloaded. Images will be stored with a filename corresponding to the url’s md5 hash. Defaults to “$HOME/.terraform/image_cache”

property imageSourceUrl

public imageSourceUrl: pulumi.Output<string | undefined>;

This is the url of the raw image that will be downloaded in the image_cache_path before being uploaded to Glance. Glance is able to download image from internet but the gophercloud library does not yet provide a way to do so. Conflicts with local_file_path.

property localFilePath

public localFilePath: pulumi.Output<string | undefined>;

This is the filepath of the raw image file that will be uploaded to Glance. Conflicts with image_source_url.

property metadata

public metadata: pulumi.Output<{ ... }>;

The metadata associated with the image. Image metadata allow for meaningfully define the image properties and tags. See http://docs.openstack.org/developer/glance/metadefs-concepts.html.

property minDiskGb

public minDiskGb: pulumi.Output<number | undefined>;

Amount of disk space (in GB) required to boot image. Defaults to 0.

property minRamMb

public minRamMb: pulumi.Output<number | undefined>;

Amount of ram (in MB) required to boot image. Defauts to 0.

property name

public name: pulumi.Output<string>;

The name of the image.

property owner

public owner: pulumi.Output<string>;

The id of the openstack user who owns the image.

property properties

public properties: pulumi.Output<{ ... }>;

A map of key/value pairs to set freeform information about an image. See the “Notes” section for further information about properties.

property protected

public protected: pulumi.Output<boolean | undefined>;

If true, image will not be deletable. Defaults to false.

property region

public region: pulumi.Output<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.

property schema

public schema: pulumi.Output<string>;

The path to the JSON-schema that represent the image or image

property sizeBytes

public sizeBytes: pulumi.Output<number>;

The size in bytes of the data associated with the image.

property status

public status: pulumi.Output<string>;

The status of the image. It can be “queued”, “active” or “saving”.

property tags

public tags: pulumi.Output<string[] | undefined>;

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.

property updateAt

public updateAt: pulumi.Output<string>;

The date the image was last updated.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property verifyChecksum

public verifyChecksum: pulumi.Output<boolean | undefined>;

If false, the checksum will not be verified once the image is finished uploading. Defaults to true.

property visibility

public visibility: pulumi.Output<string | undefined>;

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.

function getImage

getImage(args?: GetImageArgs, opts?: pulumi.InvokeOptions): Promise<GetImageResult>

Use this data source to get the ID of an available OpenStack image.

interface GetImageArgs

A collection of arguments for invoking getImage.

property memberStatus

memberStatus?: string;

The status of the image. Must be one of “accepted”, “pending”, “rejected”, or “all”.

property mostRecent

mostRecent?: boolean;

If more than one result is returned, use the most recent image.

property name

name?: string;

The name of the image.

property owner

owner?: string;

The owner (UUID) of the image.

property properties

properties?: { ... };

a map of key/value pairs to match an image with. All specified properties must be matched.

property region

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.

property sizeMax

sizeMax?: number;

The maximum size (in bytes) of the image to return.

property sizeMin

sizeMin?: number;

The minimum size (in bytes) of the image to return.

property sortDirection

sortDirection?: string;

Order the results in either asc or desc.

property sortKey

sortKey?: string;

Sort images based on a certain key. Defaults to name.

property tag

tag?: string;

Search for images with a specific tag.

property visibility

visibility?: string;

The visibility of the image. Must be one of “public”, “private”, “community”, or “shared”. Defaults to “private”.

interface GetImageResult

A collection of values returned by getImage.

property checksum

checksum: string;

The checksum of the data associated with the image.

property containerFormat

containerFormat: string;

property diskFormat

diskFormat: string;

property file

file: string;

the trailing path after the glance endpoint that represent the location of the image or the path to retrieve it.

property id

id: string;

id is the provider-assigned unique ID for this managed resource.

property metadata

metadata: { ... };

The metadata associated with the image. Image metadata allow for meaningfully define the image properties and tags. See http://docs.openstack.org/developer/glance/metadefs-concepts.html.

property minDiskGb

minDiskGb: number;

The minimum amount of disk space required to use the image.

property minRamMb

minRamMb: number;

The minimum amount of ram required to use the image.

property protected

protected: boolean;

Whether or not the image is protected.

property region

region: string;

property schema

schema: string;

The path to the JSON-schema that represent the image or image

property sizeBytes

sizeBytes: number;

The size of the image (in bytes).

property updatedAt

updatedAt: string;

interface ImageArgs

The set of arguments for constructing a Image resource.

property containerFormat

containerFormat: pulumi.Input<string>;

The container format. Must be one of “ami”, “ari”, “aki”, “bare”, “ovf”.

property diskFormat

diskFormat: pulumi.Input<string>;

The disk format. Must be one of “ami”, “ari”, “aki”, “vhd”, “vmdk”, “raw”, “qcow2”, “vdi”, “iso”.

property imageCachePath

imageCachePath?: pulumi.Input<string>;

This is the directory where the images will be downloaded. Images will be stored with a filename corresponding to the url’s md5 hash. Defaults to “$HOME/.terraform/image_cache”

property imageSourceUrl

imageSourceUrl?: pulumi.Input<string>;

This is the url of the raw image that will be downloaded in the image_cache_path before being uploaded to Glance. Glance is able to download image from internet but the gophercloud library does not yet provide a way to do so. Conflicts with local_file_path.

property localFilePath

localFilePath?: pulumi.Input<string>;

This is the filepath of the raw image file that will be uploaded to Glance. Conflicts with image_source_url.

property minDiskGb

minDiskGb?: pulumi.Input<number>;

Amount of disk space (in GB) required to boot image. Defaults to 0.

property minRamMb

minRamMb?: pulumi.Input<number>;

Amount of ram (in MB) required to boot image. Defauts to 0.

property name

name?: pulumi.Input<string>;

The name of the image.

property properties

properties?: pulumi.Input<{ ... }>;

A map of key/value pairs to set freeform information about an image. See the “Notes” section for further information about properties.

property protected

protected?: pulumi.Input<boolean>;

If true, image will not be deletable. Defaults to false.

property region

region?: pulumi.Input<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.

property tags

tags?: pulumi.Input<pulumi.Input<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.

property verifyChecksum

verifyChecksum?: pulumi.Input<boolean>;

If false, the checksum will not be verified once the image is finished uploading. Defaults to true.

property visibility

visibility?: pulumi.Input<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.

interface ImageState

Input properties used for looking up and filtering Image resources.

property checksum

checksum?: pulumi.Input<string>;

The checksum of the data associated with the image.

property containerFormat

containerFormat?: pulumi.Input<string>;

The container format. Must be one of “ami”, “ari”, “aki”, “bare”, “ovf”.

property createdAt

createdAt?: pulumi.Input<string>;

The date the image was created.

property diskFormat

diskFormat?: pulumi.Input<string>;

The disk format. Must be one of “ami”, “ari”, “aki”, “vhd”, “vmdk”, “raw”, “qcow2”, “vdi”, “iso”.

property file

file?: pulumi.Input<string>;

the trailing path after the glance endpoint that represent the location of the image or the path to retrieve it.

property imageCachePath

imageCachePath?: pulumi.Input<string>;

This is the directory where the images will be downloaded. Images will be stored with a filename corresponding to the url’s md5 hash. Defaults to “$HOME/.terraform/image_cache”

property imageSourceUrl

imageSourceUrl?: pulumi.Input<string>;

This is the url of the raw image that will be downloaded in the image_cache_path before being uploaded to Glance. Glance is able to download image from internet but the gophercloud library does not yet provide a way to do so. Conflicts with local_file_path.

property localFilePath

localFilePath?: pulumi.Input<string>;

This is the filepath of the raw image file that will be uploaded to Glance. Conflicts with image_source_url.

property metadata

metadata?: pulumi.Input<{ ... }>;

The metadata associated with the image. Image metadata allow for meaningfully define the image properties and tags. See http://docs.openstack.org/developer/glance/metadefs-concepts.html.

property minDiskGb

minDiskGb?: pulumi.Input<number>;

Amount of disk space (in GB) required to boot image. Defaults to 0.

property minRamMb

minRamMb?: pulumi.Input<number>;

Amount of ram (in MB) required to boot image. Defauts to 0.

property name

name?: pulumi.Input<string>;

The name of the image.

property owner

owner?: pulumi.Input<string>;

The id of the openstack user who owns the image.

property properties

properties?: pulumi.Input<{ ... }>;

A map of key/value pairs to set freeform information about an image. See the “Notes” section for further information about properties.

property protected

protected?: pulumi.Input<boolean>;

If true, image will not be deletable. Defaults to false.

property region

region?: pulumi.Input<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.

property schema

schema?: pulumi.Input<string>;

The path to the JSON-schema that represent the image or image

property sizeBytes

sizeBytes?: pulumi.Input<number>;

The size in bytes of the data associated with the image.

property status

status?: pulumi.Input<string>;

The status of the image. It can be “queued”, “active” or “saving”.

property tags

tags?: pulumi.Input<pulumi.Input<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.

property updateAt

updateAt?: pulumi.Input<string>;

The date the image was last updated.

property verifyChecksum

verifyChecksum?: pulumi.Input<boolean>;

If false, the checksum will not be verified once the image is finished uploading. Defaults to true.

property visibility

visibility?: pulumi.Input<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.