1. Packages
  2. Confluent Cloud
  3. API Docs
  4. getAccessPoint
Confluent v1.42.0 published on Friday, Apr 19, 2024 by Pulumi

confluentcloud.getAccessPoint

Explore with Pulumi AI

confluentcloud logo
Confluent v1.42.0 published on Friday, Apr 19, 2024 by Pulumi

    General Availability

    confluentcloud.AccessPoint describes a Access Point data source.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as confluentcloud from "@pulumi/confluentcloud";
    
    const main = confluentcloud.getAccessPoint({
        id: "ap-abc123",
        environment: {
            id: "env-123abc",
        },
    });
    export const accessPoint = main;
    
    import pulumi
    import pulumi_confluentcloud as confluentcloud
    
    main = confluentcloud.get_access_point(id="ap-abc123",
        environment=confluentcloud.GetAccessPointEnvironmentArgs(
            id="env-123abc",
        ))
    pulumi.export("accessPoint", 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.LookupAccessPoint(ctx, &confluentcloud.LookupAccessPointArgs{
    			Id: "ap-abc123",
    			Environment: confluentcloud.GetAccessPointEnvironment{
    				Id: "env-123abc",
    			},
    		}, nil)
    		if err != nil {
    			return err
    		}
    		ctx.Export("accessPoint", main)
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using ConfluentCloud = Pulumi.ConfluentCloud;
    
    return await Deployment.RunAsync(() => 
    {
        var main = ConfluentCloud.GetAccessPoint.Invoke(new()
        {
            Id = "ap-abc123",
            Environment = new ConfluentCloud.Inputs.GetAccessPointEnvironmentInputArgs
            {
                Id = "env-123abc",
            },
        });
    
        return new Dictionary<string, object?>
        {
            ["accessPoint"] = 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.GetAccessPointArgs;
    import com.pulumi.confluentcloud.inputs.GetAccessPointEnvironmentArgs;
    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.getAccessPoint(GetAccessPointArgs.builder()
                .id("ap-abc123")
                .environment(GetAccessPointEnvironmentArgs.builder()
                    .id("env-123abc")
                    .build())
                .build());
    
            ctx.export("accessPoint", main.applyValue(getAccessPointResult -> getAccessPointResult));
        }
    }
    
    variables:
      main:
        fn::invoke:
          Function: confluentcloud:getAccessPoint
          Arguments:
            id: ap-abc123
            environment:
              id: env-123abc
    outputs:
      accessPoint: ${main}
    

    Using getAccessPoint

    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 getAccessPoint(args: GetAccessPointArgs, opts?: InvokeOptions): Promise<GetAccessPointResult>
    function getAccessPointOutput(args: GetAccessPointOutputArgs, opts?: InvokeOptions): Output<GetAccessPointResult>
    def get_access_point(environment: Optional[GetAccessPointEnvironment] = None,
                         id: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetAccessPointResult
    def get_access_point_output(environment: Optional[pulumi.Input[GetAccessPointEnvironmentArgs]] = None,
                         id: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetAccessPointResult]
    func LookupAccessPoint(ctx *Context, args *LookupAccessPointArgs, opts ...InvokeOption) (*LookupAccessPointResult, error)
    func LookupAccessPointOutput(ctx *Context, args *LookupAccessPointOutputArgs, opts ...InvokeOption) LookupAccessPointResultOutput

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

    public static class GetAccessPoint 
    {
        public static Task<GetAccessPointResult> InvokeAsync(GetAccessPointArgs args, InvokeOptions? opts = null)
        public static Output<GetAccessPointResult> Invoke(GetAccessPointInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetAccessPointResult> getAccessPoint(GetAccessPointArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: confluentcloud:index/getAccessPoint:getAccessPoint
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Environment Pulumi.ConfluentCloud.Inputs.GetAccessPointEnvironment
    Id string
    The ID of the Environment that the Access Point belongs to, for example, env-123abc.
    Environment GetAccessPointEnvironment
    Id string
    The ID of the Environment that the Access Point belongs to, for example, env-123abc.
    environment GetAccessPointEnvironment
    id String
    The ID of the Environment that the Access Point belongs to, for example, env-123abc.
    environment GetAccessPointEnvironment
    id string
    The ID of the Environment that the Access Point belongs to, for example, env-123abc.
    environment GetAccessPointEnvironment
    id str
    The ID of the Environment that the Access Point belongs to, for example, env-123abc.
    environment Property Map
    id String
    The ID of the Environment that the Access Point belongs to, for example, env-123abc.

    getAccessPoint Result

    The following output properties are available:

    AwsEgressPrivateLinkEndpoints List<Pulumi.ConfluentCloud.Outputs.GetAccessPointAwsEgressPrivateLinkEndpoint>
    (Required Configuration Block) supports the following:
    DisplayName string
    (Required String) A human-readable name for the Access Point.
    Environment Pulumi.ConfluentCloud.Outputs.GetAccessPointEnvironment
    Gateways List<Pulumi.ConfluentCloud.Outputs.GetAccessPointGateway>
    (Required Configuration Block) supports the following:
    Id string
    (Required String) The ID of the gateway to which the Access Point belongs, for example, gw-abc123.
    AwsEgressPrivateLinkEndpoints []GetAccessPointAwsEgressPrivateLinkEndpoint
    (Required Configuration Block) supports the following:
    DisplayName string
    (Required String) A human-readable name for the Access Point.
    Environment GetAccessPointEnvironment
    Gateways []GetAccessPointGateway
    (Required Configuration Block) supports the following:
    Id string
    (Required String) The ID of the gateway to which the Access Point belongs, for example, gw-abc123.
    awsEgressPrivateLinkEndpoints List<GetAccessPointAwsEgressPrivateLinkEndpoint>
    (Required Configuration Block) supports the following:
    displayName String
    (Required String) A human-readable name for the Access Point.
    environment GetAccessPointEnvironment
    gateways List<GetAccessPointGateway>
    (Required Configuration Block) supports the following:
    id String
    (Required String) The ID of the gateway to which the Access Point belongs, for example, gw-abc123.
    awsEgressPrivateLinkEndpoints GetAccessPointAwsEgressPrivateLinkEndpoint[]
    (Required Configuration Block) supports the following:
    displayName string
    (Required String) A human-readable name for the Access Point.
    environment GetAccessPointEnvironment
    gateways GetAccessPointGateway[]
    (Required Configuration Block) supports the following:
    id string
    (Required String) The ID of the gateway to which the Access Point belongs, for example, gw-abc123.
    aws_egress_private_link_endpoints Sequence[GetAccessPointAwsEgressPrivateLinkEndpoint]
    (Required Configuration Block) supports the following:
    display_name str
    (Required String) A human-readable name for the Access Point.
    environment GetAccessPointEnvironment
    gateways Sequence[GetAccessPointGateway]
    (Required Configuration Block) supports the following:
    id str
    (Required String) The ID of the gateway to which the Access Point belongs, for example, gw-abc123.
    awsEgressPrivateLinkEndpoints List<Property Map>
    (Required Configuration Block) supports the following:
    displayName String
    (Required String) A human-readable name for the Access Point.
    environment Property Map
    gateways List<Property Map>
    (Required Configuration Block) supports the following:
    id String
    (Required String) The ID of the gateway to which the Access Point belongs, for example, gw-abc123.

    Supporting Types

    GetAccessPointAwsEgressPrivateLinkEndpoint

    EnableHighAvailability bool
    (Required 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
    (Required 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
    (Required 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
    (Required 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
    (Required 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
    (Required 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
    (Required 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
    (Required 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.
    enable_high_availability bool
    (Required 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.
    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.
    vpc_endpoint_service_name str
    (Required 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
    (Required 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
    (Required 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.

    GetAccessPointEnvironment

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

    GetAccessPointGateway

    Id string
    The ID of the Environment that the Access Point belongs to, for example, env-123abc.
    Id string
    The ID of the Environment that the Access Point belongs to, for example, env-123abc.
    id String
    The ID of the Environment that the Access Point belongs to, for example, env-123abc.
    id string
    The ID of the Environment that the Access Point belongs to, for example, env-123abc.
    id str
    The ID of the Environment that the Access Point belongs to, for example, env-123abc.
    id String
    The ID of the Environment that the Access Point 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
    Confluent v1.42.0 published on Friday, Apr 19, 2024 by Pulumi