MongoDB Atlas v3.7.2, Mar 31 23

mongodbatlas.PrivatelinkEndpointServiceAdl

Explore with Pulumi AI

privatelink_endpoint_service_adl Provides an Atlas Data Lake (ADL) and Online Archive PrivateLink endpoint resource. The same configuration will provide a PrivateLink connection for either Atlas Data Lake or Online Archive.

Example Usage

Basic

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

return await Deployment.RunAsync(() => 
{
    var adlTest = new Mongodbatlas.PrivatelinkEndpointServiceAdl("adlTest", new()
    {
        Comment = "comments for private link endpoint adl",
        EndpointId = "<ENDPOINT_ID>",
        ProjectId = "<PROJECT_ID>",
        ProviderName = "AWS",
        Type = "DATA_LAKE",
    });

});

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 {
		_, err := mongodbatlas.NewPrivatelinkEndpointServiceAdl(ctx, "adlTest", &mongodbatlas.PrivatelinkEndpointServiceAdlArgs{
			Comment:      pulumi.String("comments for private link endpoint adl"),
			EndpointId:   pulumi.String("<ENDPOINT_ID>"),
			ProjectId:    pulumi.String("<PROJECT_ID>"),
			ProviderName: pulumi.String("AWS"),
			Type:         pulumi.String("DATA_LAKE"),
		})
		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.mongodbatlas.PrivatelinkEndpointServiceAdl;
import com.pulumi.mongodbatlas.PrivatelinkEndpointServiceAdlArgs;
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 adlTest = new PrivatelinkEndpointServiceAdl("adlTest", PrivatelinkEndpointServiceAdlArgs.builder()        
            .comment("comments for private link endpoint adl")
            .endpointId("<ENDPOINT_ID>")
            .projectId("<PROJECT_ID>")
            .providerName("AWS")
            .type("DATA_LAKE")
            .build());

    }
}

import pulumi
import pulumi_mongodbatlas as mongodbatlas

adl_test = mongodbatlas.PrivatelinkEndpointServiceAdl("adlTest",
    comment="comments for private link endpoint adl",
    endpoint_id="<ENDPOINT_ID>",
    project_id="<PROJECT_ID>",
    provider_name="AWS",
    type="DATA_LAKE")

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

const adlTest = new mongodbatlas.PrivatelinkEndpointServiceAdl("adlTest", {
    comment: "comments for private link endpoint adl",
    endpointId: "<ENDPOINT_ID>",
    projectId: "<PROJECT_ID>",
    providerName: "AWS",
    type: "DATA_LAKE",
});

resources:
  adlTest:
    type: mongodbatlas:PrivatelinkEndpointServiceAdl
    properties:
      comment: comments for private link endpoint adl
      endpointId: <ENDPOINT_ID>
      projectId: <PROJECT_ID>
      providerName: AWS
      type: DATA_LAKE

Create PrivatelinkEndpointServiceAdl Resource

new PrivatelinkEndpointServiceAdl(name: string, args: PrivatelinkEndpointServiceAdlArgs, opts?: CustomResourceOptions);

@overload
def PrivatelinkEndpointServiceAdl(resource_name: str,
                                  opts: Optional[ResourceOptions] = None,
                                  comment: Optional[str] = None,
                                  endpoint_id: Optional[str] = None,
                                  project_id: Optional[str] = None,
                                  provider_name: Optional[str] = None,
                                  type: Optional[str] = None)
@overload
def PrivatelinkEndpointServiceAdl(resource_name: str,
                                  args: PrivatelinkEndpointServiceAdlArgs,
                                  opts: Optional[ResourceOptions] = None)

func NewPrivatelinkEndpointServiceAdl(ctx *Context, name string, args PrivatelinkEndpointServiceAdlArgs, opts ...ResourceOption) (*PrivatelinkEndpointServiceAdl, error)

public PrivatelinkEndpointServiceAdl(string name, PrivatelinkEndpointServiceAdlArgs args, CustomResourceOptions? opts = null)

public PrivatelinkEndpointServiceAdl(String name, PrivatelinkEndpointServiceAdlArgs args)
public PrivatelinkEndpointServiceAdl(String name, PrivatelinkEndpointServiceAdlArgs args, CustomResourceOptions options)

type: mongodbatlas:PrivatelinkEndpointServiceAdl
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string: The unique name of the resource.
args PrivatelinkEndpointServiceAdlArgs: 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 PrivatelinkEndpointServiceAdlArgs: 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 PrivatelinkEndpointServiceAdlArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args PrivatelinkEndpointServiceAdlArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args PrivatelinkEndpointServiceAdlArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

PrivatelinkEndpointServiceAdl Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The PrivatelinkEndpointServiceAdl resource accepts the following input properties:

EndpointId string: Unique 22-character alphanumeric string that identifies the private endpoint. Atlas supports AWS private endpoints using the |aws| PrivateLink feature.
ProjectId string: Unique 24-digit hexadecimal string that identifies the project.
ProviderName string: Human-readable label that identifies the cloud provider for this endpoint. Atlas supports AWS only. If empty, defaults to AWS.
Type string: Human-readable label that identifies the type of resource to associate with this private endpoint. Atlas supports DATA_LAKE only. If empty, defaults to DATA_LAKE.
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.
ProjectId string: Unique 24-digit hexadecimal string that identifies the project.
ProviderName string: Human-readable label that identifies the cloud provider for this endpoint. Atlas supports AWS only. If empty, defaults to AWS.
Type string: Human-readable label that identifies the type of resource to associate with this private endpoint. Atlas supports DATA_LAKE only. If empty, defaults to DATA_LAKE.
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.
projectId String: Unique 24-digit hexadecimal string that identifies the project.
providerName String: Human-readable label that identifies the cloud provider for this endpoint. Atlas supports AWS only. If empty, defaults to AWS.
type String: Human-readable label that identifies the type of resource to associate with this private endpoint. Atlas supports DATA_LAKE only. If empty, defaults to DATA_LAKE.
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.
projectId string: Unique 24-digit hexadecimal string that identifies the project.
providerName string: Human-readable label that identifies the cloud provider for this endpoint. Atlas supports AWS only. If empty, defaults to AWS.
type string: Human-readable label that identifies the type of resource to associate with this private endpoint. Atlas supports DATA_LAKE only. If empty, defaults to DATA_LAKE.
comment string: 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.
project_id str: Unique 24-digit hexadecimal string that identifies the project.
provider_name str: Human-readable label that identifies the cloud provider for this endpoint. Atlas supports AWS only. If empty, defaults to AWS.
type str: Human-readable label that identifies the type of resource to associate with this private endpoint. Atlas supports DATA_LAKE only. If empty, defaults to DATA_LAKE.
comment str: 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.
projectId String: Unique 24-digit hexadecimal string that identifies the project.
providerName String: Human-readable label that identifies the cloud provider for this endpoint. Atlas supports AWS only. If empty, defaults to AWS.
type String: Human-readable label that identifies the type of resource to associate with this private endpoint. Atlas supports DATA_LAKE only. If empty, defaults to DATA_LAKE.
comment String: Human-readable string to associate with this private endpoint.

Outputs

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

Get an existing PrivatelinkEndpointServiceAdl 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?: PrivatelinkEndpointServiceAdlState, opts?: CustomResourceOptions): PrivatelinkEndpointServiceAdl

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        comment: Optional[str] = None,
        endpoint_id: Optional[str] = None,
        project_id: Optional[str] = None,
        provider_name: Optional[str] = None,
        type: Optional[str] = None) -> PrivatelinkEndpointServiceAdl

func GetPrivatelinkEndpointServiceAdl(ctx *Context, name string, id IDInput, state *PrivatelinkEndpointServiceAdlState, opts ...ResourceOption) (*PrivatelinkEndpointServiceAdl, error)

public static PrivatelinkEndpointServiceAdl Get(string name, Input<string> id, PrivatelinkEndpointServiceAdlState? state, CustomResourceOptions? opts = null)

public static PrivatelinkEndpointServiceAdl get(String name, Output<String> id, PrivatelinkEndpointServiceAdlState 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:

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.
ProjectId string: Unique 24-digit hexadecimal string that identifies the project.
ProviderName string: Human-readable label that identifies the cloud provider for this endpoint. Atlas supports AWS only. If empty, defaults to AWS.
Type string: Human-readable label that identifies the type of resource to associate with this private endpoint. Atlas supports DATA_LAKE only. If empty, defaults to DATA_LAKE.

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.
ProjectId string: Unique 24-digit hexadecimal string that identifies the project.
ProviderName string: Human-readable label that identifies the cloud provider for this endpoint. Atlas supports AWS only. If empty, defaults to AWS.
Type string: Human-readable label that identifies the type of resource to associate with this private endpoint. Atlas supports DATA_LAKE only. If empty, defaults to DATA_LAKE.

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.
projectId String: Unique 24-digit hexadecimal string that identifies the project.
providerName String: Human-readable label that identifies the cloud provider for this endpoint. Atlas supports AWS only. If empty, defaults to AWS.
type String: Human-readable label that identifies the type of resource to associate with this private endpoint. Atlas supports DATA_LAKE only. If empty, defaults to DATA_LAKE.

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.
projectId string: Unique 24-digit hexadecimal string that identifies the project.
providerName string: Human-readable label that identifies the cloud provider for this endpoint. Atlas supports AWS only. If empty, defaults to AWS.
type string: Human-readable label that identifies the type of resource to associate with this private endpoint. Atlas supports DATA_LAKE only. If empty, defaults to DATA_LAKE.

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.
project_id str: Unique 24-digit hexadecimal string that identifies the project.
provider_name str: Human-readable label that identifies the cloud provider for this endpoint. Atlas supports AWS only. If empty, defaults to AWS.
type str: Human-readable label that identifies the type of resource to associate with this private endpoint. Atlas supports DATA_LAKE only. If empty, defaults to DATA_LAKE.

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.
projectId String: Unique 24-digit hexadecimal string that identifies the project.
providerName String: Human-readable label that identifies the cloud provider for this endpoint. Atlas supports AWS only. If empty, defaults to AWS.
type String: Human-readable label that identifies the type of resource to associate with this private endpoint. Atlas supports DATA_LAKE only. If empty, defaults to DATA_LAKE.

Import

ADL privatelink endpoint can be imported using project ID and endpoint ID, in the format project_id–endpoint_id, e.g.

 $ pulumi import mongodbatlas:index/privatelinkEndpointServiceAdl:PrivatelinkEndpointServiceAdl test 1112222b3bf99403840e8934--vpce-jjg5e24qp93513h03

For more information seeMongoDB Atlas API - DataLake

and MongoDB Atlas API - Online Archive Documentation.

Package Details

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