1. Packages
  2. Confluent Provider
  3. API Docs
  4. getGateway
Viewing docs for Confluent v2.61.0
published on Saturday, Mar 21, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-confluentcloud

confluentcloud.getGateway

confluentcloud logo
Viewing docs for Confluent v2.61.0
published on Saturday, Mar 21, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-confluentcloud

    General Availability

    confluentcloud.Gateway describes a Gateway data source.

    Example Usage

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

const main = confluentcloud.getGateway({
    id: "gw-abc123",
    environment: {
        id: "env-123abc",
    },
});
export const gateway = main;

    import pulumi
import pulumi_confluentcloud as confluentcloud

main = confluentcloud.get_gateway(id="gw-abc123",
    environment={
        "id": "env-123abc",
    })
pulumi.export("gateway", main)

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		main, err := confluentcloud.LookupGateway(ctx, &confluentcloud.LookupGatewayArgs{
			Id: "gw-abc123",
			Environment: confluentcloud.GetGatewayEnvironment{
				Id: "env-123abc",
			},
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("gateway", main)
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var main = ConfluentCloud.GetGateway.Invoke(new()
    {
        Id = "gw-abc123",
        Environment = new ConfluentCloud.Inputs.GetGatewayEnvironmentInputArgs
        {
            Id = "env-123abc",
        },
    });

    return new Dictionary<string, object?>
    {
        ["gateway"] = main,
    };
});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.confluentcloud.ConfluentcloudFunctions;
import com.pulumi.confluentcloud.inputs.GetGatewayArgs;
import com.pulumi.confluentcloud.inputs.GetGatewayEnvironmentArgs;
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 main = ConfluentcloudFunctions.getGateway(GetGatewayArgs.builder()
            .id("gw-abc123")
            .environment(GetGatewayEnvironmentArgs.builder()
                .id("env-123abc")
                .build())
            .build());

        ctx.export("gateway", main);
    }
}

    variables:
  main:
    fn::invoke:
      function: confluentcloud:getGateway
      arguments:
        id: gw-abc123
        environment:
          id: env-123abc
outputs:
  gateway: ${main}

    Using getGateway

    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 getGateway(args: GetGatewayArgs, opts?: InvokeOptions): Promise<GetGatewayResult>
function getGatewayOutput(args: GetGatewayOutputArgs, opts?: InvokeOptions): Output<GetGatewayResult>
    def get_gateway(environment: Optional[GetGatewayEnvironment] = None,
                id: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetGatewayResult
def get_gateway_output(environment: Optional[pulumi.Input[GetGatewayEnvironmentArgs]] = None,
                id: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetGatewayResult]
    func LookupGateway(ctx *Context, args *LookupGatewayArgs, opts ...InvokeOption) (*LookupGatewayResult, error)
func LookupGatewayOutput(ctx *Context, args *LookupGatewayOutputArgs, opts ...InvokeOption) LookupGatewayResultOutput

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

    public static class GetGateway 
{
    public static Task<GetGatewayResult> InvokeAsync(GetGatewayArgs args, InvokeOptions? opts = null)
    public static Output<GetGatewayResult> Invoke(GetGatewayInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetGatewayResult> getGateway(GetGatewayArgs args, InvokeOptions options)
public static Output<GetGatewayResult> getGateway(GetGatewayArgs args, InvokeOptions options)

    fn::invoke:
  function: confluentcloud:index/getGateway:getGateway
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Environment Pulumi.ConfluentCloud.Inputs.GetGatewayEnvironment
    Id string
    The ID of the Gateway, for example, gw-abc123.
    Environment GetGatewayEnvironment
    Id string
    The ID of the Gateway, for example, gw-abc123.
    environment GetGatewayEnvironment
    id String
    The ID of the Gateway, for example, gw-abc123.
    environment GetGatewayEnvironment
    id string
    The ID of the Gateway, for example, gw-abc123.
    environment GetGatewayEnvironment
    id str
    The ID of the Gateway, for example, gw-abc123.
    environment Property Map
    id String
    The ID of the Gateway, for example, gw-abc123.

    getGateway Result

    The following output properties are available:

    AwsEgressPrivateLinkGateways List<Pulumi.ConfluentCloud.Outputs.GetGatewayAwsEgressPrivateLinkGateway>
    (Optional Configuration Block) supports the following:
    AwsIngressPrivateLinkGateways List<Pulumi.ConfluentCloud.Outputs.GetGatewayAwsIngressPrivateLinkGateway>
    (Optional Configuration Block) supports the following:
    AwsPeeringGateways List<Pulumi.ConfluentCloud.Outputs.GetGatewayAwsPeeringGateway>
    (Optional Configuration Block) supports the following:
    AwsPrivateNetworkInterfaceGateways List<Pulumi.ConfluentCloud.Outputs.GetGatewayAwsPrivateNetworkInterfaceGateway>
    (Optional Configuration Block) supports the following:
    AzureEgressPrivateLinkGateways List<Pulumi.ConfluentCloud.Outputs.GetGatewayAzureEgressPrivateLinkGateway>
    (Optional Configuration Block) supports the following:
    AzurePeeringGateways List<Pulumi.ConfluentCloud.Outputs.GetGatewayAzurePeeringGateway>
    (Optional Configuration Block) supports the following:
    DisplayName string
    (Required String) A human-readable name for the Gateway.
    Environment Pulumi.ConfluentCloud.Outputs.GetGatewayEnvironment
    GcpEgressPrivateServiceConnectGateways List<Pulumi.ConfluentCloud.Outputs.GetGatewayGcpEgressPrivateServiceConnectGateway>
    (Optional Configuration Block) supports the following:
    GcpPeeringGateways List<Pulumi.ConfluentCloud.Outputs.GetGatewayGcpPeeringGateway>
    (Optional Configuration Block) supports the following:
    Id string
    AwsEgressPrivateLinkGateways []GetGatewayAwsEgressPrivateLinkGateway
    (Optional Configuration Block) supports the following:
    AwsIngressPrivateLinkGateways []GetGatewayAwsIngressPrivateLinkGateway
    (Optional Configuration Block) supports the following:
    AwsPeeringGateways []GetGatewayAwsPeeringGateway
    (Optional Configuration Block) supports the following:
    AwsPrivateNetworkInterfaceGateways []GetGatewayAwsPrivateNetworkInterfaceGateway
    (Optional Configuration Block) supports the following:
    AzureEgressPrivateLinkGateways []GetGatewayAzureEgressPrivateLinkGateway
    (Optional Configuration Block) supports the following:
    AzurePeeringGateways []GetGatewayAzurePeeringGateway
    (Optional Configuration Block) supports the following:
    DisplayName string
    (Required String) A human-readable name for the Gateway.
    Environment GetGatewayEnvironment
    GcpEgressPrivateServiceConnectGateways []GetGatewayGcpEgressPrivateServiceConnectGateway
    (Optional Configuration Block) supports the following:
    GcpPeeringGateways []GetGatewayGcpPeeringGateway
    (Optional Configuration Block) supports the following:
    Id string
    awsEgressPrivateLinkGateways List<GetGatewayAwsEgressPrivateLinkGateway>
    (Optional Configuration Block) supports the following:
    awsIngressPrivateLinkGateways List<GetGatewayAwsIngressPrivateLinkGateway>
    (Optional Configuration Block) supports the following:
    awsPeeringGateways List<GetGatewayAwsPeeringGateway>
    (Optional Configuration Block) supports the following:
    awsPrivateNetworkInterfaceGateways List<GetGatewayAwsPrivateNetworkInterfaceGateway>
    (Optional Configuration Block) supports the following:
    azureEgressPrivateLinkGateways List<GetGatewayAzureEgressPrivateLinkGateway>
    (Optional Configuration Block) supports the following:
    azurePeeringGateways List<GetGatewayAzurePeeringGateway>
    (Optional Configuration Block) supports the following:
    displayName String
    (Required String) A human-readable name for the Gateway.
    environment GetGatewayEnvironment
    gcpEgressPrivateServiceConnectGateways List<GetGatewayGcpEgressPrivateServiceConnectGateway>
    (Optional Configuration Block) supports the following:
    gcpPeeringGateways List<GetGatewayGcpPeeringGateway>
    (Optional Configuration Block) supports the following:
    id String
    awsEgressPrivateLinkGateways GetGatewayAwsEgressPrivateLinkGateway[]
    (Optional Configuration Block) supports the following:
    awsIngressPrivateLinkGateways GetGatewayAwsIngressPrivateLinkGateway[]
    (Optional Configuration Block) supports the following:
    awsPeeringGateways GetGatewayAwsPeeringGateway[]
    (Optional Configuration Block) supports the following:
    awsPrivateNetworkInterfaceGateways GetGatewayAwsPrivateNetworkInterfaceGateway[]
    (Optional Configuration Block) supports the following:
    azureEgressPrivateLinkGateways GetGatewayAzureEgressPrivateLinkGateway[]
    (Optional Configuration Block) supports the following:
    azurePeeringGateways GetGatewayAzurePeeringGateway[]
    (Optional Configuration Block) supports the following:
    displayName string
    (Required String) A human-readable name for the Gateway.
    environment GetGatewayEnvironment
    gcpEgressPrivateServiceConnectGateways GetGatewayGcpEgressPrivateServiceConnectGateway[]
    (Optional Configuration Block) supports the following:
    gcpPeeringGateways GetGatewayGcpPeeringGateway[]
    (Optional Configuration Block) supports the following:
    id string
    aws_egress_private_link_gateways Sequence[GetGatewayAwsEgressPrivateLinkGateway]
    (Optional Configuration Block) supports the following:
    aws_ingress_private_link_gateways Sequence[GetGatewayAwsIngressPrivateLinkGateway]
    (Optional Configuration Block) supports the following:
    aws_peering_gateways Sequence[GetGatewayAwsPeeringGateway]
    (Optional Configuration Block) supports the following:
    aws_private_network_interface_gateways Sequence[GetGatewayAwsPrivateNetworkInterfaceGateway]
    (Optional Configuration Block) supports the following:
    azure_egress_private_link_gateways Sequence[GetGatewayAzureEgressPrivateLinkGateway]
    (Optional Configuration Block) supports the following:
    azure_peering_gateways Sequence[GetGatewayAzurePeeringGateway]
    (Optional Configuration Block) supports the following:
    display_name str
    (Required String) A human-readable name for the Gateway.
    environment GetGatewayEnvironment
    gcp_egress_private_service_connect_gateways Sequence[GetGatewayGcpEgressPrivateServiceConnectGateway]
    (Optional Configuration Block) supports the following:
    gcp_peering_gateways Sequence[GetGatewayGcpPeeringGateway]
    (Optional Configuration Block) supports the following:
    id str
    awsEgressPrivateLinkGateways List<Property Map>
    (Optional Configuration Block) supports the following:
    awsIngressPrivateLinkGateways List<Property Map>
    (Optional Configuration Block) supports the following:
    awsPeeringGateways List<Property Map>
    (Optional Configuration Block) supports the following:
    awsPrivateNetworkInterfaceGateways List<Property Map>
    (Optional Configuration Block) supports the following:
    azureEgressPrivateLinkGateways List<Property Map>
    (Optional Configuration Block) supports the following:
    azurePeeringGateways List<Property Map>
    (Optional Configuration Block) supports the following:
    displayName String
    (Required String) A human-readable name for the Gateway.
    environment Property Map
    gcpEgressPrivateServiceConnectGateways List<Property Map>
    (Optional Configuration Block) supports the following:
    gcpPeeringGateways List<Property Map>
    (Optional Configuration Block) supports the following:
    id String

    Supporting Types

    GetGatewayAwsEgressPrivateLinkGateway

    PrincipalArn string
    (Required String) The principal ARN used by the AWS Egress Private Link Gateway.
    Region string
    (Required String) GCP region of the Peering Gateway.
    PrincipalArn string
    (Required String) The principal ARN used by the AWS Egress Private Link Gateway.
    Region string
    (Required String) GCP region of the Peering Gateway.
    principalArn String
    (Required String) The principal ARN used by the AWS Egress Private Link Gateway.
    region String
    (Required String) GCP region of the Peering Gateway.
    principalArn string
    (Required String) The principal ARN used by the AWS Egress Private Link Gateway.
    region string
    (Required String) GCP region of the Peering Gateway.
    principal_arn str
    (Required String) The principal ARN used by the AWS Egress Private Link Gateway.
    region str
    (Required String) GCP region of the Peering Gateway.
    principalArn String
    (Required String) The principal ARN used by the AWS Egress Private Link Gateway.
    region String
    (Required String) GCP region of the Peering Gateway.

    GetGatewayAwsIngressPrivateLinkGateway

    Region string
    (Required String) GCP region of the Peering Gateway.
    VpcEndpointServiceName string
    (Required String) The ID of the AWS VPC Endpoint Service that can be used to establish connections for all zones, for example, com.amazonaws.vpce.us-west-2.vpce-svc-00000000000000000.
    Region string
    (Required String) GCP region of the Peering Gateway.
    VpcEndpointServiceName string
    (Required String) The ID of the AWS VPC Endpoint Service that can be used to establish connections for all zones, for example, com.amazonaws.vpce.us-west-2.vpce-svc-00000000000000000.
    region String
    (Required String) GCP region of the Peering Gateway.
    vpcEndpointServiceName String
    (Required String) The ID of the AWS VPC Endpoint Service that can be used to establish connections for all zones, for example, com.amazonaws.vpce.us-west-2.vpce-svc-00000000000000000.
    region string
    (Required String) GCP region of the Peering Gateway.
    vpcEndpointServiceName string
    (Required String) The ID of the AWS VPC Endpoint Service that can be used to establish connections for all zones, for example, com.amazonaws.vpce.us-west-2.vpce-svc-00000000000000000.
    region str
    (Required String) GCP region of the Peering Gateway.
    vpc_endpoint_service_name str
    (Required String) The ID of the AWS VPC Endpoint Service that can be used to establish connections for all zones, for example, com.amazonaws.vpce.us-west-2.vpce-svc-00000000000000000.
    region String
    (Required String) GCP region of the Peering Gateway.
    vpcEndpointServiceName String
    (Required String) The ID of the AWS VPC Endpoint Service that can be used to establish connections for all zones, for example, com.amazonaws.vpce.us-west-2.vpce-svc-00000000000000000.

    GetGatewayAwsPeeringGateway

    Region string
    (Required String) GCP region of the Peering Gateway.
    Region string
    (Required String) GCP region of the Peering Gateway.
    region String
    (Required String) GCP region of the Peering Gateway.
    region string
    (Required String) GCP region of the Peering Gateway.
    region str
    (Required String) GCP region of the Peering Gateway.
    region String
    (Required String) GCP region of the Peering Gateway.

    GetGatewayAwsPrivateNetworkInterfaceGateway

    Account string
    (Required String) The AWS account ID associated with the Private Network Interface Gateway.
    Region string
    (Required String) GCP region of the Peering Gateway.
    Zones List<string>
    (Required List of Strings) AWS availability zone ids of the Private Network Interface Gateway.
    Account string
    (Required String) The AWS account ID associated with the Private Network Interface Gateway.
    Region string
    (Required String) GCP region of the Peering Gateway.
    Zones []string
    (Required List of Strings) AWS availability zone ids of the Private Network Interface Gateway.
    account String
    (Required String) The AWS account ID associated with the Private Network Interface Gateway.
    region String
    (Required String) GCP region of the Peering Gateway.
    zones List<String>
    (Required List of Strings) AWS availability zone ids of the Private Network Interface Gateway.
    account string
    (Required String) The AWS account ID associated with the Private Network Interface Gateway.
    region string
    (Required String) GCP region of the Peering Gateway.
    zones string[]
    (Required List of Strings) AWS availability zone ids of the Private Network Interface Gateway.
    account str
    (Required String) The AWS account ID associated with the Private Network Interface Gateway.
    region str
    (Required String) GCP region of the Peering Gateway.
    zones Sequence[str]
    (Required List of Strings) AWS availability zone ids of the Private Network Interface Gateway.
    account String
    (Required String) The AWS account ID associated with the Private Network Interface Gateway.
    region String
    (Required String) GCP region of the Peering Gateway.
    zones List<String>
    (Required List of Strings) AWS availability zone ids of the Private Network Interface Gateway.

    GetGatewayAzureEgressPrivateLinkGateway

    Region string
    (Required String) GCP region of the Peering Gateway.
    Subscription string
    (Required String) The Azure Subscription ID associated with the Confluent Cloud VPC.
    Region string
    (Required String) GCP region of the Peering Gateway.
    Subscription string
    (Required String) The Azure Subscription ID associated with the Confluent Cloud VPC.
    region String
    (Required String) GCP region of the Peering Gateway.
    subscription String
    (Required String) The Azure Subscription ID associated with the Confluent Cloud VPC.
    region string
    (Required String) GCP region of the Peering Gateway.
    subscription string
    (Required String) The Azure Subscription ID associated with the Confluent Cloud VPC.
    region str
    (Required String) GCP region of the Peering Gateway.
    subscription str
    (Required String) The Azure Subscription ID associated with the Confluent Cloud VPC.
    region String
    (Required String) GCP region of the Peering Gateway.
    subscription String
    (Required String) The Azure Subscription ID associated with the Confluent Cloud VPC.

    GetGatewayAzurePeeringGateway

    Region string
    (Required String) GCP region of the Peering Gateway.
    Region string
    (Required String) GCP region of the Peering Gateway.
    region String
    (Required String) GCP region of the Peering Gateway.
    region string
    (Required String) GCP region of the Peering Gateway.
    region str
    (Required String) GCP region of the Peering Gateway.
    region String
    (Required String) GCP region of the Peering Gateway.

    GetGatewayEnvironment

    Id string
    The ID of the Environment that the Gateway belongs to, for example, env-123abc.
    Id string
    The ID of the Environment that the Gateway belongs to, for example, env-123abc.
    id String
    The ID of the Environment that the Gateway belongs to, for example, env-123abc.
    id string
    The ID of the Environment that the Gateway belongs to, for example, env-123abc.
    id str
    The ID of the Environment that the Gateway belongs to, for example, env-123abc.
    id String
    The ID of the Environment that the Gateway belongs to, for example, env-123abc.

    GetGatewayGcpEgressPrivateServiceConnectGateway

    Project string
    (Required String) The GCP project used by the GCP Private Service Connect Gateway.
    Region string
    (Required String) GCP region of the Peering Gateway.
    Project string
    (Required String) The GCP project used by the GCP Private Service Connect Gateway.
    Region string
    (Required String) GCP region of the Peering Gateway.
    project String
    (Required String) The GCP project used by the GCP Private Service Connect Gateway.
    region String
    (Required String) GCP region of the Peering Gateway.
    project string
    (Required String) The GCP project used by the GCP Private Service Connect Gateway.
    region string
    (Required String) GCP region of the Peering Gateway.
    project str
    (Required String) The GCP project used by the GCP Private Service Connect Gateway.
    region str
    (Required String) GCP region of the Peering Gateway.
    project String
    (Required String) The GCP project used by the GCP Private Service Connect Gateway.
    region String
    (Required String) GCP region of the Peering Gateway.

    GetGatewayGcpPeeringGateway

    IamPrincipal string
    (Required String) The IAM principal used by the GCP Peering Gateway.
    Region string
    (Required String) GCP region of the Peering Gateway.
    IamPrincipal string
    (Required String) The IAM principal used by the GCP Peering Gateway.
    Region string
    (Required String) GCP region of the Peering Gateway.
    iamPrincipal String
    (Required String) The IAM principal used by the GCP Peering Gateway.
    region String
    (Required String) GCP region of the Peering Gateway.
    iamPrincipal string
    (Required String) The IAM principal used by the GCP Peering Gateway.
    region string
    (Required String) GCP region of the Peering Gateway.
    iam_principal str
    (Required String) The IAM principal used by the GCP Peering Gateway.
    region str
    (Required String) GCP region of the Peering Gateway.
    iamPrincipal String
    (Required String) The IAM principal used by the GCP Peering Gateway.
    region String
    (Required String) GCP region of the Peering Gateway.

    Package Details

    Repository
    Confluent Cloud pulumi/pulumi-confluentcloud
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the confluent Terraform Provider.
    confluentcloud logo
    Viewing docs for Confluent v2.61.0
    published on Saturday, Mar 21, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-confluentcloud
      Try Pulumi Cloud free. Your team will thank you.