1. Packages
  2. Packages
  3. Mongodbatlas Provider
  4. API Docs
  5. PrivatelinkEndpointServiceDataFederationOnlineArchive
Viewing docs for MongoDB Atlas v4.8.0
published on Thursday, Apr 23, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-mongodbatlas

mongodbatlas.PrivatelinkEndpointServiceDataFederationOnlineArchive

mongodbatlas logo
Viewing docs for MongoDB Atlas v4.8.0
published on Thursday, Apr 23, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-mongodbatlas

    mongodbatlas.PrivatelinkEndpointServiceDataFederationOnlineArchive provides a Private Endpoint Service resource for Data Federation and Online Archive. The resource allows you to create and manage a private endpoint for Federated Database Instances and Online Archives to the specified project.

    NOTE: Updates are limited to the comment argument.

    Example Usage

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

const atlas_project = new mongodbatlas.Project("atlas-project", {
    orgId: atlasOrgId,
    name: atlasProjectName,
});
const test = new aws.index.VpcEndpoint("test", {
    vpcId: "vpc-7fc0a543",
    serviceName: "<SERVICE-NAME>",
    vpcEndpointType: "Interface",
    subnetIds: ["subnet-de0406d2"],
    securityGroupIds: ["sg-3f238186"],
});
const testPrivatelinkEndpointServiceDataFederationOnlineArchive = new mongodbatlas.PrivatelinkEndpointServiceDataFederationOnlineArchive("test", {
    projectId: atlas_project.id,
    endpointId: test.id,
    providerName: "AWS",
    comment: "Test",
    region: "US_EAST_1",
    customerEndpointDnsName: test.dnsEntry[0].dnsName,
});

    import pulumi
import pulumi_aws as aws
import pulumi_mongodbatlas as mongodbatlas

atlas_project = mongodbatlas.Project("atlas-project",
    org_id=atlas_org_id,
    name=atlas_project_name)
test = aws.VpcEndpoint("test",
    vpc_id=vpc-7fc0a543,
    service_name=<SERVICE-NAME>,
    vpc_endpoint_type=Interface,
    subnet_ids=[subnet-de0406d2],
    security_group_ids=[sg-3f238186])
test_privatelink_endpoint_service_data_federation_online_archive = mongodbatlas.PrivatelinkEndpointServiceDataFederationOnlineArchive("test",
    project_id=atlas_project.id,
    endpoint_id=test["id"],
    provider_name="AWS",
    comment="Test",
    region="US_EAST_1",
    customer_endpoint_dns_name=test["dnsEntry"][0]["dnsName"])

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		atlas_project, err := mongodbatlas.NewProject(ctx, "atlas-project", &mongodbatlas.ProjectArgs{
			OrgId: pulumi.Any(atlasOrgId),
			Name:  pulumi.Any(atlasProjectName),
		})
		if err != nil {
			return err
		}
		test, err := aws.NewVpcEndpoint(ctx, "test", &aws.VpcEndpointArgs{
			VpcId:           "vpc-7fc0a543",
			ServiceName:     "<SERVICE-NAME>",
			VpcEndpointType: "Interface",
			SubnetIds: []string{
				"subnet-de0406d2",
			},
			SecurityGroupIds: []string{
				"sg-3f238186",
			},
		})
		if err != nil {
			return err
		}
		_, err = mongodbatlas.NewPrivatelinkEndpointServiceDataFederationOnlineArchive(ctx, "test", &mongodbatlas.PrivatelinkEndpointServiceDataFederationOnlineArchiveArgs{
			ProjectId:               atlas_project.ID(),
			EndpointId:              test.Id,
			ProviderName:            pulumi.String("AWS"),
			Comment:                 pulumi.String("Test"),
			Region:                  pulumi.String("US_EAST_1"),
			CustomerEndpointDnsName: test.DnsEntry[0].DnsName,
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var atlas_project = new Mongodbatlas.Index.Project("atlas-project", new()
    {
        OrgId = atlasOrgId,
        Name = atlasProjectName,
    });

    var test = new Aws.Index.VpcEndpoint("test", new()
    {
        VpcId = "vpc-7fc0a543",
        ServiceName = "<SERVICE-NAME>",
        VpcEndpointType = "Interface",
        SubnetIds = new[]
        {
            "subnet-de0406d2",
        },
        SecurityGroupIds = new[]
        {
            "sg-3f238186",
        },
    });

    var testPrivatelinkEndpointServiceDataFederationOnlineArchive = new Mongodbatlas.Index.PrivatelinkEndpointServiceDataFederationOnlineArchive("test", new()
    {
        ProjectId = atlas_project.Id,
        EndpointId = test.Id,
        ProviderName = "AWS",
        Comment = "Test",
        Region = "US_EAST_1",
        CustomerEndpointDnsName = test.DnsEntry[0].DnsName,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.mongodbatlas.Project;
import com.pulumi.mongodbatlas.ProjectArgs;
import com.pulumi.aws.VpcEndpoint;
import com.pulumi.aws.VpcEndpointArgs;
import com.pulumi.mongodbatlas.PrivatelinkEndpointServiceDataFederationOnlineArchive;
import com.pulumi.mongodbatlas.PrivatelinkEndpointServiceDataFederationOnlineArchiveArgs;
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 atlas_project = new Project("atlas-project", ProjectArgs.builder()
            .orgId(atlasOrgId)
            .name(atlasProjectName)
            .build());

        var test = new VpcEndpoint("test", VpcEndpointArgs.builder()
            .vpcId("vpc-7fc0a543")
            .serviceName("<SERVICE-NAME>")
            .vpcEndpointType("Interface")
            .subnetIds(List.of("subnet-de0406d2"))
            .securityGroupIds(List.of("sg-3f238186"))
            .build());

        var testPrivatelinkEndpointServiceDataFederationOnlineArchive = new PrivatelinkEndpointServiceDataFederationOnlineArchive("testPrivatelinkEndpointServiceDataFederationOnlineArchive", PrivatelinkEndpointServiceDataFederationOnlineArchiveArgs.builder()
            .projectId(atlas_project.id())
            .endpointId(test.id())
            .providerName("AWS")
            .comment("Test")
            .region("US_EAST_1")
            .customerEndpointDnsName(test.dnsEntry()[0].dnsName())
            .build());

    }
}

    resources:
  atlas-project:
    type: mongodbatlas:Project
    properties:
      orgId: ${atlasOrgId}
      name: ${atlasProjectName}
  test:
    type: aws:VpcEndpoint
    properties:
      vpcId: vpc-7fc0a543
      serviceName: <SERVICE-NAME>
      vpcEndpointType: Interface
      subnetIds:
        - subnet-de0406d2
      securityGroupIds:
        - sg-3f238186
  testPrivatelinkEndpointServiceDataFederationOnlineArchive:
    type: mongodbatlas:PrivatelinkEndpointServiceDataFederationOnlineArchive
    name: test
    properties:
      projectId: ${["atlas-project"].id}
      endpointId: ${test.id}
      providerName: AWS
      comment: Test
      region: US_EAST_1
      customerEndpointDnsName: ${test.dnsEntry[0].dnsName}

    The serviceName value for the region in question can be found in the MongoDB Atlas Administration documentation.

    Further Examples

    • AWS PrivateLink for Data Federation and Online Archive

    Create PrivatelinkEndpointServiceDataFederationOnlineArchive Resource

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

    Constructor syntax

    new PrivatelinkEndpointServiceDataFederationOnlineArchive(name: string, args: PrivatelinkEndpointServiceDataFederationOnlineArchiveArgs, opts?: CustomResourceOptions);
    @overload
def PrivatelinkEndpointServiceDataFederationOnlineArchive(resource_name: str,
                                                          args: PrivatelinkEndpointServiceDataFederationOnlineArchiveArgs,
                                                          opts: Optional[ResourceOptions] = None)

@overload
def PrivatelinkEndpointServiceDataFederationOnlineArchive(resource_name: str,
                                                          opts: Optional[ResourceOptions] = None,
                                                          endpoint_id: Optional[str] = None,
                                                          project_id: Optional[str] = None,
                                                          provider_name: Optional[str] = None,
                                                          comment: Optional[str] = None,
                                                          customer_endpoint_dns_name: Optional[str] = None,
                                                          delete_on_create_timeout: Optional[bool] = None,
                                                          region: Optional[str] = None,
                                                          timeouts: Optional[PrivatelinkEndpointServiceDataFederationOnlineArchiveTimeoutsArgs] = None)
    func NewPrivatelinkEndpointServiceDataFederationOnlineArchive(ctx *Context, name string, args PrivatelinkEndpointServiceDataFederationOnlineArchiveArgs, opts ...ResourceOption) (*PrivatelinkEndpointServiceDataFederationOnlineArchive, error)
    public PrivatelinkEndpointServiceDataFederationOnlineArchive(string name, PrivatelinkEndpointServiceDataFederationOnlineArchiveArgs args, CustomResourceOptions? opts = null)
    public PrivatelinkEndpointServiceDataFederationOnlineArchive(String name, PrivatelinkEndpointServiceDataFederationOnlineArchiveArgs args)
public PrivatelinkEndpointServiceDataFederationOnlineArchive(String name, PrivatelinkEndpointServiceDataFederationOnlineArchiveArgs args, CustomResourceOptions options)

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

    Constructor example

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

    var privatelinkEndpointServiceDataFederationOnlineArchiveResource = new Mongodbatlas.PrivatelinkEndpointServiceDataFederationOnlineArchive("privatelinkEndpointServiceDataFederationOnlineArchiveResource", new()
{
    EndpointId = "string",
    ProjectId = "string",
    ProviderName = "string",
    Comment = "string",
    CustomerEndpointDnsName = "string",
    DeleteOnCreateTimeout = false,
    Region = "string",
    Timeouts = new Mongodbatlas.Inputs.PrivatelinkEndpointServiceDataFederationOnlineArchiveTimeoutsArgs
    {
        Create = "string",
        Delete = "string",
        Update = "string",
    },
});

    example, err := mongodbatlas.NewPrivatelinkEndpointServiceDataFederationOnlineArchive(ctx, "privatelinkEndpointServiceDataFederationOnlineArchiveResource", &mongodbatlas.PrivatelinkEndpointServiceDataFederationOnlineArchiveArgs{
	EndpointId:              pulumi.String("string"),
	ProjectId:               pulumi.String("string"),
	ProviderName:            pulumi.String("string"),
	Comment:                 pulumi.String("string"),
	CustomerEndpointDnsName: pulumi.String("string"),
	DeleteOnCreateTimeout:   pulumi.Bool(false),
	Region:                  pulumi.String("string"),
	Timeouts: &mongodbatlas.PrivatelinkEndpointServiceDataFederationOnlineArchiveTimeoutsArgs{
		Create: pulumi.String("string"),
		Delete: pulumi.String("string"),
		Update: pulumi.String("string"),
	},
})

    var privatelinkEndpointServiceDataFederationOnlineArchiveResource = new PrivatelinkEndpointServiceDataFederationOnlineArchive("privatelinkEndpointServiceDataFederationOnlineArchiveResource", PrivatelinkEndpointServiceDataFederationOnlineArchiveArgs.builder()
    .endpointId("string")
    .projectId("string")
    .providerName("string")
    .comment("string")
    .customerEndpointDnsName("string")
    .deleteOnCreateTimeout(false)
    .region("string")
    .timeouts(PrivatelinkEndpointServiceDataFederationOnlineArchiveTimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .update("string")
        .build())
    .build());

    privatelink_endpoint_service_data_federation_online_archive_resource = mongodbatlas.PrivatelinkEndpointServiceDataFederationOnlineArchive("privatelinkEndpointServiceDataFederationOnlineArchiveResource",
    endpoint_id="string",
    project_id="string",
    provider_name="string",
    comment="string",
    customer_endpoint_dns_name="string",
    delete_on_create_timeout=False,
    region="string",
    timeouts={
        "create": "string",
        "delete": "string",
        "update": "string",
    })

    const privatelinkEndpointServiceDataFederationOnlineArchiveResource = new mongodbatlas.PrivatelinkEndpointServiceDataFederationOnlineArchive("privatelinkEndpointServiceDataFederationOnlineArchiveResource", {
    endpointId: "string",
    projectId: "string",
    providerName: "string",
    comment: "string",
    customerEndpointDnsName: "string",
    deleteOnCreateTimeout: false,
    region: "string",
    timeouts: {
        create: "string",
        "delete": "string",
        update: "string",
    },
});

    type: mongodbatlas:PrivatelinkEndpointServiceDataFederationOnlineArchive
properties:
    comment: string
    customerEndpointDnsName: string
    deleteOnCreateTimeout: false
    endpointId: string
    projectId: string
    providerName: string
    region: string
    timeouts:
        create: string
        delete: string
        update: string

    PrivatelinkEndpointServiceDataFederationOnlineArchive Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The PrivatelinkEndpointServiceDataFederationOnlineArchive resource accepts the following input properties:

    EndpointId string
    Unique 22-character alphanumeric string that identifies the private endpoint. See Atlas Data Federation supports Amazon Web Services private endpoints using the AWS PrivateLink feature.
    ProjectId string
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    ProviderName string
    Human-readable label that identifies the cloud service provider.
    Comment string
    Human-readable string to associate with this private endpoint.
    CustomerEndpointDnsName string
    Human-readable label to identify VPC endpoint DNS name. If defined, you must also specify a value for region.
    DeleteOnCreateTimeout bool
    Indicates whether to delete the resource being created if a timeout is reached when waiting for completion. When set to true and timeout occurs, it triggers the deletion and returns immediately without waiting for deletion to complete. When set to false, the timeout will not trigger resource deletion. If you suspect a transient error when the value is true, wait before retrying to allow resource deletion to finish. Default is true.
    Region string
    Human-readable label to identify the region of VPC endpoint. Requires the Atlas region name, see the reference list for AWS, GCP, Azure. If defined, you must also specify a value for customerEndpointDnsName.
    Timeouts PrivatelinkEndpointServiceDataFederationOnlineArchiveTimeouts
    The duration to wait for the Private Endpoint Service resource for Data Federation and Online Archive to be created or deleted. The timeout value is specified in a signed sequence of decimal numbers followed by a time unit (e.g., 1h45m, 300s, 10m). Valid units are: ns, us (or µs), ms, s, m, h. The default timeout values for the following operations are: create (default: 2h), delete (default: 2h). Learn more about timeouts.
    EndpointId string
    Unique 22-character alphanumeric string that identifies the private endpoint. See Atlas Data Federation supports Amazon Web Services private endpoints using the AWS PrivateLink feature.
    ProjectId string
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    ProviderName string
    Human-readable label that identifies the cloud service provider.
    Comment string
    Human-readable string to associate with this private endpoint.
    CustomerEndpointDnsName string
    Human-readable label to identify VPC endpoint DNS name. If defined, you must also specify a value for region.
    DeleteOnCreateTimeout bool
    Indicates whether to delete the resource being created if a timeout is reached when waiting for completion. When set to true and timeout occurs, it triggers the deletion and returns immediately without waiting for deletion to complete. When set to false, the timeout will not trigger resource deletion. If you suspect a transient error when the value is true, wait before retrying to allow resource deletion to finish. Default is true.
    Region string
    Human-readable label to identify the region of VPC endpoint. Requires the Atlas region name, see the reference list for AWS, GCP, Azure. If defined, you must also specify a value for customerEndpointDnsName.
    Timeouts PrivatelinkEndpointServiceDataFederationOnlineArchiveTimeoutsArgs
    The duration to wait for the Private Endpoint Service resource for Data Federation and Online Archive to be created or deleted. The timeout value is specified in a signed sequence of decimal numbers followed by a time unit (e.g., 1h45m, 300s, 10m). Valid units are: ns, us (or µs), ms, s, m, h. The default timeout values for the following operations are: create (default: 2h), delete (default: 2h). Learn more about timeouts.
    endpointId String
    Unique 22-character alphanumeric string that identifies the private endpoint. See Atlas Data Federation supports Amazon Web Services private endpoints using the AWS PrivateLink feature.
    projectId String
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    providerName String
    Human-readable label that identifies the cloud service provider.
    comment String
    Human-readable string to associate with this private endpoint.
    customerEndpointDnsName String
    Human-readable label to identify VPC endpoint DNS name. If defined, you must also specify a value for region.
    deleteOnCreateTimeout Boolean
    Indicates whether to delete the resource being created if a timeout is reached when waiting for completion. When set to true and timeout occurs, it triggers the deletion and returns immediately without waiting for deletion to complete. When set to false, the timeout will not trigger resource deletion. If you suspect a transient error when the value is true, wait before retrying to allow resource deletion to finish. Default is true.
    region String
    Human-readable label to identify the region of VPC endpoint. Requires the Atlas region name, see the reference list for AWS, GCP, Azure. If defined, you must also specify a value for customerEndpointDnsName.
    timeouts PrivatelinkEndpointServiceDataFederationOnlineArchiveTimeouts
    The duration to wait for the Private Endpoint Service resource for Data Federation and Online Archive to be created or deleted. The timeout value is specified in a signed sequence of decimal numbers followed by a time unit (e.g., 1h45m, 300s, 10m). Valid units are: ns, us (or µs), ms, s, m, h. The default timeout values for the following operations are: create (default: 2h), delete (default: 2h). Learn more about timeouts.
    endpointId string
    Unique 22-character alphanumeric string that identifies the private endpoint. See Atlas Data Federation supports Amazon Web Services private endpoints using the AWS PrivateLink feature.
    projectId string
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    providerName string
    Human-readable label that identifies the cloud service provider.
    comment string
    Human-readable string to associate with this private endpoint.
    customerEndpointDnsName string
    Human-readable label to identify VPC endpoint DNS name. If defined, you must also specify a value for region.
    deleteOnCreateTimeout boolean
    Indicates whether to delete the resource being created if a timeout is reached when waiting for completion. When set to true and timeout occurs, it triggers the deletion and returns immediately without waiting for deletion to complete. When set to false, the timeout will not trigger resource deletion. If you suspect a transient error when the value is true, wait before retrying to allow resource deletion to finish. Default is true.
    region string
    Human-readable label to identify the region of VPC endpoint. Requires the Atlas region name, see the reference list for AWS, GCP, Azure. If defined, you must also specify a value for customerEndpointDnsName.
    timeouts PrivatelinkEndpointServiceDataFederationOnlineArchiveTimeouts
    The duration to wait for the Private Endpoint Service resource for Data Federation and Online Archive to be created or deleted. The timeout value is specified in a signed sequence of decimal numbers followed by a time unit (e.g., 1h45m, 300s, 10m). Valid units are: ns, us (or µs), ms, s, m, h. The default timeout values for the following operations are: create (default: 2h), delete (default: 2h). Learn more about timeouts.
    endpoint_id str
    Unique 22-character alphanumeric string that identifies the private endpoint. See Atlas Data Federation supports Amazon Web Services private endpoints using the AWS PrivateLink feature.
    project_id str
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    provider_name str
    Human-readable label that identifies the cloud service provider.
    comment str
    Human-readable string to associate with this private endpoint.
    customer_endpoint_dns_name str
    Human-readable label to identify VPC endpoint DNS name. If defined, you must also specify a value for region.
    delete_on_create_timeout bool
    Indicates whether to delete the resource being created if a timeout is reached when waiting for completion. When set to true and timeout occurs, it triggers the deletion and returns immediately without waiting for deletion to complete. When set to false, the timeout will not trigger resource deletion. If you suspect a transient error when the value is true, wait before retrying to allow resource deletion to finish. Default is true.
    region str
    Human-readable label to identify the region of VPC endpoint. Requires the Atlas region name, see the reference list for AWS, GCP, Azure. If defined, you must also specify a value for customerEndpointDnsName.
    timeouts PrivatelinkEndpointServiceDataFederationOnlineArchiveTimeoutsArgs
    The duration to wait for the Private Endpoint Service resource for Data Federation and Online Archive to be created or deleted. The timeout value is specified in a signed sequence of decimal numbers followed by a time unit (e.g., 1h45m, 300s, 10m). Valid units are: ns, us (or µs), ms, s, m, h. The default timeout values for the following operations are: create (default: 2h), delete (default: 2h). Learn more about timeouts.
    endpointId String
    Unique 22-character alphanumeric string that identifies the private endpoint. See Atlas Data Federation supports Amazon Web Services private endpoints using the AWS PrivateLink feature.
    projectId String
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    providerName String
    Human-readable label that identifies the cloud service provider.
    comment String
    Human-readable string to associate with this private endpoint.
    customerEndpointDnsName String
    Human-readable label to identify VPC endpoint DNS name. If defined, you must also specify a value for region.
    deleteOnCreateTimeout Boolean
    Indicates whether to delete the resource being created if a timeout is reached when waiting for completion. When set to true and timeout occurs, it triggers the deletion and returns immediately without waiting for deletion to complete. When set to false, the timeout will not trigger resource deletion. If you suspect a transient error when the value is true, wait before retrying to allow resource deletion to finish. Default is true.
    region String
    Human-readable label to identify the region of VPC endpoint. Requires the Atlas region name, see the reference list for AWS, GCP, Azure. If defined, you must also specify a value for customerEndpointDnsName.
    timeouts Property Map
    The duration to wait for the Private Endpoint Service resource for Data Federation and Online Archive to be created or deleted. The timeout value is specified in a signed sequence of decimal numbers followed by a time unit (e.g., 1h45m, 300s, 10m). Valid units are: ns, us (or µs), ms, s, m, h. The default timeout values for the following operations are: create (default: 2h), delete (default: 2h). Learn more about timeouts.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Type string
    Human-readable label that identifies the resource type associated with this private endpoint.
    Id string
    The provider-assigned unique ID for this managed resource.
    Type string
    Human-readable label that identifies the resource type associated with this private endpoint.
    id String
    The provider-assigned unique ID for this managed resource.
    type String
    Human-readable label that identifies the resource type associated with this private endpoint.
    id string
    The provider-assigned unique ID for this managed resource.
    type string
    Human-readable label that identifies the resource type associated with this private endpoint.
    id str
    The provider-assigned unique ID for this managed resource.
    type str
    Human-readable label that identifies the resource type associated with this private endpoint.
    id String
    The provider-assigned unique ID for this managed resource.
    type String
    Human-readable label that identifies the resource type associated with this private endpoint.

    Look up Existing PrivatelinkEndpointServiceDataFederationOnlineArchive Resource

    Get an existing PrivatelinkEndpointServiceDataFederationOnlineArchive 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?: PrivatelinkEndpointServiceDataFederationOnlineArchiveState, opts?: CustomResourceOptions): PrivatelinkEndpointServiceDataFederationOnlineArchive
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        comment: Optional[str] = None,
        customer_endpoint_dns_name: Optional[str] = None,
        delete_on_create_timeout: Optional[bool] = None,
        endpoint_id: Optional[str] = None,
        project_id: Optional[str] = None,
        provider_name: Optional[str] = None,
        region: Optional[str] = None,
        timeouts: Optional[PrivatelinkEndpointServiceDataFederationOnlineArchiveTimeoutsArgs] = None,
        type: Optional[str] = None) -> PrivatelinkEndpointServiceDataFederationOnlineArchive
    func GetPrivatelinkEndpointServiceDataFederationOnlineArchive(ctx *Context, name string, id IDInput, state *PrivatelinkEndpointServiceDataFederationOnlineArchiveState, opts ...ResourceOption) (*PrivatelinkEndpointServiceDataFederationOnlineArchive, error)
    public static PrivatelinkEndpointServiceDataFederationOnlineArchive Get(string name, Input<string> id, PrivatelinkEndpointServiceDataFederationOnlineArchiveState? state, CustomResourceOptions? opts = null)
    public static PrivatelinkEndpointServiceDataFederationOnlineArchive get(String name, Output<String> id, PrivatelinkEndpointServiceDataFederationOnlineArchiveState state, CustomResourceOptions options)
    resources:  _:    type: mongodbatlas:PrivatelinkEndpointServiceDataFederationOnlineArchive    get:      id: ${id}
    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.
    CustomerEndpointDnsName string
    Human-readable label to identify VPC endpoint DNS name. If defined, you must also specify a value for region.
    DeleteOnCreateTimeout bool
    Indicates whether to delete the resource being created if a timeout is reached when waiting for completion. When set to true and timeout occurs, it triggers the deletion and returns immediately without waiting for deletion to complete. When set to false, the timeout will not trigger resource deletion. If you suspect a transient error when the value is true, wait before retrying to allow resource deletion to finish. Default is true.
    EndpointId string
    Unique 22-character alphanumeric string that identifies the private endpoint. See Atlas Data Federation supports Amazon Web Services private endpoints using the AWS PrivateLink feature.
    ProjectId string
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    ProviderName string
    Human-readable label that identifies the cloud service provider.
    Region string
    Human-readable label to identify the region of VPC endpoint. Requires the Atlas region name, see the reference list for AWS, GCP, Azure. If defined, you must also specify a value for customerEndpointDnsName.
    Timeouts PrivatelinkEndpointServiceDataFederationOnlineArchiveTimeouts
    The duration to wait for the Private Endpoint Service resource for Data Federation and Online Archive to be created or deleted. The timeout value is specified in a signed sequence of decimal numbers followed by a time unit (e.g., 1h45m, 300s, 10m). Valid units are: ns, us (or µs), ms, s, m, h. The default timeout values for the following operations are: create (default: 2h), delete (default: 2h). Learn more about timeouts.
    Type string
    Human-readable label that identifies the resource type associated with this private endpoint.
    Comment string
    Human-readable string to associate with this private endpoint.
    CustomerEndpointDnsName string
    Human-readable label to identify VPC endpoint DNS name. If defined, you must also specify a value for region.
    DeleteOnCreateTimeout bool
    Indicates whether to delete the resource being created if a timeout is reached when waiting for completion. When set to true and timeout occurs, it triggers the deletion and returns immediately without waiting for deletion to complete. When set to false, the timeout will not trigger resource deletion. If you suspect a transient error when the value is true, wait before retrying to allow resource deletion to finish. Default is true.
    EndpointId string
    Unique 22-character alphanumeric string that identifies the private endpoint. See Atlas Data Federation supports Amazon Web Services private endpoints using the AWS PrivateLink feature.
    ProjectId string
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    ProviderName string
    Human-readable label that identifies the cloud service provider.
    Region string
    Human-readable label to identify the region of VPC endpoint. Requires the Atlas region name, see the reference list for AWS, GCP, Azure. If defined, you must also specify a value for customerEndpointDnsName.
    Timeouts PrivatelinkEndpointServiceDataFederationOnlineArchiveTimeoutsArgs
    The duration to wait for the Private Endpoint Service resource for Data Federation and Online Archive to be created or deleted. The timeout value is specified in a signed sequence of decimal numbers followed by a time unit (e.g., 1h45m, 300s, 10m). Valid units are: ns, us (or µs), ms, s, m, h. The default timeout values for the following operations are: create (default: 2h), delete (default: 2h). Learn more about timeouts.
    Type string
    Human-readable label that identifies the resource type associated with this private endpoint.
    comment String
    Human-readable string to associate with this private endpoint.
    customerEndpointDnsName String
    Human-readable label to identify VPC endpoint DNS name. If defined, you must also specify a value for region.
    deleteOnCreateTimeout Boolean
    Indicates whether to delete the resource being created if a timeout is reached when waiting for completion. When set to true and timeout occurs, it triggers the deletion and returns immediately without waiting for deletion to complete. When set to false, the timeout will not trigger resource deletion. If you suspect a transient error when the value is true, wait before retrying to allow resource deletion to finish. Default is true.
    endpointId String
    Unique 22-character alphanumeric string that identifies the private endpoint. See Atlas Data Federation supports Amazon Web Services private endpoints using the AWS PrivateLink feature.
    projectId String
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    providerName String
    Human-readable label that identifies the cloud service provider.
    region String
    Human-readable label to identify the region of VPC endpoint. Requires the Atlas region name, see the reference list for AWS, GCP, Azure. If defined, you must also specify a value for customerEndpointDnsName.
    timeouts PrivatelinkEndpointServiceDataFederationOnlineArchiveTimeouts
    The duration to wait for the Private Endpoint Service resource for Data Federation and Online Archive to be created or deleted. The timeout value is specified in a signed sequence of decimal numbers followed by a time unit (e.g., 1h45m, 300s, 10m). Valid units are: ns, us (or µs), ms, s, m, h. The default timeout values for the following operations are: create (default: 2h), delete (default: 2h). Learn more about timeouts.
    type String
    Human-readable label that identifies the resource type associated with this private endpoint.
    comment string
    Human-readable string to associate with this private endpoint.
    customerEndpointDnsName string
    Human-readable label to identify VPC endpoint DNS name. If defined, you must also specify a value for region.
    deleteOnCreateTimeout boolean
    Indicates whether to delete the resource being created if a timeout is reached when waiting for completion. When set to true and timeout occurs, it triggers the deletion and returns immediately without waiting for deletion to complete. When set to false, the timeout will not trigger resource deletion. If you suspect a transient error when the value is true, wait before retrying to allow resource deletion to finish. Default is true.
    endpointId string
    Unique 22-character alphanumeric string that identifies the private endpoint. See Atlas Data Federation supports Amazon Web Services private endpoints using the AWS PrivateLink feature.
    projectId string
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    providerName string
    Human-readable label that identifies the cloud service provider.
    region string
    Human-readable label to identify the region of VPC endpoint. Requires the Atlas region name, see the reference list for AWS, GCP, Azure. If defined, you must also specify a value for customerEndpointDnsName.
    timeouts PrivatelinkEndpointServiceDataFederationOnlineArchiveTimeouts
    The duration to wait for the Private Endpoint Service resource for Data Federation and Online Archive to be created or deleted. The timeout value is specified in a signed sequence of decimal numbers followed by a time unit (e.g., 1h45m, 300s, 10m). Valid units are: ns, us (or µs), ms, s, m, h. The default timeout values for the following operations are: create (default: 2h), delete (default: 2h). Learn more about timeouts.
    type string
    Human-readable label that identifies the resource type associated with this private endpoint.
    comment str
    Human-readable string to associate with this private endpoint.
    customer_endpoint_dns_name str
    Human-readable label to identify VPC endpoint DNS name. If defined, you must also specify a value for region.
    delete_on_create_timeout bool
    Indicates whether to delete the resource being created if a timeout is reached when waiting for completion. When set to true and timeout occurs, it triggers the deletion and returns immediately without waiting for deletion to complete. When set to false, the timeout will not trigger resource deletion. If you suspect a transient error when the value is true, wait before retrying to allow resource deletion to finish. Default is true.
    endpoint_id str
    Unique 22-character alphanumeric string that identifies the private endpoint. See Atlas Data Federation supports Amazon Web Services private endpoints using the AWS PrivateLink feature.
    project_id str
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    provider_name str
    Human-readable label that identifies the cloud service provider.
    region str
    Human-readable label to identify the region of VPC endpoint. Requires the Atlas region name, see the reference list for AWS, GCP, Azure. If defined, you must also specify a value for customerEndpointDnsName.
    timeouts PrivatelinkEndpointServiceDataFederationOnlineArchiveTimeoutsArgs
    The duration to wait for the Private Endpoint Service resource for Data Federation and Online Archive to be created or deleted. The timeout value is specified in a signed sequence of decimal numbers followed by a time unit (e.g., 1h45m, 300s, 10m). Valid units are: ns, us (or µs), ms, s, m, h. The default timeout values for the following operations are: create (default: 2h), delete (default: 2h). Learn more about timeouts.
    type str
    Human-readable label that identifies the resource type associated with this private endpoint.
    comment String
    Human-readable string to associate with this private endpoint.
    customerEndpointDnsName String
    Human-readable label to identify VPC endpoint DNS name. If defined, you must also specify a value for region.
    deleteOnCreateTimeout Boolean
    Indicates whether to delete the resource being created if a timeout is reached when waiting for completion. When set to true and timeout occurs, it triggers the deletion and returns immediately without waiting for deletion to complete. When set to false, the timeout will not trigger resource deletion. If you suspect a transient error when the value is true, wait before retrying to allow resource deletion to finish. Default is true.
    endpointId String
    Unique 22-character alphanumeric string that identifies the private endpoint. See Atlas Data Federation supports Amazon Web Services private endpoints using the AWS PrivateLink feature.
    projectId String
    Unique 24-hexadecimal digit string that identifies your project, also known as groupId in the official documentation.
    providerName String
    Human-readable label that identifies the cloud service provider.
    region String
    Human-readable label to identify the region of VPC endpoint. Requires the Atlas region name, see the reference list for AWS, GCP, Azure. If defined, you must also specify a value for customerEndpointDnsName.
    timeouts Property Map
    The duration to wait for the Private Endpoint Service resource for Data Federation and Online Archive to be created or deleted. The timeout value is specified in a signed sequence of decimal numbers followed by a time unit (e.g., 1h45m, 300s, 10m). Valid units are: ns, us (or µs), ms, s, m, h. The default timeout values for the following operations are: create (default: 2h), delete (default: 2h). Learn more about timeouts.
    type String
    Human-readable label that identifies the resource type associated with this private endpoint.

    Supporting Types

    PrivatelinkEndpointServiceDataFederationOnlineArchiveTimeouts, PrivatelinkEndpointServiceDataFederationOnlineArchiveTimeoutsArgs

    Create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    Update string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    Update string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    update String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    update string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    update str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    update String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).

    Import

    Import the Private Endpoint Service resource for Data Federation and Online Archive using the project ID and endpoint ID in either of the following formats:

    • project_id--endpoint_id
    • project_id/endpoint_id
    $ pulumi import mongodbatlas:index/privatelinkEndpointServiceDataFederationOnlineArchive:PrivatelinkEndpointServiceDataFederationOnlineArchive example 1112222b3bf99403840e8934--vpce-3bf78b0ddee411ba1

$ pulumi import mongodbatlas:index/privatelinkEndpointServiceDataFederationOnlineArchive:PrivatelinkEndpointServiceDataFederationOnlineArchive example 1112222b3bf99403840e8934/vpce-3bf78b0ddee411ba1

    See MongoDB Atlas API Documentation for more information.

    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
    Viewing docs for MongoDB Atlas v4.8.0
    published on Thursday, Apr 23, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-mongodbatlas
      Try Pulumi Cloud free. Your team will thank you.