Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Ibm Provider
  3. API Docs
  4. PiCapture
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

ibm.PiCapture

Explore with Pulumi AI

ibm logo
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

    Create or delete for Capture Power System Virtual Server Instance

    Note: If pi_capture_destination is Cloud-Storage then delete bucket object functionality not supported by this resource , hence user need to delete bucket object manually from Cloud Storage bucket.

    For more information, about IBM power virtual server cloud, see getting started with IBM Power Systems Virtual Servers.

    Example Usage

    The following example creates a Capture Power System Virtual Server Instance.

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

const testCapture = new ibm.PiCapture("testCapture", {
    piCaptureDestination: "image-catalog",
    piCaptureName: "terraform-test-capture",
    piCloudInstanceId: "49fba6c9-23f8-40bc-9899-aca322ee7d5b",
    piInstanceName: "terraform-test-instance",
});

    import pulumi
import pulumi_ibm as ibm

test_capture = ibm.PiCapture("testCapture",
    pi_capture_destination="image-catalog",
    pi_capture_name="terraform-test-capture",
    pi_cloud_instance_id="49fba6c9-23f8-40bc-9899-aca322ee7d5b",
    pi_instance_name="terraform-test-instance")

    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.NewPiCapture(ctx, "testCapture", &ibm.PiCaptureArgs{
			PiCaptureDestination: pulumi.String("image-catalog"),
			PiCaptureName:        pulumi.String("terraform-test-capture"),
			PiCloudInstanceId:    pulumi.String("49fba6c9-23f8-40bc-9899-aca322ee7d5b"),
			PiInstanceName:       pulumi.String("terraform-test-instance"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;

return await Deployment.RunAsync(() => 
{
    var testCapture = new Ibm.PiCapture("testCapture", new()
    {
        PiCaptureDestination = "image-catalog",
        PiCaptureName = "terraform-test-capture",
        PiCloudInstanceId = "49fba6c9-23f8-40bc-9899-aca322ee7d5b",
        PiInstanceName = "terraform-test-instance",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.PiCapture;
import com.pulumi.ibm.PiCaptureArgs;
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 testCapture = new PiCapture("testCapture", PiCaptureArgs.builder()
            .piCaptureDestination("image-catalog")
            .piCaptureName("terraform-test-capture")
            .piCloudInstanceId("49fba6c9-23f8-40bc-9899-aca322ee7d5b")
            .piInstanceName("terraform-test-instance")
            .build());

    }
}

    resources:
  testCapture:
    type: ibm:PiCapture
    properties:
      piCaptureDestination: image-catalog
      piCaptureName: terraform-test-capture
      piCloudInstanceId: 49fba6c9-23f8-40bc-9899-aca322ee7d5b
      piInstanceName: terraform-test-instance

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

const testCapture = new ibm.PiCapture("testCapture", {
    piCaptureCloudStorageAccessKey: "<Cloud Storage Access key>",
    piCaptureCloudStorageRegion: "us-east",
    piCaptureCloudStorageSecretKey: "<Cloud Storage Secret key>",
    piCaptureDestination: "cloud-storage",
    piCaptureName: "test-capture",
    piCaptureStorageImagePath: "test-bucket",
    piCloudInstanceId: "49fba6c9-23f8-40bc-9899-aca322ee7d5b",
    piInstanceName: "test-vm",
});

    import pulumi
import pulumi_ibm as ibm

test_capture = ibm.PiCapture("testCapture",
    pi_capture_cloud_storage_access_key="<Cloud Storage Access key>",
    pi_capture_cloud_storage_region="us-east",
    pi_capture_cloud_storage_secret_key="<Cloud Storage Secret key>",
    pi_capture_destination="cloud-storage",
    pi_capture_name="test-capture",
    pi_capture_storage_image_path="test-bucket",
    pi_cloud_instance_id="49fba6c9-23f8-40bc-9899-aca322ee7d5b",
    pi_instance_name="test-vm")

    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.NewPiCapture(ctx, "testCapture", &ibm.PiCaptureArgs{
			PiCaptureCloudStorageAccessKey: pulumi.String("<Cloud Storage Access key>"),
			PiCaptureCloudStorageRegion:    pulumi.String("us-east"),
			PiCaptureCloudStorageSecretKey: pulumi.String("<Cloud Storage Secret key>"),
			PiCaptureDestination:           pulumi.String("cloud-storage"),
			PiCaptureName:                  pulumi.String("test-capture"),
			PiCaptureStorageImagePath:      pulumi.String("test-bucket"),
			PiCloudInstanceId:              pulumi.String("49fba6c9-23f8-40bc-9899-aca322ee7d5b"),
			PiInstanceName:                 pulumi.String("test-vm"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;

return await Deployment.RunAsync(() => 
{
    var testCapture = new Ibm.PiCapture("testCapture", new()
    {
        PiCaptureCloudStorageAccessKey = "<Cloud Storage Access key>",
        PiCaptureCloudStorageRegion = "us-east",
        PiCaptureCloudStorageSecretKey = "<Cloud Storage Secret key>",
        PiCaptureDestination = "cloud-storage",
        PiCaptureName = "test-capture",
        PiCaptureStorageImagePath = "test-bucket",
        PiCloudInstanceId = "49fba6c9-23f8-40bc-9899-aca322ee7d5b",
        PiInstanceName = "test-vm",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.PiCapture;
import com.pulumi.ibm.PiCaptureArgs;
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 testCapture = new PiCapture("testCapture", PiCaptureArgs.builder()
            .piCaptureCloudStorageAccessKey("<Cloud Storage Access key>")
            .piCaptureCloudStorageRegion("us-east")
            .piCaptureCloudStorageSecretKey("<Cloud Storage Secret key>")
            .piCaptureDestination("cloud-storage")
            .piCaptureName("test-capture")
            .piCaptureStorageImagePath("test-bucket")
            .piCloudInstanceId("49fba6c9-23f8-40bc-9899-aca322ee7d5b")
            .piInstanceName("test-vm")
            .build());

    }
}

    resources:
  testCapture:
    type: ibm:PiCapture
    properties:
      piCaptureCloudStorageAccessKey: <Cloud Storage Access key>
      piCaptureCloudStorageRegion: us-east
      piCaptureCloudStorageSecretKey: <Cloud Storage Secret key>
      piCaptureDestination: cloud-storage
      piCaptureName: test-capture
      piCaptureStorageImagePath: test-bucket
      piCloudInstanceId: 49fba6c9-23f8-40bc-9899-aca322ee7d5b
      piInstanceName: test-vm

    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";

    import pulumi

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;

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

    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) {
    }
}

    {}

    Create PiCapture Resource

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

    Constructor syntax

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

@overload
def PiCapture(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              pi_capture_destination: Optional[str] = None,
              pi_capture_name: Optional[str] = None,
              pi_cloud_instance_id: Optional[str] = None,
              pi_instance_name: Optional[str] = None,
              pi_capture_cloud_storage_access_key: Optional[str] = None,
              pi_capture_cloud_storage_region: Optional[str] = None,
              pi_capture_cloud_storage_secret_key: Optional[str] = None,
              pi_capture_id: Optional[str] = None,
              pi_capture_storage_image_path: Optional[str] = None,
              pi_capture_volume_ids: Optional[Sequence[str]] = None,
              pi_user_tags: Optional[Sequence[str]] = None,
              timeouts: Optional[PiCaptureTimeoutsArgs] = None)
    func NewPiCapture(ctx *Context, name string, args PiCaptureArgs, opts ...ResourceOption) (*PiCapture, error)
    public PiCapture(string name, PiCaptureArgs args, CustomResourceOptions? opts = null)
    public PiCapture(String name, PiCaptureArgs args)
public PiCapture(String name, PiCaptureArgs args, CustomResourceOptions options)

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

    Parameters

    name string
    The unique name of the resource.
    args PiCaptureArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args PiCaptureArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args PiCaptureArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PiCaptureArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PiCaptureArgs
    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 piCaptureResource = new Ibm.PiCapture("piCaptureResource", new()
{
    PiCaptureDestination = "string",
    PiCaptureName = "string",
    PiCloudInstanceId = "string",
    PiInstanceName = "string",
    PiCaptureCloudStorageAccessKey = "string",
    PiCaptureCloudStorageRegion = "string",
    PiCaptureCloudStorageSecretKey = "string",
    PiCaptureId = "string",
    PiCaptureStorageImagePath = "string",
    PiCaptureVolumeIds = new[]
    {
        "string",
    },
    PiUserTags = new[]
    {
        "string",
    },
    Timeouts = new Ibm.Inputs.PiCaptureTimeoutsArgs
    {
        Create = "string",
        Delete = "string",
        Update = "string",
    },
});

    example, err := ibm.NewPiCapture(ctx, "piCaptureResource", &ibm.PiCaptureArgs{
	PiCaptureDestination:           pulumi.String("string"),
	PiCaptureName:                  pulumi.String("string"),
	PiCloudInstanceId:              pulumi.String("string"),
	PiInstanceName:                 pulumi.String("string"),
	PiCaptureCloudStorageAccessKey: pulumi.String("string"),
	PiCaptureCloudStorageRegion:    pulumi.String("string"),
	PiCaptureCloudStorageSecretKey: pulumi.String("string"),
	PiCaptureId:                    pulumi.String("string"),
	PiCaptureStorageImagePath:      pulumi.String("string"),
	PiCaptureVolumeIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	PiUserTags: pulumi.StringArray{
		pulumi.String("string"),
	},
	Timeouts: &ibm.PiCaptureTimeoutsArgs{
		Create: pulumi.String("string"),
		Delete: pulumi.String("string"),
		Update: pulumi.String("string"),
	},
})

    var piCaptureResource = new PiCapture("piCaptureResource", PiCaptureArgs.builder()
    .piCaptureDestination("string")
    .piCaptureName("string")
    .piCloudInstanceId("string")
    .piInstanceName("string")
    .piCaptureCloudStorageAccessKey("string")
    .piCaptureCloudStorageRegion("string")
    .piCaptureCloudStorageSecretKey("string")
    .piCaptureId("string")
    .piCaptureStorageImagePath("string")
    .piCaptureVolumeIds("string")
    .piUserTags("string")
    .timeouts(PiCaptureTimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .update("string")
        .build())
    .build());

    pi_capture_resource = ibm.PiCapture("piCaptureResource",
    pi_capture_destination="string",
    pi_capture_name="string",
    pi_cloud_instance_id="string",
    pi_instance_name="string",
    pi_capture_cloud_storage_access_key="string",
    pi_capture_cloud_storage_region="string",
    pi_capture_cloud_storage_secret_key="string",
    pi_capture_id="string",
    pi_capture_storage_image_path="string",
    pi_capture_volume_ids=["string"],
    pi_user_tags=["string"],
    timeouts={
        "create": "string",
        "delete": "string",
        "update": "string",
    })

    const piCaptureResource = new ibm.PiCapture("piCaptureResource", {
    piCaptureDestination: "string",
    piCaptureName: "string",
    piCloudInstanceId: "string",
    piInstanceName: "string",
    piCaptureCloudStorageAccessKey: "string",
    piCaptureCloudStorageRegion: "string",
    piCaptureCloudStorageSecretKey: "string",
    piCaptureId: "string",
    piCaptureStorageImagePath: "string",
    piCaptureVolumeIds: ["string"],
    piUserTags: ["string"],
    timeouts: {
        create: "string",
        "delete": "string",
        update: "string",
    },
});

    type: ibm:PiCapture
properties:
    piCaptureCloudStorageAccessKey: string
    piCaptureCloudStorageRegion: string
    piCaptureCloudStorageSecretKey: string
    piCaptureDestination: string
    piCaptureId: string
    piCaptureName: string
    piCaptureStorageImagePath: string
    piCaptureVolumeIds:
        - string
    piCloudInstanceId: string
    piInstanceName: string
    piUserTags:
        - string
    timeouts:
        create: string
        delete: string
        update: string

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

    PiCaptureDestination string
    Destination for the deployable image.[image-catalog,cloud-storage,both]
    PiCaptureName string
    Name of the deployable image created for the captured PVMInstance.
    PiCloudInstanceId string
    The GUID of the service instance associated with an account.
    PiInstanceName string
    The name of the instance.
    PiCaptureCloudStorageAccessKey string
    Cloud Storage Access key
    PiCaptureCloudStorageRegion string
    The Cloud Object Storage region. Supported COS regions are: au-syd, br-sao, ca-tor, eu-de, eu-es, eu-gb, jp-osa, jp-tok, us-east, us-south.
    PiCaptureCloudStorageSecretKey string
    Cloud Storage Secret key
    PiCaptureId string
    (String) The image id of the instance capture. The ID is composed of <pi_cloud_instance_id>/<pi_capture_name>/<pi_capture_destination>.
    PiCaptureStorageImagePath string
    Cloud Storage Image Path (bucket-name [/folder/../..])
    PiCaptureVolumeIds List<string>
    List of Data volume IDs to include in the captured PVMInstance.
    PiUserTags List<string>
    List of user tags attached to the resource.
    Timeouts PiCaptureTimeouts
    PiCaptureDestination string
    Destination for the deployable image.[image-catalog,cloud-storage,both]
    PiCaptureName string
    Name of the deployable image created for the captured PVMInstance.
    PiCloudInstanceId string
    The GUID of the service instance associated with an account.
    PiInstanceName string
    The name of the instance.
    PiCaptureCloudStorageAccessKey string
    Cloud Storage Access key
    PiCaptureCloudStorageRegion string
    The Cloud Object Storage region. Supported COS regions are: au-syd, br-sao, ca-tor, eu-de, eu-es, eu-gb, jp-osa, jp-tok, us-east, us-south.
    PiCaptureCloudStorageSecretKey string
    Cloud Storage Secret key
    PiCaptureId string
    (String) The image id of the instance capture. The ID is composed of <pi_cloud_instance_id>/<pi_capture_name>/<pi_capture_destination>.
    PiCaptureStorageImagePath string
    Cloud Storage Image Path (bucket-name [/folder/../..])
    PiCaptureVolumeIds []string
    List of Data volume IDs to include in the captured PVMInstance.
    PiUserTags []string
    List of user tags attached to the resource.
    Timeouts PiCaptureTimeoutsArgs
    piCaptureDestination String
    Destination for the deployable image.[image-catalog,cloud-storage,both]
    piCaptureName String
    Name of the deployable image created for the captured PVMInstance.
    piCloudInstanceId String
    The GUID of the service instance associated with an account.
    piInstanceName String
    The name of the instance.
    piCaptureCloudStorageAccessKey String
    Cloud Storage Access key
    piCaptureCloudStorageRegion String
    The Cloud Object Storage region. Supported COS regions are: au-syd, br-sao, ca-tor, eu-de, eu-es, eu-gb, jp-osa, jp-tok, us-east, us-south.
    piCaptureCloudStorageSecretKey String
    Cloud Storage Secret key
    piCaptureId String
    (String) The image id of the instance capture. The ID is composed of <pi_cloud_instance_id>/<pi_capture_name>/<pi_capture_destination>.
    piCaptureStorageImagePath String
    Cloud Storage Image Path (bucket-name [/folder/../..])
    piCaptureVolumeIds List<String>
    List of Data volume IDs to include in the captured PVMInstance.
    piUserTags List<String>
    List of user tags attached to the resource.
    timeouts PiCaptureTimeouts
    piCaptureDestination string
    Destination for the deployable image.[image-catalog,cloud-storage,both]
    piCaptureName string
    Name of the deployable image created for the captured PVMInstance.
    piCloudInstanceId string
    The GUID of the service instance associated with an account.
    piInstanceName string
    The name of the instance.
    piCaptureCloudStorageAccessKey string
    Cloud Storage Access key
    piCaptureCloudStorageRegion string
    The Cloud Object Storage region. Supported COS regions are: au-syd, br-sao, ca-tor, eu-de, eu-es, eu-gb, jp-osa, jp-tok, us-east, us-south.
    piCaptureCloudStorageSecretKey string
    Cloud Storage Secret key
    piCaptureId string
    (String) The image id of the instance capture. The ID is composed of <pi_cloud_instance_id>/<pi_capture_name>/<pi_capture_destination>.
    piCaptureStorageImagePath string
    Cloud Storage Image Path (bucket-name [/folder/../..])
    piCaptureVolumeIds string[]
    List of Data volume IDs to include in the captured PVMInstance.
    piUserTags string[]
    List of user tags attached to the resource.
    timeouts PiCaptureTimeouts
    pi_capture_destination str
    Destination for the deployable image.[image-catalog,cloud-storage,both]
    pi_capture_name str
    Name of the deployable image created for the captured PVMInstance.
    pi_cloud_instance_id str
    The GUID of the service instance associated with an account.
    pi_instance_name str
    The name of the instance.
    pi_capture_cloud_storage_access_key str
    Cloud Storage Access key
    pi_capture_cloud_storage_region str
    The Cloud Object Storage region. Supported COS regions are: au-syd, br-sao, ca-tor, eu-de, eu-es, eu-gb, jp-osa, jp-tok, us-east, us-south.
    pi_capture_cloud_storage_secret_key str
    Cloud Storage Secret key
    pi_capture_id str
    (String) The image id of the instance capture. The ID is composed of <pi_cloud_instance_id>/<pi_capture_name>/<pi_capture_destination>.
    pi_capture_storage_image_path str
    Cloud Storage Image Path (bucket-name [/folder/../..])
    pi_capture_volume_ids Sequence[str]
    List of Data volume IDs to include in the captured PVMInstance.
    pi_user_tags Sequence[str]
    List of user tags attached to the resource.
    timeouts PiCaptureTimeoutsArgs
    piCaptureDestination String
    Destination for the deployable image.[image-catalog,cloud-storage,both]
    piCaptureName String
    Name of the deployable image created for the captured PVMInstance.
    piCloudInstanceId String
    The GUID of the service instance associated with an account.
    piInstanceName String
    The name of the instance.
    piCaptureCloudStorageAccessKey String
    Cloud Storage Access key
    piCaptureCloudStorageRegion String
    The Cloud Object Storage region. Supported COS regions are: au-syd, br-sao, ca-tor, eu-de, eu-es, eu-gb, jp-osa, jp-tok, us-east, us-south.
    piCaptureCloudStorageSecretKey String
    Cloud Storage Secret key
    piCaptureId String
    (String) The image id of the instance capture. The ID is composed of <pi_cloud_instance_id>/<pi_capture_name>/<pi_capture_destination>.
    piCaptureStorageImagePath String
    Cloud Storage Image Path (bucket-name [/folder/../..])
    piCaptureVolumeIds List<String>
    List of Data volume IDs to include in the captured PVMInstance.
    piUserTags List<String>
    List of user tags attached to the resource.
    timeouts Property Map

    Outputs

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

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

    Look up Existing PiCapture Resource

    Get an existing PiCapture 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?: PiCaptureState, opts?: CustomResourceOptions): PiCapture
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        crn: Optional[str] = None,
        image_id: Optional[str] = None,
        pi_capture_cloud_storage_access_key: Optional[str] = None,
        pi_capture_cloud_storage_region: Optional[str] = None,
        pi_capture_cloud_storage_secret_key: Optional[str] = None,
        pi_capture_destination: Optional[str] = None,
        pi_capture_id: Optional[str] = None,
        pi_capture_name: Optional[str] = None,
        pi_capture_storage_image_path: Optional[str] = None,
        pi_capture_volume_ids: Optional[Sequence[str]] = None,
        pi_cloud_instance_id: Optional[str] = None,
        pi_instance_name: Optional[str] = None,
        pi_user_tags: Optional[Sequence[str]] = None,
        timeouts: Optional[PiCaptureTimeoutsArgs] = None) -> PiCapture
    func GetPiCapture(ctx *Context, name string, id IDInput, state *PiCaptureState, opts ...ResourceOption) (*PiCapture, error)
    public static PiCapture Get(string name, Input<string> id, PiCaptureState? state, CustomResourceOptions? opts = null)
    public static PiCapture get(String name, Output<String> id, PiCaptureState state, CustomResourceOptions options)
    resources:  _:    type: ibm:PiCapture    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Crn string
    (String) The CRN of the resource.
    ImageId string
    (String) The image id of the instance capture.
    PiCaptureCloudStorageAccessKey string
    Cloud Storage Access key
    PiCaptureCloudStorageRegion string
    The Cloud Object Storage region. Supported COS regions are: au-syd, br-sao, ca-tor, eu-de, eu-es, eu-gb, jp-osa, jp-tok, us-east, us-south.
    PiCaptureCloudStorageSecretKey string
    Cloud Storage Secret key
    PiCaptureDestination string
    Destination for the deployable image.[image-catalog,cloud-storage,both]
    PiCaptureId string
    (String) The image id of the instance capture. The ID is composed of <pi_cloud_instance_id>/<pi_capture_name>/<pi_capture_destination>.
    PiCaptureName string
    Name of the deployable image created for the captured PVMInstance.
    PiCaptureStorageImagePath string
    Cloud Storage Image Path (bucket-name [/folder/../..])
    PiCaptureVolumeIds List<string>
    List of Data volume IDs to include in the captured PVMInstance.
    PiCloudInstanceId string
    The GUID of the service instance associated with an account.
    PiInstanceName string
    The name of the instance.
    PiUserTags List<string>
    List of user tags attached to the resource.
    Timeouts PiCaptureTimeouts
    Crn string
    (String) The CRN of the resource.
    ImageId string
    (String) The image id of the instance capture.
    PiCaptureCloudStorageAccessKey string
    Cloud Storage Access key
    PiCaptureCloudStorageRegion string
    The Cloud Object Storage region. Supported COS regions are: au-syd, br-sao, ca-tor, eu-de, eu-es, eu-gb, jp-osa, jp-tok, us-east, us-south.
    PiCaptureCloudStorageSecretKey string
    Cloud Storage Secret key
    PiCaptureDestination string
    Destination for the deployable image.[image-catalog,cloud-storage,both]
    PiCaptureId string
    (String) The image id of the instance capture. The ID is composed of <pi_cloud_instance_id>/<pi_capture_name>/<pi_capture_destination>.
    PiCaptureName string
    Name of the deployable image created for the captured PVMInstance.
    PiCaptureStorageImagePath string
    Cloud Storage Image Path (bucket-name [/folder/../..])
    PiCaptureVolumeIds []string
    List of Data volume IDs to include in the captured PVMInstance.
    PiCloudInstanceId string
    The GUID of the service instance associated with an account.
    PiInstanceName string
    The name of the instance.
    PiUserTags []string
    List of user tags attached to the resource.
    Timeouts PiCaptureTimeoutsArgs
    crn String
    (String) The CRN of the resource.
    imageId String
    (String) The image id of the instance capture.
    piCaptureCloudStorageAccessKey String
    Cloud Storage Access key
    piCaptureCloudStorageRegion String
    The Cloud Object Storage region. Supported COS regions are: au-syd, br-sao, ca-tor, eu-de, eu-es, eu-gb, jp-osa, jp-tok, us-east, us-south.
    piCaptureCloudStorageSecretKey String
    Cloud Storage Secret key
    piCaptureDestination String
    Destination for the deployable image.[image-catalog,cloud-storage,both]
    piCaptureId String
    (String) The image id of the instance capture. The ID is composed of <pi_cloud_instance_id>/<pi_capture_name>/<pi_capture_destination>.
    piCaptureName String
    Name of the deployable image created for the captured PVMInstance.
    piCaptureStorageImagePath String
    Cloud Storage Image Path (bucket-name [/folder/../..])
    piCaptureVolumeIds List<String>
    List of Data volume IDs to include in the captured PVMInstance.
    piCloudInstanceId String
    The GUID of the service instance associated with an account.
    piInstanceName String
    The name of the instance.
    piUserTags List<String>
    List of user tags attached to the resource.
    timeouts PiCaptureTimeouts
    crn string
    (String) The CRN of the resource.
    imageId string
    (String) The image id of the instance capture.
    piCaptureCloudStorageAccessKey string
    Cloud Storage Access key
    piCaptureCloudStorageRegion string
    The Cloud Object Storage region. Supported COS regions are: au-syd, br-sao, ca-tor, eu-de, eu-es, eu-gb, jp-osa, jp-tok, us-east, us-south.
    piCaptureCloudStorageSecretKey string
    Cloud Storage Secret key
    piCaptureDestination string
    Destination for the deployable image.[image-catalog,cloud-storage,both]
    piCaptureId string
    (String) The image id of the instance capture. The ID is composed of <pi_cloud_instance_id>/<pi_capture_name>/<pi_capture_destination>.
    piCaptureName string
    Name of the deployable image created for the captured PVMInstance.
    piCaptureStorageImagePath string
    Cloud Storage Image Path (bucket-name [/folder/../..])
    piCaptureVolumeIds string[]
    List of Data volume IDs to include in the captured PVMInstance.
    piCloudInstanceId string
    The GUID of the service instance associated with an account.
    piInstanceName string
    The name of the instance.
    piUserTags string[]
    List of user tags attached to the resource.
    timeouts PiCaptureTimeouts
    crn str
    (String) The CRN of the resource.
    image_id str
    (String) The image id of the instance capture.
    pi_capture_cloud_storage_access_key str
    Cloud Storage Access key
    pi_capture_cloud_storage_region str
    The Cloud Object Storage region. Supported COS regions are: au-syd, br-sao, ca-tor, eu-de, eu-es, eu-gb, jp-osa, jp-tok, us-east, us-south.
    pi_capture_cloud_storage_secret_key str
    Cloud Storage Secret key
    pi_capture_destination str
    Destination for the deployable image.[image-catalog,cloud-storage,both]
    pi_capture_id str
    (String) The image id of the instance capture. The ID is composed of <pi_cloud_instance_id>/<pi_capture_name>/<pi_capture_destination>.
    pi_capture_name str
    Name of the deployable image created for the captured PVMInstance.
    pi_capture_storage_image_path str
    Cloud Storage Image Path (bucket-name [/folder/../..])
    pi_capture_volume_ids Sequence[str]
    List of Data volume IDs to include in the captured PVMInstance.
    pi_cloud_instance_id str
    The GUID of the service instance associated with an account.
    pi_instance_name str
    The name of the instance.
    pi_user_tags Sequence[str]
    List of user tags attached to the resource.
    timeouts PiCaptureTimeoutsArgs
    crn String
    (String) The CRN of the resource.
    imageId String
    (String) The image id of the instance capture.
    piCaptureCloudStorageAccessKey String
    Cloud Storage Access key
    piCaptureCloudStorageRegion String
    The Cloud Object Storage region. Supported COS regions are: au-syd, br-sao, ca-tor, eu-de, eu-es, eu-gb, jp-osa, jp-tok, us-east, us-south.
    piCaptureCloudStorageSecretKey String
    Cloud Storage Secret key
    piCaptureDestination String
    Destination for the deployable image.[image-catalog,cloud-storage,both]
    piCaptureId String
    (String) The image id of the instance capture. The ID is composed of <pi_cloud_instance_id>/<pi_capture_name>/<pi_capture_destination>.
    piCaptureName String
    Name of the deployable image created for the captured PVMInstance.
    piCaptureStorageImagePath String
    Cloud Storage Image Path (bucket-name [/folder/../..])
    piCaptureVolumeIds List<String>
    List of Data volume IDs to include in the captured PVMInstance.
    piCloudInstanceId String
    The GUID of the service instance associated with an account.
    piInstanceName String
    The name of the instance.
    piUserTags List<String>
    List of user tags attached to the resource.
    timeouts Property Map

    Supporting Types

    PiCaptureTimeouts, PiCaptureTimeoutsArgs

    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/piCapture:PiCapture example d7bec597-4726-451f-8a63-e62e6f19c32c/test-capture/image-catalog

    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 logo
    ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
    ibm-cloud/terraform-provider-ibm