ibm 1.77.1, Apr 14 25

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

ibm.PiInstanceAction

Explore with Pulumi AI

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

Import

Example

bash

$ pulumi import ibm:index/piInstanceAction:PiInstanceAction example d7bec597-4726-451f-8a63-e62e6f19c32c/cea6651a-bc0a-4438-9f8a-a0770b112ebb

Create PiInstanceAction Resource

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

new PiInstanceAction(name: string, args: PiInstanceActionArgs, opts?: CustomResourceOptions);

@overload
def PiInstanceAction(resource_name: str,
                     args: PiInstanceActionArgs,
                     opts: Optional[ResourceOptions] = None)

@overload
def PiInstanceAction(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     pi_action: Optional[str] = None,
                     pi_cloud_instance_id: Optional[str] = None,
                     pi_instance_id: Optional[str] = None,
                     pi_health_status: Optional[str] = None,
                     pi_instance_action_id: Optional[str] = None,
                     timeouts: Optional[PiInstanceActionTimeoutsArgs] = None)

func NewPiInstanceAction(ctx *Context, name string, args PiInstanceActionArgs, opts ...ResourceOption) (*PiInstanceAction, error)

public PiInstanceAction(string name, PiInstanceActionArgs args, CustomResourceOptions? opts = null)

public PiInstanceAction(String name, PiInstanceActionArgs args)
public PiInstanceAction(String name, PiInstanceActionArgs args, CustomResourceOptions options)

type: ibm:PiInstanceAction
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 PiInstanceActionArgs: 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 PiInstanceActionArgs: 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 PiInstanceActionArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args PiInstanceActionArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args PiInstanceActionArgs: 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.

TypeScript
Python
Go
C#
Java
YAML

var piInstanceActionResource = new Ibm.PiInstanceAction("piInstanceActionResource", new()
{
    PiAction = "string",
    PiCloudInstanceId = "string",
    PiInstanceId = "string",
    PiHealthStatus = "string",
    PiInstanceActionId = "string",
    Timeouts = new Ibm.Inputs.PiInstanceActionTimeoutsArgs
    {
        Create = "string",
        Update = "string",
    },
});

example, err := ibm.NewPiInstanceAction(ctx, "piInstanceActionResource", &ibm.PiInstanceActionArgs{
	PiAction:           pulumi.String("string"),
	PiCloudInstanceId:  pulumi.String("string"),
	PiInstanceId:       pulumi.String("string"),
	PiHealthStatus:     pulumi.String("string"),
	PiInstanceActionId: pulumi.String("string"),
	Timeouts: &ibm.PiInstanceActionTimeoutsArgs{
		Create: pulumi.String("string"),
		Update: pulumi.String("string"),
	},
})

var piInstanceActionResource = new PiInstanceAction("piInstanceActionResource", PiInstanceActionArgs.builder()
    .piAction("string")
    .piCloudInstanceId("string")
    .piInstanceId("string")
    .piHealthStatus("string")
    .piInstanceActionId("string")
    .timeouts(PiInstanceActionTimeoutsArgs.builder()
        .create("string")
        .update("string")
        .build())
    .build());

pi_instance_action_resource = ibm.PiInstanceAction("piInstanceActionResource",
    pi_action="string",
    pi_cloud_instance_id="string",
    pi_instance_id="string",
    pi_health_status="string",
    pi_instance_action_id="string",
    timeouts={
        "create": "string",
        "update": "string",
    })

const piInstanceActionResource = new ibm.PiInstanceAction("piInstanceActionResource", {
    piAction: "string",
    piCloudInstanceId: "string",
    piInstanceId: "string",
    piHealthStatus: "string",
    piInstanceActionId: "string",
    timeouts: {
        create: "string",
        update: "string",
    },
});

type: ibm:PiInstanceAction
properties:
    piAction: string
    piCloudInstanceId: string
    piHealthStatus: string
    piInstanceActionId: string
    piInstanceId: string
    timeouts:
        create: string
        update: string

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

PiAction string: PVM instance action type
PiCloudInstanceId string: PI Cloud instance id
PiInstanceId string: PVM instance ID
PiHealthStatus string: Set the health status of the PVM instance to connect it faster
PiInstanceActionId string: (String) The unique identifier of the instance. The ID is composed of <pi_cloud_instance_id>/<pi_instance_id>.
Timeouts PiInstanceActionTimeouts

PiAction string: PVM instance action type
PiCloudInstanceId string: PI Cloud instance id
PiInstanceId string: PVM instance ID
PiHealthStatus string: Set the health status of the PVM instance to connect it faster
PiInstanceActionId string: (String) The unique identifier of the instance. The ID is composed of <pi_cloud_instance_id>/<pi_instance_id>.
Timeouts PiInstanceActionTimeoutsArgs

piAction String: PVM instance action type
piCloudInstanceId String: PI Cloud instance id
piInstanceId String: PVM instance ID
piHealthStatus String: Set the health status of the PVM instance to connect it faster
piInstanceActionId String: (String) The unique identifier of the instance. The ID is composed of <pi_cloud_instance_id>/<pi_instance_id>.
timeouts PiInstanceActionTimeouts

piAction string: PVM instance action type
piCloudInstanceId string: PI Cloud instance id
piInstanceId string: PVM instance ID
piHealthStatus string: Set the health status of the PVM instance to connect it faster
piInstanceActionId string: (String) The unique identifier of the instance. The ID is composed of <pi_cloud_instance_id>/<pi_instance_id>.
timeouts PiInstanceActionTimeouts

pi_action str: PVM instance action type
pi_cloud_instance_id str: PI Cloud instance id
pi_instance_id str: PVM instance ID
pi_health_status str: Set the health status of the PVM instance to connect it faster
pi_instance_action_id str: (String) The unique identifier of the instance. The ID is composed of <pi_cloud_instance_id>/<pi_instance_id>.
timeouts PiInstanceActionTimeoutsArgs

piAction String: PVM instance action type
piCloudInstanceId String: PI Cloud instance id
piInstanceId String: PVM instance ID
piHealthStatus String: Set the health status of the PVM instance to connect it faster
piInstanceActionId String: (String) The unique identifier of the instance. The ID is composed of <pi_cloud_instance_id>/<pi_instance_id>.
timeouts Property Map

Outputs

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

HealthStatus string: (String) The health status of the VM.
Id string: The provider-assigned unique ID for this managed resource.
Progress double: (Float) - The progress of the instance.
Status string: (String) - The status of the instance.

HealthStatus string: (String) The health status of the VM.
Id string: The provider-assigned unique ID for this managed resource.
Progress float64: (Float) - The progress of the instance.
Status string: (String) - The status of the instance.

healthStatus String: (String) The health status of the VM.
id String: The provider-assigned unique ID for this managed resource.
progress Double: (Float) - The progress of the instance.
status String: (String) - The status of the instance.

healthStatus string: (String) The health status of the VM.
id string: The provider-assigned unique ID for this managed resource.
progress number: (Float) - The progress of the instance.
status string: (String) - The status of the instance.

health_status str: (String) The health status of the VM.
id str: The provider-assigned unique ID for this managed resource.
progress float: (Float) - The progress of the instance.
status str: (String) - The status of the instance.

healthStatus String: (String) The health status of the VM.
id String: The provider-assigned unique ID for this managed resource.
progress Number: (Float) - The progress of the instance.
status String: (String) - The status of the instance.

Look up Existing PiInstanceAction Resource

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

TypeScript
Python
Go
C#
Java
YAML

public static get(name: string, id: Input<ID>, state?: PiInstanceActionState, opts?: CustomResourceOptions): PiInstanceAction

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        health_status: Optional[str] = None,
        pi_action: Optional[str] = None,
        pi_cloud_instance_id: Optional[str] = None,
        pi_health_status: Optional[str] = None,
        pi_instance_action_id: Optional[str] = None,
        pi_instance_id: Optional[str] = None,
        progress: Optional[float] = None,
        status: Optional[str] = None,
        timeouts: Optional[PiInstanceActionTimeoutsArgs] = None) -> PiInstanceAction

func GetPiInstanceAction(ctx *Context, name string, id IDInput, state *PiInstanceActionState, opts ...ResourceOption) (*PiInstanceAction, error)

public static PiInstanceAction Get(string name, Input<string> id, PiInstanceActionState? state, CustomResourceOptions? opts = null)

public static PiInstanceAction get(String name, Output<String> id, PiInstanceActionState state, CustomResourceOptions options)

resources:  _:    type: ibm:PiInstanceAction    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:

HealthStatus string: (String) The health status of the VM.
PiAction string: PVM instance action type
PiCloudInstanceId string: PI Cloud instance id
PiHealthStatus string: Set the health status of the PVM instance to connect it faster
PiInstanceActionId string: (String) The unique identifier of the instance. The ID is composed of <pi_cloud_instance_id>/<pi_instance_id>.
PiInstanceId string: PVM instance ID
Progress double: (Float) - The progress of the instance.
Status string: (String) - The status of the instance.
Timeouts PiInstanceActionTimeouts

HealthStatus string: (String) The health status of the VM.
PiAction string: PVM instance action type
PiCloudInstanceId string: PI Cloud instance id
PiHealthStatus string: Set the health status of the PVM instance to connect it faster
PiInstanceActionId string: (String) The unique identifier of the instance. The ID is composed of <pi_cloud_instance_id>/<pi_instance_id>.
PiInstanceId string: PVM instance ID
Progress float64: (Float) - The progress of the instance.
Status string: (String) - The status of the instance.
Timeouts PiInstanceActionTimeoutsArgs

healthStatus String: (String) The health status of the VM.
piAction String: PVM instance action type
piCloudInstanceId String: PI Cloud instance id
piHealthStatus String: Set the health status of the PVM instance to connect it faster
piInstanceActionId String: (String) The unique identifier of the instance. The ID is composed of <pi_cloud_instance_id>/<pi_instance_id>.
piInstanceId String: PVM instance ID
progress Double: (Float) - The progress of the instance.
status String: (String) - The status of the instance.
timeouts PiInstanceActionTimeouts

healthStatus string: (String) The health status of the VM.
piAction string: PVM instance action type
piCloudInstanceId string: PI Cloud instance id
piHealthStatus string: Set the health status of the PVM instance to connect it faster
piInstanceActionId string: (String) The unique identifier of the instance. The ID is composed of <pi_cloud_instance_id>/<pi_instance_id>.
piInstanceId string: PVM instance ID
progress number: (Float) - The progress of the instance.
status string: (String) - The status of the instance.
timeouts PiInstanceActionTimeouts

health_status str: (String) The health status of the VM.
pi_action str: PVM instance action type
pi_cloud_instance_id str: PI Cloud instance id
pi_health_status str: Set the health status of the PVM instance to connect it faster
pi_instance_action_id str: (String) The unique identifier of the instance. The ID is composed of <pi_cloud_instance_id>/<pi_instance_id>.
pi_instance_id str: PVM instance ID
progress float: (Float) - The progress of the instance.
status str: (String) - The status of the instance.
timeouts PiInstanceActionTimeoutsArgs

healthStatus String: (String) The health status of the VM.
piAction String: PVM instance action type
piCloudInstanceId String: PI Cloud instance id
piHealthStatus String: Set the health status of the PVM instance to connect it faster
piInstanceActionId String: (String) The unique identifier of the instance. The ID is composed of <pi_cloud_instance_id>/<pi_instance_id>.
piInstanceId String: PVM instance ID
progress Number: (Float) - The progress of the instance.
status String: (String) - The status of the instance.
timeouts Property Map

Supporting Types

PiInstanceActionTimeouts
, PiInstanceActionTimeoutsArgs

Create string
Update string

Create string
Update string

create String
update String

create string
update string

create str
update str

create String
update String

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

ibm.PiInstanceAction

On this page

On this page

Import

Example

Create PiInstanceAction Resource

Constructor syntax

Parameters

Constructor example

PiInstanceAction Resource Properties

Inputs

Outputs

Look up Existing PiInstanceAction Resource

Supporting Types

PiInstanceActionTimeouts
, PiInstanceActionTimeoutsArgs

Package Details

On this page

On this page

ibm.PiInstanceAction

On this page

On this page

Import

Example

Create PiInstanceAction Resource

Constructor syntax

Parameters

Constructor example

PiInstanceAction Resource Properties

Inputs

Outputs

Look up Existing PiInstanceAction Resource

Supporting Types

PiInstanceActionTimeouts, PiInstanceActionTimeoutsArgs

Package Details

On this page

On this page

PiInstanceActionTimeouts
, PiInstanceActionTimeoutsArgs