MongoDB Atlas

Pulumi Official

Package maintained by Pulumi

v3.5.0 published on Wednesday, Jul 20, 2022 by Pulumi

getPrivatelinkEndpointsServiceAdl

privatelink_endpoints_service_adl Describes the list of all Atlas Data Lake (ADL) and Online Archive PrivateLink endpoints resource.

NOTE: Groups and projects are synonymous terms. You may find group_id in the official documentation.

Example Usage

Basic

using Pulumi;
using Mongodbatlas = Pulumi.Mongodbatlas;

class MyStack : Stack
{
    public MyStack()
    {
        var adlTest = new Mongodbatlas.PrivatelinkEndpointServiceAdl("adlTest", new Mongodbatlas.PrivatelinkEndpointServiceAdlArgs
        {
            ProjectId = "<PROJECT_ID>",
            EndpointId = "<ENDPOINT_ID>",
            Comment = "Comment for PrivateLink endpoint ADL",
            Type = "DATA_LAKE",
            ProviderName = "AWS",
        });
        var test = Mongodbatlas.GetPrivatelinkEndpointsServiceAdl.Invoke(new Mongodbatlas.GetPrivatelinkEndpointsServiceAdlInvokeArgs
        {
            ProjectId = adlTest.ProjectId,
        });
    }

}

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		adlTest, err := mongodbatlas.NewPrivatelinkEndpointServiceAdl(ctx, "adlTest", &mongodbatlas.PrivatelinkEndpointServiceAdlArgs{
			ProjectId:    pulumi.String("<PROJECT_ID>"),
			EndpointId:   pulumi.String("<ENDPOINT_ID>"),
			Comment:      pulumi.String("Comment for PrivateLink endpoint ADL"),
			Type:         pulumi.String("DATA_LAKE"),
			ProviderName: pulumi.String("AWS"),
		})
		if err != nil {
			return err
		}
		_ = mongodbatlas.LookupPrivatelinkEndpointsServiceAdlOutput(ctx, GetPrivatelinkEndpointsServiceAdlOutputArgs{
			ProjectId: adlTest.ProjectId,
		}, nil)
		return nil
	})
}

Coming soon!

import pulumi
import pulumi_mongodbatlas as mongodbatlas

adl_test = mongodbatlas.PrivatelinkEndpointServiceAdl("adlTest",
    project_id="<PROJECT_ID>",
    endpoint_id="<ENDPOINT_ID>",
    comment="Comment for PrivateLink endpoint ADL",
    type="DATA_LAKE",
    provider_name="AWS")
test = mongodbatlas.get_privatelink_endpoints_service_adl_output(project_id=adl_test.project_id)

import * as pulumi from "@pulumi/pulumi";
import * as mongodbatlas from "@pulumi/mongodbatlas";

const adlTest = new mongodbatlas.PrivatelinkEndpointServiceAdl("adlTest", {
    projectId: "<PROJECT_ID>",
    endpointId: "<ENDPOINT_ID>",
    comment: "Comment for PrivateLink endpoint ADL",
    type: "DATA_LAKE",
    providerName: "AWS",
});
const test = mongodbatlas.getPrivatelinkEndpointsServiceAdlOutput({
    projectId: adlTest.projectId,
});

Coming soon!

Using getPrivatelinkEndpointsServiceAdl

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 getPrivatelinkEndpointsServiceAdl(args: GetPrivatelinkEndpointsServiceAdlArgs, opts?: InvokeOptions): Promise<GetPrivatelinkEndpointsServiceAdlResult>
function getPrivatelinkEndpointsServiceAdlOutput(args: GetPrivatelinkEndpointsServiceAdlOutputArgs, opts?: InvokeOptions): Output<GetPrivatelinkEndpointsServiceAdlResult>

def get_privatelink_endpoints_service_adl(project_id: Optional[str] = None,
                                          opts: Optional[InvokeOptions] = None) -> GetPrivatelinkEndpointsServiceAdlResult
def get_privatelink_endpoints_service_adl_output(project_id: Optional[pulumi.Input[str]] = None,
                                          opts: Optional[InvokeOptions] = None) -> Output[GetPrivatelinkEndpointsServiceAdlResult]

func LookupPrivatelinkEndpointsServiceAdl(ctx *Context, args *LookupPrivatelinkEndpointsServiceAdlArgs, opts ...InvokeOption) (*LookupPrivatelinkEndpointsServiceAdlResult, error)
func LookupPrivatelinkEndpointsServiceAdlOutput(ctx *Context, args *LookupPrivatelinkEndpointsServiceAdlOutputArgs, opts ...InvokeOption) LookupPrivatelinkEndpointsServiceAdlResultOutput

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

public static class GetPrivatelinkEndpointsServiceAdl 
{
    public static Task<GetPrivatelinkEndpointsServiceAdlResult> InvokeAsync(GetPrivatelinkEndpointsServiceAdlArgs args, InvokeOptions? opts = null)
    public static Output<GetPrivatelinkEndpointsServiceAdlResult> Invoke(GetPrivatelinkEndpointsServiceAdlInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetPrivatelinkEndpointsServiceAdlResult> getPrivatelinkEndpointsServiceAdl(GetPrivatelinkEndpointsServiceAdlArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

Fn::Invoke:
  Function: mongodbatlas:index/getPrivatelinkEndpointsServiceAdl:getPrivatelinkEndpointsServiceAdl
  Arguments:
    # Arguments dictionary

The following arguments are supported:

ProjectId string: The unique ID for the project.

ProjectId string: The unique ID for the project.

projectId String: The unique ID for the project.

projectId string: The unique ID for the project.

project_id str: The unique ID for the project.

projectId String: The unique ID for the project.

getPrivatelinkEndpointsServiceAdl Result

The following output properties are available:

Id string: The provider-assigned unique ID for this managed resource.
Links List<GetPrivatelinkEndpointsServiceAdlLink>
ProjectId string
Results List<GetPrivatelinkEndpointsServiceAdlResult>
TotalCount int

Id string: The provider-assigned unique ID for this managed resource.
Links []GetPrivatelinkEndpointsServiceAdlLink
ProjectId string
Results []GetPrivatelinkEndpointsServiceAdlResult
TotalCount int

id String: The provider-assigned unique ID for this managed resource.
links List<GetPrivatelinkEndpointsServiceAdlLink>
projectId String
results List<GetPrivatelinkEndpointsServiceAdlResult>
totalCount Integer

id string: The provider-assigned unique ID for this managed resource.
links GetPrivatelinkEndpointsServiceAdlLink[]
projectId string
results GetPrivatelinkEndpointsServiceAdlResult[]
totalCount number

id str: The provider-assigned unique ID for this managed resource.
links Sequence[GetPrivatelinkEndpointsServiceAdlLink]
project_id str
results Sequence[GetPrivatelinkEndpointsServiceAdlResult]
total_count int

id String: The provider-assigned unique ID for this managed resource.
links List<Property Map>
projectId String
results List<Property Map>
totalCount Number

Supporting Types

GetPrivatelinkEndpointsServiceAdlLink

Href string
Rel string

Href string
Rel string

href String
rel String

href string
rel string

href str
rel str

href String
rel String

GetPrivatelinkEndpointsServiceAdlResult

Comment string: Human-readable string to associate with this private endpoint.
EndpointId string: Unique 22-character alphanumeric string that identifies the private endpoint. Atlas supports AWS private endpoints using the |aws| PrivateLink feature.
ProviderName string: Human-readable label that identifies the cloud provider for this endpoint.
Type string: Human-readable label that identifies the type of resource to associate with this private endpoint.

Comment string: Human-readable string to associate with this private endpoint.
EndpointId string: Unique 22-character alphanumeric string that identifies the private endpoint. Atlas supports AWS private endpoints using the |aws| PrivateLink feature.
ProviderName string: Human-readable label that identifies the cloud provider for this endpoint.
Type string: Human-readable label that identifies the type of resource to associate with this private endpoint.

comment String: Human-readable string to associate with this private endpoint.
endpointId String: Unique 22-character alphanumeric string that identifies the private endpoint. Atlas supports AWS private endpoints using the |aws| PrivateLink feature.
providerName String: Human-readable label that identifies the cloud provider for this endpoint.
type String: Human-readable label that identifies the type of resource to associate with this private endpoint.

comment string: Human-readable string to associate with this private endpoint.
endpointId string: Unique 22-character alphanumeric string that identifies the private endpoint. Atlas supports AWS private endpoints using the |aws| PrivateLink feature.
providerName string: Human-readable label that identifies the cloud provider for this endpoint.
type string: Human-readable label that identifies the type of resource to associate with this private endpoint.

comment str: Human-readable string to associate with this private endpoint.
endpoint_id str: Unique 22-character alphanumeric string that identifies the private endpoint. Atlas supports AWS private endpoints using the |aws| PrivateLink feature.
provider_name str: Human-readable label that identifies the cloud provider for this endpoint.
type str: Human-readable label that identifies the type of resource to associate with this private endpoint.

comment String: Human-readable string to associate with this private endpoint.
endpointId String: Unique 22-character alphanumeric string that identifies the private endpoint. Atlas supports AWS private endpoints using the |aws| PrivateLink feature.
providerName String: Human-readable label that identifies the cloud provider for this endpoint.
type String: Human-readable label that identifies the type of resource to associate with this private endpoint.

Package Details

Repository: https://github.com/pulumi/pulumi-mongodbatlas
License: Apache-2.0
Notes: This Pulumi package is based on the mongodbatlas Terraform Provider.