Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Ibm Provider
  3. API Docs
  4. IsImage
ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

ibm.IsImage

Explore with Pulumi AI

ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

Provide an image resource. This allows images to be created, retrieved, and deleted. For more information, about VPC custom images, see IBM Cloud Docs: Virtual Private Cloud - IBM Cloud Importing and managing custom images.

Note: VPC infrastructure services are a regional specific based endpoint, by default targets to us-south. Please make sure to target right region in the provider block as shown in the provider.tf file, if VPC service is created in region other than us-south.

provider.tf

import * as pulumi from "@pulumi/pulumi";
Copy
import pulumi
Copy
package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;

return await Deployment.RunAsync(() => 
{
});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
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) {
    }
}
Copy
{}
Copy

Example Usage

Using Href And Operating_system)

import * as pulumi from "@pulumi/pulumi";
import * as ibm from "@pulumi/ibm";

const example = new ibm.IsImage("example", {
    encryptedDataKey: "eJxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx0=",
    encryptionKey: "crn:v1:bluemix:public:kms:us-south:a/6xxxxxxxxxxxxxxx:xxxxxxx-xxxx-xxxx-xxxxxxx:key:dxxxxxx-fxxx-4xxx-9xxx-7xxxxxxxx",
    href: "cos://us-south/buckettesttest/livecd.ubuntu-cpc.azure.vhd",
    operatingSystem: "ubuntu-16-04-amd64",
});
Copy
import pulumi
import pulumi_ibm as ibm

example = ibm.IsImage("example",
    encrypted_data_key="eJxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx0=",
    encryption_key="crn:v1:bluemix:public:kms:us-south:a/6xxxxxxxxxxxxxxx:xxxxxxx-xxxx-xxxx-xxxxxxx:key:dxxxxxx-fxxx-4xxx-9xxx-7xxxxxxxx",
    href="cos://us-south/buckettesttest/livecd.ubuntu-cpc.azure.vhd",
    operating_system="ubuntu-16-04-amd64")
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/ibm"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ibm.NewIsImage(ctx, "example", &ibm.IsImageArgs{
			EncryptedDataKey: pulumi.String("eJxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx0="),
			EncryptionKey:    pulumi.String("crn:v1:bluemix:public:kms:us-south:a/6xxxxxxxxxxxxxxx:xxxxxxx-xxxx-xxxx-xxxxxxx:key:dxxxxxx-fxxx-4xxx-9xxx-7xxxxxxxx"),
			Href:             pulumi.String("cos://us-south/buckettesttest/livecd.ubuntu-cpc.azure.vhd"),
			OperatingSystem:  pulumi.String("ubuntu-16-04-amd64"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;

return await Deployment.RunAsync(() => 
{
    var example = new Ibm.IsImage("example", new()
    {
        EncryptedDataKey = "eJxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx0=",
        EncryptionKey = "crn:v1:bluemix:public:kms:us-south:a/6xxxxxxxxxxxxxxx:xxxxxxx-xxxx-xxxx-xxxxxxx:key:dxxxxxx-fxxx-4xxx-9xxx-7xxxxxxxx",
        Href = "cos://us-south/buckettesttest/livecd.ubuntu-cpc.azure.vhd",
        OperatingSystem = "ubuntu-16-04-amd64",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.IsImage;
import com.pulumi.ibm.IsImageArgs;
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 example = new IsImage("example", IsImageArgs.builder()
            .encryptedDataKey("eJxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx0=")
            .encryptionKey("crn:v1:bluemix:public:kms:us-south:a/6xxxxxxxxxxxxxxx:xxxxxxx-xxxx-xxxx-xxxxxxx:key:dxxxxxx-fxxx-4xxx-9xxx-7xxxxxxxx")
            .href("cos://us-south/buckettesttest/livecd.ubuntu-cpc.azure.vhd")
            .operatingSystem("ubuntu-16-04-amd64")
            .build());

    }
}
Copy
resources:
  example:
    type: ibm:IsImage
    properties:
      encryptedDataKey: eJxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx0=
      encryptionKey: crn:v1:bluemix:public:kms:us-south:a/6xxxxxxxxxxxxxxx:xxxxxxx-xxxx-xxxx-xxxxxxx:key:dxxxxxx-fxxx-4xxx-9xxx-7xxxxxxxx
      href: cos://us-south/buckettesttest/livecd.ubuntu-cpc.azure.vhd
      operatingSystem: ubuntu-16-04-amd64
Copy

NOTE operating_system is required with href.

Using Volume)

Coming soon!

Coming soon!

Coming soon!

Coming soon!

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.IsImage;
import com.pulumi.ibm.IsImageArgs;
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 example = new IsImage("example", IsImageArgs.builder()
            .sourceVolume("xxxx-xxxx-xxxxxxx")
            .encryptedDataKey("eJxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx0=")
            .encryptionKey("crn:v1:bluemix:public:kms:us-south:a/6xxxxxxxxxxxxxxx:xxxxxxx-xxxx-xxxx-xxxxxxx:key:dxxxxxx-fxxx-4xxx-9xxx-7xxxxxxxx")
            .timeouts(IsImageTimeoutsArgs.builder()
                .create("45m")
                .build())
            .build());

    }
}
Copy
resources:
  example:
    type: ibm:IsImage
    properties:
      sourceVolume: xxxx-xxxx-xxxxxxx
      encryptedDataKey: eJxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx0=
      encryptionKey: crn:v1:bluemix:public:kms:us-south:a/6xxxxxxxxxxxxxxx:xxxxxxx-xxxx-xxxx-xxxxxxx:key:dxxxxxx-fxxx-4xxx-9xxx-7xxxxxxxx
      # increase timeouts as per volume size
      timeouts:
        - create: 45m
Copy

Lifecycle)

import * as pulumi from "@pulumi/pulumi";
import * as ibm from "@pulumi/ibm";

const example = new ibm.IsImage("example", {
    deprecationAt: "2023-09-28T15:10:00.000Z",
    href: "cos://us-south/buckettesttest/livecd.ubuntu-cpc.azure.vhd",
    obsolescenceAt: "2023-11-28T15:10:00.000Z",
    operatingSystem: "ubuntu-16-04-amd64",
});
Copy
import pulumi
import pulumi_ibm as ibm

example = ibm.IsImage("example",
    deprecation_at="2023-09-28T15:10:00.000Z",
    href="cos://us-south/buckettesttest/livecd.ubuntu-cpc.azure.vhd",
    obsolescence_at="2023-11-28T15:10:00.000Z",
    operating_system="ubuntu-16-04-amd64")
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/ibm"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ibm.NewIsImage(ctx, "example", &ibm.IsImageArgs{
			DeprecationAt:   pulumi.String("2023-09-28T15:10:00.000Z"),
			Href:            pulumi.String("cos://us-south/buckettesttest/livecd.ubuntu-cpc.azure.vhd"),
			ObsolescenceAt:  pulumi.String("2023-11-28T15:10:00.000Z"),
			OperatingSystem: pulumi.String("ubuntu-16-04-amd64"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;

return await Deployment.RunAsync(() => 
{
    var example = new Ibm.IsImage("example", new()
    {
        DeprecationAt = "2023-09-28T15:10:00.000Z",
        Href = "cos://us-south/buckettesttest/livecd.ubuntu-cpc.azure.vhd",
        ObsolescenceAt = "2023-11-28T15:10:00.000Z",
        OperatingSystem = "ubuntu-16-04-amd64",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.IsImage;
import com.pulumi.ibm.IsImageArgs;
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 example = new IsImage("example", IsImageArgs.builder()
            .deprecationAt("2023-09-28T15:10:00.000Z")
            .href("cos://us-south/buckettesttest/livecd.ubuntu-cpc.azure.vhd")
            .obsolescenceAt("2023-11-28T15:10:00.000Z")
            .operatingSystem("ubuntu-16-04-amd64")
            .build());

    }
}
Copy
resources:
  example:
    type: ibm:IsImage
    properties:
      deprecationAt: 2023-09-28T15:10:00.000Z
      href: cos://us-south/buckettesttest/livecd.ubuntu-cpc.azure.vhd
      obsolescenceAt: 2023-11-28T15:10:00.000Z
      operatingSystem: ubuntu-16-04-amd64
Copy

NOTE obsolescence_at must be later than deprecation_at (if deprecation_at is set).

Create IsImage Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new IsImage(name: string, args?: IsImageArgs, opts?: CustomResourceOptions);
@overload
def IsImage(resource_name: str,
            args: Optional[IsImageArgs] = None,
            opts: Optional[ResourceOptions] = None)

@overload
def IsImage(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            access_tags: Optional[Sequence[str]] = None,
            deprecate: Optional[bool] = None,
            deprecation_at: Optional[str] = None,
            encrypted_data_key: Optional[str] = None,
            encryption_key: Optional[str] = None,
            href: Optional[str] = None,
            is_image_id: Optional[str] = None,
            name: Optional[str] = None,
            obsolescence_at: Optional[str] = None,
            obsolete: Optional[bool] = None,
            operating_system: Optional[str] = None,
            resource_group: Optional[str] = None,
            source_volume: Optional[str] = None,
            tags: Optional[Sequence[str]] = None,
            timeouts: Optional[IsImageTimeoutsArgs] = None)
func NewIsImage(ctx *Context, name string, args *IsImageArgs, opts ...ResourceOption) (*IsImage, error)
public IsImage(string name, IsImageArgs? args = null, CustomResourceOptions? opts = null)
public IsImage(String name, IsImageArgs args)
public IsImage(String name, IsImageArgs args, CustomResourceOptions options)

type: ibm:IsImage
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args IsImageArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args IsImageArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args IsImageArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args IsImageArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. IsImageArgs
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 isImageResource = new Ibm.IsImage("isImageResource", new()
{
    AccessTags = new[]
    {
        "string",
    },
    Deprecate = false,
    DeprecationAt = "string",
    EncryptedDataKey = "string",
    EncryptionKey = "string",
    Href = "string",
    IsImageId = "string",
    Name = "string",
    ObsolescenceAt = "string",
    Obsolete = false,
    OperatingSystem = "string",
    ResourceGroup = "string",
    SourceVolume = "string",
    Tags = new[]
    {
        "string",
    },
    Timeouts = new Ibm.Inputs.IsImageTimeoutsArgs
    {
        Create = "string",
        Delete = "string",
        Update = "string",
    },
});
Copy
example, err := ibm.NewIsImage(ctx, "isImageResource", &ibm.IsImageArgs{
AccessTags: pulumi.StringArray{
pulumi.String("string"),
},
Deprecate: pulumi.Bool(false),
DeprecationAt: pulumi.String("string"),
EncryptedDataKey: pulumi.String("string"),
EncryptionKey: pulumi.String("string"),
Href: pulumi.String("string"),
IsImageId: pulumi.String("string"),
Name: pulumi.String("string"),
ObsolescenceAt: pulumi.String("string"),
Obsolete: pulumi.Bool(false),
OperatingSystem: pulumi.String("string"),
ResourceGroup: pulumi.String("string"),
SourceVolume: pulumi.String("string"),
Tags: pulumi.StringArray{
pulumi.String("string"),
},
Timeouts: &.IsImageTimeoutsArgs{
Create: pulumi.String("string"),
Delete: pulumi.String("string"),
Update: pulumi.String("string"),
},
})
Copy
var isImageResource = new IsImage("isImageResource", IsImageArgs.builder()
    .accessTags("string")
    .deprecate(false)
    .deprecationAt("string")
    .encryptedDataKey("string")
    .encryptionKey("string")
    .href("string")
    .isImageId("string")
    .name("string")
    .obsolescenceAt("string")
    .obsolete(false)
    .operatingSystem("string")
    .resourceGroup("string")
    .sourceVolume("string")
    .tags("string")
    .timeouts(IsImageTimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .update("string")
        .build())
    .build());
Copy
is_image_resource = ibm.IsImage("isImageResource",
    access_tags=["string"],
    deprecate=False,
    deprecation_at="string",
    encrypted_data_key="string",
    encryption_key="string",
    href="string",
    is_image_id="string",
    name="string",
    obsolescence_at="string",
    obsolete=False,
    operating_system="string",
    resource_group="string",
    source_volume="string",
    tags=["string"],
    timeouts={
        "create": "string",
        "delete": "string",
        "update": "string",
    })
Copy
const isImageResource = new ibm.IsImage("isImageResource", {
    accessTags: ["string"],
    deprecate: false,
    deprecationAt: "string",
    encryptedDataKey: "string",
    encryptionKey: "string",
    href: "string",
    isImageId: "string",
    name: "string",
    obsolescenceAt: "string",
    obsolete: false,
    operatingSystem: "string",
    resourceGroup: "string",
    sourceVolume: "string",
    tags: ["string"],
    timeouts: {
        create: "string",
        "delete": "string",
        update: "string",
    },
});
Copy
type: ibm:IsImage
properties:
    accessTags:
        - string
    deprecate: false
    deprecationAt: string
    encryptedDataKey: string
    encryptionKey: string
    href: string
    isImageId: string
    name: string
    obsolescenceAt: string
    obsolete: false
    operatingSystem: string
    resourceGroup: string
    sourceVolume: string
    tags:
        - string
    timeouts:
        create: string
        delete: string
        update: string
Copy

IsImage 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 IsImage resource accepts the following input properties:

AccessTags List<string>

A list of access management tags to attach to the image

Note: • You can attach only those access tags that already exists. • For more information, about creating access tags, see working with tags. • You must have the access listed in the Granting users access to tag resources for access_tags • access_tags must be in the format key:value.

Deprecate bool

This flag deprecates an image, resulting in its status becoming deprecated and deprecation_at being set to the current date and time. The image must:

  • be an existing image and have a status of available
  • have catalog_offering.managed set to false
  • not have deprecation_at set

A system-provided image is not allowed to be deprecated.

DeprecationAt string

The deprecation date and time (UTC) for this image. If absent, no deprecation date and time has been set.

NOTE Specify "null" to remove an existing deprecation date and time. If the image status is currently deprecated, it will become available. string($date-time)

  • This cannot be set if the image has a status of failed or deleting, or if catalog_offering.managed is true.
  • The date and time must not be in the past, and must be earlier than obsolescence_at (if obsolescence_at is set). Additionally, if the image status is currently deprecated, the value cannot be changed (but may be removed).
  • If the deprecation date and time is reached while the image has a status of pending, the image's status will transition to deprecated upon its successful creation (or obsolete if the obsolescence date and time was also reached).
EncryptedDataKey string
A base64-encoded, encrypted representation of the key that was used to encrypt the data for this image.
EncryptionKey string
The CRN of the Key Protect Root Key or Hyper Protect Crypto Service Root Key for this resource.
Href string

The path of an image to be uploaded. The Cloud Object Store (COS) location of the image file.

NOTE either href or source_volume is required

IsImageId string
(String) The unique identifier of the image.

  • resourceGroup - (String) The resource group to which the image belongs to.
Name string
The descriptive name used to identify an image.
ObsolescenceAt string

The obsolescence date and time (UTC) for this image. If absent, no obsolescence date and time has been set.

NOTE Specify "null" to remove an existing obsolescence date and time. If the image status is currently obsolete, it will become deprecated if deprecation_at is in the past. Otherwise, it will become available.

  • This cannot be set if the image has a status of failed or deleting, or if catalog_offering.managed is true.
  • The date and time must not be in the past, and must be later than deprecation_at (if deprecation_at is set). Additionally, if the image status is currently obsolete, the value cannot be changed (but may be removed).
  • If the obsolescence date and time is reached while the image has a status of pending, the image's status will transition to obsolete upon its successful creation.
Obsolete bool
This flag obsoletes an image, resulting in its status becoming obsolete and obsolescence_at being set to the current date and time. The image must:

  • be an existing image and have a status of available or deprecated
  • have catalog_offering.managed set to false
  • not have deprecation_at set in the future
  • not have obsolescence_at set
  • A system-provided image is not allowed to be obsolescence.
OperatingSystem string

Description of underlying OS of an image.

NOTE operating_system is required with href

ResourceGroup string
The resource group ID for this image.
SourceVolume string

The volume id of the volume from which to create the image.

NOTE either source_volume or href is required.

The specified volume must:

  • Originate from an image, which will be used to populate this image's operating system information.(boot type volumes)
  • Not be active or busy.
  • During image creation, the specified volume may briefly become busy.
  • Creating image from volume requires instance to which volume is attached to be in stopped status, running instance will be stopped on using this option.
  • increase the default timeout as per the volume size.
Tags List<string>
A list of tags that you want to your image. Tags can help you find the image more easily later.
Timeouts IsImageTimeouts
AccessTags []string

A list of access management tags to attach to the image

Note: • You can attach only those access tags that already exists. • For more information, about creating access tags, see working with tags. • You must have the access listed in the Granting users access to tag resources for access_tags • access_tags must be in the format key:value.

Deprecate bool

This flag deprecates an image, resulting in its status becoming deprecated and deprecation_at being set to the current date and time. The image must:

  • be an existing image and have a status of available
  • have catalog_offering.managed set to false
  • not have deprecation_at set

A system-provided image is not allowed to be deprecated.

DeprecationAt string

The deprecation date and time (UTC) for this image. If absent, no deprecation date and time has been set.

NOTE Specify "null" to remove an existing deprecation date and time. If the image status is currently deprecated, it will become available. string($date-time)

  • This cannot be set if the image has a status of failed or deleting, or if catalog_offering.managed is true.
  • The date and time must not be in the past, and must be earlier than obsolescence_at (if obsolescence_at is set). Additionally, if the image status is currently deprecated, the value cannot be changed (but may be removed).
  • If the deprecation date and time is reached while the image has a status of pending, the image's status will transition to deprecated upon its successful creation (or obsolete if the obsolescence date and time was also reached).
EncryptedDataKey string
A base64-encoded, encrypted representation of the key that was used to encrypt the data for this image.
EncryptionKey string
The CRN of the Key Protect Root Key or Hyper Protect Crypto Service Root Key for this resource.
Href string

The path of an image to be uploaded. The Cloud Object Store (COS) location of the image file.

NOTE either href or source_volume is required

IsImageId string
(String) The unique identifier of the image.

  • resourceGroup - (String) The resource group to which the image belongs to.
Name string
The descriptive name used to identify an image.
ObsolescenceAt string

The obsolescence date and time (UTC) for this image. If absent, no obsolescence date and time has been set.

NOTE Specify "null" to remove an existing obsolescence date and time. If the image status is currently obsolete, it will become deprecated if deprecation_at is in the past. Otherwise, it will become available.

  • This cannot be set if the image has a status of failed or deleting, or if catalog_offering.managed is true.
  • The date and time must not be in the past, and must be later than deprecation_at (if deprecation_at is set). Additionally, if the image status is currently obsolete, the value cannot be changed (but may be removed).
  • If the obsolescence date and time is reached while the image has a status of pending, the image's status will transition to obsolete upon its successful creation.
Obsolete bool
This flag obsoletes an image, resulting in its status becoming obsolete and obsolescence_at being set to the current date and time. The image must:

  • be an existing image and have a status of available or deprecated
  • have catalog_offering.managed set to false
  • not have deprecation_at set in the future
  • not have obsolescence_at set
  • A system-provided image is not allowed to be obsolescence.
OperatingSystem string

Description of underlying OS of an image.

NOTE operating_system is required with href

ResourceGroup string
The resource group ID for this image.
SourceVolume string

The volume id of the volume from which to create the image.

NOTE either source_volume or href is required.

The specified volume must:

  • Originate from an image, which will be used to populate this image's operating system information.(boot type volumes)
  • Not be active or busy.
  • During image creation, the specified volume may briefly become busy.
  • Creating image from volume requires instance to which volume is attached to be in stopped status, running instance will be stopped on using this option.
  • increase the default timeout as per the volume size.
Tags []string
A list of tags that you want to your image. Tags can help you find the image more easily later.
Timeouts IsImageTimeoutsArgs
accessTags List<String>

A list of access management tags to attach to the image

Note: • You can attach only those access tags that already exists. • For more information, about creating access tags, see working with tags. • You must have the access listed in the Granting users access to tag resources for access_tags • access_tags must be in the format key:value.

deprecate Boolean

This flag deprecates an image, resulting in its status becoming deprecated and deprecation_at being set to the current date and time. The image must:

  • be an existing image and have a status of available
  • have catalog_offering.managed set to false
  • not have deprecation_at set

A system-provided image is not allowed to be deprecated.

deprecationAt String

The deprecation date and time (UTC) for this image. If absent, no deprecation date and time has been set.

NOTE Specify "null" to remove an existing deprecation date and time. If the image status is currently deprecated, it will become available. string($date-time)

  • This cannot be set if the image has a status of failed or deleting, or if catalog_offering.managed is true.
  • The date and time must not be in the past, and must be earlier than obsolescence_at (if obsolescence_at is set). Additionally, if the image status is currently deprecated, the value cannot be changed (but may be removed).
  • If the deprecation date and time is reached while the image has a status of pending, the image's status will transition to deprecated upon its successful creation (or obsolete if the obsolescence date and time was also reached).
encryptedDataKey String
A base64-encoded, encrypted representation of the key that was used to encrypt the data for this image.
encryptionKey String
The CRN of the Key Protect Root Key or Hyper Protect Crypto Service Root Key for this resource.
href String

The path of an image to be uploaded. The Cloud Object Store (COS) location of the image file.

NOTE either href or source_volume is required

isImageId String
(String) The unique identifier of the image.

  • resourceGroup - (String) The resource group to which the image belongs to.
name String
The descriptive name used to identify an image.
obsolescenceAt String

The obsolescence date and time (UTC) for this image. If absent, no obsolescence date and time has been set.

NOTE Specify "null" to remove an existing obsolescence date and time. If the image status is currently obsolete, it will become deprecated if deprecation_at is in the past. Otherwise, it will become available.

  • This cannot be set if the image has a status of failed or deleting, or if catalog_offering.managed is true.
  • The date and time must not be in the past, and must be later than deprecation_at (if deprecation_at is set). Additionally, if the image status is currently obsolete, the value cannot be changed (but may be removed).
  • If the obsolescence date and time is reached while the image has a status of pending, the image's status will transition to obsolete upon its successful creation.
obsolete Boolean
This flag obsoletes an image, resulting in its status becoming obsolete and obsolescence_at being set to the current date and time. The image must:

  • be an existing image and have a status of available or deprecated
  • have catalog_offering.managed set to false
  • not have deprecation_at set in the future
  • not have obsolescence_at set
  • A system-provided image is not allowed to be obsolescence.
operatingSystem String

Description of underlying OS of an image.

NOTE operating_system is required with href

resourceGroup String
The resource group ID for this image.
sourceVolume String

The volume id of the volume from which to create the image.

NOTE either source_volume or href is required.

The specified volume must:

  • Originate from an image, which will be used to populate this image's operating system information.(boot type volumes)
  • Not be active or busy.
  • During image creation, the specified volume may briefly become busy.
  • Creating image from volume requires instance to which volume is attached to be in stopped status, running instance will be stopped on using this option.
  • increase the default timeout as per the volume size.
tags List<String>
A list of tags that you want to your image. Tags can help you find the image more easily later.
timeouts IsImageTimeouts
accessTags string[]

A list of access management tags to attach to the image

Note: • You can attach only those access tags that already exists. • For more information, about creating access tags, see working with tags. • You must have the access listed in the Granting users access to tag resources for access_tags • access_tags must be in the format key:value.

deprecate boolean

This flag deprecates an image, resulting in its status becoming deprecated and deprecation_at being set to the current date and time. The image must:

  • be an existing image and have a status of available
  • have catalog_offering.managed set to false
  • not have deprecation_at set

A system-provided image is not allowed to be deprecated.

deprecationAt string

The deprecation date and time (UTC) for this image. If absent, no deprecation date and time has been set.

NOTE Specify "null" to remove an existing deprecation date and time. If the image status is currently deprecated, it will become available. string($date-time)

  • This cannot be set if the image has a status of failed or deleting, or if catalog_offering.managed is true.
  • The date and time must not be in the past, and must be earlier than obsolescence_at (if obsolescence_at is set). Additionally, if the image status is currently deprecated, the value cannot be changed (but may be removed).
  • If the deprecation date and time is reached while the image has a status of pending, the image's status will transition to deprecated upon its successful creation (or obsolete if the obsolescence date and time was also reached).
encryptedDataKey string
A base64-encoded, encrypted representation of the key that was used to encrypt the data for this image.
encryptionKey string
The CRN of the Key Protect Root Key or Hyper Protect Crypto Service Root Key for this resource.
href string

The path of an image to be uploaded. The Cloud Object Store (COS) location of the image file.

NOTE either href or source_volume is required

isImageId string
(String) The unique identifier of the image.

  • resourceGroup - (String) The resource group to which the image belongs to.
name string
The descriptive name used to identify an image.
obsolescenceAt string

The obsolescence date and time (UTC) for this image. If absent, no obsolescence date and time has been set.

NOTE Specify "null" to remove an existing obsolescence date and time. If the image status is currently obsolete, it will become deprecated if deprecation_at is in the past. Otherwise, it will become available.

  • This cannot be set if the image has a status of failed or deleting, or if catalog_offering.managed is true.
  • The date and time must not be in the past, and must be later than deprecation_at (if deprecation_at is set). Additionally, if the image status is currently obsolete, the value cannot be changed (but may be removed).
  • If the obsolescence date and time is reached while the image has a status of pending, the image's status will transition to obsolete upon its successful creation.
obsolete boolean
This flag obsoletes an image, resulting in its status becoming obsolete and obsolescence_at being set to the current date and time. The image must:

  • be an existing image and have a status of available or deprecated
  • have catalog_offering.managed set to false
  • not have deprecation_at set in the future
  • not have obsolescence_at set
  • A system-provided image is not allowed to be obsolescence.
operatingSystem string

Description of underlying OS of an image.

NOTE operating_system is required with href

resourceGroup string
The resource group ID for this image.
sourceVolume string

The volume id of the volume from which to create the image.

NOTE either source_volume or href is required.

The specified volume must:

  • Originate from an image, which will be used to populate this image's operating system information.(boot type volumes)
  • Not be active or busy.
  • During image creation, the specified volume may briefly become busy.
  • Creating image from volume requires instance to which volume is attached to be in stopped status, running instance will be stopped on using this option.
  • increase the default timeout as per the volume size.
tags string[]
A list of tags that you want to your image. Tags can help you find the image more easily later.
timeouts IsImageTimeouts
access_tags Sequence[str]

A list of access management tags to attach to the image

Note: • You can attach only those access tags that already exists. • For more information, about creating access tags, see working with tags. • You must have the access listed in the Granting users access to tag resources for access_tags • access_tags must be in the format key:value.

deprecate bool

This flag deprecates an image, resulting in its status becoming deprecated and deprecation_at being set to the current date and time. The image must:

  • be an existing image and have a status of available
  • have catalog_offering.managed set to false
  • not have deprecation_at set

A system-provided image is not allowed to be deprecated.

deprecation_at str

The deprecation date and time (UTC) for this image. If absent, no deprecation date and time has been set.

NOTE Specify "null" to remove an existing deprecation date and time. If the image status is currently deprecated, it will become available. string($date-time)

  • This cannot be set if the image has a status of failed or deleting, or if catalog_offering.managed is true.
  • The date and time must not be in the past, and must be earlier than obsolescence_at (if obsolescence_at is set). Additionally, if the image status is currently deprecated, the value cannot be changed (but may be removed).
  • If the deprecation date and time is reached while the image has a status of pending, the image's status will transition to deprecated upon its successful creation (or obsolete if the obsolescence date and time was also reached).
encrypted_data_key str
A base64-encoded, encrypted representation of the key that was used to encrypt the data for this image.
encryption_key str
The CRN of the Key Protect Root Key or Hyper Protect Crypto Service Root Key for this resource.
href str

The path of an image to be uploaded. The Cloud Object Store (COS) location of the image file.

NOTE either href or source_volume is required

is_image_id str
(String) The unique identifier of the image.

  • resourceGroup - (String) The resource group to which the image belongs to.
name str
The descriptive name used to identify an image.
obsolescence_at str

The obsolescence date and time (UTC) for this image. If absent, no obsolescence date and time has been set.

NOTE Specify "null" to remove an existing obsolescence date and time. If the image status is currently obsolete, it will become deprecated if deprecation_at is in the past. Otherwise, it will become available.

  • This cannot be set if the image has a status of failed or deleting, or if catalog_offering.managed is true.
  • The date and time must not be in the past, and must be later than deprecation_at (if deprecation_at is set). Additionally, if the image status is currently obsolete, the value cannot be changed (but may be removed).
  • If the obsolescence date and time is reached while the image has a status of pending, the image's status will transition to obsolete upon its successful creation.
obsolete bool
This flag obsoletes an image, resulting in its status becoming obsolete and obsolescence_at being set to the current date and time. The image must:

  • be an existing image and have a status of available or deprecated
  • have catalog_offering.managed set to false
  • not have deprecation_at set in the future
  • not have obsolescence_at set
  • A system-provided image is not allowed to be obsolescence.
operating_system str

Description of underlying OS of an image.

NOTE operating_system is required with href

resource_group str
The resource group ID for this image.
source_volume str

The volume id of the volume from which to create the image.

NOTE either source_volume or href is required.

The specified volume must:

  • Originate from an image, which will be used to populate this image's operating system information.(boot type volumes)
  • Not be active or busy.
  • During image creation, the specified volume may briefly become busy.
  • Creating image from volume requires instance to which volume is attached to be in stopped status, running instance will be stopped on using this option.
  • increase the default timeout as per the volume size.
tags Sequence[str]
A list of tags that you want to your image. Tags can help you find the image more easily later.
timeouts IsImageTimeoutsArgs
accessTags List<String>

A list of access management tags to attach to the image

Note: • You can attach only those access tags that already exists. • For more information, about creating access tags, see working with tags. • You must have the access listed in the Granting users access to tag resources for access_tags • access_tags must be in the format key:value.

deprecate Boolean

This flag deprecates an image, resulting in its status becoming deprecated and deprecation_at being set to the current date and time. The image must:

  • be an existing image and have a status of available
  • have catalog_offering.managed set to false
  • not have deprecation_at set

A system-provided image is not allowed to be deprecated.

deprecationAt String

The deprecation date and time (UTC) for this image. If absent, no deprecation date and time has been set.

NOTE Specify "null" to remove an existing deprecation date and time. If the image status is currently deprecated, it will become available. string($date-time)

  • This cannot be set if the image has a status of failed or deleting, or if catalog_offering.managed is true.
  • The date and time must not be in the past, and must be earlier than obsolescence_at (if obsolescence_at is set). Additionally, if the image status is currently deprecated, the value cannot be changed (but may be removed).
  • If the deprecation date and time is reached while the image has a status of pending, the image's status will transition to deprecated upon its successful creation (or obsolete if the obsolescence date and time was also reached).
encryptedDataKey String
A base64-encoded, encrypted representation of the key that was used to encrypt the data for this image.
encryptionKey String
The CRN of the Key Protect Root Key or Hyper Protect Crypto Service Root Key for this resource.
href String

The path of an image to be uploaded. The Cloud Object Store (COS) location of the image file.

NOTE either href or source_volume is required

isImageId String
(String) The unique identifier of the image.

  • resourceGroup - (String) The resource group to which the image belongs to.
name String
The descriptive name used to identify an image.
obsolescenceAt String

The obsolescence date and time (UTC) for this image. If absent, no obsolescence date and time has been set.

NOTE Specify "null" to remove an existing obsolescence date and time. If the image status is currently obsolete, it will become deprecated if deprecation_at is in the past. Otherwise, it will become available.

  • This cannot be set if the image has a status of failed or deleting, or if catalog_offering.managed is true.
  • The date and time must not be in the past, and must be later than deprecation_at (if deprecation_at is set). Additionally, if the image status is currently obsolete, the value cannot be changed (but may be removed).
  • If the obsolescence date and time is reached while the image has a status of pending, the image's status will transition to obsolete upon its successful creation.
obsolete Boolean
This flag obsoletes an image, resulting in its status becoming obsolete and obsolescence_at being set to the current date and time. The image must:

  • be an existing image and have a status of available or deprecated
  • have catalog_offering.managed set to false
  • not have deprecation_at set in the future
  • not have obsolescence_at set
  • A system-provided image is not allowed to be obsolescence.
operatingSystem String

Description of underlying OS of an image.

NOTE operating_system is required with href

resourceGroup String
The resource group ID for this image.
sourceVolume String

The volume id of the volume from which to create the image.

NOTE either source_volume or href is required.

The specified volume must:

  • Originate from an image, which will be used to populate this image's operating system information.(boot type volumes)
  • Not be active or busy.
  • During image creation, the specified volume may briefly become busy.
  • Creating image from volume requires instance to which volume is attached to be in stopped status, running instance will be stopped on using this option.
  • increase the default timeout as per the volume size.
tags List<String>
A list of tags that you want to your image. Tags can help you find the image more easily later.
timeouts Property Map

Outputs

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

Checksum string
(String) The SHA256 checksum of the image.
CreatedAt string
(String) The date and time that the image was created
Crn string
(String) The CRN of the image.
Encryption string
(String) The type of encryption used on the image.
File double
(String) The file.
Id string
The provider-assigned unique ID for this managed resource.
ResourceControllerUrl string
The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
ResourceCrn string
The crn of the resource
ResourceGroupName string
The resource group name in which resource is provisioned
ResourceName string
The name of the resource
ResourceStatus string
The status of the resource
Size double
The minimum size (in gigabytes) of a volume onto which this image may be provisioned
Status string
(String) The status of an image such as corrupt, or available.
UserDataFormat string
(String) The user data format for this image.
Visibility string
(String) The access scope of an image such as private or public.
Checksum string
(String) The SHA256 checksum of the image.
CreatedAt string
(String) The date and time that the image was created
Crn string
(String) The CRN of the image.
Encryption string
(String) The type of encryption used on the image.
File float64
(String) The file.
Id string
The provider-assigned unique ID for this managed resource.
ResourceControllerUrl string
The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
ResourceCrn string
The crn of the resource
ResourceGroupName string
The resource group name in which resource is provisioned
ResourceName string
The name of the resource
ResourceStatus string
The status of the resource
Size float64
The minimum size (in gigabytes) of a volume onto which this image may be provisioned
Status string
(String) The status of an image such as corrupt, or available.
UserDataFormat string
(String) The user data format for this image.
Visibility string
(String) The access scope of an image such as private or public.
checksum String
(String) The SHA256 checksum of the image.
createdAt String
(String) The date and time that the image was created
crn String
(String) The CRN of the image.
encryption String
(String) The type of encryption used on the image.
file Double
(String) The file.
id String
The provider-assigned unique ID for this managed resource.
resourceControllerUrl String
The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
resourceCrn String
The crn of the resource
resourceGroupName String
The resource group name in which resource is provisioned
resourceName String
The name of the resource
resourceStatus String
The status of the resource
size Double
The minimum size (in gigabytes) of a volume onto which this image may be provisioned
status String
(String) The status of an image such as corrupt, or available.
userDataFormat String
(String) The user data format for this image.
visibility String
(String) The access scope of an image such as private or public.
checksum string
(String) The SHA256 checksum of the image.
createdAt string
(String) The date and time that the image was created
crn string
(String) The CRN of the image.
encryption string
(String) The type of encryption used on the image.
file number
(String) The file.
id string
The provider-assigned unique ID for this managed resource.
resourceControllerUrl string
The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
resourceCrn string
The crn of the resource
resourceGroupName string
The resource group name in which resource is provisioned
resourceName string
The name of the resource
resourceStatus string
The status of the resource
size number
The minimum size (in gigabytes) of a volume onto which this image may be provisioned
status string
(String) The status of an image such as corrupt, or available.
userDataFormat string
(String) The user data format for this image.
visibility string
(String) The access scope of an image such as private or public.
checksum str
(String) The SHA256 checksum of the image.
created_at str
(String) The date and time that the image was created
crn str
(String) The CRN of the image.
encryption str
(String) The type of encryption used on the image.
file float
(String) The file.
id str
The provider-assigned unique ID for this managed resource.
resource_controller_url str
The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
resource_crn str
The crn of the resource
resource_group_name str
The resource group name in which resource is provisioned
resource_name str
The name of the resource
resource_status str
The status of the resource
size float
The minimum size (in gigabytes) of a volume onto which this image may be provisioned
status str
(String) The status of an image such as corrupt, or available.
user_data_format str
(String) The user data format for this image.
visibility str
(String) The access scope of an image such as private or public.
checksum String
(String) The SHA256 checksum of the image.
createdAt String
(String) The date and time that the image was created
crn String
(String) The CRN of the image.
encryption String
(String) The type of encryption used on the image.
file Number
(String) The file.
id String
The provider-assigned unique ID for this managed resource.
resourceControllerUrl String
The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
resourceCrn String
The crn of the resource
resourceGroupName String
The resource group name in which resource is provisioned
resourceName String
The name of the resource
resourceStatus String
The status of the resource
size Number
The minimum size (in gigabytes) of a volume onto which this image may be provisioned
status String
(String) The status of an image such as corrupt, or available.
userDataFormat String
(String) The user data format for this image.
visibility String
(String) The access scope of an image such as private or public.

Look up Existing IsImage Resource

Get an existing IsImage 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?: IsImageState, opts?: CustomResourceOptions): IsImage
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        access_tags: Optional[Sequence[str]] = None,
        checksum: Optional[str] = None,
        created_at: Optional[str] = None,
        crn: Optional[str] = None,
        deprecate: Optional[bool] = None,
        deprecation_at: Optional[str] = None,
        encrypted_data_key: Optional[str] = None,
        encryption: Optional[str] = None,
        encryption_key: Optional[str] = None,
        file: Optional[float] = None,
        href: Optional[str] = None,
        is_image_id: Optional[str] = None,
        name: Optional[str] = None,
        obsolescence_at: Optional[str] = None,
        obsolete: Optional[bool] = None,
        operating_system: Optional[str] = None,
        resource_controller_url: Optional[str] = None,
        resource_crn: Optional[str] = None,
        resource_group: Optional[str] = None,
        resource_group_name: Optional[str] = None,
        resource_name: Optional[str] = None,
        resource_status: Optional[str] = None,
        size: Optional[float] = None,
        source_volume: Optional[str] = None,
        status: Optional[str] = None,
        tags: Optional[Sequence[str]] = None,
        timeouts: Optional[IsImageTimeoutsArgs] = None,
        user_data_format: Optional[str] = None,
        visibility: Optional[str] = None) -> IsImage
func GetIsImage(ctx *Context, name string, id IDInput, state *IsImageState, opts ...ResourceOption) (*IsImage, error)
public static IsImage Get(string name, Input<string> id, IsImageState? state, CustomResourceOptions? opts = null)
public static IsImage get(String name, Output<String> id, IsImageState state, CustomResourceOptions options)
resources:  _:    type: ibm:IsImage    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
AccessTags List<string>

A list of access management tags to attach to the image

Note: • You can attach only those access tags that already exists. • For more information, about creating access tags, see working with tags. • You must have the access listed in the Granting users access to tag resources for access_tags • access_tags must be in the format key:value.

Checksum string
(String) The SHA256 checksum of the image.
CreatedAt string
(String) The date and time that the image was created
Crn string
(String) The CRN of the image.
Deprecate bool

This flag deprecates an image, resulting in its status becoming deprecated and deprecation_at being set to the current date and time. The image must:

  • be an existing image and have a status of available
  • have catalog_offering.managed set to false
  • not have deprecation_at set

A system-provided image is not allowed to be deprecated.

DeprecationAt string

The deprecation date and time (UTC) for this image. If absent, no deprecation date and time has been set.

NOTE Specify "null" to remove an existing deprecation date and time. If the image status is currently deprecated, it will become available. string($date-time)

  • This cannot be set if the image has a status of failed or deleting, or if catalog_offering.managed is true.
  • The date and time must not be in the past, and must be earlier than obsolescence_at (if obsolescence_at is set). Additionally, if the image status is currently deprecated, the value cannot be changed (but may be removed).
  • If the deprecation date and time is reached while the image has a status of pending, the image's status will transition to deprecated upon its successful creation (or obsolete if the obsolescence date and time was also reached).
EncryptedDataKey string
A base64-encoded, encrypted representation of the key that was used to encrypt the data for this image.
Encryption string
(String) The type of encryption used on the image.
EncryptionKey string
The CRN of the Key Protect Root Key or Hyper Protect Crypto Service Root Key for this resource.
File double
(String) The file.
Href string

The path of an image to be uploaded. The Cloud Object Store (COS) location of the image file.

NOTE either href or source_volume is required

IsImageId string
(String) The unique identifier of the image.

  • resourceGroup - (String) The resource group to which the image belongs to.
Name string
The descriptive name used to identify an image.
ObsolescenceAt string

The obsolescence date and time (UTC) for this image. If absent, no obsolescence date and time has been set.

NOTE Specify "null" to remove an existing obsolescence date and time. If the image status is currently obsolete, it will become deprecated if deprecation_at is in the past. Otherwise, it will become available.

  • This cannot be set if the image has a status of failed or deleting, or if catalog_offering.managed is true.
  • The date and time must not be in the past, and must be later than deprecation_at (if deprecation_at is set). Additionally, if the image status is currently obsolete, the value cannot be changed (but may be removed).
  • If the obsolescence date and time is reached while the image has a status of pending, the image's status will transition to obsolete upon its successful creation.
Obsolete bool
This flag obsoletes an image, resulting in its status becoming obsolete and obsolescence_at being set to the current date and time. The image must:

  • be an existing image and have a status of available or deprecated
  • have catalog_offering.managed set to false
  • not have deprecation_at set in the future
  • not have obsolescence_at set
  • A system-provided image is not allowed to be obsolescence.
OperatingSystem string

Description of underlying OS of an image.

NOTE operating_system is required with href

ResourceControllerUrl string
The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
ResourceCrn string
The crn of the resource
ResourceGroup string
The resource group ID for this image.
ResourceGroupName string
The resource group name in which resource is provisioned
ResourceName string
The name of the resource
ResourceStatus string
The status of the resource
Size double
The minimum size (in gigabytes) of a volume onto which this image may be provisioned
SourceVolume string

The volume id of the volume from which to create the image.

NOTE either source_volume or href is required.

The specified volume must:

  • Originate from an image, which will be used to populate this image's operating system information.(boot type volumes)
  • Not be active or busy.
  • During image creation, the specified volume may briefly become busy.
  • Creating image from volume requires instance to which volume is attached to be in stopped status, running instance will be stopped on using this option.
  • increase the default timeout as per the volume size.
Status string
(String) The status of an image such as corrupt, or available.
Tags List<string>
A list of tags that you want to your image. Tags can help you find the image more easily later.
Timeouts IsImageTimeouts
UserDataFormat string
(String) The user data format for this image.
Visibility string
(String) The access scope of an image such as private or public.
AccessTags []string

A list of access management tags to attach to the image

Note: • You can attach only those access tags that already exists. • For more information, about creating access tags, see working with tags. • You must have the access listed in the Granting users access to tag resources for access_tags • access_tags must be in the format key:value.

Checksum string
(String) The SHA256 checksum of the image.
CreatedAt string
(String) The date and time that the image was created
Crn string
(String) The CRN of the image.
Deprecate bool

This flag deprecates an image, resulting in its status becoming deprecated and deprecation_at being set to the current date and time. The image must:

  • be an existing image and have a status of available
  • have catalog_offering.managed set to false
  • not have deprecation_at set

A system-provided image is not allowed to be deprecated.

DeprecationAt string

The deprecation date and time (UTC) for this image. If absent, no deprecation date and time has been set.

NOTE Specify "null" to remove an existing deprecation date and time. If the image status is currently deprecated, it will become available. string($date-time)

  • This cannot be set if the image has a status of failed or deleting, or if catalog_offering.managed is true.
  • The date and time must not be in the past, and must be earlier than obsolescence_at (if obsolescence_at is set). Additionally, if the image status is currently deprecated, the value cannot be changed (but may be removed).
  • If the deprecation date and time is reached while the image has a status of pending, the image's status will transition to deprecated upon its successful creation (or obsolete if the obsolescence date and time was also reached).
EncryptedDataKey string
A base64-encoded, encrypted representation of the key that was used to encrypt the data for this image.
Encryption string
(String) The type of encryption used on the image.
EncryptionKey string
The CRN of the Key Protect Root Key or Hyper Protect Crypto Service Root Key for this resource.
File float64
(String) The file.
Href string

The path of an image to be uploaded. The Cloud Object Store (COS) location of the image file.

NOTE either href or source_volume is required

IsImageId string
(String) The unique identifier of the image.

  • resourceGroup - (String) The resource group to which the image belongs to.
Name string
The descriptive name used to identify an image.
ObsolescenceAt string

The obsolescence date and time (UTC) for this image. If absent, no obsolescence date and time has been set.

NOTE Specify "null" to remove an existing obsolescence date and time. If the image status is currently obsolete, it will become deprecated if deprecation_at is in the past. Otherwise, it will become available.

  • This cannot be set if the image has a status of failed or deleting, or if catalog_offering.managed is true.
  • The date and time must not be in the past, and must be later than deprecation_at (if deprecation_at is set). Additionally, if the image status is currently obsolete, the value cannot be changed (but may be removed).
  • If the obsolescence date and time is reached while the image has a status of pending, the image's status will transition to obsolete upon its successful creation.
Obsolete bool
This flag obsoletes an image, resulting in its status becoming obsolete and obsolescence_at being set to the current date and time. The image must:

  • be an existing image and have a status of available or deprecated
  • have catalog_offering.managed set to false
  • not have deprecation_at set in the future
  • not have obsolescence_at set
  • A system-provided image is not allowed to be obsolescence.
OperatingSystem string

Description of underlying OS of an image.

NOTE operating_system is required with href

ResourceControllerUrl string
The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
ResourceCrn string
The crn of the resource
ResourceGroup string
The resource group ID for this image.
ResourceGroupName string
The resource group name in which resource is provisioned
ResourceName string
The name of the resource
ResourceStatus string
The status of the resource
Size float64
The minimum size (in gigabytes) of a volume onto which this image may be provisioned
SourceVolume string

The volume id of the volume from which to create the image.

NOTE either source_volume or href is required.

The specified volume must:

  • Originate from an image, which will be used to populate this image's operating system information.(boot type volumes)
  • Not be active or busy.
  • During image creation, the specified volume may briefly become busy.
  • Creating image from volume requires instance to which volume is attached to be in stopped status, running instance will be stopped on using this option.
  • increase the default timeout as per the volume size.
Status string
(String) The status of an image such as corrupt, or available.
Tags []string
A list of tags that you want to your image. Tags can help you find the image more easily later.
Timeouts IsImageTimeoutsArgs
UserDataFormat string
(String) The user data format for this image.
Visibility string
(String) The access scope of an image such as private or public.
accessTags List<String>

A list of access management tags to attach to the image

Note: • You can attach only those access tags that already exists. • For more information, about creating access tags, see working with tags. • You must have the access listed in the Granting users access to tag resources for access_tags • access_tags must be in the format key:value.

checksum String
(String) The SHA256 checksum of the image.
createdAt String
(String) The date and time that the image was created
crn String
(String) The CRN of the image.
deprecate Boolean

This flag deprecates an image, resulting in its status becoming deprecated and deprecation_at being set to the current date and time. The image must:

  • be an existing image and have a status of available
  • have catalog_offering.managed set to false
  • not have deprecation_at set

A system-provided image is not allowed to be deprecated.

deprecationAt String

The deprecation date and time (UTC) for this image. If absent, no deprecation date and time has been set.

NOTE Specify "null" to remove an existing deprecation date and time. If the image status is currently deprecated, it will become available. string($date-time)

  • This cannot be set if the image has a status of failed or deleting, or if catalog_offering.managed is true.
  • The date and time must not be in the past, and must be earlier than obsolescence_at (if obsolescence_at is set). Additionally, if the image status is currently deprecated, the value cannot be changed (but may be removed).
  • If the deprecation date and time is reached while the image has a status of pending, the image's status will transition to deprecated upon its successful creation (or obsolete if the obsolescence date and time was also reached).
encryptedDataKey String
A base64-encoded, encrypted representation of the key that was used to encrypt the data for this image.
encryption String
(String) The type of encryption used on the image.
encryptionKey String
The CRN of the Key Protect Root Key or Hyper Protect Crypto Service Root Key for this resource.
file Double
(String) The file.
href String

The path of an image to be uploaded. The Cloud Object Store (COS) location of the image file.

NOTE either href or source_volume is required

isImageId String
(String) The unique identifier of the image.

  • resourceGroup - (String) The resource group to which the image belongs to.
name String
The descriptive name used to identify an image.
obsolescenceAt String

The obsolescence date and time (UTC) for this image. If absent, no obsolescence date and time has been set.

NOTE Specify "null" to remove an existing obsolescence date and time. If the image status is currently obsolete, it will become deprecated if deprecation_at is in the past. Otherwise, it will become available.

  • This cannot be set if the image has a status of failed or deleting, or if catalog_offering.managed is true.
  • The date and time must not be in the past, and must be later than deprecation_at (if deprecation_at is set). Additionally, if the image status is currently obsolete, the value cannot be changed (but may be removed).
  • If the obsolescence date and time is reached while the image has a status of pending, the image's status will transition to obsolete upon its successful creation.
obsolete Boolean
This flag obsoletes an image, resulting in its status becoming obsolete and obsolescence_at being set to the current date and time. The image must:

  • be an existing image and have a status of available or deprecated
  • have catalog_offering.managed set to false
  • not have deprecation_at set in the future
  • not have obsolescence_at set
  • A system-provided image is not allowed to be obsolescence.
operatingSystem String

Description of underlying OS of an image.

NOTE operating_system is required with href

resourceControllerUrl String
The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
resourceCrn String
The crn of the resource
resourceGroup String
The resource group ID for this image.
resourceGroupName String
The resource group name in which resource is provisioned
resourceName String
The name of the resource
resourceStatus String
The status of the resource
size Double
The minimum size (in gigabytes) of a volume onto which this image may be provisioned
sourceVolume String

The volume id of the volume from which to create the image.

NOTE either source_volume or href is required.

The specified volume must:

  • Originate from an image, which will be used to populate this image's operating system information.(boot type volumes)
  • Not be active or busy.
  • During image creation, the specified volume may briefly become busy.
  • Creating image from volume requires instance to which volume is attached to be in stopped status, running instance will be stopped on using this option.
  • increase the default timeout as per the volume size.
status String
(String) The status of an image such as corrupt, or available.
tags List<String>
A list of tags that you want to your image. Tags can help you find the image more easily later.
timeouts IsImageTimeouts
userDataFormat String
(String) The user data format for this image.
visibility String
(String) The access scope of an image such as private or public.
accessTags string[]

A list of access management tags to attach to the image

Note: • You can attach only those access tags that already exists. • For more information, about creating access tags, see working with tags. • You must have the access listed in the Granting users access to tag resources for access_tags • access_tags must be in the format key:value.

checksum string
(String) The SHA256 checksum of the image.
createdAt string
(String) The date and time that the image was created
crn string
(String) The CRN of the image.
deprecate boolean

This flag deprecates an image, resulting in its status becoming deprecated and deprecation_at being set to the current date and time. The image must:

  • be an existing image and have a status of available
  • have catalog_offering.managed set to false
  • not have deprecation_at set

A system-provided image is not allowed to be deprecated.

deprecationAt string

The deprecation date and time (UTC) for this image. If absent, no deprecation date and time has been set.

NOTE Specify "null" to remove an existing deprecation date and time. If the image status is currently deprecated, it will become available. string($date-time)

  • This cannot be set if the image has a status of failed or deleting, or if catalog_offering.managed is true.
  • The date and time must not be in the past, and must be earlier than obsolescence_at (if obsolescence_at is set). Additionally, if the image status is currently deprecated, the value cannot be changed (but may be removed).
  • If the deprecation date and time is reached while the image has a status of pending, the image's status will transition to deprecated upon its successful creation (or obsolete if the obsolescence date and time was also reached).
encryptedDataKey string
A base64-encoded, encrypted representation of the key that was used to encrypt the data for this image.
encryption string
(String) The type of encryption used on the image.
encryptionKey string
The CRN of the Key Protect Root Key or Hyper Protect Crypto Service Root Key for this resource.
file number
(String) The file.
href string

The path of an image to be uploaded. The Cloud Object Store (COS) location of the image file.

NOTE either href or source_volume is required

isImageId string
(String) The unique identifier of the image.

  • resourceGroup - (String) The resource group to which the image belongs to.
name string
The descriptive name used to identify an image.
obsolescenceAt string

The obsolescence date and time (UTC) for this image. If absent, no obsolescence date and time has been set.

NOTE Specify "null" to remove an existing obsolescence date and time. If the image status is currently obsolete, it will become deprecated if deprecation_at is in the past. Otherwise, it will become available.

  • This cannot be set if the image has a status of failed or deleting, or if catalog_offering.managed is true.
  • The date and time must not be in the past, and must be later than deprecation_at (if deprecation_at is set). Additionally, if the image status is currently obsolete, the value cannot be changed (but may be removed).
  • If the obsolescence date and time is reached while the image has a status of pending, the image's status will transition to obsolete upon its successful creation.
obsolete boolean
This flag obsoletes an image, resulting in its status becoming obsolete and obsolescence_at being set to the current date and time. The image must:

  • be an existing image and have a status of available or deprecated
  • have catalog_offering.managed set to false
  • not have deprecation_at set in the future
  • not have obsolescence_at set
  • A system-provided image is not allowed to be obsolescence.
operatingSystem string

Description of underlying OS of an image.

NOTE operating_system is required with href

resourceControllerUrl string
The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
resourceCrn string
The crn of the resource
resourceGroup string
The resource group ID for this image.
resourceGroupName string
The resource group name in which resource is provisioned
resourceName string
The name of the resource
resourceStatus string
The status of the resource
size number
The minimum size (in gigabytes) of a volume onto which this image may be provisioned
sourceVolume string

The volume id of the volume from which to create the image.

NOTE either source_volume or href is required.

The specified volume must:

  • Originate from an image, which will be used to populate this image's operating system information.(boot type volumes)
  • Not be active or busy.
  • During image creation, the specified volume may briefly become busy.
  • Creating image from volume requires instance to which volume is attached to be in stopped status, running instance will be stopped on using this option.
  • increase the default timeout as per the volume size.
status string
(String) The status of an image such as corrupt, or available.
tags string[]
A list of tags that you want to your image. Tags can help you find the image more easily later.
timeouts IsImageTimeouts
userDataFormat string
(String) The user data format for this image.
visibility string
(String) The access scope of an image such as private or public.
access_tags Sequence[str]

A list of access management tags to attach to the image

Note: • You can attach only those access tags that already exists. • For more information, about creating access tags, see working with tags. • You must have the access listed in the Granting users access to tag resources for access_tags • access_tags must be in the format key:value.

checksum str
(String) The SHA256 checksum of the image.
created_at str
(String) The date and time that the image was created
crn str
(String) The CRN of the image.
deprecate bool

This flag deprecates an image, resulting in its status becoming deprecated and deprecation_at being set to the current date and time. The image must:

  • be an existing image and have a status of available
  • have catalog_offering.managed set to false
  • not have deprecation_at set

A system-provided image is not allowed to be deprecated.

deprecation_at str

The deprecation date and time (UTC) for this image. If absent, no deprecation date and time has been set.

NOTE Specify "null" to remove an existing deprecation date and time. If the image status is currently deprecated, it will become available. string($date-time)

  • This cannot be set if the image has a status of failed or deleting, or if catalog_offering.managed is true.
  • The date and time must not be in the past, and must be earlier than obsolescence_at (if obsolescence_at is set). Additionally, if the image status is currently deprecated, the value cannot be changed (but may be removed).
  • If the deprecation date and time is reached while the image has a status of pending, the image's status will transition to deprecated upon its successful creation (or obsolete if the obsolescence date and time was also reached).
encrypted_data_key str
A base64-encoded, encrypted representation of the key that was used to encrypt the data for this image.
encryption str
(String) The type of encryption used on the image.
encryption_key str
The CRN of the Key Protect Root Key or Hyper Protect Crypto Service Root Key for this resource.
file float
(String) The file.
href str

The path of an image to be uploaded. The Cloud Object Store (COS) location of the image file.

NOTE either href or source_volume is required

is_image_id str
(String) The unique identifier of the image.

  • resourceGroup - (String) The resource group to which the image belongs to.
name str
The descriptive name used to identify an image.
obsolescence_at str

The obsolescence date and time (UTC) for this image. If absent, no obsolescence date and time has been set.

NOTE Specify "null" to remove an existing obsolescence date and time. If the image status is currently obsolete, it will become deprecated if deprecation_at is in the past. Otherwise, it will become available.

  • This cannot be set if the image has a status of failed or deleting, or if catalog_offering.managed is true.
  • The date and time must not be in the past, and must be later than deprecation_at (if deprecation_at is set). Additionally, if the image status is currently obsolete, the value cannot be changed (but may be removed).
  • If the obsolescence date and time is reached while the image has a status of pending, the image's status will transition to obsolete upon its successful creation.
obsolete bool
This flag obsoletes an image, resulting in its status becoming obsolete and obsolescence_at being set to the current date and time. The image must:

  • be an existing image and have a status of available or deprecated
  • have catalog_offering.managed set to false
  • not have deprecation_at set in the future
  • not have obsolescence_at set
  • A system-provided image is not allowed to be obsolescence.
operating_system str

Description of underlying OS of an image.

NOTE operating_system is required with href

resource_controller_url str
The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
resource_crn str
The crn of the resource
resource_group str
The resource group ID for this image.
resource_group_name str
The resource group name in which resource is provisioned
resource_name str
The name of the resource
resource_status str
The status of the resource
size float
The minimum size (in gigabytes) of a volume onto which this image may be provisioned
source_volume str

The volume id of the volume from which to create the image.

NOTE either source_volume or href is required.

The specified volume must:

  • Originate from an image, which will be used to populate this image's operating system information.(boot type volumes)
  • Not be active or busy.
  • During image creation, the specified volume may briefly become busy.
  • Creating image from volume requires instance to which volume is attached to be in stopped status, running instance will be stopped on using this option.
  • increase the default timeout as per the volume size.
status str
(String) The status of an image such as corrupt, or available.
tags Sequence[str]
A list of tags that you want to your image. Tags can help you find the image more easily later.
timeouts IsImageTimeoutsArgs
user_data_format str
(String) The user data format for this image.
visibility str
(String) The access scope of an image such as private or public.
accessTags List<String>

A list of access management tags to attach to the image

Note: • You can attach only those access tags that already exists. • For more information, about creating access tags, see working with tags. • You must have the access listed in the Granting users access to tag resources for access_tags • access_tags must be in the format key:value.

checksum String
(String) The SHA256 checksum of the image.
createdAt String
(String) The date and time that the image was created
crn String
(String) The CRN of the image.
deprecate Boolean

This flag deprecates an image, resulting in its status becoming deprecated and deprecation_at being set to the current date and time. The image must:

  • be an existing image and have a status of available
  • have catalog_offering.managed set to false
  • not have deprecation_at set

A system-provided image is not allowed to be deprecated.

deprecationAt String

The deprecation date and time (UTC) for this image. If absent, no deprecation date and time has been set.

NOTE Specify "null" to remove an existing deprecation date and time. If the image status is currently deprecated, it will become available. string($date-time)

  • This cannot be set if the image has a status of failed or deleting, or if catalog_offering.managed is true.
  • The date and time must not be in the past, and must be earlier than obsolescence_at (if obsolescence_at is set). Additionally, if the image status is currently deprecated, the value cannot be changed (but may be removed).
  • If the deprecation date and time is reached while the image has a status of pending, the image's status will transition to deprecated upon its successful creation (or obsolete if the obsolescence date and time was also reached).
encryptedDataKey String
A base64-encoded, encrypted representation of the key that was used to encrypt the data for this image.
encryption String
(String) The type of encryption used on the image.
encryptionKey String
The CRN of the Key Protect Root Key or Hyper Protect Crypto Service Root Key for this resource.
file Number
(String) The file.
href String

The path of an image to be uploaded. The Cloud Object Store (COS) location of the image file.

NOTE either href or source_volume is required

isImageId String
(String) The unique identifier of the image.

  • resourceGroup - (String) The resource group to which the image belongs to.
name String
The descriptive name used to identify an image.
obsolescenceAt String

The obsolescence date and time (UTC) for this image. If absent, no obsolescence date and time has been set.

NOTE Specify "null" to remove an existing obsolescence date and time. If the image status is currently obsolete, it will become deprecated if deprecation_at is in the past. Otherwise, it will become available.

  • This cannot be set if the image has a status of failed or deleting, or if catalog_offering.managed is true.
  • The date and time must not be in the past, and must be later than deprecation_at (if deprecation_at is set). Additionally, if the image status is currently obsolete, the value cannot be changed (but may be removed).
  • If the obsolescence date and time is reached while the image has a status of pending, the image's status will transition to obsolete upon its successful creation.
obsolete Boolean
This flag obsoletes an image, resulting in its status becoming obsolete and obsolescence_at being set to the current date and time. The image must:

  • be an existing image and have a status of available or deprecated
  • have catalog_offering.managed set to false
  • not have deprecation_at set in the future
  • not have obsolescence_at set
  • A system-provided image is not allowed to be obsolescence.
operatingSystem String

Description of underlying OS of an image.

NOTE operating_system is required with href

resourceControllerUrl String
The URL of the IBM Cloud dashboard that can be used to explore and view details about this instance
resourceCrn String
The crn of the resource
resourceGroup String
The resource group ID for this image.
resourceGroupName String
The resource group name in which resource is provisioned
resourceName String
The name of the resource
resourceStatus String
The status of the resource
size Number
The minimum size (in gigabytes) of a volume onto which this image may be provisioned
sourceVolume String

The volume id of the volume from which to create the image.

NOTE either source_volume or href is required.

The specified volume must:

  • Originate from an image, which will be used to populate this image's operating system information.(boot type volumes)
  • Not be active or busy.
  • During image creation, the specified volume may briefly become busy.
  • Creating image from volume requires instance to which volume is attached to be in stopped status, running instance will be stopped on using this option.
  • increase the default timeout as per the volume size.
status String
(String) The status of an image such as corrupt, or available.
tags List<String>
A list of tags that you want to your image. Tags can help you find the image more easily later.
timeouts Property Map
userDataFormat String
(String) The user data format for this image.
visibility String
(String) The access scope of an image such as private or public.

Supporting Types

IsImageTimeouts
, IsImageTimeoutsArgs

Create string
Delete string
Update string
Create string
Delete string
Update string
create String
delete String
update String
create string
delete string
update string
create str
delete str
update str
create String
delete String
update String

Import

The ibm_is_image resource can be imported by using image ID.

Example

$ pulumi import ibm:index/isImage:IsImage example d7bec597-4726-451f-8a63-e62e6f121c32c
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
ibm ibm-cloud/terraform-provider-ibm
License
Notes
This Pulumi package is based on the ibm Terraform Provider.
ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm