1. Packages
  2. Packages
  3. Confluent Provider
  4. API Docs
  5. getGateway
Viewing docs for Confluent v1.53.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
Go to latest version
Schema (JSON)
pulumi/pulumi-confluentcloud

confluentcloud.getGateway

confluentcloud logo
Viewing docs for Confluent v1.53.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
Go to latest version
Schema (JSON)
pulumi/pulumi-confluentcloud

    General Availability

    confluentcloud.getGateway 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=confluentcloud.GetGatewayEnvironmentArgs(
        id="env-123abc",
    ))
pulumi.export("gateway", main)

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		main, err := confluentcloud.GetGateway(ctx, &confluentcloud.GetGatewayArgs{
			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.applyValue(getGatewayResult -> getGatewayResult));
    }
}

    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 GetGateway(ctx *Context, args *GetGatewayArgs, opts ...InvokeOption) (*GetGatewayResult, error)
func GetGatewayOutput(ctx *Context, args *GetGatewayOutputArgs, opts ...InvokeOption) GetGatewayResultOutput

    > Note: This function is named GetGateway 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 []GetGatewayAwsEgressPrivateLinkGateway
    (Optional Configuration Block) supports the following:
    AwsPeeringGateways []GetGatewayAwsPeeringGateway
    (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
    Id string
    awsEgressPrivateLinkGateways List<GetGatewayAwsEgressPrivateLinkGateway>
    (Optional Configuration Block) supports the following:
    awsPeeringGateways List<GetGatewayAwsPeeringGateway>
    (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
    id String
    awsEgressPrivateLinkGateways GetGatewayAwsEgressPrivateLinkGateway[]
    (Optional Configuration Block) supports the following:
    awsPeeringGateways GetGatewayAwsPeeringGateway[]
    (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
    id string
    aws_egress_private_link_gateways Sequence[GetGatewayAwsEgressPrivateLinkGateway]
    (Optional Configuration Block) supports the following:
    aws_peering_gateways Sequence[GetGatewayAwsPeeringGateway]
    (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
    id str
    awsEgressPrivateLinkGateways List<Property Map>
    (Optional Configuration Block) supports the following:
    awsPeeringGateways 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
    id String

    Supporting Types

    GetGatewayAwsEgressPrivateLinkGateway

    PrincipalArn string
    (Required String) The principal ARN used by the AWS Egress Private Link Gateway.
    Region string
    (Required String) Azure region of the Peering Gateway.
    PrincipalArn string
    (Required String) The principal ARN used by the AWS Egress Private Link Gateway.
    Region string
    (Required String) Azure region of the Peering Gateway.
    principalArn String
    (Required String) The principal ARN used by the AWS Egress Private Link Gateway.
    region String
    (Required String) Azure region of the Peering Gateway.
    principalArn string
    (Required String) The principal ARN used by the AWS Egress Private Link Gateway.
    region string
    (Required String) Azure 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) Azure region of the Peering Gateway.
    principalArn String
    (Required String) The principal ARN used by the AWS Egress Private Link Gateway.
    region String
    (Required String) Azure region of the Peering Gateway.

    GetGatewayAwsPeeringGateway

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

    GetGatewayAzureEgressPrivateLinkGateway

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

    GetGatewayAzurePeeringGateway

    Region string
    (Required String) Azure region of the Peering Gateway.
    Region string
    (Required String) Azure region of the Peering Gateway.
    region String
    (Required String) Azure region of the Peering Gateway.
    region string
    (Required String) Azure region of the Peering Gateway.
    region str
    (Required String) Azure region of the Peering Gateway.
    region String
    (Required String) Azure 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.

    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 v1.53.0 (Older version)
    published on Monday, Mar 9, 2026 by Pulumi
    Go to latest version
    Schema (JSON)
    pulumi/pulumi-confluentcloud
      Try Pulumi Cloud free. Your team will thank you.