1. Packages
  2. Astra DB
  3. API Docs
  4. getPrivateLinkEndpoints
Astra DB v1.0.42 published on Tuesday, Jun 6, 2023 by pulumiverse

astra.getPrivateLinkEndpoints

Explore with Pulumi AI

astra.getPrivateLinkEndpoints provides a datasource that lists the private link endpoints for an Astra database.

Example Usage

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

return await Deployment.RunAsync(() => 
{
    var dev = Astra.GetPrivateLinkEndpoints.Invoke(new()
    {
        DatabaseId = "8d356587-73b3-430a-9c0e-d780332e2afb",
        DatacenterId = "8d356587-73b3-430a-9c0e-d780332e2afb-1",
        EndpointId = "com.amazonaws.vpce.us-east-1.vpce-svc-03ac5a4b18ee480df",
    });

});
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := astra.LookupPrivateLinkEndpoints(ctx, &GetPrivateLinkEndpointsArgs{
			DatabaseId:   "8d356587-73b3-430a-9c0e-d780332e2afb",
			DatacenterId: "8d356587-73b3-430a-9c0e-d780332e2afb-1",
			EndpointId:   "com.amazonaws.vpce.us-east-1.vpce-svc-03ac5a4b18ee480df",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.astra.AstraFunctions;
import com.pulumi.astra.inputs.GetPrivateLinkEndpointsArgs;
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 dev = AstraFunctions.getPrivateLinkEndpoints(GetPrivateLinkEndpointsArgs.builder()
            .databaseId("8d356587-73b3-430a-9c0e-d780332e2afb")
            .datacenterId("8d356587-73b3-430a-9c0e-d780332e2afb-1")
            .endpointId("com.amazonaws.vpce.us-east-1.vpce-svc-03ac5a4b18ee480df")
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as astra from "@pulumi/astra";

const dev = pulumi.output(astra.getPrivateLinkEndpoints({
    databaseId: "8d356587-73b3-430a-9c0e-d780332e2afb",
    datacenterId: "8d356587-73b3-430a-9c0e-d780332e2afb-1",
    endpointId: "com.amazonaws.vpce.us-east-1.vpce-svc-03ac5a4b18ee480df",
}));
Copy
import pulumi
import pulumi_astra as astra

dev = astra.get_private_link_endpoints(database_id="8d356587-73b3-430a-9c0e-d780332e2afb",
    datacenter_id="8d356587-73b3-430a-9c0e-d780332e2afb-1",
    endpoint_id="com.amazonaws.vpce.us-east-1.vpce-svc-03ac5a4b18ee480df")
Copy
variables:
  dev:
    Fn::Invoke:
      Function: astra:getPrivateLinkEndpoints
      Arguments:
        databaseId: 8d356587-73b3-430a-9c0e-d780332e2afb
        datacenterId: 8d356587-73b3-430a-9c0e-d780332e2afb-1
        endpointId: com.amazonaws.vpce.us-east-1.vpce-svc-03ac5a4b18ee480df
Copy

Using getPrivateLinkEndpoints

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 getPrivateLinkEndpoints(args: GetPrivateLinkEndpointsArgs, opts?: InvokeOptions): Promise<GetPrivateLinkEndpointsResult>
function getPrivateLinkEndpointsOutput(args: GetPrivateLinkEndpointsOutputArgs, opts?: InvokeOptions): Output<GetPrivateLinkEndpointsResult>
Copy
def get_private_link_endpoints(database_id: Optional[str] = None,
                               datacenter_id: Optional[str] = None,
                               endpoint_id: Optional[str] = None,
                               opts: Optional[InvokeOptions] = None) -> GetPrivateLinkEndpointsResult
def get_private_link_endpoints_output(database_id: Optional[pulumi.Input[str]] = None,
                               datacenter_id: Optional[pulumi.Input[str]] = None,
                               endpoint_id: Optional[pulumi.Input[str]] = None,
                               opts: Optional[InvokeOptions] = None) -> Output[GetPrivateLinkEndpointsResult]
Copy
func LookupPrivateLinkEndpoints(ctx *Context, args *LookupPrivateLinkEndpointsArgs, opts ...InvokeOption) (*LookupPrivateLinkEndpointsResult, error)
func LookupPrivateLinkEndpointsOutput(ctx *Context, args *LookupPrivateLinkEndpointsOutputArgs, opts ...InvokeOption) LookupPrivateLinkEndpointsResultOutput
Copy

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

public static class GetPrivateLinkEndpoints 
{
    public static Task<GetPrivateLinkEndpointsResult> InvokeAsync(GetPrivateLinkEndpointsArgs args, InvokeOptions? opts = null)
    public static Output<GetPrivateLinkEndpointsResult> Invoke(GetPrivateLinkEndpointsInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetPrivateLinkEndpointsResult> getPrivateLinkEndpoints(GetPrivateLinkEndpointsArgs args, InvokeOptions options)
public static Output<GetPrivateLinkEndpointsResult> getPrivateLinkEndpoints(GetPrivateLinkEndpointsArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: astra:index/getPrivateLinkEndpoints:getPrivateLinkEndpoints
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

DatabaseId This property is required. string
The ID of the Astra database.
DatacenterId This property is required. string
The Datacenter ID of the Astra database.
EndpointId This property is required. string
Endpoint ID.
DatabaseId This property is required. string
The ID of the Astra database.
DatacenterId This property is required. string
The Datacenter ID of the Astra database.
EndpointId This property is required. string
Endpoint ID.
databaseId This property is required. String
The ID of the Astra database.
datacenterId This property is required. String
The Datacenter ID of the Astra database.
endpointId This property is required. String
Endpoint ID.
databaseId This property is required. string
The ID of the Astra database.
datacenterId This property is required. string
The Datacenter ID of the Astra database.
endpointId This property is required. string
Endpoint ID.
database_id This property is required. str
The ID of the Astra database.
datacenter_id This property is required. str
The Datacenter ID of the Astra database.
endpoint_id This property is required. str
Endpoint ID.
databaseId This property is required. String
The ID of the Astra database.
datacenterId This property is required. String
The Datacenter ID of the Astra database.
endpointId This property is required. String
Endpoint ID.

getPrivateLinkEndpoints Result

The following output properties are available:

DatabaseId string
The ID of the Astra database.
DatacenterId string
The Datacenter ID of the Astra database.
EndpointId string
Endpoint ID.
Id string
The provider-assigned unique ID for this managed resource.
Results List<Pulumiverse.Astra.Outputs.GetPrivateLinkEndpointsResult>
The list of private links endpoint details that match the search criteria.
DatabaseId string
The ID of the Astra database.
DatacenterId string
The Datacenter ID of the Astra database.
EndpointId string
Endpoint ID.
Id string
The provider-assigned unique ID for this managed resource.
Results []GetPrivateLinkEndpointsResult
The list of private links endpoint details that match the search criteria.
databaseId String
The ID of the Astra database.
datacenterId String
The Datacenter ID of the Astra database.
endpointId String
Endpoint ID.
id String
The provider-assigned unique ID for this managed resource.
results List<GetPrivateLinkEndpointsResult>
The list of private links endpoint details that match the search criteria.
databaseId string
The ID of the Astra database.
datacenterId string
The Datacenter ID of the Astra database.
endpointId string
Endpoint ID.
id string
The provider-assigned unique ID for this managed resource.
results GetPrivateLinkEndpointsResult[]
The list of private links endpoint details that match the search criteria.
database_id str
The ID of the Astra database.
datacenter_id str
The Datacenter ID of the Astra database.
endpoint_id str
Endpoint ID.
id str
The provider-assigned unique ID for this managed resource.
results Sequence[GetPrivateLinkEndpointsResult]
The list of private links endpoint details that match the search criteria.
databaseId String
The ID of the Astra database.
datacenterId String
The Datacenter ID of the Astra database.
endpointId String
Endpoint ID.
id String
The provider-assigned unique ID for this managed resource.
results List<Property Map>
The list of private links endpoint details that match the search criteria.

Supporting Types

GetPrivateLinkEndpointsResult

CreateTime This property is required. string
Description This property is required. string
EndpointId This property is required. string
Endpoint ID.
Status This property is required. string
CreateTime This property is required. string
Description This property is required. string
EndpointId This property is required. string
Endpoint ID.
Status This property is required. string
createTime This property is required. String
description This property is required. String
endpointId This property is required. String
Endpoint ID.
status This property is required. String
createTime This property is required. string
description This property is required. string
endpointId This property is required. string
Endpoint ID.
status This property is required. string
create_time This property is required. str
description This property is required. str
endpoint_id This property is required. str
Endpoint ID.
status This property is required. str
createTime This property is required. String
description This property is required. String
endpointId This property is required. String
Endpoint ID.
status This property is required. String

Package Details

Repository
astra pulumiverse/pulumi-astra
License
Apache-2.0
Notes
This Pulumi package is based on the astra Terraform Provider.