1. Packages
  2. Confluent Provider
  3. API Docs
  4. AccessPoint
Confluent v2.12.0 published on Wednesday, Dec 4, 2024 by Pulumi

confluentcloud.AccessPoint

Explore with Pulumi AI

confluentcloud logo
Confluent v2.12.0 published on Wednesday, Dec 4, 2024 by Pulumi

    General Availability

    confluentcloud.AccessPoint provides a Access Point resource that enables creating, editing, and deleting Access Points 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 aws = new confluentcloud.AccessPoint("aws", {
        displayName: "access_point",
        environment: {
            id: development.id,
        },
        gateway: {
            id: main.gateway[0].id,
        },
        awsEgressPrivateLinkEndpoint: {
            vpcEndpointServiceName: "com.amazonaws.vpce.us-west-2.vpce-svc-00000000000000000",
        },
    });
    const azure = new confluentcloud.AccessPoint("azure", {
        displayName: "access_point",
        environment: {
            id: development.id,
        },
        gateway: {
            id: main.gateway[0].id,
        },
        azureEgressPrivateLinkEndpoint: {
            privateLinkServiceResourceId: "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/s-abcde/providers/Microsoft.Network/privateLinkServices/pls-plt-abcdef-az3",
            privateLinkSubresourceName: "sqlServer",
        },
    });
    
    import pulumi
    import pulumi_confluentcloud as confluentcloud
    
    development = confluentcloud.Environment("development", display_name="Development")
    aws = confluentcloud.AccessPoint("aws",
        display_name="access_point",
        environment={
            "id": development.id,
        },
        gateway={
            "id": main["gateway"][0]["id"],
        },
        aws_egress_private_link_endpoint={
            "vpc_endpoint_service_name": "com.amazonaws.vpce.us-west-2.vpce-svc-00000000000000000",
        })
    azure = confluentcloud.AccessPoint("azure",
        display_name="access_point",
        environment={
            "id": development.id,
        },
        gateway={
            "id": main["gateway"][0]["id"],
        },
        azure_egress_private_link_endpoint={
            "private_link_service_resource_id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/s-abcde/providers/Microsoft.Network/privateLinkServices/pls-plt-abcdef-az3",
            "private_link_subresource_name": "sqlServer",
        })
    
    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.NewAccessPoint(ctx, "aws", &confluentcloud.AccessPointArgs{
    			DisplayName: pulumi.String("access_point"),
    			Environment: &confluentcloud.AccessPointEnvironmentArgs{
    				Id: development.ID(),
    			},
    			Gateway: &confluentcloud.AccessPointGatewayArgs{
    				Id: pulumi.Any(main.Gateway[0].Id),
    			},
    			AwsEgressPrivateLinkEndpoint: &confluentcloud.AccessPointAwsEgressPrivateLinkEndpointArgs{
    				VpcEndpointServiceName: pulumi.String("com.amazonaws.vpce.us-west-2.vpce-svc-00000000000000000"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		_, err = confluentcloud.NewAccessPoint(ctx, "azure", &confluentcloud.AccessPointArgs{
    			DisplayName: pulumi.String("access_point"),
    			Environment: &confluentcloud.AccessPointEnvironmentArgs{
    				Id: development.ID(),
    			},
    			Gateway: &confluentcloud.AccessPointGatewayArgs{
    				Id: pulumi.Any(main.Gateway[0].Id),
    			},
    			AzureEgressPrivateLinkEndpoint: &confluentcloud.AccessPointAzureEgressPrivateLinkEndpointArgs{
    				PrivateLinkServiceResourceId: pulumi.String("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/s-abcde/providers/Microsoft.Network/privateLinkServices/pls-plt-abcdef-az3"),
    				PrivateLinkSubresourceName:   pulumi.String("sqlServer"),
    			},
    		})
    		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 aws = new ConfluentCloud.AccessPoint("aws", new()
        {
            DisplayName = "access_point",
            Environment = new ConfluentCloud.Inputs.AccessPointEnvironmentArgs
            {
                Id = development.Id,
            },
            Gateway = new ConfluentCloud.Inputs.AccessPointGatewayArgs
            {
                Id = main.Gateway[0].Id,
            },
            AwsEgressPrivateLinkEndpoint = new ConfluentCloud.Inputs.AccessPointAwsEgressPrivateLinkEndpointArgs
            {
                VpcEndpointServiceName = "com.amazonaws.vpce.us-west-2.vpce-svc-00000000000000000",
            },
        });
    
        var azure = new ConfluentCloud.AccessPoint("azure", new()
        {
            DisplayName = "access_point",
            Environment = new ConfluentCloud.Inputs.AccessPointEnvironmentArgs
            {
                Id = development.Id,
            },
            Gateway = new ConfluentCloud.Inputs.AccessPointGatewayArgs
            {
                Id = main.Gateway[0].Id,
            },
            AzureEgressPrivateLinkEndpoint = new ConfluentCloud.Inputs.AccessPointAzureEgressPrivateLinkEndpointArgs
            {
                PrivateLinkServiceResourceId = "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/s-abcde/providers/Microsoft.Network/privateLinkServices/pls-plt-abcdef-az3",
                PrivateLinkSubresourceName = "sqlServer",
            },
        });
    
    });
    
    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.AccessPoint;
    import com.pulumi.confluentcloud.AccessPointArgs;
    import com.pulumi.confluentcloud.inputs.AccessPointEnvironmentArgs;
    import com.pulumi.confluentcloud.inputs.AccessPointGatewayArgs;
    import com.pulumi.confluentcloud.inputs.AccessPointAwsEgressPrivateLinkEndpointArgs;
    import com.pulumi.confluentcloud.inputs.AccessPointAzureEgressPrivateLinkEndpointArgs;
    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 aws = new AccessPoint("aws", AccessPointArgs.builder()
                .displayName("access_point")
                .environment(AccessPointEnvironmentArgs.builder()
                    .id(development.id())
                    .build())
                .gateway(AccessPointGatewayArgs.builder()
                    .id(main.gateway()[0].id())
                    .build())
                .awsEgressPrivateLinkEndpoint(AccessPointAwsEgressPrivateLinkEndpointArgs.builder()
                    .vpcEndpointServiceName("com.amazonaws.vpce.us-west-2.vpce-svc-00000000000000000")
                    .build())
                .build());
    
            var azure = new AccessPoint("azure", AccessPointArgs.builder()
                .displayName("access_point")
                .environment(AccessPointEnvironmentArgs.builder()
                    .id(development.id())
                    .build())
                .gateway(AccessPointGatewayArgs.builder()
                    .id(main.gateway()[0].id())
                    .build())
                .azureEgressPrivateLinkEndpoint(AccessPointAzureEgressPrivateLinkEndpointArgs.builder()
                    .privateLinkServiceResourceId("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/s-abcde/providers/Microsoft.Network/privateLinkServices/pls-plt-abcdef-az3")
                    .privateLinkSubresourceName("sqlServer")
                    .build())
                .build());
    
        }
    }
    
    resources:
      development:
        type: confluentcloud:Environment
        properties:
          displayName: Development
      aws:
        type: confluentcloud:AccessPoint
        properties:
          displayName: access_point
          environment:
            id: ${development.id}
          gateway:
            id: ${main.gateway[0].id}
          awsEgressPrivateLinkEndpoint:
            vpcEndpointServiceName: com.amazonaws.vpce.us-west-2.vpce-svc-00000000000000000
      azure:
        type: confluentcloud:AccessPoint
        properties:
          displayName: access_point
          environment:
            id: ${development.id}
          gateway:
            id: ${main.gateway[0].id}
          azureEgressPrivateLinkEndpoint:
            privateLinkServiceResourceId: /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/s-abcde/providers/Microsoft.Network/privateLinkServices/pls-plt-abcdef-az3
            privateLinkSubresourceName: sqlServer
    

    Create AccessPoint Resource

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

    Constructor syntax

    new AccessPoint(name: string, args: AccessPointArgs, opts?: CustomResourceOptions);
    @overload
    def AccessPoint(resource_name: str,
                    args: AccessPointArgs,
                    opts: Optional[ResourceOptions] = None)
    
    @overload
    def AccessPoint(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    environment: Optional[AccessPointEnvironmentArgs] = None,
                    gateway: Optional[AccessPointGatewayArgs] = None,
                    aws_egress_private_link_endpoint: Optional[AccessPointAwsEgressPrivateLinkEndpointArgs] = None,
                    aws_private_network_interface: Optional[AccessPointAwsPrivateNetworkInterfaceArgs] = None,
                    azure_egress_private_link_endpoint: Optional[AccessPointAzureEgressPrivateLinkEndpointArgs] = None,
                    display_name: Optional[str] = None)
    func NewAccessPoint(ctx *Context, name string, args AccessPointArgs, opts ...ResourceOption) (*AccessPoint, error)
    public AccessPoint(string name, AccessPointArgs args, CustomResourceOptions? opts = null)
    public AccessPoint(String name, AccessPointArgs args)
    public AccessPoint(String name, AccessPointArgs args, CustomResourceOptions options)
    
    type: confluentcloud:AccessPoint
    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 AccessPointArgs
    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 AccessPointArgs
    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 AccessPointArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AccessPointArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AccessPointArgs
    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 accessPointResource = new ConfluentCloud.AccessPoint("accessPointResource", new()
    {
        Environment = new ConfluentCloud.Inputs.AccessPointEnvironmentArgs
        {
            Id = "string",
        },
        Gateway = new ConfluentCloud.Inputs.AccessPointGatewayArgs
        {
            Id = "string",
        },
        AwsEgressPrivateLinkEndpoint = new ConfluentCloud.Inputs.AccessPointAwsEgressPrivateLinkEndpointArgs
        {
            VpcEndpointServiceName = "string",
            EnableHighAvailability = false,
            VpcEndpointDnsName = "string",
            VpcEndpointId = "string",
        },
        AwsPrivateNetworkInterface = new ConfluentCloud.Inputs.AccessPointAwsPrivateNetworkInterfaceArgs
        {
            Account = "string",
            NetworkInterfaces = new[]
            {
                "string",
            },
        },
        AzureEgressPrivateLinkEndpoint = new ConfluentCloud.Inputs.AccessPointAzureEgressPrivateLinkEndpointArgs
        {
            PrivateLinkServiceResourceId = "string",
            PrivateEndpointCustomDnsConfigDomains = new[]
            {
                "string",
            },
            PrivateEndpointDomain = "string",
            PrivateEndpointIpAddress = "string",
            PrivateEndpointResourceId = "string",
            PrivateLinkSubresourceName = "string",
        },
        DisplayName = "string",
    });
    
    example, err := confluentcloud.NewAccessPoint(ctx, "accessPointResource", &confluentcloud.AccessPointArgs{
    	Environment: &confluentcloud.AccessPointEnvironmentArgs{
    		Id: pulumi.String("string"),
    	},
    	Gateway: &confluentcloud.AccessPointGatewayArgs{
    		Id: pulumi.String("string"),
    	},
    	AwsEgressPrivateLinkEndpoint: &confluentcloud.AccessPointAwsEgressPrivateLinkEndpointArgs{
    		VpcEndpointServiceName: pulumi.String("string"),
    		EnableHighAvailability: pulumi.Bool(false),
    		VpcEndpointDnsName:     pulumi.String("string"),
    		VpcEndpointId:          pulumi.String("string"),
    	},
    	AwsPrivateNetworkInterface: &confluentcloud.AccessPointAwsPrivateNetworkInterfaceArgs{
    		Account: pulumi.String("string"),
    		NetworkInterfaces: pulumi.StringArray{
    			pulumi.String("string"),
    		},
    	},
    	AzureEgressPrivateLinkEndpoint: &confluentcloud.AccessPointAzureEgressPrivateLinkEndpointArgs{
    		PrivateLinkServiceResourceId: pulumi.String("string"),
    		PrivateEndpointCustomDnsConfigDomains: pulumi.StringArray{
    			pulumi.String("string"),
    		},
    		PrivateEndpointDomain:      pulumi.String("string"),
    		PrivateEndpointIpAddress:   pulumi.String("string"),
    		PrivateEndpointResourceId:  pulumi.String("string"),
    		PrivateLinkSubresourceName: pulumi.String("string"),
    	},
    	DisplayName: pulumi.String("string"),
    })
    
    var accessPointResource = new AccessPoint("accessPointResource", AccessPointArgs.builder()
        .environment(AccessPointEnvironmentArgs.builder()
            .id("string")
            .build())
        .gateway(AccessPointGatewayArgs.builder()
            .id("string")
            .build())
        .awsEgressPrivateLinkEndpoint(AccessPointAwsEgressPrivateLinkEndpointArgs.builder()
            .vpcEndpointServiceName("string")
            .enableHighAvailability(false)
            .vpcEndpointDnsName("string")
            .vpcEndpointId("string")
            .build())
        .awsPrivateNetworkInterface(AccessPointAwsPrivateNetworkInterfaceArgs.builder()
            .account("string")
            .networkInterfaces("string")
            .build())
        .azureEgressPrivateLinkEndpoint(AccessPointAzureEgressPrivateLinkEndpointArgs.builder()
            .privateLinkServiceResourceId("string")
            .privateEndpointCustomDnsConfigDomains("string")
            .privateEndpointDomain("string")
            .privateEndpointIpAddress("string")
            .privateEndpointResourceId("string")
            .privateLinkSubresourceName("string")
            .build())
        .displayName("string")
        .build());
    
    access_point_resource = confluentcloud.AccessPoint("accessPointResource",
        environment={
            "id": "string",
        },
        gateway={
            "id": "string",
        },
        aws_egress_private_link_endpoint={
            "vpc_endpoint_service_name": "string",
            "enable_high_availability": False,
            "vpc_endpoint_dns_name": "string",
            "vpc_endpoint_id": "string",
        },
        aws_private_network_interface={
            "account": "string",
            "network_interfaces": ["string"],
        },
        azure_egress_private_link_endpoint={
            "private_link_service_resource_id": "string",
            "private_endpoint_custom_dns_config_domains": ["string"],
            "private_endpoint_domain": "string",
            "private_endpoint_ip_address": "string",
            "private_endpoint_resource_id": "string",
            "private_link_subresource_name": "string",
        },
        display_name="string")
    
    const accessPointResource = new confluentcloud.AccessPoint("accessPointResource", {
        environment: {
            id: "string",
        },
        gateway: {
            id: "string",
        },
        awsEgressPrivateLinkEndpoint: {
            vpcEndpointServiceName: "string",
            enableHighAvailability: false,
            vpcEndpointDnsName: "string",
            vpcEndpointId: "string",
        },
        awsPrivateNetworkInterface: {
            account: "string",
            networkInterfaces: ["string"],
        },
        azureEgressPrivateLinkEndpoint: {
            privateLinkServiceResourceId: "string",
            privateEndpointCustomDnsConfigDomains: ["string"],
            privateEndpointDomain: "string",
            privateEndpointIpAddress: "string",
            privateEndpointResourceId: "string",
            privateLinkSubresourceName: "string",
        },
        displayName: "string",
    });
    
    type: confluentcloud:AccessPoint
    properties:
        awsEgressPrivateLinkEndpoint:
            enableHighAvailability: false
            vpcEndpointDnsName: string
            vpcEndpointId: string
            vpcEndpointServiceName: string
        awsPrivateNetworkInterface:
            account: string
            networkInterfaces:
                - string
        azureEgressPrivateLinkEndpoint:
            privateEndpointCustomDnsConfigDomains:
                - string
            privateEndpointDomain: string
            privateEndpointIpAddress: string
            privateEndpointResourceId: string
            privateLinkServiceResourceId: string
            privateLinkSubresourceName: string
        displayName: string
        environment:
            id: string
        gateway:
            id: string
    

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

    Environment Pulumi.ConfluentCloud.Inputs.AccessPointEnvironment
    Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
    Gateway Pulumi.ConfluentCloud.Inputs.AccessPointGateway
    AwsEgressPrivateLinkEndpoint Pulumi.ConfluentCloud.Inputs.AccessPointAwsEgressPrivateLinkEndpoint
    (Optional Configuration Block) supports the following:
    AwsPrivateNetworkInterface Pulumi.ConfluentCloud.Inputs.AccessPointAwsPrivateNetworkInterface
    (Optional Configuration Block) supports the following:
    AzureEgressPrivateLinkEndpoint Pulumi.ConfluentCloud.Inputs.AccessPointAzureEgressPrivateLinkEndpoint
    (Optional Configuration Block) supports the following:
    DisplayName string
    The name of the Access Point.
    Environment AccessPointEnvironmentArgs
    Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
    Gateway AccessPointGatewayArgs
    AwsEgressPrivateLinkEndpoint AccessPointAwsEgressPrivateLinkEndpointArgs
    (Optional Configuration Block) supports the following:
    AwsPrivateNetworkInterface AccessPointAwsPrivateNetworkInterfaceArgs
    (Optional Configuration Block) supports the following:
    AzureEgressPrivateLinkEndpoint AccessPointAzureEgressPrivateLinkEndpointArgs
    (Optional Configuration Block) supports the following:
    DisplayName string
    The name of the Access Point.
    environment AccessPointEnvironment
    Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
    gateway AccessPointGateway
    awsEgressPrivateLinkEndpoint AccessPointAwsEgressPrivateLinkEndpoint
    (Optional Configuration Block) supports the following:
    awsPrivateNetworkInterface AccessPointAwsPrivateNetworkInterface
    (Optional Configuration Block) supports the following:
    azureEgressPrivateLinkEndpoint AccessPointAzureEgressPrivateLinkEndpoint
    (Optional Configuration Block) supports the following:
    displayName String
    The name of the Access Point.
    environment AccessPointEnvironment
    Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
    gateway AccessPointGateway
    awsEgressPrivateLinkEndpoint AccessPointAwsEgressPrivateLinkEndpoint
    (Optional Configuration Block) supports the following:
    awsPrivateNetworkInterface AccessPointAwsPrivateNetworkInterface
    (Optional Configuration Block) supports the following:
    azureEgressPrivateLinkEndpoint AccessPointAzureEgressPrivateLinkEndpoint
    (Optional Configuration Block) supports the following:
    displayName string
    The name of the Access Point.
    environment AccessPointEnvironmentArgs
    Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
    gateway AccessPointGatewayArgs
    aws_egress_private_link_endpoint AccessPointAwsEgressPrivateLinkEndpointArgs
    (Optional Configuration Block) supports the following:
    aws_private_network_interface AccessPointAwsPrivateNetworkInterfaceArgs
    (Optional Configuration Block) supports the following:
    azure_egress_private_link_endpoint AccessPointAzureEgressPrivateLinkEndpointArgs
    (Optional Configuration Block) supports the following:
    display_name str
    The name of the Access Point.
    environment Property Map
    Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
    gateway Property Map
    awsEgressPrivateLinkEndpoint Property Map
    (Optional Configuration Block) supports the following:
    awsPrivateNetworkInterface Property Map
    (Optional Configuration Block) supports the following:
    azureEgressPrivateLinkEndpoint Property Map
    (Optional Configuration Block) supports the following:
    displayName String
    The name of the Access Point.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the AccessPoint 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 AccessPoint Resource

    Get an existing AccessPoint 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?: AccessPointState, opts?: CustomResourceOptions): AccessPoint
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            aws_egress_private_link_endpoint: Optional[AccessPointAwsEgressPrivateLinkEndpointArgs] = None,
            aws_private_network_interface: Optional[AccessPointAwsPrivateNetworkInterfaceArgs] = None,
            azure_egress_private_link_endpoint: Optional[AccessPointAzureEgressPrivateLinkEndpointArgs] = None,
            display_name: Optional[str] = None,
            environment: Optional[AccessPointEnvironmentArgs] = None,
            gateway: Optional[AccessPointGatewayArgs] = None) -> AccessPoint
    func GetAccessPoint(ctx *Context, name string, id IDInput, state *AccessPointState, opts ...ResourceOption) (*AccessPoint, error)
    public static AccessPoint Get(string name, Input<string> id, AccessPointState? state, CustomResourceOptions? opts = null)
    public static AccessPoint get(String name, Output<String> id, AccessPointState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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:
    AwsEgressPrivateLinkEndpoint Pulumi.ConfluentCloud.Inputs.AccessPointAwsEgressPrivateLinkEndpoint
    (Optional Configuration Block) supports the following:
    AwsPrivateNetworkInterface Pulumi.ConfluentCloud.Inputs.AccessPointAwsPrivateNetworkInterface
    (Optional Configuration Block) supports the following:
    AzureEgressPrivateLinkEndpoint Pulumi.ConfluentCloud.Inputs.AccessPointAzureEgressPrivateLinkEndpoint
    (Optional Configuration Block) supports the following:
    DisplayName string
    The name of the Access Point.
    Environment Pulumi.ConfluentCloud.Inputs.AccessPointEnvironment
    Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
    Gateway Pulumi.ConfluentCloud.Inputs.AccessPointGateway
    AwsEgressPrivateLinkEndpoint AccessPointAwsEgressPrivateLinkEndpointArgs
    (Optional Configuration Block) supports the following:
    AwsPrivateNetworkInterface AccessPointAwsPrivateNetworkInterfaceArgs
    (Optional Configuration Block) supports the following:
    AzureEgressPrivateLinkEndpoint AccessPointAzureEgressPrivateLinkEndpointArgs
    (Optional Configuration Block) supports the following:
    DisplayName string
    The name of the Access Point.
    Environment AccessPointEnvironmentArgs
    Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
    Gateway AccessPointGatewayArgs
    awsEgressPrivateLinkEndpoint AccessPointAwsEgressPrivateLinkEndpoint
    (Optional Configuration Block) supports the following:
    awsPrivateNetworkInterface AccessPointAwsPrivateNetworkInterface
    (Optional Configuration Block) supports the following:
    azureEgressPrivateLinkEndpoint AccessPointAzureEgressPrivateLinkEndpoint
    (Optional Configuration Block) supports the following:
    displayName String
    The name of the Access Point.
    environment AccessPointEnvironment
    Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
    gateway AccessPointGateway
    awsEgressPrivateLinkEndpoint AccessPointAwsEgressPrivateLinkEndpoint
    (Optional Configuration Block) supports the following:
    awsPrivateNetworkInterface AccessPointAwsPrivateNetworkInterface
    (Optional Configuration Block) supports the following:
    azureEgressPrivateLinkEndpoint AccessPointAzureEgressPrivateLinkEndpoint
    (Optional Configuration Block) supports the following:
    displayName string
    The name of the Access Point.
    environment AccessPointEnvironment
    Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
    gateway AccessPointGateway
    aws_egress_private_link_endpoint AccessPointAwsEgressPrivateLinkEndpointArgs
    (Optional Configuration Block) supports the following:
    aws_private_network_interface AccessPointAwsPrivateNetworkInterfaceArgs
    (Optional Configuration Block) supports the following:
    azure_egress_private_link_endpoint AccessPointAzureEgressPrivateLinkEndpointArgs
    (Optional Configuration Block) supports the following:
    display_name str
    The name of the Access Point.
    environment AccessPointEnvironmentArgs
    Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
    gateway AccessPointGatewayArgs
    awsEgressPrivateLinkEndpoint Property Map
    (Optional Configuration Block) supports the following:
    awsPrivateNetworkInterface Property Map
    (Optional Configuration Block) supports the following:
    azureEgressPrivateLinkEndpoint Property Map
    (Optional Configuration Block) supports the following:
    displayName String
    The name of the Access Point.
    environment Property Map
    Environment objects represent an isolated namespace for your Confluent resources for organizational purposes.
    gateway Property Map

    Supporting Types

    AccessPointAwsEgressPrivateLinkEndpoint, AccessPointAwsEgressPrivateLinkEndpointArgs

    VpcEndpointServiceName string
    AWS VPC Endpoint Service that can be used to establish connections for all zones, for example com.amazonaws.vpce.us-west-2.vpce-svc-0d3be37e21708ecd3.
    EnableHighAvailability bool
    Whether a resource should be provisioned with high availability. Endpoints deployed with high availability have network interfaces deployed in multiple AZs. Defaults to false.
    VpcEndpointDnsName string
    (Required String) The DNS name of a VPC Endpoint (if any) that is connected to the VPC Endpoint service, for example, *.vpce-00000000000000000-abcd1234.s3.us-west-2.vpce.amazonaws.com.
    VpcEndpointId string
    (Required String) The ID of a VPC Endpoint (if any) that is connected to the VPC Endpoint service, for example, vpce-00000000000000000.
    VpcEndpointServiceName string
    AWS VPC Endpoint Service that can be used to establish connections for all zones, for example com.amazonaws.vpce.us-west-2.vpce-svc-0d3be37e21708ecd3.
    EnableHighAvailability bool
    Whether a resource should be provisioned with high availability. Endpoints deployed with high availability have network interfaces deployed in multiple AZs. Defaults to false.
    VpcEndpointDnsName string
    (Required String) The DNS name of a VPC Endpoint (if any) that is connected to the VPC Endpoint service, for example, *.vpce-00000000000000000-abcd1234.s3.us-west-2.vpce.amazonaws.com.
    VpcEndpointId string
    (Required String) The ID of a VPC Endpoint (if any) that is connected to the VPC Endpoint service, for example, vpce-00000000000000000.
    vpcEndpointServiceName String
    AWS VPC Endpoint Service that can be used to establish connections for all zones, for example com.amazonaws.vpce.us-west-2.vpce-svc-0d3be37e21708ecd3.
    enableHighAvailability Boolean
    Whether a resource should be provisioned with high availability. Endpoints deployed with high availability have network interfaces deployed in multiple AZs. Defaults to false.
    vpcEndpointDnsName String
    (Required String) The DNS name of a VPC Endpoint (if any) that is connected to the VPC Endpoint service, for example, *.vpce-00000000000000000-abcd1234.s3.us-west-2.vpce.amazonaws.com.
    vpcEndpointId String
    (Required String) The ID of a VPC Endpoint (if any) that is connected to the VPC Endpoint service, for example, vpce-00000000000000000.
    vpcEndpointServiceName string
    AWS VPC Endpoint Service that can be used to establish connections for all zones, for example com.amazonaws.vpce.us-west-2.vpce-svc-0d3be37e21708ecd3.
    enableHighAvailability boolean
    Whether a resource should be provisioned with high availability. Endpoints deployed with high availability have network interfaces deployed in multiple AZs. Defaults to false.
    vpcEndpointDnsName string
    (Required String) The DNS name of a VPC Endpoint (if any) that is connected to the VPC Endpoint service, for example, *.vpce-00000000000000000-abcd1234.s3.us-west-2.vpce.amazonaws.com.
    vpcEndpointId string
    (Required String) The ID of a VPC Endpoint (if any) that is connected to the VPC Endpoint service, for example, vpce-00000000000000000.
    vpc_endpoint_service_name str
    AWS VPC Endpoint Service that can be used to establish connections for all zones, for example com.amazonaws.vpce.us-west-2.vpce-svc-0d3be37e21708ecd3.
    enable_high_availability bool
    Whether a resource should be provisioned with high availability. Endpoints deployed with high availability have network interfaces deployed in multiple AZs. Defaults to false.
    vpc_endpoint_dns_name str
    (Required String) The DNS name of a VPC Endpoint (if any) that is connected to the VPC Endpoint service, for example, *.vpce-00000000000000000-abcd1234.s3.us-west-2.vpce.amazonaws.com.
    vpc_endpoint_id str
    (Required String) The ID of a VPC Endpoint (if any) that is connected to the VPC Endpoint service, for example, vpce-00000000000000000.
    vpcEndpointServiceName String
    AWS VPC Endpoint Service that can be used to establish connections for all zones, for example com.amazonaws.vpce.us-west-2.vpce-svc-0d3be37e21708ecd3.
    enableHighAvailability Boolean
    Whether a resource should be provisioned with high availability. Endpoints deployed with high availability have network interfaces deployed in multiple AZs. Defaults to false.
    vpcEndpointDnsName String
    (Required String) The DNS name of a VPC Endpoint (if any) that is connected to the VPC Endpoint service, for example, *.vpce-00000000000000000-abcd1234.s3.us-west-2.vpce.amazonaws.com.
    vpcEndpointId String
    (Required String) The ID of a VPC Endpoint (if any) that is connected to the VPC Endpoint service, for example, vpce-00000000000000000.

    AccessPointAwsPrivateNetworkInterface, AccessPointAwsPrivateNetworkInterfaceArgs

    Account string
    (Required String) The AWS account ID associated with the ENIs you are using for the Confluent Private Network Interface, for example: 000000000000.
    NetworkInterfaces List<string>
    (Required List of Strings) List of the IDs of the Elastic Network Interfaces, for example: ["eni-00000000000000000", "eni-00000000000000001", "eni-00000000000000002", "eni-00000000000000003", "eni-00000000000000004", "eni-00000000000000005"]
    Account string
    (Required String) The AWS account ID associated with the ENIs you are using for the Confluent Private Network Interface, for example: 000000000000.
    NetworkInterfaces []string
    (Required List of Strings) List of the IDs of the Elastic Network Interfaces, for example: ["eni-00000000000000000", "eni-00000000000000001", "eni-00000000000000002", "eni-00000000000000003", "eni-00000000000000004", "eni-00000000000000005"]
    account String
    (Required String) The AWS account ID associated with the ENIs you are using for the Confluent Private Network Interface, for example: 000000000000.
    networkInterfaces List<String>
    (Required List of Strings) List of the IDs of the Elastic Network Interfaces, for example: ["eni-00000000000000000", "eni-00000000000000001", "eni-00000000000000002", "eni-00000000000000003", "eni-00000000000000004", "eni-00000000000000005"]
    account string
    (Required String) The AWS account ID associated with the ENIs you are using for the Confluent Private Network Interface, for example: 000000000000.
    networkInterfaces string[]
    (Required List of Strings) List of the IDs of the Elastic Network Interfaces, for example: ["eni-00000000000000000", "eni-00000000000000001", "eni-00000000000000002", "eni-00000000000000003", "eni-00000000000000004", "eni-00000000000000005"]
    account str
    (Required String) The AWS account ID associated with the ENIs you are using for the Confluent Private Network Interface, for example: 000000000000.
    network_interfaces Sequence[str]
    (Required List of Strings) List of the IDs of the Elastic Network Interfaces, for example: ["eni-00000000000000000", "eni-00000000000000001", "eni-00000000000000002", "eni-00000000000000003", "eni-00000000000000004", "eni-00000000000000005"]
    account String
    (Required String) The AWS account ID associated with the ENIs you are using for the Confluent Private Network Interface, for example: 000000000000.
    networkInterfaces List<String>
    (Required List of Strings) List of the IDs of the Elastic Network Interfaces, for example: ["eni-00000000000000000", "eni-00000000000000001", "eni-00000000000000002", "eni-00000000000000003", "eni-00000000000000004", "eni-00000000000000005"]

    AccessPointAzureEgressPrivateLinkEndpoint, AccessPointAzureEgressPrivateLinkEndpointArgs

    PrivateLinkServiceResourceId string
    Resource ID of the Azure Private Link service.
    PrivateEndpointCustomDnsConfigDomains List<string>
    (Required List of Strings) Domains of the Private Endpoint (if any) based off FQDNs in Azure custom DNS configs, which are required in your private DNS setup, for example: ["dbname.database.windows.net", "dbname-region.database.windows.net"].
    PrivateEndpointDomain string
    (Required String) Domain of the Private Endpoint (if any) that is connected to the Private Link service.
    PrivateEndpointIpAddress string
    (Required String) IP address of the Private Endpoint (if any) that is connected to the Private Link service.
    PrivateEndpointResourceId string
    (Required String) Resource ID of the Private Endpoint (if any) that is connected to the Private Link service.
    PrivateLinkSubresourceName string
    Name of the subresource for the Private Endpoint to connect to.
    PrivateLinkServiceResourceId string
    Resource ID of the Azure Private Link service.
    PrivateEndpointCustomDnsConfigDomains []string
    (Required List of Strings) Domains of the Private Endpoint (if any) based off FQDNs in Azure custom DNS configs, which are required in your private DNS setup, for example: ["dbname.database.windows.net", "dbname-region.database.windows.net"].
    PrivateEndpointDomain string
    (Required String) Domain of the Private Endpoint (if any) that is connected to the Private Link service.
    PrivateEndpointIpAddress string
    (Required String) IP address of the Private Endpoint (if any) that is connected to the Private Link service.
    PrivateEndpointResourceId string
    (Required String) Resource ID of the Private Endpoint (if any) that is connected to the Private Link service.
    PrivateLinkSubresourceName string
    Name of the subresource for the Private Endpoint to connect to.
    privateLinkServiceResourceId String
    Resource ID of the Azure Private Link service.
    privateEndpointCustomDnsConfigDomains List<String>
    (Required List of Strings) Domains of the Private Endpoint (if any) based off FQDNs in Azure custom DNS configs, which are required in your private DNS setup, for example: ["dbname.database.windows.net", "dbname-region.database.windows.net"].
    privateEndpointDomain String
    (Required String) Domain of the Private Endpoint (if any) that is connected to the Private Link service.
    privateEndpointIpAddress String
    (Required String) IP address of the Private Endpoint (if any) that is connected to the Private Link service.
    privateEndpointResourceId String
    (Required String) Resource ID of the Private Endpoint (if any) that is connected to the Private Link service.
    privateLinkSubresourceName String
    Name of the subresource for the Private Endpoint to connect to.
    privateLinkServiceResourceId string
    Resource ID of the Azure Private Link service.
    privateEndpointCustomDnsConfigDomains string[]
    (Required List of Strings) Domains of the Private Endpoint (if any) based off FQDNs in Azure custom DNS configs, which are required in your private DNS setup, for example: ["dbname.database.windows.net", "dbname-region.database.windows.net"].
    privateEndpointDomain string
    (Required String) Domain of the Private Endpoint (if any) that is connected to the Private Link service.
    privateEndpointIpAddress string
    (Required String) IP address of the Private Endpoint (if any) that is connected to the Private Link service.
    privateEndpointResourceId string
    (Required String) Resource ID of the Private Endpoint (if any) that is connected to the Private Link service.
    privateLinkSubresourceName string
    Name of the subresource for the Private Endpoint to connect to.
    private_link_service_resource_id str
    Resource ID of the Azure Private Link service.
    private_endpoint_custom_dns_config_domains Sequence[str]
    (Required List of Strings) Domains of the Private Endpoint (if any) based off FQDNs in Azure custom DNS configs, which are required in your private DNS setup, for example: ["dbname.database.windows.net", "dbname-region.database.windows.net"].
    private_endpoint_domain str
    (Required String) Domain of the Private Endpoint (if any) that is connected to the Private Link service.
    private_endpoint_ip_address str
    (Required String) IP address of the Private Endpoint (if any) that is connected to the Private Link service.
    private_endpoint_resource_id str
    (Required String) Resource ID of the Private Endpoint (if any) that is connected to the Private Link service.
    private_link_subresource_name str
    Name of the subresource for the Private Endpoint to connect to.
    privateLinkServiceResourceId String
    Resource ID of the Azure Private Link service.
    privateEndpointCustomDnsConfigDomains List<String>
    (Required List of Strings) Domains of the Private Endpoint (if any) based off FQDNs in Azure custom DNS configs, which are required in your private DNS setup, for example: ["dbname.database.windows.net", "dbname-region.database.windows.net"].
    privateEndpointDomain String
    (Required String) Domain of the Private Endpoint (if any) that is connected to the Private Link service.
    privateEndpointIpAddress String
    (Required String) IP address of the Private Endpoint (if any) that is connected to the Private Link service.
    privateEndpointResourceId String
    (Required String) Resource ID of the Private Endpoint (if any) that is connected to the Private Link service.
    privateLinkSubresourceName String
    Name of the subresource for the Private Endpoint to connect to.

    AccessPointEnvironment, AccessPointEnvironmentArgs

    Id string
    The ID of the Environment that the Access Point belongs to, for example, env-abc123.
    Id string
    The ID of the Environment that the Access Point belongs to, for example, env-abc123.
    id String
    The ID of the Environment that the Access Point belongs to, for example, env-abc123.
    id string
    The ID of the Environment that the Access Point belongs to, for example, env-abc123.
    id str
    The ID of the Environment that the Access Point belongs to, for example, env-abc123.
    id String
    The ID of the Environment that the Access Point belongs to, for example, env-abc123.

    AccessPointGateway, AccessPointGatewayArgs

    Id string
    The ID of the gateway to which the Access Point belongs, for example, gw-abc123.
    Id string
    The ID of the gateway to which the Access Point belongs, for example, gw-abc123.
    id String
    The ID of the gateway to which the Access Point belongs, for example, gw-abc123.
    id string
    The ID of the gateway to which the Access Point belongs, for example, gw-abc123.
    id str
    The ID of the gateway to which the Access Point belongs, for example, gw-abc123.
    id String
    The ID of the gateway to which the Access Point belongs, for example, gw-abc123.

    Import

    You can import a Access Point by using Environment ID and Access Point ID, in the format <Environment ID>/<Access Point ID>. The following example shows how to import a Access Point:

    $ export CONFLUENT_CLOUD_API_KEY="<cloud_api_key>"

    $ export CONFLUENT_CLOUD_API_SECRET="<cloud_api_secret>"

    $ pulumi import confluentcloud:index/accessPoint:AccessPoint main env-abc123/ap-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 confluent Terraform Provider.
    confluentcloud logo
    Confluent v2.12.0 published on Wednesday, Dec 4, 2024 by Pulumi