1. Packages
  2. MongoDB Atlas
  3. API Docs
  4. PrivatelinkEndpointServerless
MongoDB Atlas v3.16.1 published on Saturday, Jun 15, 2024 by Pulumi

mongodbatlas.PrivatelinkEndpointServerless

Explore with Pulumi AI

mongodbatlas logo
MongoDB Atlas v3.16.1 published on Saturday, Jun 15, 2024 by Pulumi

    privatelink_endpoint_serverless Provides a Serverless PrivateLink Endpoint resource. This is the first of two resources required to configure PrivateLink for Serverless, the second is mongodbatlas_privatelink_endpoint_service_serverless.

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

    Example Usage

    AWS Example

    import * as pulumi from "@pulumi/pulumi";
    import * as mongodbatlas from "@pulumi/mongodbatlas";
    
    const testServerlessInstance = new mongodbatlas.ServerlessInstance("test", {
        projectId: "<PROJECT_ID>",
        name: "test-db",
        providerSettingsBackingProviderName: "AWS",
        providerSettingsProviderName: "SERVERLESS",
        providerSettingsRegionName: "US_EAST_1",
        continuousBackupEnabled: true,
    });
    const test = new mongodbatlas.PrivatelinkEndpointServerless("test", {
        projectId: "<PROJECT_ID>",
        instanceName: testServerlessInstance.name,
        providerName: "AWS",
    });
    
    import pulumi
    import pulumi_mongodbatlas as mongodbatlas
    
    test_serverless_instance = mongodbatlas.ServerlessInstance("test",
        project_id="<PROJECT_ID>",
        name="test-db",
        provider_settings_backing_provider_name="AWS",
        provider_settings_provider_name="SERVERLESS",
        provider_settings_region_name="US_EAST_1",
        continuous_backup_enabled=True)
    test = mongodbatlas.PrivatelinkEndpointServerless("test",
        project_id="<PROJECT_ID>",
        instance_name=test_serverless_instance.name,
        provider_name="AWS")
    
    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 {
    		testServerlessInstance, err := mongodbatlas.NewServerlessInstance(ctx, "test", &mongodbatlas.ServerlessInstanceArgs{
    			ProjectId:                           pulumi.String("<PROJECT_ID>"),
    			Name:                                pulumi.String("test-db"),
    			ProviderSettingsBackingProviderName: pulumi.String("AWS"),
    			ProviderSettingsProviderName:        pulumi.String("SERVERLESS"),
    			ProviderSettingsRegionName:          pulumi.String("US_EAST_1"),
    			ContinuousBackupEnabled:             pulumi.Bool(true),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = mongodbatlas.NewPrivatelinkEndpointServerless(ctx, "test", &mongodbatlas.PrivatelinkEndpointServerlessArgs{
    			ProjectId:    pulumi.String("<PROJECT_ID>"),
    			InstanceName: testServerlessInstance.Name,
    			ProviderName: pulumi.String("AWS"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Mongodbatlas = Pulumi.Mongodbatlas;
    
    return await Deployment.RunAsync(() => 
    {
        var testServerlessInstance = new Mongodbatlas.ServerlessInstance("test", new()
        {
            ProjectId = "<PROJECT_ID>",
            Name = "test-db",
            ProviderSettingsBackingProviderName = "AWS",
            ProviderSettingsProviderName = "SERVERLESS",
            ProviderSettingsRegionName = "US_EAST_1",
            ContinuousBackupEnabled = true,
        });
    
        var test = new Mongodbatlas.PrivatelinkEndpointServerless("test", new()
        {
            ProjectId = "<PROJECT_ID>",
            InstanceName = testServerlessInstance.Name,
            ProviderName = "AWS",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.mongodbatlas.ServerlessInstance;
    import com.pulumi.mongodbatlas.ServerlessInstanceArgs;
    import com.pulumi.mongodbatlas.PrivatelinkEndpointServerless;
    import com.pulumi.mongodbatlas.PrivatelinkEndpointServerlessArgs;
    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 testServerlessInstance = new ServerlessInstance("testServerlessInstance", ServerlessInstanceArgs.builder()
                .projectId("<PROJECT_ID>")
                .name("test-db")
                .providerSettingsBackingProviderName("AWS")
                .providerSettingsProviderName("SERVERLESS")
                .providerSettingsRegionName("US_EAST_1")
                .continuousBackupEnabled(true)
                .build());
    
            var test = new PrivatelinkEndpointServerless("test", PrivatelinkEndpointServerlessArgs.builder()
                .projectId("<PROJECT_ID>")
                .instanceName(testServerlessInstance.name())
                .providerName("AWS")
                .build());
    
        }
    }
    
    resources:
      test:
        type: mongodbatlas:PrivatelinkEndpointServerless
        properties:
          projectId: <PROJECT_ID>
          instanceName: ${testServerlessInstance.name}
          providerName: AWS
      testServerlessInstance:
        type: mongodbatlas:ServerlessInstance
        name: test
        properties:
          projectId: <PROJECT_ID>
          name: test-db
          providerSettingsBackingProviderName: AWS
          providerSettingsProviderName: SERVERLESS
          providerSettingsRegionName: US_EAST_1
          continuousBackupEnabled: true
    

    Create PrivatelinkEndpointServerless Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new PrivatelinkEndpointServerless(name: string, args: PrivatelinkEndpointServerlessArgs, opts?: CustomResourceOptions);
    @overload
    def PrivatelinkEndpointServerless(resource_name: str,
                                      args: PrivatelinkEndpointServerlessArgs,
                                      opts: Optional[ResourceOptions] = None)
    
    @overload
    def PrivatelinkEndpointServerless(resource_name: str,
                                      opts: Optional[ResourceOptions] = None,
                                      instance_name: Optional[str] = None,
                                      project_id: Optional[str] = None,
                                      provider_name: Optional[str] = None)
    func NewPrivatelinkEndpointServerless(ctx *Context, name string, args PrivatelinkEndpointServerlessArgs, opts ...ResourceOption) (*PrivatelinkEndpointServerless, error)
    public PrivatelinkEndpointServerless(string name, PrivatelinkEndpointServerlessArgs args, CustomResourceOptions? opts = null)
    public PrivatelinkEndpointServerless(String name, PrivatelinkEndpointServerlessArgs args)
    public PrivatelinkEndpointServerless(String name, PrivatelinkEndpointServerlessArgs args, CustomResourceOptions options)
    
    type: mongodbatlas:PrivatelinkEndpointServerless
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

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

    Example

    The following reference example uses placeholder values for all input properties.

    var privatelinkEndpointServerlessResource = new Mongodbatlas.PrivatelinkEndpointServerless("privatelinkEndpointServerlessResource", new()
    {
        InstanceName = "string",
        ProjectId = "string",
        ProviderName = "string",
    });
    
    example, err := mongodbatlas.NewPrivatelinkEndpointServerless(ctx, "privatelinkEndpointServerlessResource", &mongodbatlas.PrivatelinkEndpointServerlessArgs{
    	InstanceName: pulumi.String("string"),
    	ProjectId:    pulumi.String("string"),
    	ProviderName: pulumi.String("string"),
    })
    
    var privatelinkEndpointServerlessResource = new PrivatelinkEndpointServerless("privatelinkEndpointServerlessResource", PrivatelinkEndpointServerlessArgs.builder()
        .instanceName("string")
        .projectId("string")
        .providerName("string")
        .build());
    
    privatelink_endpoint_serverless_resource = mongodbatlas.PrivatelinkEndpointServerless("privatelinkEndpointServerlessResource",
        instance_name="string",
        project_id="string",
        provider_name="string")
    
    const privatelinkEndpointServerlessResource = new mongodbatlas.PrivatelinkEndpointServerless("privatelinkEndpointServerlessResource", {
        instanceName: "string",
        projectId: "string",
        providerName: "string",
    });
    
    type: mongodbatlas:PrivatelinkEndpointServerless
    properties:
        instanceName: string
        projectId: string
        providerName: string
    

    PrivatelinkEndpointServerless 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 PrivatelinkEndpointServerless resource accepts the following input properties:

    InstanceName string
    Human-readable label that identifies the serverless instance.
    ProjectId string
    Unique 24-digit hexadecimal string that identifies the project.
    ProviderName string
    Cloud provider name; AWS is currently supported
    InstanceName string
    Human-readable label that identifies the serverless instance.
    ProjectId string
    Unique 24-digit hexadecimal string that identifies the project.
    ProviderName string
    Cloud provider name; AWS is currently supported
    instanceName String
    Human-readable label that identifies the serverless instance.
    projectId String
    Unique 24-digit hexadecimal string that identifies the project.
    providerName String
    Cloud provider name; AWS is currently supported
    instanceName string
    Human-readable label that identifies the serverless instance.
    projectId string
    Unique 24-digit hexadecimal string that identifies the project.
    providerName string
    Cloud provider name; AWS is currently supported
    instance_name str
    Human-readable label that identifies the serverless instance.
    project_id str
    Unique 24-digit hexadecimal string that identifies the project.
    provider_name str
    Cloud provider name; AWS is currently supported
    instanceName String
    Human-readable label that identifies the serverless instance.
    projectId String
    Unique 24-digit hexadecimal string that identifies the project.
    providerName String
    Cloud provider name; AWS is currently supported

    Outputs

    All input properties are implicitly available as output properties. Additionally, the PrivatelinkEndpointServerless resource produces the following output properties:

    EndpointId string
    Unique 24-hexadecimal digit string that identifies the private endpoint.
    EndpointServiceName string
    Unique string that identifies the PrivateLink endpoint service.
    Id string
    The provider-assigned unique ID for this managed resource.
    PrivateLinkServiceResourceId string
    Root-relative path that identifies the Azure Private Link Service that MongoDB Cloud manages.
    Status string
    Human-readable label that indicates the current operating status of the private endpoint. Values include: RESERVATION_REQUESTED, RESERVED, INITIATING, AVAILABLE, FAILED, DELETING.
    EndpointId string
    Unique 24-hexadecimal digit string that identifies the private endpoint.
    EndpointServiceName string
    Unique string that identifies the PrivateLink endpoint service.
    Id string
    The provider-assigned unique ID for this managed resource.
    PrivateLinkServiceResourceId string
    Root-relative path that identifies the Azure Private Link Service that MongoDB Cloud manages.
    Status string
    Human-readable label that indicates the current operating status of the private endpoint. Values include: RESERVATION_REQUESTED, RESERVED, INITIATING, AVAILABLE, FAILED, DELETING.
    endpointId String
    Unique 24-hexadecimal digit string that identifies the private endpoint.
    endpointServiceName String
    Unique string that identifies the PrivateLink endpoint service.
    id String
    The provider-assigned unique ID for this managed resource.
    privateLinkServiceResourceId String
    Root-relative path that identifies the Azure Private Link Service that MongoDB Cloud manages.
    status String
    Human-readable label that indicates the current operating status of the private endpoint. Values include: RESERVATION_REQUESTED, RESERVED, INITIATING, AVAILABLE, FAILED, DELETING.
    endpointId string
    Unique 24-hexadecimal digit string that identifies the private endpoint.
    endpointServiceName string
    Unique string that identifies the PrivateLink endpoint service.
    id string
    The provider-assigned unique ID for this managed resource.
    privateLinkServiceResourceId string
    Root-relative path that identifies the Azure Private Link Service that MongoDB Cloud manages.
    status string
    Human-readable label that indicates the current operating status of the private endpoint. Values include: RESERVATION_REQUESTED, RESERVED, INITIATING, AVAILABLE, FAILED, DELETING.
    endpoint_id str
    Unique 24-hexadecimal digit string that identifies the private endpoint.
    endpoint_service_name str
    Unique string that identifies the PrivateLink endpoint service.
    id str
    The provider-assigned unique ID for this managed resource.
    private_link_service_resource_id str
    Root-relative path that identifies the Azure Private Link Service that MongoDB Cloud manages.
    status str
    Human-readable label that indicates the current operating status of the private endpoint. Values include: RESERVATION_REQUESTED, RESERVED, INITIATING, AVAILABLE, FAILED, DELETING.
    endpointId String
    Unique 24-hexadecimal digit string that identifies the private endpoint.
    endpointServiceName String
    Unique string that identifies the PrivateLink endpoint service.
    id String
    The provider-assigned unique ID for this managed resource.
    privateLinkServiceResourceId String
    Root-relative path that identifies the Azure Private Link Service that MongoDB Cloud manages.
    status String
    Human-readable label that indicates the current operating status of the private endpoint. Values include: RESERVATION_REQUESTED, RESERVED, INITIATING, AVAILABLE, FAILED, DELETING.

    Look up Existing PrivatelinkEndpointServerless Resource

    Get an existing PrivatelinkEndpointServerless 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?: PrivatelinkEndpointServerlessState, opts?: CustomResourceOptions): PrivatelinkEndpointServerless
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            endpoint_id: Optional[str] = None,
            endpoint_service_name: Optional[str] = None,
            instance_name: Optional[str] = None,
            private_link_service_resource_id: Optional[str] = None,
            project_id: Optional[str] = None,
            provider_name: Optional[str] = None,
            status: Optional[str] = None) -> PrivatelinkEndpointServerless
    func GetPrivatelinkEndpointServerless(ctx *Context, name string, id IDInput, state *PrivatelinkEndpointServerlessState, opts ...ResourceOption) (*PrivatelinkEndpointServerless, error)
    public static PrivatelinkEndpointServerless Get(string name, Input<string> id, PrivatelinkEndpointServerlessState? state, CustomResourceOptions? opts = null)
    public static PrivatelinkEndpointServerless get(String name, Output<String> id, PrivatelinkEndpointServerlessState 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:
    EndpointId string
    Unique 24-hexadecimal digit string that identifies the private endpoint.
    EndpointServiceName string
    Unique string that identifies the PrivateLink endpoint service.
    InstanceName string
    Human-readable label that identifies the serverless instance.
    PrivateLinkServiceResourceId string
    Root-relative path that identifies the Azure Private Link Service that MongoDB Cloud manages.
    ProjectId string
    Unique 24-digit hexadecimal string that identifies the project.
    ProviderName string
    Cloud provider name; AWS is currently supported
    Status string
    Human-readable label that indicates the current operating status of the private endpoint. Values include: RESERVATION_REQUESTED, RESERVED, INITIATING, AVAILABLE, FAILED, DELETING.
    EndpointId string
    Unique 24-hexadecimal digit string that identifies the private endpoint.
    EndpointServiceName string
    Unique string that identifies the PrivateLink endpoint service.
    InstanceName string
    Human-readable label that identifies the serverless instance.
    PrivateLinkServiceResourceId string
    Root-relative path that identifies the Azure Private Link Service that MongoDB Cloud manages.
    ProjectId string
    Unique 24-digit hexadecimal string that identifies the project.
    ProviderName string
    Cloud provider name; AWS is currently supported
    Status string
    Human-readable label that indicates the current operating status of the private endpoint. Values include: RESERVATION_REQUESTED, RESERVED, INITIATING, AVAILABLE, FAILED, DELETING.
    endpointId String
    Unique 24-hexadecimal digit string that identifies the private endpoint.
    endpointServiceName String
    Unique string that identifies the PrivateLink endpoint service.
    instanceName String
    Human-readable label that identifies the serverless instance.
    privateLinkServiceResourceId String
    Root-relative path that identifies the Azure Private Link Service that MongoDB Cloud manages.
    projectId String
    Unique 24-digit hexadecimal string that identifies the project.
    providerName String
    Cloud provider name; AWS is currently supported
    status String
    Human-readable label that indicates the current operating status of the private endpoint. Values include: RESERVATION_REQUESTED, RESERVED, INITIATING, AVAILABLE, FAILED, DELETING.
    endpointId string
    Unique 24-hexadecimal digit string that identifies the private endpoint.
    endpointServiceName string
    Unique string that identifies the PrivateLink endpoint service.
    instanceName string
    Human-readable label that identifies the serverless instance.
    privateLinkServiceResourceId string
    Root-relative path that identifies the Azure Private Link Service that MongoDB Cloud manages.
    projectId string
    Unique 24-digit hexadecimal string that identifies the project.
    providerName string
    Cloud provider name; AWS is currently supported
    status string
    Human-readable label that indicates the current operating status of the private endpoint. Values include: RESERVATION_REQUESTED, RESERVED, INITIATING, AVAILABLE, FAILED, DELETING.
    endpoint_id str
    Unique 24-hexadecimal digit string that identifies the private endpoint.
    endpoint_service_name str
    Unique string that identifies the PrivateLink endpoint service.
    instance_name str
    Human-readable label that identifies the serverless instance.
    private_link_service_resource_id str
    Root-relative path that identifies the Azure Private Link Service that MongoDB Cloud manages.
    project_id str
    Unique 24-digit hexadecimal string that identifies the project.
    provider_name str
    Cloud provider name; AWS is currently supported
    status str
    Human-readable label that indicates the current operating status of the private endpoint. Values include: RESERVATION_REQUESTED, RESERVED, INITIATING, AVAILABLE, FAILED, DELETING.
    endpointId String
    Unique 24-hexadecimal digit string that identifies the private endpoint.
    endpointServiceName String
    Unique string that identifies the PrivateLink endpoint service.
    instanceName String
    Human-readable label that identifies the serverless instance.
    privateLinkServiceResourceId String
    Root-relative path that identifies the Azure Private Link Service that MongoDB Cloud manages.
    projectId String
    Unique 24-digit hexadecimal string that identifies the project.
    providerName String
    Cloud provider name; AWS is currently supported
    status String
    Human-readable label that indicates the current operating status of the private endpoint. Values include: RESERVATION_REQUESTED, RESERVED, INITIATING, AVAILABLE, FAILED, DELETING.

    Import

    Serverless privatelink endpoint can be imported using project ID and endpoint ID, in the format project_idendpoint_id, e.g.

    $ pulumi import mongodbatlas:index/privatelinkEndpointServerless:PrivatelinkEndpointServerless test 1112222b3bf99403840e8934--serverless_name--vpce-jjg5e24qp93513h03
    

    For more information see: MongoDB Atlas API - Serverless Private Endpoints.

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    MongoDB Atlas pulumi/pulumi-mongodbatlas
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the mongodbatlas Terraform Provider.
    mongodbatlas logo
    MongoDB Atlas v3.16.1 published on Saturday, Jun 15, 2024 by Pulumi