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

ibm.PiImage

Explore with Pulumi AI

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

Create, update, or delete for a Power Systems Virtual Server image. For more information, about IBM power virtual server cloud, see getting started with IBM Power Systems Virtual Servers.

Notes

  • Please find supported Regions for endpoints.
  • If a Power cloud instance is provisioned at lon04, The provider level attributes should be as follows:
    • region - lon
    • zone - lon04

Example usage:

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

Create PiImage Resource

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

Constructor syntax

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

@overload
def PiImage(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            pi_cloud_instance_id: Optional[str] = None,
            pi_image_bucket_name: Optional[str] = None,
            pi_image_bucket_region: Optional[str] = None,
            pi_affinity_volume: Optional[str] = None,
            ibm_pi_image_id: Optional[str] = None,
            pi_anti_affinity_volumes: Optional[Sequence[str]] = None,
            pi_affinity_instance: Optional[str] = None,
            pi_image_access_key: Optional[str] = None,
            pi_image_bucket_access: Optional[str] = None,
            pi_affinity_policy: Optional[str] = None,
            pi_image_bucket_file_name: Optional[str] = None,
            pi_anti_affinity_instances: Optional[Sequence[str]] = None,
            pi_image_id: Optional[str] = None,
            pi_image_import_details: Optional[PiImagePiImageImportDetailsArgs] = None,
            pi_image_name: Optional[str] = None,
            pi_image_secret_key: Optional[str] = None,
            pi_image_storage_pool: Optional[str] = None,
            pi_image_storage_type: Optional[str] = None,
            pi_user_tags: Optional[Sequence[str]] = None,
            timeouts: Optional[PiImageTimeoutsArgs] = None)
func NewPiImage(ctx *Context, name string, args PiImageArgs, opts ...ResourceOption) (*PiImage, error)
public PiImage(string name, PiImageArgs args, CustomResourceOptions? opts = null)
public PiImage(String name, PiImageArgs args)
public PiImage(String name, PiImageArgs args, CustomResourceOptions options)

type: ibm:PiImage
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 This property is required. PiImageArgs
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 This property is required. PiImageArgs
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 This property is required. PiImageArgs
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 This property is required. PiImageArgs
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. PiImageArgs
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 piImageResource = new Ibm.PiImage("piImageResource", new()
{
    PiCloudInstanceId = "string",
    PiImageBucketName = "string",
    PiImageBucketRegion = "string",
    PiAffinityVolume = "string",
    IbmPiImageId = "string",
    PiAntiAffinityVolumes = new[]
    {
        "string",
    },
    PiAffinityInstance = "string",
    PiImageAccessKey = "string",
    PiImageBucketAccess = "string",
    PiAffinityPolicy = "string",
    PiImageBucketFileName = "string",
    PiAntiAffinityInstances = new[]
    {
        "string",
    },
    PiImageId = "string",
    PiImageImportDetails = new Ibm.Inputs.PiImagePiImageImportDetailsArgs
    {
        LicenseType = "string",
        Product = "string",
        Vendor = "string",
    },
    PiImageName = "string",
    PiImageSecretKey = "string",
    PiImageStoragePool = "string",
    PiImageStorageType = "string",
    PiUserTags = new[]
    {
        "string",
    },
    Timeouts = new Ibm.Inputs.PiImageTimeoutsArgs
    {
        Create = "string",
        Delete = "string",
        Update = "string",
    },
});
Copy
example, err := ibm.NewPiImage(ctx, "piImageResource", &ibm.PiImageArgs{
PiCloudInstanceId: pulumi.String("string"),
PiImageBucketName: pulumi.String("string"),
PiImageBucketRegion: pulumi.String("string"),
PiAffinityVolume: pulumi.String("string"),
IbmPiImageId: pulumi.String("string"),
PiAntiAffinityVolumes: pulumi.StringArray{
pulumi.String("string"),
},
PiAffinityInstance: pulumi.String("string"),
PiImageAccessKey: pulumi.String("string"),
PiImageBucketAccess: pulumi.String("string"),
PiAffinityPolicy: pulumi.String("string"),
PiImageBucketFileName: pulumi.String("string"),
PiAntiAffinityInstances: pulumi.StringArray{
pulumi.String("string"),
},
PiImageId: pulumi.String("string"),
PiImageImportDetails: &.PiImagePiImageImportDetailsArgs{
LicenseType: pulumi.String("string"),
Product: pulumi.String("string"),
Vendor: pulumi.String("string"),
},
PiImageName: pulumi.String("string"),
PiImageSecretKey: pulumi.String("string"),
PiImageStoragePool: pulumi.String("string"),
PiImageStorageType: pulumi.String("string"),
PiUserTags: pulumi.StringArray{
pulumi.String("string"),
},
Timeouts: &.PiImageTimeoutsArgs{
Create: pulumi.String("string"),
Delete: pulumi.String("string"),
Update: pulumi.String("string"),
},
})
Copy
var piImageResource = new PiImage("piImageResource", PiImageArgs.builder()
    .piCloudInstanceId("string")
    .piImageBucketName("string")
    .piImageBucketRegion("string")
    .piAffinityVolume("string")
    .ibmPiImageId("string")
    .piAntiAffinityVolumes("string")
    .piAffinityInstance("string")
    .piImageAccessKey("string")
    .piImageBucketAccess("string")
    .piAffinityPolicy("string")
    .piImageBucketFileName("string")
    .piAntiAffinityInstances("string")
    .piImageId("string")
    .piImageImportDetails(PiImagePiImageImportDetailsArgs.builder()
        .licenseType("string")
        .product("string")
        .vendor("string")
        .build())
    .piImageName("string")
    .piImageSecretKey("string")
    .piImageStoragePool("string")
    .piImageStorageType("string")
    .piUserTags("string")
    .timeouts(PiImageTimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .update("string")
        .build())
    .build());
Copy
pi_image_resource = ibm.PiImage("piImageResource",
    pi_cloud_instance_id="string",
    pi_image_bucket_name="string",
    pi_image_bucket_region="string",
    pi_affinity_volume="string",
    ibm_pi_image_id="string",
    pi_anti_affinity_volumes=["string"],
    pi_affinity_instance="string",
    pi_image_access_key="string",
    pi_image_bucket_access="string",
    pi_affinity_policy="string",
    pi_image_bucket_file_name="string",
    pi_anti_affinity_instances=["string"],
    pi_image_id="string",
    pi_image_import_details={
        "license_type": "string",
        "product": "string",
        "vendor": "string",
    },
    pi_image_name="string",
    pi_image_secret_key="string",
    pi_image_storage_pool="string",
    pi_image_storage_type="string",
    pi_user_tags=["string"],
    timeouts={
        "create": "string",
        "delete": "string",
        "update": "string",
    })
Copy
const piImageResource = new ibm.PiImage("piImageResource", {
    piCloudInstanceId: "string",
    piImageBucketName: "string",
    piImageBucketRegion: "string",
    piAffinityVolume: "string",
    ibmPiImageId: "string",
    piAntiAffinityVolumes: ["string"],
    piAffinityInstance: "string",
    piImageAccessKey: "string",
    piImageBucketAccess: "string",
    piAffinityPolicy: "string",
    piImageBucketFileName: "string",
    piAntiAffinityInstances: ["string"],
    piImageId: "string",
    piImageImportDetails: {
        licenseType: "string",
        product: "string",
        vendor: "string",
    },
    piImageName: "string",
    piImageSecretKey: "string",
    piImageStoragePool: "string",
    piImageStorageType: "string",
    piUserTags: ["string"],
    timeouts: {
        create: "string",
        "delete": "string",
        update: "string",
    },
});
Copy
type: ibm:PiImage
properties:
    ibmPiImageId: string
    piAffinityInstance: string
    piAffinityPolicy: string
    piAffinityVolume: string
    piAntiAffinityInstances:
        - string
    piAntiAffinityVolumes:
        - string
    piCloudInstanceId: string
    piImageAccessKey: string
    piImageBucketAccess: string
    piImageBucketFileName: string
    piImageBucketName: string
    piImageBucketRegion: string
    piImageId: string
    piImageImportDetails:
        licenseType: string
        product: string
        vendor: string
    piImageName: string
    piImageSecretKey: string
    piImageStoragePool: string
    piImageStorageType: string
    piUserTags:
        - string
    timeouts:
        create: string
        delete: string
        update: string
Copy

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

PiCloudInstanceId This property is required. string
The GUID of the service instance associated with an account.
IbmPiImageId string
(String) The unique identifier of an image. The ID is composed of <pi_cloud_instance_id>/<image_id>.
PiAffinityInstance string
PVM Instance (ID or Name) to base storage affinity policy against; required if requesting affinity and pi_affinity_volume is not provided.
PiAffinityPolicy string
Affinity policy for image; ignored if pi_image_storage_pool provided; for policy affinity requires one of pi_affinity_instance or pi_affinity_volume to be specified; for policy anti-affinity requires one of pi_anti_affinity_instances or pi_anti_affinity_volumes to be specified; Allowable values: affinity, anti-affinity
PiAffinityVolume string
Volume (ID or Name) to base storage affinity policy against; required if requesting affinity and pi_affinity_instance is not provided.
PiAntiAffinityInstances List<string>
List of pvmInstances to base storage anti-affinity policy against; required if requesting anti-affinity and pi_anti_affinity_volumes is not provided.
PiAntiAffinityVolumes List<string>
List of volumes to base storage anti-affinity policy against; required if requesting anti-affinity and pi_anti_affinity_instances is not provided.
PiImageAccessKey string
Cloud Object Storage access key; required for buckets with private access.
PiImageBucketAccess string
Indicates if the bucket has public or private access. The default value is public.
PiImageBucketFileName string
Cloud Object Storage image filename
PiImageBucketName string
Cloud Object Storage bucket name; bucket-name[/optional/folder]

  • Either pi_image_bucket_name or pi_image_id is required.
PiImageBucketRegion string
Cloud Object Storage region. Supported COS regions are: au-syd, br-sao, ca-tor, che01, eu-de, eu-es, eu-gb, jp-osa, jp-tok, us-east, us-south.
PiImageId string
Image ID of existing source image; required for copy image.

  • Either pi_image_id or pi_image_bucket_name is required.
  • You can retrieve this value from pi_catalog_images as image_id from the stock image you intend to use.
PiImageImportDetails PiImagePiImageImportDetails
Import details for SAP images Nested schema for pi_image_import_details:
PiImageName string
The name of an image for importing only. Required if importing from bucket. Conflicts with pi_image_id.
PiImageSecretKey string
Cloud Object Storage secret key; required for buckets with private access.
PiImageStoragePool string
Storage pool where the image will be loaded, if provided then pi_affinity_policy will be ignored. Used only when importing an image from cloud storage.
PiImageStorageType string
Type of storage; If not provided the storage type will default to 'tier3'. Used only when importing an image from cloud storage. To get a list of available storage types, please use the ibm.getPiStorageTypesCapacity data source.
PiUserTags List<string>
The user tags attached to this resource.
Timeouts PiImageTimeouts
PiCloudInstanceId This property is required. string
The GUID of the service instance associated with an account.
IbmPiImageId string
(String) The unique identifier of an image. The ID is composed of <pi_cloud_instance_id>/<image_id>.
PiAffinityInstance string
PVM Instance (ID or Name) to base storage affinity policy against; required if requesting affinity and pi_affinity_volume is not provided.
PiAffinityPolicy string
Affinity policy for image; ignored if pi_image_storage_pool provided; for policy affinity requires one of pi_affinity_instance or pi_affinity_volume to be specified; for policy anti-affinity requires one of pi_anti_affinity_instances or pi_anti_affinity_volumes to be specified; Allowable values: affinity, anti-affinity
PiAffinityVolume string
Volume (ID or Name) to base storage affinity policy against; required if requesting affinity and pi_affinity_instance is not provided.
PiAntiAffinityInstances []string
List of pvmInstances to base storage anti-affinity policy against; required if requesting anti-affinity and pi_anti_affinity_volumes is not provided.
PiAntiAffinityVolumes []string
List of volumes to base storage anti-affinity policy against; required if requesting anti-affinity and pi_anti_affinity_instances is not provided.
PiImageAccessKey string
Cloud Object Storage access key; required for buckets with private access.
PiImageBucketAccess string
Indicates if the bucket has public or private access. The default value is public.
PiImageBucketFileName string
Cloud Object Storage image filename
PiImageBucketName string
Cloud Object Storage bucket name; bucket-name[/optional/folder]

  • Either pi_image_bucket_name or pi_image_id is required.
PiImageBucketRegion string
Cloud Object Storage region. Supported COS regions are: au-syd, br-sao, ca-tor, che01, eu-de, eu-es, eu-gb, jp-osa, jp-tok, us-east, us-south.
PiImageId string
Image ID of existing source image; required for copy image.

  • Either pi_image_id or pi_image_bucket_name is required.
  • You can retrieve this value from pi_catalog_images as image_id from the stock image you intend to use.
PiImageImportDetails PiImagePiImageImportDetailsArgs
Import details for SAP images Nested schema for pi_image_import_details:
PiImageName string
The name of an image for importing only. Required if importing from bucket. Conflicts with pi_image_id.
PiImageSecretKey string
Cloud Object Storage secret key; required for buckets with private access.
PiImageStoragePool string
Storage pool where the image will be loaded, if provided then pi_affinity_policy will be ignored. Used only when importing an image from cloud storage.
PiImageStorageType string
Type of storage; If not provided the storage type will default to 'tier3'. Used only when importing an image from cloud storage. To get a list of available storage types, please use the ibm.getPiStorageTypesCapacity data source.
PiUserTags []string
The user tags attached to this resource.
Timeouts PiImageTimeoutsArgs
piCloudInstanceId This property is required. String
The GUID of the service instance associated with an account.
ibmPiImageId String
(String) The unique identifier of an image. The ID is composed of <pi_cloud_instance_id>/<image_id>.
piAffinityInstance String
PVM Instance (ID or Name) to base storage affinity policy against; required if requesting affinity and pi_affinity_volume is not provided.
piAffinityPolicy String
Affinity policy for image; ignored if pi_image_storage_pool provided; for policy affinity requires one of pi_affinity_instance or pi_affinity_volume to be specified; for policy anti-affinity requires one of pi_anti_affinity_instances or pi_anti_affinity_volumes to be specified; Allowable values: affinity, anti-affinity
piAffinityVolume String
Volume (ID or Name) to base storage affinity policy against; required if requesting affinity and pi_affinity_instance is not provided.
piAntiAffinityInstances List<String>
List of pvmInstances to base storage anti-affinity policy against; required if requesting anti-affinity and pi_anti_affinity_volumes is not provided.
piAntiAffinityVolumes List<String>
List of volumes to base storage anti-affinity policy against; required if requesting anti-affinity and pi_anti_affinity_instances is not provided.
piImageAccessKey String
Cloud Object Storage access key; required for buckets with private access.
piImageBucketAccess String
Indicates if the bucket has public or private access. The default value is public.
piImageBucketFileName String
Cloud Object Storage image filename
piImageBucketName String
Cloud Object Storage bucket name; bucket-name[/optional/folder]

  • Either pi_image_bucket_name or pi_image_id is required.
piImageBucketRegion String
Cloud Object Storage region. Supported COS regions are: au-syd, br-sao, ca-tor, che01, eu-de, eu-es, eu-gb, jp-osa, jp-tok, us-east, us-south.
piImageId String
Image ID of existing source image; required for copy image.

  • Either pi_image_id or pi_image_bucket_name is required.
  • You can retrieve this value from pi_catalog_images as image_id from the stock image you intend to use.
piImageImportDetails PiImagePiImageImportDetails
Import details for SAP images Nested schema for pi_image_import_details:
piImageName String
The name of an image for importing only. Required if importing from bucket. Conflicts with pi_image_id.
piImageSecretKey String
Cloud Object Storage secret key; required for buckets with private access.
piImageStoragePool String
Storage pool where the image will be loaded, if provided then pi_affinity_policy will be ignored. Used only when importing an image from cloud storage.
piImageStorageType String
Type of storage; If not provided the storage type will default to 'tier3'. Used only when importing an image from cloud storage. To get a list of available storage types, please use the ibm.getPiStorageTypesCapacity data source.
piUserTags List<String>
The user tags attached to this resource.
timeouts PiImageTimeouts
piCloudInstanceId This property is required. string
The GUID of the service instance associated with an account.
ibmPiImageId string
(String) The unique identifier of an image. The ID is composed of <pi_cloud_instance_id>/<image_id>.
piAffinityInstance string
PVM Instance (ID or Name) to base storage affinity policy against; required if requesting affinity and pi_affinity_volume is not provided.
piAffinityPolicy string
Affinity policy for image; ignored if pi_image_storage_pool provided; for policy affinity requires one of pi_affinity_instance or pi_affinity_volume to be specified; for policy anti-affinity requires one of pi_anti_affinity_instances or pi_anti_affinity_volumes to be specified; Allowable values: affinity, anti-affinity
piAffinityVolume string
Volume (ID or Name) to base storage affinity policy against; required if requesting affinity and pi_affinity_instance is not provided.
piAntiAffinityInstances string[]
List of pvmInstances to base storage anti-affinity policy against; required if requesting anti-affinity and pi_anti_affinity_volumes is not provided.
piAntiAffinityVolumes string[]
List of volumes to base storage anti-affinity policy against; required if requesting anti-affinity and pi_anti_affinity_instances is not provided.
piImageAccessKey string
Cloud Object Storage access key; required for buckets with private access.
piImageBucketAccess string
Indicates if the bucket has public or private access. The default value is public.
piImageBucketFileName string
Cloud Object Storage image filename
piImageBucketName string
Cloud Object Storage bucket name; bucket-name[/optional/folder]

  • Either pi_image_bucket_name or pi_image_id is required.
piImageBucketRegion string
Cloud Object Storage region. Supported COS regions are: au-syd, br-sao, ca-tor, che01, eu-de, eu-es, eu-gb, jp-osa, jp-tok, us-east, us-south.
piImageId string
Image ID of existing source image; required for copy image.

  • Either pi_image_id or pi_image_bucket_name is required.
  • You can retrieve this value from pi_catalog_images as image_id from the stock image you intend to use.
piImageImportDetails PiImagePiImageImportDetails
Import details for SAP images Nested schema for pi_image_import_details:
piImageName string
The name of an image for importing only. Required if importing from bucket. Conflicts with pi_image_id.
piImageSecretKey string
Cloud Object Storage secret key; required for buckets with private access.
piImageStoragePool string
Storage pool where the image will be loaded, if provided then pi_affinity_policy will be ignored. Used only when importing an image from cloud storage.
piImageStorageType string
Type of storage; If not provided the storage type will default to 'tier3'. Used only when importing an image from cloud storage. To get a list of available storage types, please use the ibm.getPiStorageTypesCapacity data source.
piUserTags string[]
The user tags attached to this resource.
timeouts PiImageTimeouts
pi_cloud_instance_id This property is required. str
The GUID of the service instance associated with an account.
ibm_pi_image_id str
(String) The unique identifier of an image. The ID is composed of <pi_cloud_instance_id>/<image_id>.
pi_affinity_instance str
PVM Instance (ID or Name) to base storage affinity policy against; required if requesting affinity and pi_affinity_volume is not provided.
pi_affinity_policy str
Affinity policy for image; ignored if pi_image_storage_pool provided; for policy affinity requires one of pi_affinity_instance or pi_affinity_volume to be specified; for policy anti-affinity requires one of pi_anti_affinity_instances or pi_anti_affinity_volumes to be specified; Allowable values: affinity, anti-affinity
pi_affinity_volume str
Volume (ID or Name) to base storage affinity policy against; required if requesting affinity and pi_affinity_instance is not provided.
pi_anti_affinity_instances Sequence[str]
List of pvmInstances to base storage anti-affinity policy against; required if requesting anti-affinity and pi_anti_affinity_volumes is not provided.
pi_anti_affinity_volumes Sequence[str]
List of volumes to base storage anti-affinity policy against; required if requesting anti-affinity and pi_anti_affinity_instances is not provided.
pi_image_access_key str
Cloud Object Storage access key; required for buckets with private access.
pi_image_bucket_access str
Indicates if the bucket has public or private access. The default value is public.
pi_image_bucket_file_name str
Cloud Object Storage image filename
pi_image_bucket_name str
Cloud Object Storage bucket name; bucket-name[/optional/folder]

  • Either pi_image_bucket_name or pi_image_id is required.
pi_image_bucket_region str
Cloud Object Storage region. Supported COS regions are: au-syd, br-sao, ca-tor, che01, eu-de, eu-es, eu-gb, jp-osa, jp-tok, us-east, us-south.
pi_image_id str
Image ID of existing source image; required for copy image.

  • Either pi_image_id or pi_image_bucket_name is required.
  • You can retrieve this value from pi_catalog_images as image_id from the stock image you intend to use.
pi_image_import_details PiImagePiImageImportDetailsArgs
Import details for SAP images Nested schema for pi_image_import_details:
pi_image_name str
The name of an image for importing only. Required if importing from bucket. Conflicts with pi_image_id.
pi_image_secret_key str
Cloud Object Storage secret key; required for buckets with private access.
pi_image_storage_pool str
Storage pool where the image will be loaded, if provided then pi_affinity_policy will be ignored. Used only when importing an image from cloud storage.
pi_image_storage_type str
Type of storage; If not provided the storage type will default to 'tier3'. Used only when importing an image from cloud storage. To get a list of available storage types, please use the ibm.getPiStorageTypesCapacity data source.
pi_user_tags Sequence[str]
The user tags attached to this resource.
timeouts PiImageTimeoutsArgs
piCloudInstanceId This property is required. String
The GUID of the service instance associated with an account.
ibmPiImageId String
(String) The unique identifier of an image. The ID is composed of <pi_cloud_instance_id>/<image_id>.
piAffinityInstance String
PVM Instance (ID or Name) to base storage affinity policy against; required if requesting affinity and pi_affinity_volume is not provided.
piAffinityPolicy String
Affinity policy for image; ignored if pi_image_storage_pool provided; for policy affinity requires one of pi_affinity_instance or pi_affinity_volume to be specified; for policy anti-affinity requires one of pi_anti_affinity_instances or pi_anti_affinity_volumes to be specified; Allowable values: affinity, anti-affinity
piAffinityVolume String
Volume (ID or Name) to base storage affinity policy against; required if requesting affinity and pi_affinity_instance is not provided.
piAntiAffinityInstances List<String>
List of pvmInstances to base storage anti-affinity policy against; required if requesting anti-affinity and pi_anti_affinity_volumes is not provided.
piAntiAffinityVolumes List<String>
List of volumes to base storage anti-affinity policy against; required if requesting anti-affinity and pi_anti_affinity_instances is not provided.
piImageAccessKey String
Cloud Object Storage access key; required for buckets with private access.
piImageBucketAccess String
Indicates if the bucket has public or private access. The default value is public.
piImageBucketFileName String
Cloud Object Storage image filename
piImageBucketName String
Cloud Object Storage bucket name; bucket-name[/optional/folder]

  • Either pi_image_bucket_name or pi_image_id is required.
piImageBucketRegion String
Cloud Object Storage region. Supported COS regions are: au-syd, br-sao, ca-tor, che01, eu-de, eu-es, eu-gb, jp-osa, jp-tok, us-east, us-south.
piImageId String
Image ID of existing source image; required for copy image.

  • Either pi_image_id or pi_image_bucket_name is required.
  • You can retrieve this value from pi_catalog_images as image_id from the stock image you intend to use.
piImageImportDetails Property Map
Import details for SAP images Nested schema for pi_image_import_details:
piImageName String
The name of an image for importing only. Required if importing from bucket. Conflicts with pi_image_id.
piImageSecretKey String
Cloud Object Storage secret key; required for buckets with private access.
piImageStoragePool String
Storage pool where the image will be loaded, if provided then pi_affinity_policy will be ignored. Used only when importing an image from cloud storage.
piImageStorageType String
Type of storage; If not provided the storage type will default to 'tier3'. Used only when importing an image from cloud storage. To get a list of available storage types, please use the ibm.getPiStorageTypesCapacity data source.
piUserTags List<String>
The user tags attached to this resource.
timeouts Property Map

Outputs

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

Crn string
(String) The CRN of this resource.
Id string
The provider-assigned unique ID for this managed resource.
ImageId string
(String) The unique identifier of an image.
Crn string
(String) The CRN of this resource.
Id string
The provider-assigned unique ID for this managed resource.
ImageId string
(String) The unique identifier of an image.
crn String
(String) The CRN of this resource.
id String
The provider-assigned unique ID for this managed resource.
imageId String
(String) The unique identifier of an image.
crn string
(String) The CRN of this resource.
id string
The provider-assigned unique ID for this managed resource.
imageId string
(String) The unique identifier of an image.
crn str
(String) The CRN of this resource.
id str
The provider-assigned unique ID for this managed resource.
image_id str
(String) The unique identifier of an image.
crn String
(String) The CRN of this resource.
id String
The provider-assigned unique ID for this managed resource.
imageId String
(String) The unique identifier of an image.

Look up Existing PiImage Resource

Get an existing PiImage 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?: PiImageState, opts?: CustomResourceOptions): PiImage
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        crn: Optional[str] = None,
        ibm_pi_image_id: Optional[str] = None,
        image_id: Optional[str] = None,
        pi_affinity_instance: Optional[str] = None,
        pi_affinity_policy: Optional[str] = None,
        pi_affinity_volume: Optional[str] = None,
        pi_anti_affinity_instances: Optional[Sequence[str]] = None,
        pi_anti_affinity_volumes: Optional[Sequence[str]] = None,
        pi_cloud_instance_id: Optional[str] = None,
        pi_image_access_key: Optional[str] = None,
        pi_image_bucket_access: Optional[str] = None,
        pi_image_bucket_file_name: Optional[str] = None,
        pi_image_bucket_name: Optional[str] = None,
        pi_image_bucket_region: Optional[str] = None,
        pi_image_id: Optional[str] = None,
        pi_image_import_details: Optional[PiImagePiImageImportDetailsArgs] = None,
        pi_image_name: Optional[str] = None,
        pi_image_secret_key: Optional[str] = None,
        pi_image_storage_pool: Optional[str] = None,
        pi_image_storage_type: Optional[str] = None,
        pi_user_tags: Optional[Sequence[str]] = None,
        timeouts: Optional[PiImageTimeoutsArgs] = None) -> PiImage
func GetPiImage(ctx *Context, name string, id IDInput, state *PiImageState, opts ...ResourceOption) (*PiImage, error)
public static PiImage Get(string name, Input<string> id, PiImageState? state, CustomResourceOptions? opts = null)
public static PiImage get(String name, Output<String> id, PiImageState state, CustomResourceOptions options)
resources:  _:    type: ibm:PiImage    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:
Crn string
(String) The CRN of this resource.
IbmPiImageId string
(String) The unique identifier of an image. The ID is composed of <pi_cloud_instance_id>/<image_id>.
ImageId string
(String) The unique identifier of an image.
PiAffinityInstance string
PVM Instance (ID or Name) to base storage affinity policy against; required if requesting affinity and pi_affinity_volume is not provided.
PiAffinityPolicy string
Affinity policy for image; ignored if pi_image_storage_pool provided; for policy affinity requires one of pi_affinity_instance or pi_affinity_volume to be specified; for policy anti-affinity requires one of pi_anti_affinity_instances or pi_anti_affinity_volumes to be specified; Allowable values: affinity, anti-affinity
PiAffinityVolume string
Volume (ID or Name) to base storage affinity policy against; required if requesting affinity and pi_affinity_instance is not provided.
PiAntiAffinityInstances List<string>
List of pvmInstances to base storage anti-affinity policy against; required if requesting anti-affinity and pi_anti_affinity_volumes is not provided.
PiAntiAffinityVolumes List<string>
List of volumes to base storage anti-affinity policy against; required if requesting anti-affinity and pi_anti_affinity_instances is not provided.
PiCloudInstanceId string
The GUID of the service instance associated with an account.
PiImageAccessKey string
Cloud Object Storage access key; required for buckets with private access.
PiImageBucketAccess string
Indicates if the bucket has public or private access. The default value is public.
PiImageBucketFileName string
Cloud Object Storage image filename
PiImageBucketName string
Cloud Object Storage bucket name; bucket-name[/optional/folder]

  • Either pi_image_bucket_name or pi_image_id is required.
PiImageBucketRegion string
Cloud Object Storage region. Supported COS regions are: au-syd, br-sao, ca-tor, che01, eu-de, eu-es, eu-gb, jp-osa, jp-tok, us-east, us-south.
PiImageId string
Image ID of existing source image; required for copy image.

  • Either pi_image_id or pi_image_bucket_name is required.
  • You can retrieve this value from pi_catalog_images as image_id from the stock image you intend to use.
PiImageImportDetails PiImagePiImageImportDetails
Import details for SAP images Nested schema for pi_image_import_details:
PiImageName string
The name of an image for importing only. Required if importing from bucket. Conflicts with pi_image_id.
PiImageSecretKey string
Cloud Object Storage secret key; required for buckets with private access.
PiImageStoragePool string
Storage pool where the image will be loaded, if provided then pi_affinity_policy will be ignored. Used only when importing an image from cloud storage.
PiImageStorageType string
Type of storage; If not provided the storage type will default to 'tier3'. Used only when importing an image from cloud storage. To get a list of available storage types, please use the ibm.getPiStorageTypesCapacity data source.
PiUserTags List<string>
The user tags attached to this resource.
Timeouts PiImageTimeouts
Crn string
(String) The CRN of this resource.
IbmPiImageId string
(String) The unique identifier of an image. The ID is composed of <pi_cloud_instance_id>/<image_id>.
ImageId string
(String) The unique identifier of an image.
PiAffinityInstance string
PVM Instance (ID or Name) to base storage affinity policy against; required if requesting affinity and pi_affinity_volume is not provided.
PiAffinityPolicy string
Affinity policy for image; ignored if pi_image_storage_pool provided; for policy affinity requires one of pi_affinity_instance or pi_affinity_volume to be specified; for policy anti-affinity requires one of pi_anti_affinity_instances or pi_anti_affinity_volumes to be specified; Allowable values: affinity, anti-affinity
PiAffinityVolume string
Volume (ID or Name) to base storage affinity policy against; required if requesting affinity and pi_affinity_instance is not provided.
PiAntiAffinityInstances []string
List of pvmInstances to base storage anti-affinity policy against; required if requesting anti-affinity and pi_anti_affinity_volumes is not provided.
PiAntiAffinityVolumes []string
List of volumes to base storage anti-affinity policy against; required if requesting anti-affinity and pi_anti_affinity_instances is not provided.
PiCloudInstanceId string
The GUID of the service instance associated with an account.
PiImageAccessKey string
Cloud Object Storage access key; required for buckets with private access.
PiImageBucketAccess string
Indicates if the bucket has public or private access. The default value is public.
PiImageBucketFileName string
Cloud Object Storage image filename
PiImageBucketName string
Cloud Object Storage bucket name; bucket-name[/optional/folder]

  • Either pi_image_bucket_name or pi_image_id is required.
PiImageBucketRegion string
Cloud Object Storage region. Supported COS regions are: au-syd, br-sao, ca-tor, che01, eu-de, eu-es, eu-gb, jp-osa, jp-tok, us-east, us-south.
PiImageId string
Image ID of existing source image; required for copy image.

  • Either pi_image_id or pi_image_bucket_name is required.
  • You can retrieve this value from pi_catalog_images as image_id from the stock image you intend to use.
PiImageImportDetails PiImagePiImageImportDetailsArgs
Import details for SAP images Nested schema for pi_image_import_details:
PiImageName string
The name of an image for importing only. Required if importing from bucket. Conflicts with pi_image_id.
PiImageSecretKey string
Cloud Object Storage secret key; required for buckets with private access.
PiImageStoragePool string
Storage pool where the image will be loaded, if provided then pi_affinity_policy will be ignored. Used only when importing an image from cloud storage.
PiImageStorageType string
Type of storage; If not provided the storage type will default to 'tier3'. Used only when importing an image from cloud storage. To get a list of available storage types, please use the ibm.getPiStorageTypesCapacity data source.
PiUserTags []string
The user tags attached to this resource.
Timeouts PiImageTimeoutsArgs
crn String
(String) The CRN of this resource.
ibmPiImageId String
(String) The unique identifier of an image. The ID is composed of <pi_cloud_instance_id>/<image_id>.
imageId String
(String) The unique identifier of an image.
piAffinityInstance String
PVM Instance (ID or Name) to base storage affinity policy against; required if requesting affinity and pi_affinity_volume is not provided.
piAffinityPolicy String
Affinity policy for image; ignored if pi_image_storage_pool provided; for policy affinity requires one of pi_affinity_instance or pi_affinity_volume to be specified; for policy anti-affinity requires one of pi_anti_affinity_instances or pi_anti_affinity_volumes to be specified; Allowable values: affinity, anti-affinity
piAffinityVolume String
Volume (ID or Name) to base storage affinity policy against; required if requesting affinity and pi_affinity_instance is not provided.
piAntiAffinityInstances List<String>
List of pvmInstances to base storage anti-affinity policy against; required if requesting anti-affinity and pi_anti_affinity_volumes is not provided.
piAntiAffinityVolumes List<String>
List of volumes to base storage anti-affinity policy against; required if requesting anti-affinity and pi_anti_affinity_instances is not provided.
piCloudInstanceId String
The GUID of the service instance associated with an account.
piImageAccessKey String
Cloud Object Storage access key; required for buckets with private access.
piImageBucketAccess String
Indicates if the bucket has public or private access. The default value is public.
piImageBucketFileName String
Cloud Object Storage image filename
piImageBucketName String
Cloud Object Storage bucket name; bucket-name[/optional/folder]

  • Either pi_image_bucket_name or pi_image_id is required.
piImageBucketRegion String
Cloud Object Storage region. Supported COS regions are: au-syd, br-sao, ca-tor, che01, eu-de, eu-es, eu-gb, jp-osa, jp-tok, us-east, us-south.
piImageId String
Image ID of existing source image; required for copy image.

  • Either pi_image_id or pi_image_bucket_name is required.
  • You can retrieve this value from pi_catalog_images as image_id from the stock image you intend to use.
piImageImportDetails PiImagePiImageImportDetails
Import details for SAP images Nested schema for pi_image_import_details:
piImageName String
The name of an image for importing only. Required if importing from bucket. Conflicts with pi_image_id.
piImageSecretKey String
Cloud Object Storage secret key; required for buckets with private access.
piImageStoragePool String
Storage pool where the image will be loaded, if provided then pi_affinity_policy will be ignored. Used only when importing an image from cloud storage.
piImageStorageType String
Type of storage; If not provided the storage type will default to 'tier3'. Used only when importing an image from cloud storage. To get a list of available storage types, please use the ibm.getPiStorageTypesCapacity data source.
piUserTags List<String>
The user tags attached to this resource.
timeouts PiImageTimeouts
crn string
(String) The CRN of this resource.
ibmPiImageId string
(String) The unique identifier of an image. The ID is composed of <pi_cloud_instance_id>/<image_id>.
imageId string
(String) The unique identifier of an image.
piAffinityInstance string
PVM Instance (ID or Name) to base storage affinity policy against; required if requesting affinity and pi_affinity_volume is not provided.
piAffinityPolicy string
Affinity policy for image; ignored if pi_image_storage_pool provided; for policy affinity requires one of pi_affinity_instance or pi_affinity_volume to be specified; for policy anti-affinity requires one of pi_anti_affinity_instances or pi_anti_affinity_volumes to be specified; Allowable values: affinity, anti-affinity
piAffinityVolume string
Volume (ID or Name) to base storage affinity policy against; required if requesting affinity and pi_affinity_instance is not provided.
piAntiAffinityInstances string[]
List of pvmInstances to base storage anti-affinity policy against; required if requesting anti-affinity and pi_anti_affinity_volumes is not provided.
piAntiAffinityVolumes string[]
List of volumes to base storage anti-affinity policy against; required if requesting anti-affinity and pi_anti_affinity_instances is not provided.
piCloudInstanceId string
The GUID of the service instance associated with an account.
piImageAccessKey string
Cloud Object Storage access key; required for buckets with private access.
piImageBucketAccess string
Indicates if the bucket has public or private access. The default value is public.
piImageBucketFileName string
Cloud Object Storage image filename
piImageBucketName string
Cloud Object Storage bucket name; bucket-name[/optional/folder]

  • Either pi_image_bucket_name or pi_image_id is required.
piImageBucketRegion string
Cloud Object Storage region. Supported COS regions are: au-syd, br-sao, ca-tor, che01, eu-de, eu-es, eu-gb, jp-osa, jp-tok, us-east, us-south.
piImageId string
Image ID of existing source image; required for copy image.

  • Either pi_image_id or pi_image_bucket_name is required.
  • You can retrieve this value from pi_catalog_images as image_id from the stock image you intend to use.
piImageImportDetails PiImagePiImageImportDetails
Import details for SAP images Nested schema for pi_image_import_details:
piImageName string
The name of an image for importing only. Required if importing from bucket. Conflicts with pi_image_id.
piImageSecretKey string
Cloud Object Storage secret key; required for buckets with private access.
piImageStoragePool string
Storage pool where the image will be loaded, if provided then pi_affinity_policy will be ignored. Used only when importing an image from cloud storage.
piImageStorageType string
Type of storage; If not provided the storage type will default to 'tier3'. Used only when importing an image from cloud storage. To get a list of available storage types, please use the ibm.getPiStorageTypesCapacity data source.
piUserTags string[]
The user tags attached to this resource.
timeouts PiImageTimeouts
crn str
(String) The CRN of this resource.
ibm_pi_image_id str
(String) The unique identifier of an image. The ID is composed of <pi_cloud_instance_id>/<image_id>.
image_id str
(String) The unique identifier of an image.
pi_affinity_instance str
PVM Instance (ID or Name) to base storage affinity policy against; required if requesting affinity and pi_affinity_volume is not provided.
pi_affinity_policy str
Affinity policy for image; ignored if pi_image_storage_pool provided; for policy affinity requires one of pi_affinity_instance or pi_affinity_volume to be specified; for policy anti-affinity requires one of pi_anti_affinity_instances or pi_anti_affinity_volumes to be specified; Allowable values: affinity, anti-affinity
pi_affinity_volume str
Volume (ID or Name) to base storage affinity policy against; required if requesting affinity and pi_affinity_instance is not provided.
pi_anti_affinity_instances Sequence[str]
List of pvmInstances to base storage anti-affinity policy against; required if requesting anti-affinity and pi_anti_affinity_volumes is not provided.
pi_anti_affinity_volumes Sequence[str]
List of volumes to base storage anti-affinity policy against; required if requesting anti-affinity and pi_anti_affinity_instances is not provided.
pi_cloud_instance_id str
The GUID of the service instance associated with an account.
pi_image_access_key str
Cloud Object Storage access key; required for buckets with private access.
pi_image_bucket_access str
Indicates if the bucket has public or private access. The default value is public.
pi_image_bucket_file_name str
Cloud Object Storage image filename
pi_image_bucket_name str
Cloud Object Storage bucket name; bucket-name[/optional/folder]

  • Either pi_image_bucket_name or pi_image_id is required.
pi_image_bucket_region str
Cloud Object Storage region. Supported COS regions are: au-syd, br-sao, ca-tor, che01, eu-de, eu-es, eu-gb, jp-osa, jp-tok, us-east, us-south.
pi_image_id str
Image ID of existing source image; required for copy image.

  • Either pi_image_id or pi_image_bucket_name is required.
  • You can retrieve this value from pi_catalog_images as image_id from the stock image you intend to use.
pi_image_import_details PiImagePiImageImportDetailsArgs
Import details for SAP images Nested schema for pi_image_import_details:
pi_image_name str
The name of an image for importing only. Required if importing from bucket. Conflicts with pi_image_id.
pi_image_secret_key str
Cloud Object Storage secret key; required for buckets with private access.
pi_image_storage_pool str
Storage pool where the image will be loaded, if provided then pi_affinity_policy will be ignored. Used only when importing an image from cloud storage.
pi_image_storage_type str
Type of storage; If not provided the storage type will default to 'tier3'. Used only when importing an image from cloud storage. To get a list of available storage types, please use the ibm.getPiStorageTypesCapacity data source.
pi_user_tags Sequence[str]
The user tags attached to this resource.
timeouts PiImageTimeoutsArgs
crn String
(String) The CRN of this resource.
ibmPiImageId String
(String) The unique identifier of an image. The ID is composed of <pi_cloud_instance_id>/<image_id>.
imageId String
(String) The unique identifier of an image.
piAffinityInstance String
PVM Instance (ID or Name) to base storage affinity policy against; required if requesting affinity and pi_affinity_volume is not provided.
piAffinityPolicy String
Affinity policy for image; ignored if pi_image_storage_pool provided; for policy affinity requires one of pi_affinity_instance or pi_affinity_volume to be specified; for policy anti-affinity requires one of pi_anti_affinity_instances or pi_anti_affinity_volumes to be specified; Allowable values: affinity, anti-affinity
piAffinityVolume String
Volume (ID or Name) to base storage affinity policy against; required if requesting affinity and pi_affinity_instance is not provided.
piAntiAffinityInstances List<String>
List of pvmInstances to base storage anti-affinity policy against; required if requesting anti-affinity and pi_anti_affinity_volumes is not provided.
piAntiAffinityVolumes List<String>
List of volumes to base storage anti-affinity policy against; required if requesting anti-affinity and pi_anti_affinity_instances is not provided.
piCloudInstanceId String
The GUID of the service instance associated with an account.
piImageAccessKey String
Cloud Object Storage access key; required for buckets with private access.
piImageBucketAccess String
Indicates if the bucket has public or private access. The default value is public.
piImageBucketFileName String
Cloud Object Storage image filename
piImageBucketName String
Cloud Object Storage bucket name; bucket-name[/optional/folder]

  • Either pi_image_bucket_name or pi_image_id is required.
piImageBucketRegion String
Cloud Object Storage region. Supported COS regions are: au-syd, br-sao, ca-tor, che01, eu-de, eu-es, eu-gb, jp-osa, jp-tok, us-east, us-south.
piImageId String
Image ID of existing source image; required for copy image.

  • Either pi_image_id or pi_image_bucket_name is required.
  • You can retrieve this value from pi_catalog_images as image_id from the stock image you intend to use.
piImageImportDetails Property Map
Import details for SAP images Nested schema for pi_image_import_details:
piImageName String
The name of an image for importing only. Required if importing from bucket. Conflicts with pi_image_id.
piImageSecretKey String
Cloud Object Storage secret key; required for buckets with private access.
piImageStoragePool String
Storage pool where the image will be loaded, if provided then pi_affinity_policy will be ignored. Used only when importing an image from cloud storage.
piImageStorageType String
Type of storage; If not provided the storage type will default to 'tier3'. Used only when importing an image from cloud storage. To get a list of available storage types, please use the ibm.getPiStorageTypesCapacity data source.
piUserTags List<String>
The user tags attached to this resource.
timeouts Property Map

Supporting Types

PiImagePiImageImportDetails
, PiImagePiImageImportDetailsArgs

LicenseType This property is required. string
Origin of the license of the product. Allowable value is: byol.
Product This property is required. string
Product within the image.Allowable values are: Hana, Netweaver.
Vendor This property is required. string
Vendor supporting the product. Allowable value is: SAP.
LicenseType This property is required. string
Origin of the license of the product. Allowable value is: byol.
Product This property is required. string
Product within the image.Allowable values are: Hana, Netweaver.
Vendor This property is required. string
Vendor supporting the product. Allowable value is: SAP.
licenseType This property is required. String
Origin of the license of the product. Allowable value is: byol.
product This property is required. String
Product within the image.Allowable values are: Hana, Netweaver.
vendor This property is required. String
Vendor supporting the product. Allowable value is: SAP.
licenseType This property is required. string
Origin of the license of the product. Allowable value is: byol.
product This property is required. string
Product within the image.Allowable values are: Hana, Netweaver.
vendor This property is required. string
Vendor supporting the product. Allowable value is: SAP.
license_type This property is required. str
Origin of the license of the product. Allowable value is: byol.
product This property is required. str
Product within the image.Allowable values are: Hana, Netweaver.
vendor This property is required. str
Vendor supporting the product. Allowable value is: SAP.
licenseType This property is required. String
Origin of the license of the product. Allowable value is: byol.
product This property is required. String
Product within the image.Allowable values are: Hana, Netweaver.
vendor This property is required. String
Vendor supporting the product. Allowable value is: SAP.

PiImageTimeouts
, PiImageTimeoutsArgs

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

Example

bash

$ pulumi import ibm:index/piImage:PiImage example d7bec597-4726-451f-8a63-e62e6f19c32c/cea6651a-bc0a-4438-9f8a-a0770bbf3ebb
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