ec logo
ElasticCloud (EC) v0.5.0, Jan 25 23

ec.getAwsPrivatelinkEndpoint

Use this data source to retrieve information about the AWS Private Link configuration for a given region. Further documentation on how to establish a PrivateLink connection can be found in the ESS documentation.

NOTE: This data source provides data relevant to the Elasticsearch Service (ESS) only, and should not be used for ECE.

Example Usage

using System.Collections.Generic;
using Pulumi;
using ElasticCloud = Pulumi.ElasticCloud;

return await Deployment.RunAsync(() => 
{
    var us_east_1 = ElasticCloud.GetAwsPrivatelinkEndpoint.Invoke(new()
    {
        Region = "us-east-1",
    });

});
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ec.GetAwsPrivatelinkEndpoint(ctx, &ec.GetAwsPrivatelinkEndpointArgs{
			Region: "us-east-1",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ec.EcFunctions;
import com.pulumi.ec.inputs.GetAwsPrivatelinkEndpointArgs;
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 us-east-1 = EcFunctions.getAwsPrivatelinkEndpoint(GetAwsPrivatelinkEndpointArgs.builder()
            .region("us-east-1")
            .build());

    }
}
import pulumi
import pulumi_ec as ec

us_east_1 = ec.get_aws_privatelink_endpoint(region="us-east-1")
import * as pulumi from "@pulumi/pulumi";
import * as ec from "@pulumi/ec";

const us-east-1 = ec.getAwsPrivatelinkEndpoint({
    region: "us-east-1",
});
variables:
  us-east-1:
    fn::invoke:
      Function: ec:getAwsPrivatelinkEndpoint
      Arguments:
        region: us-east-1

Using getAwsPrivatelinkEndpoint

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 getAwsPrivatelinkEndpoint(args: GetAwsPrivatelinkEndpointArgs, opts?: InvokeOptions): Promise<GetAwsPrivatelinkEndpointResult>
function getAwsPrivatelinkEndpointOutput(args: GetAwsPrivatelinkEndpointOutputArgs, opts?: InvokeOptions): Output<GetAwsPrivatelinkEndpointResult>
def get_aws_privatelink_endpoint(region: Optional[str] = None,
                                 opts: Optional[InvokeOptions] = None) -> GetAwsPrivatelinkEndpointResult
def get_aws_privatelink_endpoint_output(region: Optional[pulumi.Input[str]] = None,
                                 opts: Optional[InvokeOptions] = None) -> Output[GetAwsPrivatelinkEndpointResult]
func GetAwsPrivatelinkEndpoint(ctx *Context, args *GetAwsPrivatelinkEndpointArgs, opts ...InvokeOption) (*GetAwsPrivatelinkEndpointResult, error)
func GetAwsPrivatelinkEndpointOutput(ctx *Context, args *GetAwsPrivatelinkEndpointOutputArgs, opts ...InvokeOption) GetAwsPrivatelinkEndpointResultOutput

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

public static class GetAwsPrivatelinkEndpoint 
{
    public static Task<GetAwsPrivatelinkEndpointResult> InvokeAsync(GetAwsPrivatelinkEndpointArgs args, InvokeOptions? opts = null)
    public static Output<GetAwsPrivatelinkEndpointResult> Invoke(GetAwsPrivatelinkEndpointInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetAwsPrivatelinkEndpointResult> getAwsPrivatelinkEndpoint(GetAwsPrivatelinkEndpointArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
  function: ec:index/getAwsPrivatelinkEndpoint:getAwsPrivatelinkEndpoint
  arguments:
    # arguments dictionary

The following arguments are supported:

Region string

Region to retrieve the Private Link configuration for.

Region string

Region to retrieve the Private Link configuration for.

region String

Region to retrieve the Private Link configuration for.

region string

Region to retrieve the Private Link configuration for.

region str

Region to retrieve the Private Link configuration for.

region String

Region to retrieve the Private Link configuration for.

getAwsPrivatelinkEndpoint Result

The following output properties are available:

DomainName string

The domain name to used in when configuring a private hosted zone in the VPCE connection.

Id string

The provider-assigned unique ID for this managed resource.

Region string
VpcServiceName string

The VPC service name used to connect to the region.

ZoneIds List<string>

The IDs of the availability zones hosting the VPC endpoints.

DomainName string

The domain name to used in when configuring a private hosted zone in the VPCE connection.

Id string

The provider-assigned unique ID for this managed resource.

Region string
VpcServiceName string

The VPC service name used to connect to the region.

ZoneIds []string

The IDs of the availability zones hosting the VPC endpoints.

domainName String

The domain name to used in when configuring a private hosted zone in the VPCE connection.

id String

The provider-assigned unique ID for this managed resource.

region String
vpcServiceName String

The VPC service name used to connect to the region.

zoneIds List<String>

The IDs of the availability zones hosting the VPC endpoints.

domainName string

The domain name to used in when configuring a private hosted zone in the VPCE connection.

id string

The provider-assigned unique ID for this managed resource.

region string
vpcServiceName string

The VPC service name used to connect to the region.

zoneIds string[]

The IDs of the availability zones hosting the VPC endpoints.

domain_name str

The domain name to used in when configuring a private hosted zone in the VPCE connection.

id str

The provider-assigned unique ID for this managed resource.

region str
vpc_service_name str

The VPC service name used to connect to the region.

zone_ids Sequence[str]

The IDs of the availability zones hosting the VPC endpoints.

domainName String

The domain name to used in when configuring a private hosted zone in the VPCE connection.

id String

The provider-assigned unique ID for this managed resource.

region String
vpcServiceName String

The VPC service name used to connect to the region.

zoneIds List<String>

The IDs of the availability zones hosting the VPC endpoints.

Package Details

Repository
ec pulumi/pulumi-ec
License
Apache-2.0
Notes

This Pulumi package is based on the ec Terraform Provider.