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

ibm.getPiCloudConnections

Explore with Pulumi AI

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

    Retrieve information about all cloud connections as a read-only data source. For more information, about IBM power virtual server cloud, see getting started with IBM Power Systems Virtual Servers.

    Example Usage

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

const example = ibm.getPiCloudConnections({
    piCloudInstanceId: "<value of the cloud_instance_id>",
});

    import pulumi
import pulumi_ibm as ibm

example = ibm.get_pi_cloud_connections(pi_cloud_instance_id="<value of the cloud_instance_id>")

    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.GetPiCloudConnections(ctx, &ibm.GetPiCloudConnectionsArgs{
			PiCloudInstanceId: "<value of the cloud_instance_id>",
		}, nil)
		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 example = Ibm.GetPiCloudConnections.Invoke(new()
    {
        PiCloudInstanceId = "<value of the cloud_instance_id>",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.IbmFunctions;
import com.pulumi.ibm.inputs.GetPiCloudConnectionsArgs;
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) {
        final var example = IbmFunctions.getPiCloudConnections(GetPiCloudConnectionsArgs.builder()
            .piCloudInstanceId("<value of the cloud_instance_id>")
            .build());

    }
}

    variables:
  example:
    fn::invoke:
      function: ibm:getPiCloudConnections
      arguments:
        piCloudInstanceId: <value of the cloud_instance_id>

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

    {}

    Using getPiCloudConnections

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getPiCloudConnections(args: GetPiCloudConnectionsArgs, opts?: InvokeOptions): Promise<GetPiCloudConnectionsResult>
function getPiCloudConnectionsOutput(args: GetPiCloudConnectionsOutputArgs, opts?: InvokeOptions): Output<GetPiCloudConnectionsResult>
    def get_pi_cloud_connections(id: Optional[str] = None,
                             pi_cloud_instance_id: Optional[str] = None,
                             opts: Optional[InvokeOptions] = None) -> GetPiCloudConnectionsResult
def get_pi_cloud_connections_output(id: Optional[pulumi.Input[str]] = None,
                             pi_cloud_instance_id: Optional[pulumi.Input[str]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetPiCloudConnectionsResult]
    func GetPiCloudConnections(ctx *Context, args *GetPiCloudConnectionsArgs, opts ...InvokeOption) (*GetPiCloudConnectionsResult, error)
func GetPiCloudConnectionsOutput(ctx *Context, args *GetPiCloudConnectionsOutputArgs, opts ...InvokeOption) GetPiCloudConnectionsResultOutput

    > Note: This function is named GetPiCloudConnections in the Go SDK.

    public static class GetPiCloudConnections 
{
    public static Task<GetPiCloudConnectionsResult> InvokeAsync(GetPiCloudConnectionsArgs args, InvokeOptions? opts = null)
    public static Output<GetPiCloudConnectionsResult> Invoke(GetPiCloudConnectionsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetPiCloudConnectionsResult> getPiCloudConnections(GetPiCloudConnectionsArgs args, InvokeOptions options)
public static Output<GetPiCloudConnectionsResult> getPiCloudConnections(GetPiCloudConnectionsArgs args, InvokeOptions options)

    fn::invoke:
  function: ibm:index/getPiCloudConnections:getPiCloudConnections
  arguments:
    # arguments dictionary

    The following arguments are supported:

    PiCloudInstanceId string
    The GUID of the service instance associated with an account.
    Id string
    PiCloudInstanceId string
    The GUID of the service instance associated with an account.
    Id string
    piCloudInstanceId String
    The GUID of the service instance associated with an account.
    id String
    piCloudInstanceId string
    The GUID of the service instance associated with an account.
    id string
    pi_cloud_instance_id str
    The GUID of the service instance associated with an account.
    id str
    piCloudInstanceId String
    The GUID of the service instance associated with an account.
    id String

    getPiCloudConnections Result

    The following output properties are available:

    Connections List<GetPiCloudConnectionsConnection>
    (List) List of all the Cloud Connections.
    Id string
    PiCloudInstanceId string
    Connections []GetPiCloudConnectionsConnection
    (List) List of all the Cloud Connections.
    Id string
    PiCloudInstanceId string
    connections List<GetPiCloudConnectionsConnection>
    (List) List of all the Cloud Connections.
    id String
    piCloudInstanceId String
    connections GetPiCloudConnectionsConnection[]
    (List) List of all the Cloud Connections.
    id string
    piCloudInstanceId string
    connections Sequence[GetPiCloudConnectionsConnection]
    (List) List of all the Cloud Connections.
    id str
    pi_cloud_instance_id str
    connections List<Property Map>
    (List) List of all the Cloud Connections.
    id String
    piCloudInstanceId String

    Supporting Types

    GetPiCloudConnectionsConnection

    ClassicEnabled bool
    (Boolean) Enable classic endpoint destination.
    CloudConnectionId string
    (String) The unique identifier of the cloud connection.
    ConnectionMode string
    (String) Type of service the gateway is attached to.
    GlobalRouting bool
    (String) Enable global routing for this cloud connection.
    GreDestinationAddress string
    (String) GRE destination IP address.
    GreSourceAddress string
    (String) GRE auto-assigned source IP address.
    IbmIpAddress string
    (String) IBM IP address.
    Metered bool
    (String) Enable metering for this cloud connection.
    Name string
    (String) Name of the cloud connection.
    Networks List<string>
    (Set) Set of Networks attached to this cloud connection.
    Port string
    (String) Port.
    Speed double
    (Integer) Speed of the cloud connection (speed in megabits per second).
    Status string
    (String) Link status.
    UserIpAddress string
    (String) User IP address.
    VpcCrns List<string>
    (Set) Set of VPCs attached to this cloud connection.
    VpcEnabled bool
    (Boolean) Enable VPC for this cloud connection.
    ClassicEnabled bool
    (Boolean) Enable classic endpoint destination.
    CloudConnectionId string
    (String) The unique identifier of the cloud connection.
    ConnectionMode string
    (String) Type of service the gateway is attached to.
    GlobalRouting bool
    (String) Enable global routing for this cloud connection.
    GreDestinationAddress string
    (String) GRE destination IP address.
    GreSourceAddress string
    (String) GRE auto-assigned source IP address.
    IbmIpAddress string
    (String) IBM IP address.
    Metered bool
    (String) Enable metering for this cloud connection.
    Name string
    (String) Name of the cloud connection.
    Networks []string
    (Set) Set of Networks attached to this cloud connection.
    Port string
    (String) Port.
    Speed float64
    (Integer) Speed of the cloud connection (speed in megabits per second).
    Status string
    (String) Link status.
    UserIpAddress string
    (String) User IP address.
    VpcCrns []string
    (Set) Set of VPCs attached to this cloud connection.
    VpcEnabled bool
    (Boolean) Enable VPC for this cloud connection.
    classicEnabled Boolean
    (Boolean) Enable classic endpoint destination.
    cloudConnectionId String
    (String) The unique identifier of the cloud connection.
    connectionMode String
    (String) Type of service the gateway is attached to.
    globalRouting Boolean
    (String) Enable global routing for this cloud connection.
    greDestinationAddress String
    (String) GRE destination IP address.
    greSourceAddress String
    (String) GRE auto-assigned source IP address.
    ibmIpAddress String
    (String) IBM IP address.
    metered Boolean
    (String) Enable metering for this cloud connection.
    name String
    (String) Name of the cloud connection.
    networks List<String>
    (Set) Set of Networks attached to this cloud connection.
    port String
    (String) Port.
    speed Double
    (Integer) Speed of the cloud connection (speed in megabits per second).
    status String
    (String) Link status.
    userIpAddress String
    (String) User IP address.
    vpcCrns List<String>
    (Set) Set of VPCs attached to this cloud connection.
    vpcEnabled Boolean
    (Boolean) Enable VPC for this cloud connection.
    classicEnabled boolean
    (Boolean) Enable classic endpoint destination.
    cloudConnectionId string
    (String) The unique identifier of the cloud connection.
    connectionMode string
    (String) Type of service the gateway is attached to.
    globalRouting boolean
    (String) Enable global routing for this cloud connection.
    greDestinationAddress string
    (String) GRE destination IP address.
    greSourceAddress string
    (String) GRE auto-assigned source IP address.
    ibmIpAddress string
    (String) IBM IP address.
    metered boolean
    (String) Enable metering for this cloud connection.
    name string
    (String) Name of the cloud connection.
    networks string[]
    (Set) Set of Networks attached to this cloud connection.
    port string
    (String) Port.
    speed number
    (Integer) Speed of the cloud connection (speed in megabits per second).
    status string
    (String) Link status.
    userIpAddress string
    (String) User IP address.
    vpcCrns string[]
    (Set) Set of VPCs attached to this cloud connection.
    vpcEnabled boolean
    (Boolean) Enable VPC for this cloud connection.
    classic_enabled bool
    (Boolean) Enable classic endpoint destination.
    cloud_connection_id str
    (String) The unique identifier of the cloud connection.
    connection_mode str
    (String) Type of service the gateway is attached to.
    global_routing bool
    (String) Enable global routing for this cloud connection.
    gre_destination_address str
    (String) GRE destination IP address.
    gre_source_address str
    (String) GRE auto-assigned source IP address.
    ibm_ip_address str
    (String) IBM IP address.
    metered bool
    (String) Enable metering for this cloud connection.
    name str
    (String) Name of the cloud connection.
    networks Sequence[str]
    (Set) Set of Networks attached to this cloud connection.
    port str
    (String) Port.
    speed float
    (Integer) Speed of the cloud connection (speed in megabits per second).
    status str
    (String) Link status.
    user_ip_address str
    (String) User IP address.
    vpc_crns Sequence[str]
    (Set) Set of VPCs attached to this cloud connection.
    vpc_enabled bool
    (Boolean) Enable VPC for this cloud connection.
    classicEnabled Boolean
    (Boolean) Enable classic endpoint destination.
    cloudConnectionId String
    (String) The unique identifier of the cloud connection.
    connectionMode String
    (String) Type of service the gateway is attached to.
    globalRouting Boolean
    (String) Enable global routing for this cloud connection.
    greDestinationAddress String
    (String) GRE destination IP address.
    greSourceAddress String
    (String) GRE auto-assigned source IP address.
    ibmIpAddress String
    (String) IBM IP address.
    metered Boolean
    (String) Enable metering for this cloud connection.
    name String
    (String) Name of the cloud connection.
    networks List<String>
    (Set) Set of Networks attached to this cloud connection.
    port String
    (String) Port.
    speed Number
    (Integer) Speed of the cloud connection (speed in megabits per second).
    status String
    (String) Link status.
    userIpAddress String
    (String) User IP address.
    vpcCrns List<String>
    (Set) Set of VPCs attached to this cloud connection.
    vpcEnabled Boolean
    (Boolean) Enable VPC for this cloud connection.

    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