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

ibm.MqcloudVirtualPrivateEndpointGateway

Explore with Pulumi AI

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

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as ibm from "@pulumi/ibm";
    
    const mqcloudVirtualPrivateEndpointGatewayInstance = new ibm.MqcloudVirtualPrivateEndpointGateway("mqcloudVirtualPrivateEndpointGatewayInstance", {
        serviceInstanceGuid: "a2b4d4bc-dadb-4637-bcec-9b7d1e723af8",
        targetCrn: "crn:v1:staging:public:mq-eude-stackname:eu-de:::endpoint:qm1.private.stackname.mq2.test.appdomain.cloud",
        trustedProfile: "crn:v1:staging:public:mq-eude-stackname:eu-de:::endpoint:qm1.private.stackname.mq2.test.appdomain.cloud",
    });
    
    import pulumi
    import pulumi_ibm as ibm
    
    mqcloud_virtual_private_endpoint_gateway_instance = ibm.MqcloudVirtualPrivateEndpointGateway("mqcloudVirtualPrivateEndpointGatewayInstance",
        service_instance_guid="a2b4d4bc-dadb-4637-bcec-9b7d1e723af8",
        target_crn="crn:v1:staging:public:mq-eude-stackname:eu-de:::endpoint:qm1.private.stackname.mq2.test.appdomain.cloud",
        trusted_profile="crn:v1:staging:public:mq-eude-stackname:eu-de:::endpoint:qm1.private.stackname.mq2.test.appdomain.cloud")
    
    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.NewMqcloudVirtualPrivateEndpointGateway(ctx, "mqcloudVirtualPrivateEndpointGatewayInstance", &ibm.MqcloudVirtualPrivateEndpointGatewayArgs{
    			ServiceInstanceGuid: pulumi.String("a2b4d4bc-dadb-4637-bcec-9b7d1e723af8"),
    			TargetCrn:           pulumi.String("crn:v1:staging:public:mq-eude-stackname:eu-de:::endpoint:qm1.private.stackname.mq2.test.appdomain.cloud"),
    			TrustedProfile:      pulumi.String("crn:v1:staging:public:mq-eude-stackname:eu-de:::endpoint:qm1.private.stackname.mq2.test.appdomain.cloud"),
    		})
    		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 mqcloudVirtualPrivateEndpointGatewayInstance = new Ibm.MqcloudVirtualPrivateEndpointGateway("mqcloudVirtualPrivateEndpointGatewayInstance", new()
        {
            ServiceInstanceGuid = "a2b4d4bc-dadb-4637-bcec-9b7d1e723af8",
            TargetCrn = "crn:v1:staging:public:mq-eude-stackname:eu-de:::endpoint:qm1.private.stackname.mq2.test.appdomain.cloud",
            TrustedProfile = "crn:v1:staging:public:mq-eude-stackname:eu-de:::endpoint:qm1.private.stackname.mq2.test.appdomain.cloud",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.ibm.MqcloudVirtualPrivateEndpointGateway;
    import com.pulumi.ibm.MqcloudVirtualPrivateEndpointGatewayArgs;
    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 mqcloudVirtualPrivateEndpointGatewayInstance = new MqcloudVirtualPrivateEndpointGateway("mqcloudVirtualPrivateEndpointGatewayInstance", MqcloudVirtualPrivateEndpointGatewayArgs.builder()
                .serviceInstanceGuid("a2b4d4bc-dadb-4637-bcec-9b7d1e723af8")
                .targetCrn("crn:v1:staging:public:mq-eude-stackname:eu-de:::endpoint:qm1.private.stackname.mq2.test.appdomain.cloud")
                .trustedProfile("crn:v1:staging:public:mq-eude-stackname:eu-de:::endpoint:qm1.private.stackname.mq2.test.appdomain.cloud")
                .build());
    
        }
    }
    
    resources:
      mqcloudVirtualPrivateEndpointGatewayInstance:
        type: ibm:MqcloudVirtualPrivateEndpointGateway
        properties:
          serviceInstanceGuid: a2b4d4bc-dadb-4637-bcec-9b7d1e723af8
          targetCrn: crn:v1:staging:public:mq-eude-stackname:eu-de:::endpoint:qm1.private.stackname.mq2.test.appdomain.cloud
          trustedProfile: crn:v1:staging:public:mq-eude-stackname:eu-de:::endpoint:qm1.private.stackname.mq2.test.appdomain.cloud
    

    Create MqcloudVirtualPrivateEndpointGateway Resource

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

    Constructor syntax

    new MqcloudVirtualPrivateEndpointGateway(name: string, args: MqcloudVirtualPrivateEndpointGatewayArgs, opts?: CustomResourceOptions);
    @overload
    def MqcloudVirtualPrivateEndpointGateway(resource_name: str,
                                             args: MqcloudVirtualPrivateEndpointGatewayArgs,
                                             opts: Optional[ResourceOptions] = None)
    
    @overload
    def MqcloudVirtualPrivateEndpointGateway(resource_name: str,
                                             opts: Optional[ResourceOptions] = None,
                                             service_instance_guid: Optional[str] = None,
                                             target_crn: Optional[str] = None,
                                             mqcloud_virtual_private_endpoint_gateway_id: Optional[str] = None,
                                             name: Optional[str] = None,
                                             trusted_profile: Optional[str] = None)
    func NewMqcloudVirtualPrivateEndpointGateway(ctx *Context, name string, args MqcloudVirtualPrivateEndpointGatewayArgs, opts ...ResourceOption) (*MqcloudVirtualPrivateEndpointGateway, error)
    public MqcloudVirtualPrivateEndpointGateway(string name, MqcloudVirtualPrivateEndpointGatewayArgs args, CustomResourceOptions? opts = null)
    public MqcloudVirtualPrivateEndpointGateway(String name, MqcloudVirtualPrivateEndpointGatewayArgs args)
    public MqcloudVirtualPrivateEndpointGateway(String name, MqcloudVirtualPrivateEndpointGatewayArgs args, CustomResourceOptions options)
    
    type: ibm:MqcloudVirtualPrivateEndpointGateway
    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 MqcloudVirtualPrivateEndpointGatewayArgs
    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 MqcloudVirtualPrivateEndpointGatewayArgs
    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 MqcloudVirtualPrivateEndpointGatewayArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args MqcloudVirtualPrivateEndpointGatewayArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args MqcloudVirtualPrivateEndpointGatewayArgs
    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 mqcloudVirtualPrivateEndpointGatewayResource = new Ibm.MqcloudVirtualPrivateEndpointGateway("mqcloudVirtualPrivateEndpointGatewayResource", new()
    {
        ServiceInstanceGuid = "string",
        TargetCrn = "string",
        MqcloudVirtualPrivateEndpointGatewayId = "string",
        Name = "string",
        TrustedProfile = "string",
    });
    
    example, err := ibm.NewMqcloudVirtualPrivateEndpointGateway(ctx, "mqcloudVirtualPrivateEndpointGatewayResource", &ibm.MqcloudVirtualPrivateEndpointGatewayArgs{
    	ServiceInstanceGuid:                    pulumi.String("string"),
    	TargetCrn:                              pulumi.String("string"),
    	MqcloudVirtualPrivateEndpointGatewayId: pulumi.String("string"),
    	Name:                                   pulumi.String("string"),
    	TrustedProfile:                         pulumi.String("string"),
    })
    
    var mqcloudVirtualPrivateEndpointGatewayResource = new MqcloudVirtualPrivateEndpointGateway("mqcloudVirtualPrivateEndpointGatewayResource", MqcloudVirtualPrivateEndpointGatewayArgs.builder()
        .serviceInstanceGuid("string")
        .targetCrn("string")
        .mqcloudVirtualPrivateEndpointGatewayId("string")
        .name("string")
        .trustedProfile("string")
        .build());
    
    mqcloud_virtual_private_endpoint_gateway_resource = ibm.MqcloudVirtualPrivateEndpointGateway("mqcloudVirtualPrivateEndpointGatewayResource",
        service_instance_guid="string",
        target_crn="string",
        mqcloud_virtual_private_endpoint_gateway_id="string",
        name="string",
        trusted_profile="string")
    
    const mqcloudVirtualPrivateEndpointGatewayResource = new ibm.MqcloudVirtualPrivateEndpointGateway("mqcloudVirtualPrivateEndpointGatewayResource", {
        serviceInstanceGuid: "string",
        targetCrn: "string",
        mqcloudVirtualPrivateEndpointGatewayId: "string",
        name: "string",
        trustedProfile: "string",
    });
    
    type: ibm:MqcloudVirtualPrivateEndpointGateway
    properties:
        mqcloudVirtualPrivateEndpointGatewayId: string
        name: string
        serviceInstanceGuid: string
        targetCrn: string
        trustedProfile: string
    

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

    ServiceInstanceGuid string
    The GUID that uniquely identifies the MQaaS service instance.

    • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/.
    TargetCrn string
    The CRN of the reserved capacity service instance the user is trying to connect to.

    • Constraints: The maximum length is 512 characters. The minimum length is 9 characters. The value must match regular expression /^crn:v[0-9]+:[a-z0-9-]+:[a-z0-9-]+:[a-z0-9-]+:[a-z0-9-]*:([a-z]\/[a-z0-9-]+)?:[a-z0-9-]*:[a-z0-9-]*:[a-zA-Z0-9-_\\.\/]*$|^crn:\\[\\.\\.\\.\\]$/.
    MqcloudVirtualPrivateEndpointGatewayId string
    The unique identifier of the mqcloud_virtual_private_endpoint_gateway.
    Name string
    The name of the virtual private endpoint gateway, created by the user.

    • Constraints: The maximum length is 63 characters. The minimum length is 1 character. The value must match regular expression /^[a-z]|[a-z][-a-z0-9]*[a-z0-9]$/.
    TrustedProfile string
    The CRN of the trusted profile to assume for this request.

    • Constraints: The maximum length is 512 characters. The minimum length is 9 characters. The value must match regular expression /^crn:v[0-9]+:[a-z0-9-]+:[a-z0-9-]+:[a-z0-9-]+:[a-z0-9-]*:([a-z]\/[a-z0-9-]+)?:[a-z0-9-]*:[a-z0-9-]*:[a-zA-Z0-9-_\\.\/]*$|^crn:\\[\\.\\.\\.\\]$/.
    ServiceInstanceGuid string
    The GUID that uniquely identifies the MQaaS service instance.

    • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/.
    TargetCrn string
    The CRN of the reserved capacity service instance the user is trying to connect to.

    • Constraints: The maximum length is 512 characters. The minimum length is 9 characters. The value must match regular expression /^crn:v[0-9]+:[a-z0-9-]+:[a-z0-9-]+:[a-z0-9-]+:[a-z0-9-]*:([a-z]\/[a-z0-9-]+)?:[a-z0-9-]*:[a-z0-9-]*:[a-zA-Z0-9-_\\.\/]*$|^crn:\\[\\.\\.\\.\\]$/.
    MqcloudVirtualPrivateEndpointGatewayId string
    The unique identifier of the mqcloud_virtual_private_endpoint_gateway.
    Name string
    The name of the virtual private endpoint gateway, created by the user.

    • Constraints: The maximum length is 63 characters. The minimum length is 1 character. The value must match regular expression /^[a-z]|[a-z][-a-z0-9]*[a-z0-9]$/.
    TrustedProfile string
    The CRN of the trusted profile to assume for this request.

    • Constraints: The maximum length is 512 characters. The minimum length is 9 characters. The value must match regular expression /^crn:v[0-9]+:[a-z0-9-]+:[a-z0-9-]+:[a-z0-9-]+:[a-z0-9-]*:([a-z]\/[a-z0-9-]+)?:[a-z0-9-]*:[a-z0-9-]*:[a-zA-Z0-9-_\\.\/]*$|^crn:\\[\\.\\.\\.\\]$/.
    serviceInstanceGuid String
    The GUID that uniquely identifies the MQaaS service instance.

    • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/.
    targetCrn String
    The CRN of the reserved capacity service instance the user is trying to connect to.

    • Constraints: The maximum length is 512 characters. The minimum length is 9 characters. The value must match regular expression /^crn:v[0-9]+:[a-z0-9-]+:[a-z0-9-]+:[a-z0-9-]+:[a-z0-9-]*:([a-z]\/[a-z0-9-]+)?:[a-z0-9-]*:[a-z0-9-]*:[a-zA-Z0-9-_\\.\/]*$|^crn:\\[\\.\\.\\.\\]$/.
    mqcloudVirtualPrivateEndpointGatewayId String
    The unique identifier of the mqcloud_virtual_private_endpoint_gateway.
    name String
    The name of the virtual private endpoint gateway, created by the user.

    • Constraints: The maximum length is 63 characters. The minimum length is 1 character. The value must match regular expression /^[a-z]|[a-z][-a-z0-9]*[a-z0-9]$/.
    trustedProfile String
    The CRN of the trusted profile to assume for this request.

    • Constraints: The maximum length is 512 characters. The minimum length is 9 characters. The value must match regular expression /^crn:v[0-9]+:[a-z0-9-]+:[a-z0-9-]+:[a-z0-9-]+:[a-z0-9-]*:([a-z]\/[a-z0-9-]+)?:[a-z0-9-]*:[a-z0-9-]*:[a-zA-Z0-9-_\\.\/]*$|^crn:\\[\\.\\.\\.\\]$/.
    serviceInstanceGuid string
    The GUID that uniquely identifies the MQaaS service instance.

    • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/.
    targetCrn string
    The CRN of the reserved capacity service instance the user is trying to connect to.

    • Constraints: The maximum length is 512 characters. The minimum length is 9 characters. The value must match regular expression /^crn:v[0-9]+:[a-z0-9-]+:[a-z0-9-]+:[a-z0-9-]+:[a-z0-9-]*:([a-z]\/[a-z0-9-]+)?:[a-z0-9-]*:[a-z0-9-]*:[a-zA-Z0-9-_\\.\/]*$|^crn:\\[\\.\\.\\.\\]$/.
    mqcloudVirtualPrivateEndpointGatewayId string
    The unique identifier of the mqcloud_virtual_private_endpoint_gateway.
    name string
    The name of the virtual private endpoint gateway, created by the user.

    • Constraints: The maximum length is 63 characters. The minimum length is 1 character. The value must match regular expression /^[a-z]|[a-z][-a-z0-9]*[a-z0-9]$/.
    trustedProfile string
    The CRN of the trusted profile to assume for this request.

    • Constraints: The maximum length is 512 characters. The minimum length is 9 characters. The value must match regular expression /^crn:v[0-9]+:[a-z0-9-]+:[a-z0-9-]+:[a-z0-9-]+:[a-z0-9-]*:([a-z]\/[a-z0-9-]+)?:[a-z0-9-]*:[a-z0-9-]*:[a-zA-Z0-9-_\\.\/]*$|^crn:\\[\\.\\.\\.\\]$/.
    service_instance_guid str
    The GUID that uniquely identifies the MQaaS service instance.

    • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/.
    target_crn str
    The CRN of the reserved capacity service instance the user is trying to connect to.

    • Constraints: The maximum length is 512 characters. The minimum length is 9 characters. The value must match regular expression /^crn:v[0-9]+:[a-z0-9-]+:[a-z0-9-]+:[a-z0-9-]+:[a-z0-9-]*:([a-z]\/[a-z0-9-]+)?:[a-z0-9-]*:[a-z0-9-]*:[a-zA-Z0-9-_\\.\/]*$|^crn:\\[\\.\\.\\.\\]$/.
    mqcloud_virtual_private_endpoint_gateway_id str
    The unique identifier of the mqcloud_virtual_private_endpoint_gateway.
    name str
    The name of the virtual private endpoint gateway, created by the user.

    • Constraints: The maximum length is 63 characters. The minimum length is 1 character. The value must match regular expression /^[a-z]|[a-z][-a-z0-9]*[a-z0-9]$/.
    trusted_profile str
    The CRN of the trusted profile to assume for this request.

    • Constraints: The maximum length is 512 characters. The minimum length is 9 characters. The value must match regular expression /^crn:v[0-9]+:[a-z0-9-]+:[a-z0-9-]+:[a-z0-9-]+:[a-z0-9-]*:([a-z]\/[a-z0-9-]+)?:[a-z0-9-]*:[a-z0-9-]*:[a-zA-Z0-9-_\\.\/]*$|^crn:\\[\\.\\.\\.\\]$/.
    serviceInstanceGuid String
    The GUID that uniquely identifies the MQaaS service instance.

    • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/.
    targetCrn String
    The CRN of the reserved capacity service instance the user is trying to connect to.

    • Constraints: The maximum length is 512 characters. The minimum length is 9 characters. The value must match regular expression /^crn:v[0-9]+:[a-z0-9-]+:[a-z0-9-]+:[a-z0-9-]+:[a-z0-9-]*:([a-z]\/[a-z0-9-]+)?:[a-z0-9-]*:[a-z0-9-]*:[a-zA-Z0-9-_\\.\/]*$|^crn:\\[\\.\\.\\.\\]$/.
    mqcloudVirtualPrivateEndpointGatewayId String
    The unique identifier of the mqcloud_virtual_private_endpoint_gateway.
    name String
    The name of the virtual private endpoint gateway, created by the user.

    • Constraints: The maximum length is 63 characters. The minimum length is 1 character. The value must match regular expression /^[a-z]|[a-z][-a-z0-9]*[a-z0-9]$/.
    trustedProfile String
    The CRN of the trusted profile to assume for this request.

    • Constraints: The maximum length is 512 characters. The minimum length is 9 characters. The value must match regular expression /^crn:v[0-9]+:[a-z0-9-]+:[a-z0-9-]+:[a-z0-9-]+:[a-z0-9-]*:([a-z]\/[a-z0-9-]+)?:[a-z0-9-]*:[a-z0-9-]*:[a-zA-Z0-9-_\\.\/]*$|^crn:\\[\\.\\.\\.\\]$/.

    Outputs

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

    Href string
    (String) URL for the details of the virtual private endpoint gateway.

    • Constraints: The maximum length is 8000 characters. The minimum length is 10 characters. The value must match regular expression /^http(s)?:\/\/([^\/?#]*)([^?#]*)(\\?([^#]*))?(#(.*))?$/.
    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    (String) The lifecycle state of this virtual privage endpoint.

    • Constraints: The maximum length is 12 characters. The minimum length is 2 characters. The value must match regular expression /^deleting$|failed$|pending$|stable$|suspended$|updating$|waiting$/.
    VirtualPrivateEndpointGatewayGuid string
    (String) The ID of the virtual private endpoint gateway which was allocated on creation.

    • Constraints: The maximum length is 41 characters. The minimum length is 41 characters. The value must match regular expression /^[0-9a-zA-Z]{4}-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/.
    Href string
    (String) URL for the details of the virtual private endpoint gateway.

    • Constraints: The maximum length is 8000 characters. The minimum length is 10 characters. The value must match regular expression /^http(s)?:\/\/([^\/?#]*)([^?#]*)(\\?([^#]*))?(#(.*))?$/.
    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    (String) The lifecycle state of this virtual privage endpoint.

    • Constraints: The maximum length is 12 characters. The minimum length is 2 characters. The value must match regular expression /^deleting$|failed$|pending$|stable$|suspended$|updating$|waiting$/.
    VirtualPrivateEndpointGatewayGuid string
    (String) The ID of the virtual private endpoint gateway which was allocated on creation.

    • Constraints: The maximum length is 41 characters. The minimum length is 41 characters. The value must match regular expression /^[0-9a-zA-Z]{4}-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/.
    href String
    (String) URL for the details of the virtual private endpoint gateway.

    • Constraints: The maximum length is 8000 characters. The minimum length is 10 characters. The value must match regular expression /^http(s)?:\/\/([^\/?#]*)([^?#]*)(\\?([^#]*))?(#(.*))?$/.
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    (String) The lifecycle state of this virtual privage endpoint.

    • Constraints: The maximum length is 12 characters. The minimum length is 2 characters. The value must match regular expression /^deleting$|failed$|pending$|stable$|suspended$|updating$|waiting$/.
    virtualPrivateEndpointGatewayGuid String
    (String) The ID of the virtual private endpoint gateway which was allocated on creation.

    • Constraints: The maximum length is 41 characters. The minimum length is 41 characters. The value must match regular expression /^[0-9a-zA-Z]{4}-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/.
    href string
    (String) URL for the details of the virtual private endpoint gateway.

    • Constraints: The maximum length is 8000 characters. The minimum length is 10 characters. The value must match regular expression /^http(s)?:\/\/([^\/?#]*)([^?#]*)(\\?([^#]*))?(#(.*))?$/.
    id string
    The provider-assigned unique ID for this managed resource.
    status string
    (String) The lifecycle state of this virtual privage endpoint.

    • Constraints: The maximum length is 12 characters. The minimum length is 2 characters. The value must match regular expression /^deleting$|failed$|pending$|stable$|suspended$|updating$|waiting$/.
    virtualPrivateEndpointGatewayGuid string
    (String) The ID of the virtual private endpoint gateway which was allocated on creation.

    • Constraints: The maximum length is 41 characters. The minimum length is 41 characters. The value must match regular expression /^[0-9a-zA-Z]{4}-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/.
    href str
    (String) URL for the details of the virtual private endpoint gateway.

    • Constraints: The maximum length is 8000 characters. The minimum length is 10 characters. The value must match regular expression /^http(s)?:\/\/([^\/?#]*)([^?#]*)(\\?([^#]*))?(#(.*))?$/.
    id str
    The provider-assigned unique ID for this managed resource.
    status str
    (String) The lifecycle state of this virtual privage endpoint.

    • Constraints: The maximum length is 12 characters. The minimum length is 2 characters. The value must match regular expression /^deleting$|failed$|pending$|stable$|suspended$|updating$|waiting$/.
    virtual_private_endpoint_gateway_guid str
    (String) The ID of the virtual private endpoint gateway which was allocated on creation.

    • Constraints: The maximum length is 41 characters. The minimum length is 41 characters. The value must match regular expression /^[0-9a-zA-Z]{4}-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/.
    href String
    (String) URL for the details of the virtual private endpoint gateway.

    • Constraints: The maximum length is 8000 characters. The minimum length is 10 characters. The value must match regular expression /^http(s)?:\/\/([^\/?#]*)([^?#]*)(\\?([^#]*))?(#(.*))?$/.
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    (String) The lifecycle state of this virtual privage endpoint.

    • Constraints: The maximum length is 12 characters. The minimum length is 2 characters. The value must match regular expression /^deleting$|failed$|pending$|stable$|suspended$|updating$|waiting$/.
    virtualPrivateEndpointGatewayGuid String
    (String) The ID of the virtual private endpoint gateway which was allocated on creation.

    • Constraints: The maximum length is 41 characters. The minimum length is 41 characters. The value must match regular expression /^[0-9a-zA-Z]{4}-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/.

    Look up Existing MqcloudVirtualPrivateEndpointGateway Resource

    Get an existing MqcloudVirtualPrivateEndpointGateway 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?: MqcloudVirtualPrivateEndpointGatewayState, opts?: CustomResourceOptions): MqcloudVirtualPrivateEndpointGateway
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            href: Optional[str] = None,
            mqcloud_virtual_private_endpoint_gateway_id: Optional[str] = None,
            name: Optional[str] = None,
            service_instance_guid: Optional[str] = None,
            status: Optional[str] = None,
            target_crn: Optional[str] = None,
            trusted_profile: Optional[str] = None,
            virtual_private_endpoint_gateway_guid: Optional[str] = None) -> MqcloudVirtualPrivateEndpointGateway
    func GetMqcloudVirtualPrivateEndpointGateway(ctx *Context, name string, id IDInput, state *MqcloudVirtualPrivateEndpointGatewayState, opts ...ResourceOption) (*MqcloudVirtualPrivateEndpointGateway, error)
    public static MqcloudVirtualPrivateEndpointGateway Get(string name, Input<string> id, MqcloudVirtualPrivateEndpointGatewayState? state, CustomResourceOptions? opts = null)
    public static MqcloudVirtualPrivateEndpointGateway get(String name, Output<String> id, MqcloudVirtualPrivateEndpointGatewayState state, CustomResourceOptions options)
    resources:  _:    type: ibm:MqcloudVirtualPrivateEndpointGateway    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:
    Href string
    (String) URL for the details of the virtual private endpoint gateway.

    • Constraints: The maximum length is 8000 characters. The minimum length is 10 characters. The value must match regular expression /^http(s)?:\/\/([^\/?#]*)([^?#]*)(\\?([^#]*))?(#(.*))?$/.
    MqcloudVirtualPrivateEndpointGatewayId string
    The unique identifier of the mqcloud_virtual_private_endpoint_gateway.
    Name string
    The name of the virtual private endpoint gateway, created by the user.

    • Constraints: The maximum length is 63 characters. The minimum length is 1 character. The value must match regular expression /^[a-z]|[a-z][-a-z0-9]*[a-z0-9]$/.
    ServiceInstanceGuid string
    The GUID that uniquely identifies the MQaaS service instance.

    • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/.
    Status string
    (String) The lifecycle state of this virtual privage endpoint.

    • Constraints: The maximum length is 12 characters. The minimum length is 2 characters. The value must match regular expression /^deleting$|failed$|pending$|stable$|suspended$|updating$|waiting$/.
    TargetCrn string
    The CRN of the reserved capacity service instance the user is trying to connect to.

    • Constraints: The maximum length is 512 characters. The minimum length is 9 characters. The value must match regular expression /^crn:v[0-9]+:[a-z0-9-]+:[a-z0-9-]+:[a-z0-9-]+:[a-z0-9-]*:([a-z]\/[a-z0-9-]+)?:[a-z0-9-]*:[a-z0-9-]*:[a-zA-Z0-9-_\\.\/]*$|^crn:\\[\\.\\.\\.\\]$/.
    TrustedProfile string
    The CRN of the trusted profile to assume for this request.

    • Constraints: The maximum length is 512 characters. The minimum length is 9 characters. The value must match regular expression /^crn:v[0-9]+:[a-z0-9-]+:[a-z0-9-]+:[a-z0-9-]+:[a-z0-9-]*:([a-z]\/[a-z0-9-]+)?:[a-z0-9-]*:[a-z0-9-]*:[a-zA-Z0-9-_\\.\/]*$|^crn:\\[\\.\\.\\.\\]$/.
    VirtualPrivateEndpointGatewayGuid string
    (String) The ID of the virtual private endpoint gateway which was allocated on creation.

    • Constraints: The maximum length is 41 characters. The minimum length is 41 characters. The value must match regular expression /^[0-9a-zA-Z]{4}-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/.
    Href string
    (String) URL for the details of the virtual private endpoint gateway.

    • Constraints: The maximum length is 8000 characters. The minimum length is 10 characters. The value must match regular expression /^http(s)?:\/\/([^\/?#]*)([^?#]*)(\\?([^#]*))?(#(.*))?$/.
    MqcloudVirtualPrivateEndpointGatewayId string
    The unique identifier of the mqcloud_virtual_private_endpoint_gateway.
    Name string
    The name of the virtual private endpoint gateway, created by the user.

    • Constraints: The maximum length is 63 characters. The minimum length is 1 character. The value must match regular expression /^[a-z]|[a-z][-a-z0-9]*[a-z0-9]$/.
    ServiceInstanceGuid string
    The GUID that uniquely identifies the MQaaS service instance.

    • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/.
    Status string
    (String) The lifecycle state of this virtual privage endpoint.

    • Constraints: The maximum length is 12 characters. The minimum length is 2 characters. The value must match regular expression /^deleting$|failed$|pending$|stable$|suspended$|updating$|waiting$/.
    TargetCrn string
    The CRN of the reserved capacity service instance the user is trying to connect to.

    • Constraints: The maximum length is 512 characters. The minimum length is 9 characters. The value must match regular expression /^crn:v[0-9]+:[a-z0-9-]+:[a-z0-9-]+:[a-z0-9-]+:[a-z0-9-]*:([a-z]\/[a-z0-9-]+)?:[a-z0-9-]*:[a-z0-9-]*:[a-zA-Z0-9-_\\.\/]*$|^crn:\\[\\.\\.\\.\\]$/.
    TrustedProfile string
    The CRN of the trusted profile to assume for this request.

    • Constraints: The maximum length is 512 characters. The minimum length is 9 characters. The value must match regular expression /^crn:v[0-9]+:[a-z0-9-]+:[a-z0-9-]+:[a-z0-9-]+:[a-z0-9-]*:([a-z]\/[a-z0-9-]+)?:[a-z0-9-]*:[a-z0-9-]*:[a-zA-Z0-9-_\\.\/]*$|^crn:\\[\\.\\.\\.\\]$/.
    VirtualPrivateEndpointGatewayGuid string
    (String) The ID of the virtual private endpoint gateway which was allocated on creation.

    • Constraints: The maximum length is 41 characters. The minimum length is 41 characters. The value must match regular expression /^[0-9a-zA-Z]{4}-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/.
    href String
    (String) URL for the details of the virtual private endpoint gateway.

    • Constraints: The maximum length is 8000 characters. The minimum length is 10 characters. The value must match regular expression /^http(s)?:\/\/([^\/?#]*)([^?#]*)(\\?([^#]*))?(#(.*))?$/.
    mqcloudVirtualPrivateEndpointGatewayId String
    The unique identifier of the mqcloud_virtual_private_endpoint_gateway.
    name String
    The name of the virtual private endpoint gateway, created by the user.

    • Constraints: The maximum length is 63 characters. The minimum length is 1 character. The value must match regular expression /^[a-z]|[a-z][-a-z0-9]*[a-z0-9]$/.
    serviceInstanceGuid String
    The GUID that uniquely identifies the MQaaS service instance.

    • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/.
    status String
    (String) The lifecycle state of this virtual privage endpoint.

    • Constraints: The maximum length is 12 characters. The minimum length is 2 characters. The value must match regular expression /^deleting$|failed$|pending$|stable$|suspended$|updating$|waiting$/.
    targetCrn String
    The CRN of the reserved capacity service instance the user is trying to connect to.

    • Constraints: The maximum length is 512 characters. The minimum length is 9 characters. The value must match regular expression /^crn:v[0-9]+:[a-z0-9-]+:[a-z0-9-]+:[a-z0-9-]+:[a-z0-9-]*:([a-z]\/[a-z0-9-]+)?:[a-z0-9-]*:[a-z0-9-]*:[a-zA-Z0-9-_\\.\/]*$|^crn:\\[\\.\\.\\.\\]$/.
    trustedProfile String
    The CRN of the trusted profile to assume for this request.

    • Constraints: The maximum length is 512 characters. The minimum length is 9 characters. The value must match regular expression /^crn:v[0-9]+:[a-z0-9-]+:[a-z0-9-]+:[a-z0-9-]+:[a-z0-9-]*:([a-z]\/[a-z0-9-]+)?:[a-z0-9-]*:[a-z0-9-]*:[a-zA-Z0-9-_\\.\/]*$|^crn:\\[\\.\\.\\.\\]$/.
    virtualPrivateEndpointGatewayGuid String
    (String) The ID of the virtual private endpoint gateway which was allocated on creation.

    • Constraints: The maximum length is 41 characters. The minimum length is 41 characters. The value must match regular expression /^[0-9a-zA-Z]{4}-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/.
    href string
    (String) URL for the details of the virtual private endpoint gateway.

    • Constraints: The maximum length is 8000 characters. The minimum length is 10 characters. The value must match regular expression /^http(s)?:\/\/([^\/?#]*)([^?#]*)(\\?([^#]*))?(#(.*))?$/.
    mqcloudVirtualPrivateEndpointGatewayId string
    The unique identifier of the mqcloud_virtual_private_endpoint_gateway.
    name string
    The name of the virtual private endpoint gateway, created by the user.

    • Constraints: The maximum length is 63 characters. The minimum length is 1 character. The value must match regular expression /^[a-z]|[a-z][-a-z0-9]*[a-z0-9]$/.
    serviceInstanceGuid string
    The GUID that uniquely identifies the MQaaS service instance.

    • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/.
    status string
    (String) The lifecycle state of this virtual privage endpoint.

    • Constraints: The maximum length is 12 characters. The minimum length is 2 characters. The value must match regular expression /^deleting$|failed$|pending$|stable$|suspended$|updating$|waiting$/.
    targetCrn string
    The CRN of the reserved capacity service instance the user is trying to connect to.

    • Constraints: The maximum length is 512 characters. The minimum length is 9 characters. The value must match regular expression /^crn:v[0-9]+:[a-z0-9-]+:[a-z0-9-]+:[a-z0-9-]+:[a-z0-9-]*:([a-z]\/[a-z0-9-]+)?:[a-z0-9-]*:[a-z0-9-]*:[a-zA-Z0-9-_\\.\/]*$|^crn:\\[\\.\\.\\.\\]$/.
    trustedProfile string
    The CRN of the trusted profile to assume for this request.

    • Constraints: The maximum length is 512 characters. The minimum length is 9 characters. The value must match regular expression /^crn:v[0-9]+:[a-z0-9-]+:[a-z0-9-]+:[a-z0-9-]+:[a-z0-9-]*:([a-z]\/[a-z0-9-]+)?:[a-z0-9-]*:[a-z0-9-]*:[a-zA-Z0-9-_\\.\/]*$|^crn:\\[\\.\\.\\.\\]$/.
    virtualPrivateEndpointGatewayGuid string
    (String) The ID of the virtual private endpoint gateway which was allocated on creation.

    • Constraints: The maximum length is 41 characters. The minimum length is 41 characters. The value must match regular expression /^[0-9a-zA-Z]{4}-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/.
    href str
    (String) URL for the details of the virtual private endpoint gateway.

    • Constraints: The maximum length is 8000 characters. The minimum length is 10 characters. The value must match regular expression /^http(s)?:\/\/([^\/?#]*)([^?#]*)(\\?([^#]*))?(#(.*))?$/.
    mqcloud_virtual_private_endpoint_gateway_id str
    The unique identifier of the mqcloud_virtual_private_endpoint_gateway.
    name str
    The name of the virtual private endpoint gateway, created by the user.

    • Constraints: The maximum length is 63 characters. The minimum length is 1 character. The value must match regular expression /^[a-z]|[a-z][-a-z0-9]*[a-z0-9]$/.
    service_instance_guid str
    The GUID that uniquely identifies the MQaaS service instance.

    • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/.
    status str
    (String) The lifecycle state of this virtual privage endpoint.

    • Constraints: The maximum length is 12 characters. The minimum length is 2 characters. The value must match regular expression /^deleting$|failed$|pending$|stable$|suspended$|updating$|waiting$/.
    target_crn str
    The CRN of the reserved capacity service instance the user is trying to connect to.

    • Constraints: The maximum length is 512 characters. The minimum length is 9 characters. The value must match regular expression /^crn:v[0-9]+:[a-z0-9-]+:[a-z0-9-]+:[a-z0-9-]+:[a-z0-9-]*:([a-z]\/[a-z0-9-]+)?:[a-z0-9-]*:[a-z0-9-]*:[a-zA-Z0-9-_\\.\/]*$|^crn:\\[\\.\\.\\.\\]$/.
    trusted_profile str
    The CRN of the trusted profile to assume for this request.

    • Constraints: The maximum length is 512 characters. The minimum length is 9 characters. The value must match regular expression /^crn:v[0-9]+:[a-z0-9-]+:[a-z0-9-]+:[a-z0-9-]+:[a-z0-9-]*:([a-z]\/[a-z0-9-]+)?:[a-z0-9-]*:[a-z0-9-]*:[a-zA-Z0-9-_\\.\/]*$|^crn:\\[\\.\\.\\.\\]$/.
    virtual_private_endpoint_gateway_guid str
    (String) The ID of the virtual private endpoint gateway which was allocated on creation.

    • Constraints: The maximum length is 41 characters. The minimum length is 41 characters. The value must match regular expression /^[0-9a-zA-Z]{4}-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/.
    href String
    (String) URL for the details of the virtual private endpoint gateway.

    • Constraints: The maximum length is 8000 characters. The minimum length is 10 characters. The value must match regular expression /^http(s)?:\/\/([^\/?#]*)([^?#]*)(\\?([^#]*))?(#(.*))?$/.
    mqcloudVirtualPrivateEndpointGatewayId String
    The unique identifier of the mqcloud_virtual_private_endpoint_gateway.
    name String
    The name of the virtual private endpoint gateway, created by the user.

    • Constraints: The maximum length is 63 characters. The minimum length is 1 character. The value must match regular expression /^[a-z]|[a-z][-a-z0-9]*[a-z0-9]$/.
    serviceInstanceGuid String
    The GUID that uniquely identifies the MQaaS service instance.

    • Constraints: The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/.
    status String
    (String) The lifecycle state of this virtual privage endpoint.

    • Constraints: The maximum length is 12 characters. The minimum length is 2 characters. The value must match regular expression /^deleting$|failed$|pending$|stable$|suspended$|updating$|waiting$/.
    targetCrn String
    The CRN of the reserved capacity service instance the user is trying to connect to.

    • Constraints: The maximum length is 512 characters. The minimum length is 9 characters. The value must match regular expression /^crn:v[0-9]+:[a-z0-9-]+:[a-z0-9-]+:[a-z0-9-]+:[a-z0-9-]*:([a-z]\/[a-z0-9-]+)?:[a-z0-9-]*:[a-z0-9-]*:[a-zA-Z0-9-_\\.\/]*$|^crn:\\[\\.\\.\\.\\]$/.
    trustedProfile String
    The CRN of the trusted profile to assume for this request.

    • Constraints: The maximum length is 512 characters. The minimum length is 9 characters. The value must match regular expression /^crn:v[0-9]+:[a-z0-9-]+:[a-z0-9-]+:[a-z0-9-]+:[a-z0-9-]*:([a-z]\/[a-z0-9-]+)?:[a-z0-9-]*:[a-z0-9-]*:[a-zA-Z0-9-_\\.\/]*$|^crn:\\[\\.\\.\\.\\]$/.
    virtualPrivateEndpointGatewayGuid String
    (String) The ID of the virtual private endpoint gateway which was allocated on creation.

    • Constraints: The maximum length is 41 characters. The minimum length is 41 characters. The value must match regular expression /^[0-9a-zA-Z]{4}-[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/.

    Import

    You can import the ibm_mqcloud_virtual_private_endpoint_gateway resource by using id.

    The id property can be formed from service_instance_guid, and virtual_private_endpoint_gateway_guid in the following format:

    
    <service_instance_guid>/<virtual_private_endpoint_gateway_guid>
    
    
    • service_instance_guid: A string in the format a2b4d4bc-dadb-4637-bcec-9b7d1e723af8. The GUID that uniquely identifies the MQaaS service instance.

    • virtual_private_endpoint_gateway_guid: A string. The ID of the virtual private endpoint gateway which was allocated on creation.

    Syntax

    
    ```sh
    $ pulumi import ibm:index/mqcloudVirtualPrivateEndpointGateway:MqcloudVirtualPrivateEndpointGateway mqcloud_virtual_private_endpoint_gateway <service_instance_guid>/<virtual_private_endpoint_gateway_guid>
    ```
    
    

    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