1. Packages
  2. Ibm Provider
  3. API Docs
  4. PiCloudConnection
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud

ibm.PiCloudConnection

Explore with Pulumi AI

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

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

    NOTE: Cloud connection are not supported in new workspaces in DAL10 data center.

    Example Usage

    The following example enables you to create a cloud connection:

    import * as pulumi from "@pulumi/pulumi";
    import * as ibm from "@pulumi/ibm";
    
    const cloudConnection = new ibm.PiCloudConnection("cloudConnection", {
        piCloudConnectionName: "test_cloud_connection",
        piCloudConnectionSpeed: 50,
        piCloudInstanceId: "<value of the cloud_instance_id>",
    });
    
    import pulumi
    import pulumi_ibm as ibm
    
    cloud_connection = ibm.PiCloudConnection("cloudConnection",
        pi_cloud_connection_name="test_cloud_connection",
        pi_cloud_connection_speed=50,
        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.NewPiCloudConnection(ctx, "cloudConnection", &ibm.PiCloudConnectionArgs{
    			PiCloudConnectionName:  pulumi.String("test_cloud_connection"),
    			PiCloudConnectionSpeed: pulumi.Float64(50),
    			PiCloudInstanceId:      pulumi.String("<value of the cloud_instance_id>"),
    		})
    		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 cloudConnection = new Ibm.PiCloudConnection("cloudConnection", new()
        {
            PiCloudConnectionName = "test_cloud_connection",
            PiCloudConnectionSpeed = 50,
            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.PiCloudConnection;
    import com.pulumi.ibm.PiCloudConnectionArgs;
    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 cloudConnection = new PiCloudConnection("cloudConnection", PiCloudConnectionArgs.builder()
                .piCloudConnectionName("test_cloud_connection")
                .piCloudConnectionSpeed(50)
                .piCloudInstanceId("<value of the cloud_instance_id>")
                .build());
    
        }
    }
    
    resources:
      cloudConnection:
        type: ibm:PiCloudConnection
        properties:
          piCloudConnectionName: test_cloud_connection
          piCloudConnectionSpeed: 50
          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) {
        }
    }
    
    {}
    

    Create PiCloudConnection Resource

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

    Constructor syntax

    new PiCloudConnection(name: string, args: PiCloudConnectionArgs, opts?: CustomResourceOptions);
    @overload
    def PiCloudConnection(resource_name: str,
                          args: PiCloudConnectionArgs,
                          opts: Optional[ResourceOptions] = None)
    
    @overload
    def PiCloudConnection(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          pi_cloud_connection_name: Optional[str] = None,
                          pi_cloud_instance_id: Optional[str] = None,
                          pi_cloud_connection_speed: Optional[float] = None,
                          pi_cloud_connection_gre_destination_address: Optional[str] = None,
                          pi_cloud_connection_id: Optional[str] = None,
                          pi_cloud_connection_metered: Optional[bool] = None,
                          pi_cloud_connection_classic_enabled: Optional[bool] = None,
                          pi_cloud_connection_networks: Optional[Sequence[str]] = None,
                          pi_cloud_connection_gre_cidr: Optional[str] = None,
                          pi_cloud_connection_transit_enabled: Optional[bool] = None,
                          pi_cloud_connection_vpc_crns: Optional[Sequence[str]] = None,
                          pi_cloud_connection_vpc_enabled: Optional[bool] = None,
                          pi_cloud_connection_global_routing: Optional[bool] = None,
                          timeouts: Optional[PiCloudConnectionTimeoutsArgs] = None)
    func NewPiCloudConnection(ctx *Context, name string, args PiCloudConnectionArgs, opts ...ResourceOption) (*PiCloudConnection, error)
    public PiCloudConnection(string name, PiCloudConnectionArgs args, CustomResourceOptions? opts = null)
    public PiCloudConnection(String name, PiCloudConnectionArgs args)
    public PiCloudConnection(String name, PiCloudConnectionArgs args, CustomResourceOptions options)
    
    type: ibm:PiCloudConnection
    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 PiCloudConnectionArgs
    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 PiCloudConnectionArgs
    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 PiCloudConnectionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PiCloudConnectionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PiCloudConnectionArgs
    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 piCloudConnectionResource = new Ibm.PiCloudConnection("piCloudConnectionResource", new()
    {
        PiCloudConnectionName = "string",
        PiCloudInstanceId = "string",
        PiCloudConnectionSpeed = 0,
        PiCloudConnectionGreDestinationAddress = "string",
        PiCloudConnectionId = "string",
        PiCloudConnectionMetered = false,
        PiCloudConnectionClassicEnabled = false,
        PiCloudConnectionNetworks = new[]
        {
            "string",
        },
        PiCloudConnectionGreCidr = "string",
        PiCloudConnectionTransitEnabled = false,
        PiCloudConnectionVpcCrns = new[]
        {
            "string",
        },
        PiCloudConnectionVpcEnabled = false,
        PiCloudConnectionGlobalRouting = false,
        Timeouts = new Ibm.Inputs.PiCloudConnectionTimeoutsArgs
        {
            Create = "string",
            Delete = "string",
            Update = "string",
        },
    });
    
    example, err := ibm.NewPiCloudConnection(ctx, "piCloudConnectionResource", &ibm.PiCloudConnectionArgs{
    	PiCloudConnectionName:                  pulumi.String("string"),
    	PiCloudInstanceId:                      pulumi.String("string"),
    	PiCloudConnectionSpeed:                 pulumi.Float64(0),
    	PiCloudConnectionGreDestinationAddress: pulumi.String("string"),
    	PiCloudConnectionId:                    pulumi.String("string"),
    	PiCloudConnectionMetered:               pulumi.Bool(false),
    	PiCloudConnectionClassicEnabled:        pulumi.Bool(false),
    	PiCloudConnectionNetworks: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	PiCloudConnectionGreCidr:        pulumi.String("string"),
    	PiCloudConnectionTransitEnabled: pulumi.Bool(false),
    	PiCloudConnectionVpcCrns: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	PiCloudConnectionVpcEnabled:    pulumi.Bool(false),
    	PiCloudConnectionGlobalRouting: pulumi.Bool(false),
    	Timeouts: &ibm.PiCloudConnectionTimeoutsArgs{
    		Create: pulumi.String("string"),
    		Delete: pulumi.String("string"),
    		Update: pulumi.String("string"),
    	},
    })
    
    var piCloudConnectionResource = new PiCloudConnection("piCloudConnectionResource", PiCloudConnectionArgs.builder()
        .piCloudConnectionName("string")
        .piCloudInstanceId("string")
        .piCloudConnectionSpeed(0)
        .piCloudConnectionGreDestinationAddress("string")
        .piCloudConnectionId("string")
        .piCloudConnectionMetered(false)
        .piCloudConnectionClassicEnabled(false)
        .piCloudConnectionNetworks("string")
        .piCloudConnectionGreCidr("string")
        .piCloudConnectionTransitEnabled(false)
        .piCloudConnectionVpcCrns("string")
        .piCloudConnectionVpcEnabled(false)
        .piCloudConnectionGlobalRouting(false)
        .timeouts(PiCloudConnectionTimeoutsArgs.builder()
            .create("string")
            .delete("string")
            .update("string")
            .build())
        .build());
    
    pi_cloud_connection_resource = ibm.PiCloudConnection("piCloudConnectionResource",
        pi_cloud_connection_name="string",
        pi_cloud_instance_id="string",
        pi_cloud_connection_speed=0,
        pi_cloud_connection_gre_destination_address="string",
        pi_cloud_connection_id="string",
        pi_cloud_connection_metered=False,
        pi_cloud_connection_classic_enabled=False,
        pi_cloud_connection_networks=["string"],
        pi_cloud_connection_gre_cidr="string",
        pi_cloud_connection_transit_enabled=False,
        pi_cloud_connection_vpc_crns=["string"],
        pi_cloud_connection_vpc_enabled=False,
        pi_cloud_connection_global_routing=False,
        timeouts={
            "create": "string",
            "delete": "string",
            "update": "string",
        })
    
    const piCloudConnectionResource = new ibm.PiCloudConnection("piCloudConnectionResource", {
        piCloudConnectionName: "string",
        piCloudInstanceId: "string",
        piCloudConnectionSpeed: 0,
        piCloudConnectionGreDestinationAddress: "string",
        piCloudConnectionId: "string",
        piCloudConnectionMetered: false,
        piCloudConnectionClassicEnabled: false,
        piCloudConnectionNetworks: ["string"],
        piCloudConnectionGreCidr: "string",
        piCloudConnectionTransitEnabled: false,
        piCloudConnectionVpcCrns: ["string"],
        piCloudConnectionVpcEnabled: false,
        piCloudConnectionGlobalRouting: false,
        timeouts: {
            create: "string",
            "delete": "string",
            update: "string",
        },
    });
    
    type: ibm:PiCloudConnection
    properties:
        piCloudConnectionClassicEnabled: false
        piCloudConnectionGlobalRouting: false
        piCloudConnectionGreCidr: string
        piCloudConnectionGreDestinationAddress: string
        piCloudConnectionId: string
        piCloudConnectionMetered: false
        piCloudConnectionName: string
        piCloudConnectionNetworks:
            - string
        piCloudConnectionSpeed: 0
        piCloudConnectionTransitEnabled: false
        piCloudConnectionVpcCrns:
            - string
        piCloudConnectionVpcEnabled: false
        piCloudInstanceId: string
        timeouts:
            create: string
            delete: string
            update: string
    

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

    PiCloudConnectionName string
    The name of the cloud connection.
    PiCloudConnectionSpeed double
    Speed of the cloud connection (speed in megabits per second). Supported values are 50, 100, 200, 500, 1000, 2000, 5000, 10000.
    PiCloudInstanceId string
    The GUID of the service instance associated with an account.
    PiCloudConnectionClassicEnabled bool
    Enable classic endpoint destination.
    PiCloudConnectionGlobalRouting bool
    Enable global routing for this cloud connection.
    PiCloudConnectionGreCidr string
    The GRE network in CIDR notation.
    PiCloudConnectionGreDestinationAddress string
    The GRE destination IP address.
    PiCloudConnectionId string
    (String) The unique identifier of cloud connection.
    PiCloudConnectionMetered bool
    Enable metered for this cloud connection.
    PiCloudConnectionNetworks List<string>
    Set of Networks to attach to this cloud connection.
    PiCloudConnectionTransitEnabled bool
    Enable transit gateway for this cloud connection.
    PiCloudConnectionVpcCrns List<string>
    Set of VPC CRNs to attach to this cloud connection.
    PiCloudConnectionVpcEnabled bool
    Enable VPC for this cloud connection.
    Timeouts PiCloudConnectionTimeouts
    PiCloudConnectionName string
    The name of the cloud connection.
    PiCloudConnectionSpeed float64
    Speed of the cloud connection (speed in megabits per second). Supported values are 50, 100, 200, 500, 1000, 2000, 5000, 10000.
    PiCloudInstanceId string
    The GUID of the service instance associated with an account.
    PiCloudConnectionClassicEnabled bool
    Enable classic endpoint destination.
    PiCloudConnectionGlobalRouting bool
    Enable global routing for this cloud connection.
    PiCloudConnectionGreCidr string
    The GRE network in CIDR notation.
    PiCloudConnectionGreDestinationAddress string
    The GRE destination IP address.
    PiCloudConnectionId string
    (String) The unique identifier of cloud connection.
    PiCloudConnectionMetered bool
    Enable metered for this cloud connection.
    PiCloudConnectionNetworks []string
    Set of Networks to attach to this cloud connection.
    PiCloudConnectionTransitEnabled bool
    Enable transit gateway for this cloud connection.
    PiCloudConnectionVpcCrns []string
    Set of VPC CRNs to attach to this cloud connection.
    PiCloudConnectionVpcEnabled bool
    Enable VPC for this cloud connection.
    Timeouts PiCloudConnectionTimeoutsArgs
    piCloudConnectionName String
    The name of the cloud connection.
    piCloudConnectionSpeed Double
    Speed of the cloud connection (speed in megabits per second). Supported values are 50, 100, 200, 500, 1000, 2000, 5000, 10000.
    piCloudInstanceId String
    The GUID of the service instance associated with an account.
    piCloudConnectionClassicEnabled Boolean
    Enable classic endpoint destination.
    piCloudConnectionGlobalRouting Boolean
    Enable global routing for this cloud connection.
    piCloudConnectionGreCidr String
    The GRE network in CIDR notation.
    piCloudConnectionGreDestinationAddress String
    The GRE destination IP address.
    piCloudConnectionId String
    (String) The unique identifier of cloud connection.
    piCloudConnectionMetered Boolean
    Enable metered for this cloud connection.
    piCloudConnectionNetworks List<String>
    Set of Networks to attach to this cloud connection.
    piCloudConnectionTransitEnabled Boolean
    Enable transit gateway for this cloud connection.
    piCloudConnectionVpcCrns List<String>
    Set of VPC CRNs to attach to this cloud connection.
    piCloudConnectionVpcEnabled Boolean
    Enable VPC for this cloud connection.
    timeouts PiCloudConnectionTimeouts
    piCloudConnectionName string
    The name of the cloud connection.
    piCloudConnectionSpeed number
    Speed of the cloud connection (speed in megabits per second). Supported values are 50, 100, 200, 500, 1000, 2000, 5000, 10000.
    piCloudInstanceId string
    The GUID of the service instance associated with an account.
    piCloudConnectionClassicEnabled boolean
    Enable classic endpoint destination.
    piCloudConnectionGlobalRouting boolean
    Enable global routing for this cloud connection.
    piCloudConnectionGreCidr string
    The GRE network in CIDR notation.
    piCloudConnectionGreDestinationAddress string
    The GRE destination IP address.
    piCloudConnectionId string
    (String) The unique identifier of cloud connection.
    piCloudConnectionMetered boolean
    Enable metered for this cloud connection.
    piCloudConnectionNetworks string[]
    Set of Networks to attach to this cloud connection.
    piCloudConnectionTransitEnabled boolean
    Enable transit gateway for this cloud connection.
    piCloudConnectionVpcCrns string[]
    Set of VPC CRNs to attach to this cloud connection.
    piCloudConnectionVpcEnabled boolean
    Enable VPC for this cloud connection.
    timeouts PiCloudConnectionTimeouts
    pi_cloud_connection_name str
    The name of the cloud connection.
    pi_cloud_connection_speed float
    Speed of the cloud connection (speed in megabits per second). Supported values are 50, 100, 200, 500, 1000, 2000, 5000, 10000.
    pi_cloud_instance_id str
    The GUID of the service instance associated with an account.
    pi_cloud_connection_classic_enabled bool
    Enable classic endpoint destination.
    pi_cloud_connection_global_routing bool
    Enable global routing for this cloud connection.
    pi_cloud_connection_gre_cidr str
    The GRE network in CIDR notation.
    pi_cloud_connection_gre_destination_address str
    The GRE destination IP address.
    pi_cloud_connection_id str
    (String) The unique identifier of cloud connection.
    pi_cloud_connection_metered bool
    Enable metered for this cloud connection.
    pi_cloud_connection_networks Sequence[str]
    Set of Networks to attach to this cloud connection.
    pi_cloud_connection_transit_enabled bool
    Enable transit gateway for this cloud connection.
    pi_cloud_connection_vpc_crns Sequence[str]
    Set of VPC CRNs to attach to this cloud connection.
    pi_cloud_connection_vpc_enabled bool
    Enable VPC for this cloud connection.
    timeouts PiCloudConnectionTimeoutsArgs
    piCloudConnectionName String
    The name of the cloud connection.
    piCloudConnectionSpeed Number
    Speed of the cloud connection (speed in megabits per second). Supported values are 50, 100, 200, 500, 1000, 2000, 5000, 10000.
    piCloudInstanceId String
    The GUID of the service instance associated with an account.
    piCloudConnectionClassicEnabled Boolean
    Enable classic endpoint destination.
    piCloudConnectionGlobalRouting Boolean
    Enable global routing for this cloud connection.
    piCloudConnectionGreCidr String
    The GRE network in CIDR notation.
    piCloudConnectionGreDestinationAddress String
    The GRE destination IP address.
    piCloudConnectionId String
    (String) The unique identifier of cloud connection.
    piCloudConnectionMetered Boolean
    Enable metered for this cloud connection.
    piCloudConnectionNetworks List<String>
    Set of Networks to attach to this cloud connection.
    piCloudConnectionTransitEnabled Boolean
    Enable transit gateway for this cloud connection.
    piCloudConnectionVpcCrns List<String>
    Set of VPC CRNs to attach to this cloud connection.
    piCloudConnectionVpcEnabled Boolean
    Enable VPC for this cloud connection.
    timeouts Property Map

    Outputs

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

    CloudConnectionId string
    (String) The cloud connection ID.
    ConnectionMode string
    (String) Type of service the gateway is attached to.
    GreSourceAddress string
    (String) The GRE auto-assigned source IP address.
    IbmIpAddress string
    (String) The IBM IP address.
    Id string
    The provider-assigned unique ID for this managed resource.
    Port string
    (String) Port.
    Status string
    (String) Link status.
    UserIpAddress string
    (String) User IP address.
    CloudConnectionId string
    (String) The cloud connection ID.
    ConnectionMode string
    (String) Type of service the gateway is attached to.
    GreSourceAddress string
    (String) The GRE auto-assigned source IP address.
    IbmIpAddress string
    (String) The IBM IP address.
    Id string
    The provider-assigned unique ID for this managed resource.
    Port string
    (String) Port.
    Status string
    (String) Link status.
    UserIpAddress string
    (String) User IP address.
    cloudConnectionId String
    (String) The cloud connection ID.
    connectionMode String
    (String) Type of service the gateway is attached to.
    greSourceAddress String
    (String) The GRE auto-assigned source IP address.
    ibmIpAddress String
    (String) The IBM IP address.
    id String
    The provider-assigned unique ID for this managed resource.
    port String
    (String) Port.
    status String
    (String) Link status.
    userIpAddress String
    (String) User IP address.
    cloudConnectionId string
    (String) The cloud connection ID.
    connectionMode string
    (String) Type of service the gateway is attached to.
    greSourceAddress string
    (String) The GRE auto-assigned source IP address.
    ibmIpAddress string
    (String) The IBM IP address.
    id string
    The provider-assigned unique ID for this managed resource.
    port string
    (String) Port.
    status string
    (String) Link status.
    userIpAddress string
    (String) User IP address.
    cloud_connection_id str
    (String) The cloud connection ID.
    connection_mode str
    (String) Type of service the gateway is attached to.
    gre_source_address str
    (String) The GRE auto-assigned source IP address.
    ibm_ip_address str
    (String) The IBM IP address.
    id str
    The provider-assigned unique ID for this managed resource.
    port str
    (String) Port.
    status str
    (String) Link status.
    user_ip_address str
    (String) User IP address.
    cloudConnectionId String
    (String) The cloud connection ID.
    connectionMode String
    (String) Type of service the gateway is attached to.
    greSourceAddress String
    (String) The GRE auto-assigned source IP address.
    ibmIpAddress String
    (String) The IBM IP address.
    id String
    The provider-assigned unique ID for this managed resource.
    port String
    (String) Port.
    status String
    (String) Link status.
    userIpAddress String
    (String) User IP address.

    Look up Existing PiCloudConnection Resource

    Get an existing PiCloudConnection 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?: PiCloudConnectionState, opts?: CustomResourceOptions): PiCloudConnection
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            cloud_connection_id: Optional[str] = None,
            connection_mode: Optional[str] = None,
            gre_source_address: Optional[str] = None,
            ibm_ip_address: Optional[str] = None,
            pi_cloud_connection_classic_enabled: Optional[bool] = None,
            pi_cloud_connection_global_routing: Optional[bool] = None,
            pi_cloud_connection_gre_cidr: Optional[str] = None,
            pi_cloud_connection_gre_destination_address: Optional[str] = None,
            pi_cloud_connection_id: Optional[str] = None,
            pi_cloud_connection_metered: Optional[bool] = None,
            pi_cloud_connection_name: Optional[str] = None,
            pi_cloud_connection_networks: Optional[Sequence[str]] = None,
            pi_cloud_connection_speed: Optional[float] = None,
            pi_cloud_connection_transit_enabled: Optional[bool] = None,
            pi_cloud_connection_vpc_crns: Optional[Sequence[str]] = None,
            pi_cloud_connection_vpc_enabled: Optional[bool] = None,
            pi_cloud_instance_id: Optional[str] = None,
            port: Optional[str] = None,
            status: Optional[str] = None,
            timeouts: Optional[PiCloudConnectionTimeoutsArgs] = None,
            user_ip_address: Optional[str] = None) -> PiCloudConnection
    func GetPiCloudConnection(ctx *Context, name string, id IDInput, state *PiCloudConnectionState, opts ...ResourceOption) (*PiCloudConnection, error)
    public static PiCloudConnection Get(string name, Input<string> id, PiCloudConnectionState? state, CustomResourceOptions? opts = null)
    public static PiCloudConnection get(String name, Output<String> id, PiCloudConnectionState state, CustomResourceOptions options)
    resources:  _:    type: ibm:PiCloudConnection    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:
    CloudConnectionId string
    (String) The cloud connection ID.
    ConnectionMode string
    (String) Type of service the gateway is attached to.
    GreSourceAddress string
    (String) The GRE auto-assigned source IP address.
    IbmIpAddress string
    (String) The IBM IP address.
    PiCloudConnectionClassicEnabled bool
    Enable classic endpoint destination.
    PiCloudConnectionGlobalRouting bool
    Enable global routing for this cloud connection.
    PiCloudConnectionGreCidr string
    The GRE network in CIDR notation.
    PiCloudConnectionGreDestinationAddress string
    The GRE destination IP address.
    PiCloudConnectionId string
    (String) The unique identifier of cloud connection.
    PiCloudConnectionMetered bool
    Enable metered for this cloud connection.
    PiCloudConnectionName string
    The name of the cloud connection.
    PiCloudConnectionNetworks List<string>
    Set of Networks to attach to this cloud connection.
    PiCloudConnectionSpeed double
    Speed of the cloud connection (speed in megabits per second). Supported values are 50, 100, 200, 500, 1000, 2000, 5000, 10000.
    PiCloudConnectionTransitEnabled bool
    Enable transit gateway for this cloud connection.
    PiCloudConnectionVpcCrns List<string>
    Set of VPC CRNs to attach to this cloud connection.
    PiCloudConnectionVpcEnabled bool
    Enable VPC for this cloud connection.
    PiCloudInstanceId string
    The GUID of the service instance associated with an account.
    Port string
    (String) Port.
    Status string
    (String) Link status.
    Timeouts PiCloudConnectionTimeouts
    UserIpAddress string
    (String) User IP address.
    CloudConnectionId string
    (String) The cloud connection ID.
    ConnectionMode string
    (String) Type of service the gateway is attached to.
    GreSourceAddress string
    (String) The GRE auto-assigned source IP address.
    IbmIpAddress string
    (String) The IBM IP address.
    PiCloudConnectionClassicEnabled bool
    Enable classic endpoint destination.
    PiCloudConnectionGlobalRouting bool
    Enable global routing for this cloud connection.
    PiCloudConnectionGreCidr string
    The GRE network in CIDR notation.
    PiCloudConnectionGreDestinationAddress string
    The GRE destination IP address.
    PiCloudConnectionId string
    (String) The unique identifier of cloud connection.
    PiCloudConnectionMetered bool
    Enable metered for this cloud connection.
    PiCloudConnectionName string
    The name of the cloud connection.
    PiCloudConnectionNetworks []string
    Set of Networks to attach to this cloud connection.
    PiCloudConnectionSpeed float64
    Speed of the cloud connection (speed in megabits per second). Supported values are 50, 100, 200, 500, 1000, 2000, 5000, 10000.
    PiCloudConnectionTransitEnabled bool
    Enable transit gateway for this cloud connection.
    PiCloudConnectionVpcCrns []string
    Set of VPC CRNs to attach to this cloud connection.
    PiCloudConnectionVpcEnabled bool
    Enable VPC for this cloud connection.
    PiCloudInstanceId string
    The GUID of the service instance associated with an account.
    Port string
    (String) Port.
    Status string
    (String) Link status.
    Timeouts PiCloudConnectionTimeoutsArgs
    UserIpAddress string
    (String) User IP address.
    cloudConnectionId String
    (String) The cloud connection ID.
    connectionMode String
    (String) Type of service the gateway is attached to.
    greSourceAddress String
    (String) The GRE auto-assigned source IP address.
    ibmIpAddress String
    (String) The IBM IP address.
    piCloudConnectionClassicEnabled Boolean
    Enable classic endpoint destination.
    piCloudConnectionGlobalRouting Boolean
    Enable global routing for this cloud connection.
    piCloudConnectionGreCidr String
    The GRE network in CIDR notation.
    piCloudConnectionGreDestinationAddress String
    The GRE destination IP address.
    piCloudConnectionId String
    (String) The unique identifier of cloud connection.
    piCloudConnectionMetered Boolean
    Enable metered for this cloud connection.
    piCloudConnectionName String
    The name of the cloud connection.
    piCloudConnectionNetworks List<String>
    Set of Networks to attach to this cloud connection.
    piCloudConnectionSpeed Double
    Speed of the cloud connection (speed in megabits per second). Supported values are 50, 100, 200, 500, 1000, 2000, 5000, 10000.
    piCloudConnectionTransitEnabled Boolean
    Enable transit gateway for this cloud connection.
    piCloudConnectionVpcCrns List<String>
    Set of VPC CRNs to attach to this cloud connection.
    piCloudConnectionVpcEnabled Boolean
    Enable VPC for this cloud connection.
    piCloudInstanceId String
    The GUID of the service instance associated with an account.
    port String
    (String) Port.
    status String
    (String) Link status.
    timeouts PiCloudConnectionTimeouts
    userIpAddress String
    (String) User IP address.
    cloudConnectionId string
    (String) The cloud connection ID.
    connectionMode string
    (String) Type of service the gateway is attached to.
    greSourceAddress string
    (String) The GRE auto-assigned source IP address.
    ibmIpAddress string
    (String) The IBM IP address.
    piCloudConnectionClassicEnabled boolean
    Enable classic endpoint destination.
    piCloudConnectionGlobalRouting boolean
    Enable global routing for this cloud connection.
    piCloudConnectionGreCidr string
    The GRE network in CIDR notation.
    piCloudConnectionGreDestinationAddress string
    The GRE destination IP address.
    piCloudConnectionId string
    (String) The unique identifier of cloud connection.
    piCloudConnectionMetered boolean
    Enable metered for this cloud connection.
    piCloudConnectionName string
    The name of the cloud connection.
    piCloudConnectionNetworks string[]
    Set of Networks to attach to this cloud connection.
    piCloudConnectionSpeed number
    Speed of the cloud connection (speed in megabits per second). Supported values are 50, 100, 200, 500, 1000, 2000, 5000, 10000.
    piCloudConnectionTransitEnabled boolean
    Enable transit gateway for this cloud connection.
    piCloudConnectionVpcCrns string[]
    Set of VPC CRNs to attach to this cloud connection.
    piCloudConnectionVpcEnabled boolean
    Enable VPC for this cloud connection.
    piCloudInstanceId string
    The GUID of the service instance associated with an account.
    port string
    (String) Port.
    status string
    (String) Link status.
    timeouts PiCloudConnectionTimeouts
    userIpAddress string
    (String) User IP address.
    cloud_connection_id str
    (String) The cloud connection ID.
    connection_mode str
    (String) Type of service the gateway is attached to.
    gre_source_address str
    (String) The GRE auto-assigned source IP address.
    ibm_ip_address str
    (String) The IBM IP address.
    pi_cloud_connection_classic_enabled bool
    Enable classic endpoint destination.
    pi_cloud_connection_global_routing bool
    Enable global routing for this cloud connection.
    pi_cloud_connection_gre_cidr str
    The GRE network in CIDR notation.
    pi_cloud_connection_gre_destination_address str
    The GRE destination IP address.
    pi_cloud_connection_id str
    (String) The unique identifier of cloud connection.
    pi_cloud_connection_metered bool
    Enable metered for this cloud connection.
    pi_cloud_connection_name str
    The name of the cloud connection.
    pi_cloud_connection_networks Sequence[str]
    Set of Networks to attach to this cloud connection.
    pi_cloud_connection_speed float
    Speed of the cloud connection (speed in megabits per second). Supported values are 50, 100, 200, 500, 1000, 2000, 5000, 10000.
    pi_cloud_connection_transit_enabled bool
    Enable transit gateway for this cloud connection.
    pi_cloud_connection_vpc_crns Sequence[str]
    Set of VPC CRNs to attach to this cloud connection.
    pi_cloud_connection_vpc_enabled bool
    Enable VPC for this cloud connection.
    pi_cloud_instance_id str
    The GUID of the service instance associated with an account.
    port str
    (String) Port.
    status str
    (String) Link status.
    timeouts PiCloudConnectionTimeoutsArgs
    user_ip_address str
    (String) User IP address.
    cloudConnectionId String
    (String) The cloud connection ID.
    connectionMode String
    (String) Type of service the gateway is attached to.
    greSourceAddress String
    (String) The GRE auto-assigned source IP address.
    ibmIpAddress String
    (String) The IBM IP address.
    piCloudConnectionClassicEnabled Boolean
    Enable classic endpoint destination.
    piCloudConnectionGlobalRouting Boolean
    Enable global routing for this cloud connection.
    piCloudConnectionGreCidr String
    The GRE network in CIDR notation.
    piCloudConnectionGreDestinationAddress String
    The GRE destination IP address.
    piCloudConnectionId String
    (String) The unique identifier of cloud connection.
    piCloudConnectionMetered Boolean
    Enable metered for this cloud connection.
    piCloudConnectionName String
    The name of the cloud connection.
    piCloudConnectionNetworks List<String>
    Set of Networks to attach to this cloud connection.
    piCloudConnectionSpeed Number
    Speed of the cloud connection (speed in megabits per second). Supported values are 50, 100, 200, 500, 1000, 2000, 5000, 10000.
    piCloudConnectionTransitEnabled Boolean
    Enable transit gateway for this cloud connection.
    piCloudConnectionVpcCrns List<String>
    Set of VPC CRNs to attach to this cloud connection.
    piCloudConnectionVpcEnabled Boolean
    Enable VPC for this cloud connection.
    piCloudInstanceId String
    The GUID of the service instance associated with an account.
    port String
    (String) Port.
    status String
    (String) Link status.
    timeouts Property Map
    userIpAddress String
    (String) User IP address.

    Supporting Types

    PiCloudConnectionTimeouts, PiCloudConnectionTimeoutsArgs

    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/piCloudConnection:PiCloudConnection example d7bec597-4726-451f-8a63-e62e6f19c32c/cea6651a-bc0a-4438-9f8a-a0770bbf3ebb
    

    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