confluentcloud.Gateway
Explore with Pulumi AI
confluentcloud.Gateway provides a Gateway resource that enables creating, editing, and deleting Gateways on Confluent Cloud.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as confluentcloud from "@pulumi/confluentcloud";
const development = new confluentcloud.Environment("development", {displayName: "Development"});
const main = new confluentcloud.Gateway("main", {
    displayName: "my_gateway",
    environment: {
        id: development.id,
    },
    awsEgressPrivateLinkGateway: {
        region: "us-west-2",
    },
});
import pulumi
import pulumi_confluentcloud as confluentcloud
development = confluentcloud.Environment("development", display_name="Development")
main = confluentcloud.Gateway("main",
    display_name="my_gateway",
    environment={
        "id": development.id,
    },
    aws_egress_private_link_gateway={
        "region": "us-west-2",
    })
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 {
		development, err := confluentcloud.NewEnvironment(ctx, "development", &confluentcloud.EnvironmentArgs{
			DisplayName: pulumi.String("Development"),
		})
		if err != nil {
			return err
		}
		_, err = confluentcloud.NewGateway(ctx, "main", &confluentcloud.GatewayArgs{
			DisplayName: pulumi.String("my_gateway"),
			Environment: &confluentcloud.GatewayEnvironmentArgs{
				Id: development.ID(),
			},
			AwsEgressPrivateLinkGateway: &confluentcloud.GatewayAwsEgressPrivateLinkGatewayArgs{
				Region: pulumi.String("us-west-2"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using ConfluentCloud = Pulumi.ConfluentCloud;
return await Deployment.RunAsync(() => 
{
    var development = new ConfluentCloud.Environment("development", new()
    {
        DisplayName = "Development",
    });
    var main = new ConfluentCloud.Gateway("main", new()
    {
        DisplayName = "my_gateway",
        Environment = new ConfluentCloud.Inputs.GatewayEnvironmentArgs
        {
            Id = development.Id,
        },
        AwsEgressPrivateLinkGateway = new ConfluentCloud.Inputs.GatewayAwsEgressPrivateLinkGatewayArgs
        {
            Region = "us-west-2",
        },
    });
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.confluentcloud.Environment;
import com.pulumi.confluentcloud.EnvironmentArgs;
import com.pulumi.confluentcloud.Gateway;
import com.pulumi.confluentcloud.GatewayArgs;
import com.pulumi.confluentcloud.inputs.GatewayEnvironmentArgs;
import com.pulumi.confluentcloud.inputs.GatewayAwsEgressPrivateLinkGatewayArgs;
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 development = new Environment("development", EnvironmentArgs.builder()
            .displayName("Development")
            .build());
        var main = new Gateway("main", GatewayArgs.builder()
            .displayName("my_gateway")
            .environment(GatewayEnvironmentArgs.builder()
                .id(development.id())
                .build())
            .awsEgressPrivateLinkGateway(GatewayAwsEgressPrivateLinkGatewayArgs.builder()
                .region("us-west-2")
                .build())
            .build());
    }
}
resources:
  development:
    type: confluentcloud:Environment
    properties:
      displayName: Development
  main:
    type: confluentcloud:Gateway
    properties:
      displayName: my_gateway
      environment:
        id: ${development.id}
      awsEgressPrivateLinkGateway:
        region: us-west-2
Create Gateway Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Gateway(name: string, args: GatewayArgs, opts?: CustomResourceOptions);@overload
def Gateway(resource_name: str,
            args: GatewayArgs,
            opts: Optional[ResourceOptions] = None)
@overload
def Gateway(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            display_name: Optional[str] = None,
            environment: Optional[GatewayEnvironmentArgs] = None,
            aws_egress_private_link_gateway: Optional[GatewayAwsEgressPrivateLinkGatewayArgs] = None,
            aws_private_network_interface_gateway: Optional[GatewayAwsPrivateNetworkInterfaceGatewayArgs] = None,
            azure_egress_private_link_gateway: Optional[GatewayAzureEgressPrivateLinkGatewayArgs] = None)func NewGateway(ctx *Context, name string, args GatewayArgs, opts ...ResourceOption) (*Gateway, error)public Gateway(string name, GatewayArgs args, CustomResourceOptions? opts = null)
public Gateway(String name, GatewayArgs args)
public Gateway(String name, GatewayArgs args, CustomResourceOptions options)
type: confluentcloud:Gateway
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 GatewayArgs
- 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 GatewayArgs
- 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 GatewayArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args GatewayArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args GatewayArgs
- 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 gatewayResource = new ConfluentCloud.Gateway("gatewayResource", new()
{
    DisplayName = "string",
    Environment = new ConfluentCloud.Inputs.GatewayEnvironmentArgs
    {
        Id = "string",
    },
    AwsEgressPrivateLinkGateway = new ConfluentCloud.Inputs.GatewayAwsEgressPrivateLinkGatewayArgs
    {
        Region = "string",
        PrincipalArn = "string",
    },
    AwsPrivateNetworkInterfaceGateway = new ConfluentCloud.Inputs.GatewayAwsPrivateNetworkInterfaceGatewayArgs
    {
        Region = "string",
        Zones = new[]
        {
            "string",
        },
        Account = "string",
    },
    AzureEgressPrivateLinkGateway = new ConfluentCloud.Inputs.GatewayAzureEgressPrivateLinkGatewayArgs
    {
        Region = "string",
        Subscription = "string",
    },
});
example, err := confluentcloud.NewGateway(ctx, "gatewayResource", &confluentcloud.GatewayArgs{
	DisplayName: pulumi.String("string"),
	Environment: &confluentcloud.GatewayEnvironmentArgs{
		Id: pulumi.String("string"),
	},
	AwsEgressPrivateLinkGateway: &confluentcloud.GatewayAwsEgressPrivateLinkGatewayArgs{
		Region:       pulumi.String("string"),
		PrincipalArn: pulumi.String("string"),
	},
	AwsPrivateNetworkInterfaceGateway: &confluentcloud.GatewayAwsPrivateNetworkInterfaceGatewayArgs{
		Region: pulumi.String("string"),
		Zones: pulumi.StringArray{
			pulumi.String("string"),
		},
		Account: pulumi.String("string"),
	},
	AzureEgressPrivateLinkGateway: &confluentcloud.GatewayAzureEgressPrivateLinkGatewayArgs{
		Region:       pulumi.String("string"),
		Subscription: pulumi.String("string"),
	},
})
var gatewayResource = new Gateway("gatewayResource", GatewayArgs.builder()
    .displayName("string")
    .environment(GatewayEnvironmentArgs.builder()
        .id("string")
        .build())
    .awsEgressPrivateLinkGateway(GatewayAwsEgressPrivateLinkGatewayArgs.builder()
        .region("string")
        .principalArn("string")
        .build())
    .awsPrivateNetworkInterfaceGateway(GatewayAwsPrivateNetworkInterfaceGatewayArgs.builder()
        .region("string")
        .zones("string")
        .account("string")
        .build())
    .azureEgressPrivateLinkGateway(GatewayAzureEgressPrivateLinkGatewayArgs.builder()
        .region("string")
        .subscription("string")
        .build())
    .build());
gateway_resource = confluentcloud.Gateway("gatewayResource",
    display_name="string",
    environment={
        "id": "string",
    },
    aws_egress_private_link_gateway={
        "region": "string",
        "principal_arn": "string",
    },
    aws_private_network_interface_gateway={
        "region": "string",
        "zones": ["string"],
        "account": "string",
    },
    azure_egress_private_link_gateway={
        "region": "string",
        "subscription": "string",
    })
const gatewayResource = new confluentcloud.Gateway("gatewayResource", {
    displayName: "string",
    environment: {
        id: "string",
    },
    awsEgressPrivateLinkGateway: {
        region: "string",
        principalArn: "string",
    },
    awsPrivateNetworkInterfaceGateway: {
        region: "string",
        zones: ["string"],
        account: "string",
    },
    azureEgressPrivateLinkGateway: {
        region: "string",
        subscription: "string",
    },
});
type: confluentcloud:Gateway
properties:
    awsEgressPrivateLinkGateway:
        principalArn: string
        region: string
    awsPrivateNetworkInterfaceGateway:
        account: string
        region: string
        zones:
            - string
    azureEgressPrivateLinkGateway:
        region: string
        subscription: string
    displayName: string
    environment:
        id: string
Gateway 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 Gateway resource accepts the following input properties:
- DisplayName string
- The name of the Gateway.
- Environment
Pulumi.Confluent Cloud. Inputs. Gateway Environment 
- Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
- AwsEgress Pulumi.Private Link Gateway Confluent Cloud. Inputs. Gateway Aws Egress Private Link Gateway 
- (Optional Configuration Block) supports the following:
- AwsPrivate Pulumi.Network Interface Gateway Confluent Cloud. Inputs. Gateway Aws Private Network Interface Gateway 
- (Optional Configuration Block) supports the following:
- AzureEgress Pulumi.Private Link Gateway Confluent Cloud. Inputs. Gateway Azure Egress Private Link Gateway 
- (Optional Configuration Block) supports the following:
- DisplayName string
- The name of the Gateway.
- Environment
GatewayEnvironment Args 
- Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
- AwsEgress GatewayPrivate Link Gateway Aws Egress Private Link Gateway Args 
- (Optional Configuration Block) supports the following:
- AwsPrivate GatewayNetwork Interface Gateway Aws Private Network Interface Gateway Args 
- (Optional Configuration Block) supports the following:
- AzureEgress GatewayPrivate Link Gateway Azure Egress Private Link Gateway Args 
- (Optional Configuration Block) supports the following:
- displayName String
- The name of the Gateway.
- environment
GatewayEnvironment 
- Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
- awsEgress GatewayPrivate Link Gateway Aws Egress Private Link Gateway 
- (Optional Configuration Block) supports the following:
- awsPrivate GatewayNetwork Interface Gateway Aws Private Network Interface Gateway 
- (Optional Configuration Block) supports the following:
- azureEgress GatewayPrivate Link Gateway Azure Egress Private Link Gateway 
- (Optional Configuration Block) supports the following:
- displayName string
- The name of the Gateway.
- environment
GatewayEnvironment 
- Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
- awsEgress GatewayPrivate Link Gateway Aws Egress Private Link Gateway 
- (Optional Configuration Block) supports the following:
- awsPrivate GatewayNetwork Interface Gateway Aws Private Network Interface Gateway 
- (Optional Configuration Block) supports the following:
- azureEgress GatewayPrivate Link Gateway Azure Egress Private Link Gateway 
- (Optional Configuration Block) supports the following:
- display_name str
- The name of the Gateway.
- environment
GatewayEnvironment Args 
- Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
- aws_egress_ Gatewayprivate_ link_ gateway Aws Egress Private Link Gateway Args 
- (Optional Configuration Block) supports the following:
- aws_private_ Gatewaynetwork_ interface_ gateway Aws Private Network Interface Gateway Args 
- (Optional Configuration Block) supports the following:
- azure_egress_ Gatewayprivate_ link_ gateway Azure Egress Private Link Gateway Args 
- (Optional Configuration Block) supports the following:
- displayName String
- The name of the Gateway.
- environment Property Map
- Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
- awsEgress Property MapPrivate Link Gateway 
- (Optional Configuration Block) supports the following:
- awsPrivate Property MapNetwork Interface Gateway 
- (Optional Configuration Block) supports the following:
- azureEgress Property MapPrivate Link Gateway 
- (Optional Configuration Block) supports the following:
Outputs
All input properties are implicitly available as output properties. Additionally, the Gateway resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id str
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
Look up Existing Gateway Resource
Get an existing Gateway 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?: GatewayState, opts?: CustomResourceOptions): Gateway@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        aws_egress_private_link_gateway: Optional[GatewayAwsEgressPrivateLinkGatewayArgs] = None,
        aws_private_network_interface_gateway: Optional[GatewayAwsPrivateNetworkInterfaceGatewayArgs] = None,
        azure_egress_private_link_gateway: Optional[GatewayAzureEgressPrivateLinkGatewayArgs] = None,
        display_name: Optional[str] = None,
        environment: Optional[GatewayEnvironmentArgs] = None) -> Gatewayfunc GetGateway(ctx *Context, name string, id IDInput, state *GatewayState, opts ...ResourceOption) (*Gateway, error)public static Gateway Get(string name, Input<string> id, GatewayState? state, CustomResourceOptions? opts = null)public static Gateway get(String name, Output<String> id, GatewayState state, CustomResourceOptions options)resources:  _:    type: confluentcloud:Gateway    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.
- AwsEgress Pulumi.Private Link Gateway Confluent Cloud. Inputs. Gateway Aws Egress Private Link Gateway 
- (Optional Configuration Block) supports the following:
- AwsPrivate Pulumi.Network Interface Gateway Confluent Cloud. Inputs. Gateway Aws Private Network Interface Gateway 
- (Optional Configuration Block) supports the following:
- AzureEgress Pulumi.Private Link Gateway Confluent Cloud. Inputs. Gateway Azure Egress Private Link Gateway 
- (Optional Configuration Block) supports the following:
- DisplayName string
- The name of the Gateway.
- Environment
Pulumi.Confluent Cloud. Inputs. Gateway Environment 
- Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
- AwsEgress GatewayPrivate Link Gateway Aws Egress Private Link Gateway Args 
- (Optional Configuration Block) supports the following:
- AwsPrivate GatewayNetwork Interface Gateway Aws Private Network Interface Gateway Args 
- (Optional Configuration Block) supports the following:
- AzureEgress GatewayPrivate Link Gateway Azure Egress Private Link Gateway Args 
- (Optional Configuration Block) supports the following:
- DisplayName string
- The name of the Gateway.
- Environment
GatewayEnvironment Args 
- Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
- awsEgress GatewayPrivate Link Gateway Aws Egress Private Link Gateway 
- (Optional Configuration Block) supports the following:
- awsPrivate GatewayNetwork Interface Gateway Aws Private Network Interface Gateway 
- (Optional Configuration Block) supports the following:
- azureEgress GatewayPrivate Link Gateway Azure Egress Private Link Gateway 
- (Optional Configuration Block) supports the following:
- displayName String
- The name of the Gateway.
- environment
GatewayEnvironment 
- Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
- awsEgress GatewayPrivate Link Gateway Aws Egress Private Link Gateway 
- (Optional Configuration Block) supports the following:
- awsPrivate GatewayNetwork Interface Gateway Aws Private Network Interface Gateway 
- (Optional Configuration Block) supports the following:
- azureEgress GatewayPrivate Link Gateway Azure Egress Private Link Gateway 
- (Optional Configuration Block) supports the following:
- displayName string
- The name of the Gateway.
- environment
GatewayEnvironment 
- Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
- aws_egress_ Gatewayprivate_ link_ gateway Aws Egress Private Link Gateway Args 
- (Optional Configuration Block) supports the following:
- aws_private_ Gatewaynetwork_ interface_ gateway Aws Private Network Interface Gateway Args 
- (Optional Configuration Block) supports the following:
- azure_egress_ Gatewayprivate_ link_ gateway Azure Egress Private Link Gateway Args 
- (Optional Configuration Block) supports the following:
- display_name str
- The name of the Gateway.
- environment
GatewayEnvironment Args 
- Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
- awsEgress Property MapPrivate Link Gateway 
- (Optional Configuration Block) supports the following:
- awsPrivate Property MapNetwork Interface Gateway 
- (Optional Configuration Block) supports the following:
- azureEgress Property MapPrivate Link Gateway 
- (Optional Configuration Block) supports the following:
- displayName String
- The name of the Gateway.
- environment Property Map
- Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
Supporting Types
GatewayAwsEgressPrivateLinkGateway, GatewayAwsEgressPrivateLinkGatewayArgs            
- Region string
- AWS region of the Gateway, for example, us-east-1.
- PrincipalArn string
- (Required String) The principal ARN used by the AWS Egress Private Link Gateway, for example, arn:aws:iam::123456789012:tenant-1-role.
- Region string
- AWS region of the Gateway, for example, us-east-1.
- PrincipalArn string
- (Required String) The principal ARN used by the AWS Egress Private Link Gateway, for example, arn:aws:iam::123456789012:tenant-1-role.
- region String
- AWS region of the Gateway, for example, us-east-1.
- principalArn String
- (Required String) The principal ARN used by the AWS Egress Private Link Gateway, for example, arn:aws:iam::123456789012:tenant-1-role.
- region string
- AWS region of the Gateway, for example, us-east-1.
- principalArn string
- (Required String) The principal ARN used by the AWS Egress Private Link Gateway, for example, arn:aws:iam::123456789012:tenant-1-role.
- region str
- AWS region of the Gateway, for example, us-east-1.
- principal_arn str
- (Required String) The principal ARN used by the AWS Egress Private Link Gateway, for example, arn:aws:iam::123456789012:tenant-1-role.
- region String
- AWS region of the Gateway, for example, us-east-1.
- principalArn String
- (Required String) The principal ARN used by the AWS Egress Private Link Gateway, for example, arn:aws:iam::123456789012:tenant-1-role.
GatewayAwsPrivateNetworkInterfaceGateway, GatewayAwsPrivateNetworkInterfaceGatewayArgs            
GatewayAzureEgressPrivateLinkGateway, GatewayAzureEgressPrivateLinkGatewayArgs            
- Region string
- Azure region of the Gateway, for example, eastus.
- Subscription string
- (Required String) The Azure Subscription ID associated with the Confluent Cloud VPC, for example, 00000000-0000-0000-0000-000000000000.
- Region string
- Azure region of the Gateway, for example, eastus.
- Subscription string
- (Required String) The Azure Subscription ID associated with the Confluent Cloud VPC, for example, 00000000-0000-0000-0000-000000000000.
- region String
- Azure region of the Gateway, for example, eastus.
- subscription String
- (Required String) The Azure Subscription ID associated with the Confluent Cloud VPC, for example, 00000000-0000-0000-0000-000000000000.
- region string
- Azure region of the Gateway, for example, eastus.
- subscription string
- (Required String) The Azure Subscription ID associated with the Confluent Cloud VPC, for example, 00000000-0000-0000-0000-000000000000.
- region str
- Azure region of the Gateway, for example, eastus.
- subscription str
- (Required String) The Azure Subscription ID associated with the Confluent Cloud VPC, for example, 00000000-0000-0000-0000-000000000000.
- region String
- Azure region of the Gateway, for example, eastus.
- subscription String
- (Required String) The Azure Subscription ID associated with the Confluent Cloud VPC, for example, 00000000-0000-0000-0000-000000000000.
GatewayEnvironment, GatewayEnvironmentArgs    
- Id string
- The ID of the Environment that the Gateway belongs to, for example, env-abc123.
- Id string
- The ID of the Environment that the Gateway belongs to, for example, env-abc123.
- id String
- The ID of the Environment that the Gateway belongs to, for example, env-abc123.
- id string
- The ID of the Environment that the Gateway belongs to, for example, env-abc123.
- id str
- The ID of the Environment that the Gateway belongs to, for example, env-abc123.
- id String
- The ID of the Environment that the Gateway belongs to, for example, env-abc123.
Import
You can import a Gateway by using Environment ID and Gateway ID, in the format <Environment ID>/<Gateway ID>. The following example shows how to import a Gateway:
$ export CONFLUENT_CLOUD_API_KEY="<cloud_api_key>"
$ export CONFLUENT_CLOUD_API_SECRET="<cloud_api_secret>"
$ pulumi import confluentcloud:index/gateway:Gateway main env-abc123/gw-abc123
!> Warning: Do not forget to delete terminal command history afterwards for security purposes.
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Confluent Cloud pulumi/pulumi-confluentcloud
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the confluentTerraform Provider.