Docs Packages
  1. Pulumi Registry
  2. MongoDB Atlas
  3. API Docs
  4. OnlineArchive
mongodbatlas logo
MongoDB Atlas v3.7.2, Mar 31 23

mongodbatlas.OnlineArchive

Explore with Pulumi AI

mongodbatlas.OnlineArchive resource provides access to create, edit, pause and resume an online archive for a collection.

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

IMPORTANT: The collection must exists before performing an online archive.

IMPORTANT: There are fields that are immutable after creation, i.e if date_field value does not exist in the collection, the online archive state will be pending forever, and this field cannot be updated, that means a destroy is required, known error ONLINE_ARCHIVE_CANNOT_MODIFY_FIELD

Example Usage

S

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

return await Deployment.RunAsync(() => 
{
    var test = new Mongodbatlas.OnlineArchive("test", new()
    {
        ProjectId = @var.Project_id,
        ClusterName = @var.Cluster_name,
        CollName = @var.Collection_name,
        DbName = @var.Database_name,
        PartitionFields = new[]
        {
            new Mongodbatlas.Inputs.OnlineArchivePartitionFieldArgs
            {
                FieldName = "firstName",
                Order = 0,
            },
            new Mongodbatlas.Inputs.OnlineArchivePartitionFieldArgs
            {
                FieldName = "lastName",
                Order = 1,
            },
        },
        Criteria = new Mongodbatlas.Inputs.OnlineArchiveCriteriaArgs
        {
            Type = "DATE",
            DateField = "created",
            ExpireAfterDays = 5,
        },
    });

});

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.NewOnlineArchive(ctx, "test", &mongodbatlas.OnlineArchiveArgs{
			ProjectId:   pulumi.Any(_var.Project_id),
			ClusterName: pulumi.Any(_var.Cluster_name),
			CollName:    pulumi.Any(_var.Collection_name),
			DbName:      pulumi.Any(_var.Database_name),
			PartitionFields: mongodbatlas.OnlineArchivePartitionFieldArray{
				&mongodbatlas.OnlineArchivePartitionFieldArgs{
					FieldName: pulumi.String("firstName"),
					Order:     pulumi.Int(0),
				},
				&mongodbatlas.OnlineArchivePartitionFieldArgs{
					FieldName: pulumi.String("lastName"),
					Order:     pulumi.Int(1),
				},
			},
			Criteria: &mongodbatlas.OnlineArchiveCriteriaArgs{
				Type:            pulumi.String("DATE"),
				DateField:       pulumi.String("created"),
				ExpireAfterDays: pulumi.Int(5),
			},
		})
		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.OnlineArchive;
import com.pulumi.mongodbatlas.OnlineArchiveArgs;
import com.pulumi.mongodbatlas.inputs.OnlineArchivePartitionFieldArgs;
import com.pulumi.mongodbatlas.inputs.OnlineArchiveCriteriaArgs;
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 test = new OnlineArchive("test", OnlineArchiveArgs.builder()        
            .projectId(var_.project_id())
            .clusterName(var_.cluster_name())
            .collName(var_.collection_name())
            .dbName(var_.database_name())
            .partitionFields(            
                OnlineArchivePartitionFieldArgs.builder()
                    .fieldName("firstName")
                    .order(0)
                    .build(),
                OnlineArchivePartitionFieldArgs.builder()
                    .fieldName("lastName")
                    .order(1)
                    .build())
            .criteria(OnlineArchiveCriteriaArgs.builder()
                .type("DATE")
                .dateField("created")
                .expireAfterDays(5)
                .build())
            .build());

    }
}

import pulumi
import pulumi_mongodbatlas as mongodbatlas

test = mongodbatlas.OnlineArchive("test",
    project_id=var["project_id"],
    cluster_name=var["cluster_name"],
    coll_name=var["collection_name"],
    db_name=var["database_name"],
    partition_fields=[
        mongodbatlas.OnlineArchivePartitionFieldArgs(
            field_name="firstName",
            order=0,
        ),
        mongodbatlas.OnlineArchivePartitionFieldArgs(
            field_name="lastName",
            order=1,
        ),
    ],
    criteria=mongodbatlas.OnlineArchiveCriteriaArgs(
        type="DATE",
        date_field="created",
        expire_after_days=5,
    ))

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

const test = new mongodbatlas.OnlineArchive("test", {
    projectId: _var.project_id,
    clusterName: _var.cluster_name,
    collName: _var.collection_name,
    dbName: _var.database_name,
    partitionFields: [
        {
            fieldName: "firstName",
            order: 0,
        },
        {
            fieldName: "lastName",
            order: 1,
        },
    ],
    criteria: {
        type: "DATE",
        dateField: "created",
        expireAfterDays: 5,
    },
});

resources:
  test:
    type: mongodbatlas:OnlineArchive
    properties:
      projectId: ${var.project_id}
      clusterName: ${var.cluster_name}
      collName: ${var.collection_name}
      dbName: ${var.database_name}
      partitionFields:
        - fieldName: firstName
          order: 0
        - fieldName: lastName
          order: 1
      criteria:
        type: DATE
        dateField: created
        expireAfterDays: 5

For custom criteria example

Coming soon!

Coming soon!

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.mongodbatlas.OnlineArchive;
import com.pulumi.mongodbatlas.OnlineArchiveArgs;
import com.pulumi.mongodbatlas.inputs.OnlineArchivePartitionFieldArgs;
import com.pulumi.mongodbatlas.inputs.OnlineArchiveCriteriaArgs;
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 test = new OnlineArchive("test", OnlineArchiveArgs.builder()        
            .projectId(var_.project_id())
            .clusterName(var_.cluster_name())
            .collName(var_.collection_name())
            .dbName(var_.database_name())
            .partitionFields(OnlineArchivePartitionFieldArgs.builder()
                .fieldName("firstName")
                .order(0)
                .build())
            .partitionsFields(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
            .criteria(OnlineArchiveCriteriaArgs.builder()
                .type("CUSTOM")
                .query("{ \"department\": \"engineering\" }")
                .build())
            .build());

    }
}

Coming soon!

Coming soon!

resources:
  test:
    type: mongodbatlas:OnlineArchive
    properties:
      projectId: ${var.project_id}
      clusterName: ${var.cluster_name}
      collName: ${var.collection_name}
      dbName: ${var.database_name}
      partitionFields:
        - fieldName: firstName
          order: 0
      partitionsFields:
        - fieldName: secondName
          order: 1
      criteria:
        type: CUSTOM
        query: '{ "department": "engineering" }'

Create OnlineArchive Resource

new OnlineArchive(name: string, args: OnlineArchiveArgs, opts?: CustomResourceOptions);
@overload
def OnlineArchive(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  cluster_name: Optional[str] = None,
                  coll_name: Optional[str] = None,
                  collection_type: Optional[str] = None,
                  criteria: Optional[OnlineArchiveCriteriaArgs] = None,
                  db_name: Optional[str] = None,
                  partition_fields: Optional[Sequence[OnlineArchivePartitionFieldArgs]] = None,
                  paused: Optional[bool] = None,
                  project_id: Optional[str] = None,
                  sync_creation: Optional[bool] = None)
@overload
def OnlineArchive(resource_name: str,
                  args: OnlineArchiveArgs,
                  opts: Optional[ResourceOptions] = None)
func NewOnlineArchive(ctx *Context, name string, args OnlineArchiveArgs, opts ...ResourceOption) (*OnlineArchive, error)
public OnlineArchive(string name, OnlineArchiveArgs args, CustomResourceOptions? opts = null)
public OnlineArchive(String name, OnlineArchiveArgs args)
public OnlineArchive(String name, OnlineArchiveArgs args, CustomResourceOptions options)

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

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

ClusterName string

Name of the cluster that contains the collection.

CollName string

Name of the collection.

Criteria OnlineArchiveCriteriaArgs

Criteria to use for archiving data.

DbName string

Name of the database that contains the collection.

ProjectId string

The unique ID for the project

CollectionType string

Classification of MongoDB database collection that you want to return, "TIMESERIES" or "STANDARD". Default is "STANDARD".

PartitionFields List<OnlineArchivePartitionFieldArgs>

Fields to use to partition data. You can specify up to two frequently queried fields to use for partitioning data. Note that queries that don’t contain the specified fields will require a full collection scan of all archived documents, which will take longer and increase your costs. To learn more about how partition improves query performance, see Data Structure in S3. The value of a partition field can be up to a maximum of 700 characters. Documents with values exceeding 700 characters are not archived.

Paused bool

State of the online archive. This is required for pausing an active or resume a paused online archive. The resume request will fail if the collection has another active online archive.

SyncCreation bool
ClusterName string

Name of the cluster that contains the collection.

CollName string

Name of the collection.

Criteria OnlineArchiveCriteriaArgs

Criteria to use for archiving data.

DbName string

Name of the database that contains the collection.

ProjectId string

The unique ID for the project

CollectionType string

Classification of MongoDB database collection that you want to return, "TIMESERIES" or "STANDARD". Default is "STANDARD".

PartitionFields []OnlineArchivePartitionFieldArgs

Fields to use to partition data. You can specify up to two frequently queried fields to use for partitioning data. Note that queries that don’t contain the specified fields will require a full collection scan of all archived documents, which will take longer and increase your costs. To learn more about how partition improves query performance, see Data Structure in S3. The value of a partition field can be up to a maximum of 700 characters. Documents with values exceeding 700 characters are not archived.

Paused bool

State of the online archive. This is required for pausing an active or resume a paused online archive. The resume request will fail if the collection has another active online archive.

SyncCreation bool
clusterName String

Name of the cluster that contains the collection.

collName String

Name of the collection.

criteria OnlineArchiveCriteriaArgs

Criteria to use for archiving data.

dbName String

Name of the database that contains the collection.

projectId String

The unique ID for the project

collectionType String

Classification of MongoDB database collection that you want to return, "TIMESERIES" or "STANDARD". Default is "STANDARD".

partitionFields List<OnlineArchivePartitionFieldArgs>

Fields to use to partition data. You can specify up to two frequently queried fields to use for partitioning data. Note that queries that don’t contain the specified fields will require a full collection scan of all archived documents, which will take longer and increase your costs. To learn more about how partition improves query performance, see Data Structure in S3. The value of a partition field can be up to a maximum of 700 characters. Documents with values exceeding 700 characters are not archived.

paused Boolean

State of the online archive. This is required for pausing an active or resume a paused online archive. The resume request will fail if the collection has another active online archive.

syncCreation Boolean
clusterName string

Name of the cluster that contains the collection.

collName string

Name of the collection.

criteria OnlineArchiveCriteriaArgs

Criteria to use for archiving data.

dbName string

Name of the database that contains the collection.

projectId string

The unique ID for the project

collectionType string

Classification of MongoDB database collection that you want to return, "TIMESERIES" or "STANDARD". Default is "STANDARD".

partitionFields OnlineArchivePartitionFieldArgs[]

Fields to use to partition data. You can specify up to two frequently queried fields to use for partitioning data. Note that queries that don’t contain the specified fields will require a full collection scan of all archived documents, which will take longer and increase your costs. To learn more about how partition improves query performance, see Data Structure in S3. The value of a partition field can be up to a maximum of 700 characters. Documents with values exceeding 700 characters are not archived.

paused boolean

State of the online archive. This is required for pausing an active or resume a paused online archive. The resume request will fail if the collection has another active online archive.

syncCreation boolean
cluster_name str

Name of the cluster that contains the collection.

coll_name str

Name of the collection.

criteria OnlineArchiveCriteriaArgs

Criteria to use for archiving data.

db_name str

Name of the database that contains the collection.

project_id str

The unique ID for the project

collection_type str

Classification of MongoDB database collection that you want to return, "TIMESERIES" or "STANDARD". Default is "STANDARD".

partition_fields Sequence[OnlineArchivePartitionFieldArgs]

Fields to use to partition data. You can specify up to two frequently queried fields to use for partitioning data. Note that queries that don’t contain the specified fields will require a full collection scan of all archived documents, which will take longer and increase your costs. To learn more about how partition improves query performance, see Data Structure in S3. The value of a partition field can be up to a maximum of 700 characters. Documents with values exceeding 700 characters are not archived.

paused bool

State of the online archive. This is required for pausing an active or resume a paused online archive. The resume request will fail if the collection has another active online archive.

sync_creation bool
clusterName String

Name of the cluster that contains the collection.

collName String

Name of the collection.

criteria Property Map

Criteria to use for archiving data.

dbName String

Name of the database that contains the collection.

projectId String

The unique ID for the project

collectionType String

Classification of MongoDB database collection that you want to return, "TIMESERIES" or "STANDARD". Default is "STANDARD".

partitionFields List<Property Map>

Fields to use to partition data. You can specify up to two frequently queried fields to use for partitioning data. Note that queries that don’t contain the specified fields will require a full collection scan of all archived documents, which will take longer and increase your costs. To learn more about how partition improves query performance, see Data Structure in S3. The value of a partition field can be up to a maximum of 700 characters. Documents with values exceeding 700 characters are not archived.

paused Boolean

State of the online archive. This is required for pausing an active or resume a paused online archive. The resume request will fail if the collection has another active online archive.

syncCreation Boolean

Outputs

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

ArchiveId string

ID of the online archive.

Id string

The provider-assigned unique ID for this managed resource.

State string

Status of the online archive. Valid values are: Pending, Archiving, Idle, Pausing, Paused, Orphaned and Deleted

ArchiveId string

ID of the online archive.

Id string

The provider-assigned unique ID for this managed resource.

State string

Status of the online archive. Valid values are: Pending, Archiving, Idle, Pausing, Paused, Orphaned and Deleted

archiveId String

ID of the online archive.

id String

The provider-assigned unique ID for this managed resource.

state String

Status of the online archive. Valid values are: Pending, Archiving, Idle, Pausing, Paused, Orphaned and Deleted

archiveId string

ID of the online archive.

id string

The provider-assigned unique ID for this managed resource.

state string

Status of the online archive. Valid values are: Pending, Archiving, Idle, Pausing, Paused, Orphaned and Deleted

archive_id str

ID of the online archive.

id str

The provider-assigned unique ID for this managed resource.

state str

Status of the online archive. Valid values are: Pending, Archiving, Idle, Pausing, Paused, Orphaned and Deleted

archiveId String

ID of the online archive.

id String

The provider-assigned unique ID for this managed resource.

state String

Status of the online archive. Valid values are: Pending, Archiving, Idle, Pausing, Paused, Orphaned and Deleted

Look up Existing OnlineArchive Resource

Get an existing OnlineArchive 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?: OnlineArchiveState, opts?: CustomResourceOptions): OnlineArchive
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        archive_id: Optional[str] = None,
        cluster_name: Optional[str] = None,
        coll_name: Optional[str] = None,
        collection_type: Optional[str] = None,
        criteria: Optional[OnlineArchiveCriteriaArgs] = None,
        db_name: Optional[str] = None,
        partition_fields: Optional[Sequence[OnlineArchivePartitionFieldArgs]] = None,
        paused: Optional[bool] = None,
        project_id: Optional[str] = None,
        state: Optional[str] = None,
        sync_creation: Optional[bool] = None) -> OnlineArchive
func GetOnlineArchive(ctx *Context, name string, id IDInput, state *OnlineArchiveState, opts ...ResourceOption) (*OnlineArchive, error)
public static OnlineArchive Get(string name, Input<string> id, OnlineArchiveState? state, CustomResourceOptions? opts = null)
public static OnlineArchive get(String name, Output<String> id, OnlineArchiveState 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:
ArchiveId string

ID of the online archive.

ClusterName string

Name of the cluster that contains the collection.

CollName string

Name of the collection.

CollectionType string

Classification of MongoDB database collection that you want to return, "TIMESERIES" or "STANDARD". Default is "STANDARD".

Criteria OnlineArchiveCriteriaArgs

Criteria to use for archiving data.

DbName string

Name of the database that contains the collection.

PartitionFields List<OnlineArchivePartitionFieldArgs>

Fields to use to partition data. You can specify up to two frequently queried fields to use for partitioning data. Note that queries that don’t contain the specified fields will require a full collection scan of all archived documents, which will take longer and increase your costs. To learn more about how partition improves query performance, see Data Structure in S3. The value of a partition field can be up to a maximum of 700 characters. Documents with values exceeding 700 characters are not archived.

Paused bool

State of the online archive. This is required for pausing an active or resume a paused online archive. The resume request will fail if the collection has another active online archive.

ProjectId string

The unique ID for the project

State string

Status of the online archive. Valid values are: Pending, Archiving, Idle, Pausing, Paused, Orphaned and Deleted

SyncCreation bool
ArchiveId string

ID of the online archive.

ClusterName string

Name of the cluster that contains the collection.

CollName string

Name of the collection.

CollectionType string

Classification of MongoDB database collection that you want to return, "TIMESERIES" or "STANDARD". Default is "STANDARD".

Criteria OnlineArchiveCriteriaArgs

Criteria to use for archiving data.

DbName string

Name of the database that contains the collection.

PartitionFields []OnlineArchivePartitionFieldArgs

Fields to use to partition data. You can specify up to two frequently queried fields to use for partitioning data. Note that queries that don’t contain the specified fields will require a full collection scan of all archived documents, which will take longer and increase your costs. To learn more about how partition improves query performance, see Data Structure in S3. The value of a partition field can be up to a maximum of 700 characters. Documents with values exceeding 700 characters are not archived.

Paused bool

State of the online archive. This is required for pausing an active or resume a paused online archive. The resume request will fail if the collection has another active online archive.

ProjectId string

The unique ID for the project

State string

Status of the online archive. Valid values are: Pending, Archiving, Idle, Pausing, Paused, Orphaned and Deleted

SyncCreation bool
archiveId String

ID of the online archive.

clusterName String

Name of the cluster that contains the collection.

collName String

Name of the collection.

collectionType String

Classification of MongoDB database collection that you want to return, "TIMESERIES" or "STANDARD". Default is "STANDARD".

criteria OnlineArchiveCriteriaArgs

Criteria to use for archiving data.

dbName String

Name of the database that contains the collection.

partitionFields List<OnlineArchivePartitionFieldArgs>

Fields to use to partition data. You can specify up to two frequently queried fields to use for partitioning data. Note that queries that don’t contain the specified fields will require a full collection scan of all archived documents, which will take longer and increase your costs. To learn more about how partition improves query performance, see Data Structure in S3. The value of a partition field can be up to a maximum of 700 characters. Documents with values exceeding 700 characters are not archived.

paused Boolean

State of the online archive. This is required for pausing an active or resume a paused online archive. The resume request will fail if the collection has another active online archive.

projectId String

The unique ID for the project

state String

Status of the online archive. Valid values are: Pending, Archiving, Idle, Pausing, Paused, Orphaned and Deleted

syncCreation Boolean
archiveId string

ID of the online archive.

clusterName string

Name of the cluster that contains the collection.

collName string

Name of the collection.

collectionType string

Classification of MongoDB database collection that you want to return, "TIMESERIES" or "STANDARD". Default is "STANDARD".

criteria OnlineArchiveCriteriaArgs

Criteria to use for archiving data.

dbName string

Name of the database that contains the collection.

partitionFields OnlineArchivePartitionFieldArgs[]

Fields to use to partition data. You can specify up to two frequently queried fields to use for partitioning data. Note that queries that don’t contain the specified fields will require a full collection scan of all archived documents, which will take longer and increase your costs. To learn more about how partition improves query performance, see Data Structure in S3. The value of a partition field can be up to a maximum of 700 characters. Documents with values exceeding 700 characters are not archived.

paused boolean

State of the online archive. This is required for pausing an active or resume a paused online archive. The resume request will fail if the collection has another active online archive.

projectId string

The unique ID for the project

state string

Status of the online archive. Valid values are: Pending, Archiving, Idle, Pausing, Paused, Orphaned and Deleted

syncCreation boolean
archive_id str

ID of the online archive.

cluster_name str

Name of the cluster that contains the collection.

coll_name str

Name of the collection.

collection_type str

Classification of MongoDB database collection that you want to return, "TIMESERIES" or "STANDARD". Default is "STANDARD".

criteria OnlineArchiveCriteriaArgs

Criteria to use for archiving data.

db_name str

Name of the database that contains the collection.

partition_fields Sequence[OnlineArchivePartitionFieldArgs]

Fields to use to partition data. You can specify up to two frequently queried fields to use for partitioning data. Note that queries that don’t contain the specified fields will require a full collection scan of all archived documents, which will take longer and increase your costs. To learn more about how partition improves query performance, see Data Structure in S3. The value of a partition field can be up to a maximum of 700 characters. Documents with values exceeding 700 characters are not archived.

paused bool

State of the online archive. This is required for pausing an active or resume a paused online archive. The resume request will fail if the collection has another active online archive.

project_id str

The unique ID for the project

state str

Status of the online archive. Valid values are: Pending, Archiving, Idle, Pausing, Paused, Orphaned and Deleted

sync_creation bool
archiveId String

ID of the online archive.

clusterName String

Name of the cluster that contains the collection.

collName String

Name of the collection.

collectionType String

Classification of MongoDB database collection that you want to return, "TIMESERIES" or "STANDARD". Default is "STANDARD".

criteria Property Map

Criteria to use for archiving data.

dbName String

Name of the database that contains the collection.

partitionFields List<Property Map>

Fields to use to partition data. You can specify up to two frequently queried fields to use for partitioning data. Note that queries that don’t contain the specified fields will require a full collection scan of all archived documents, which will take longer and increase your costs. To learn more about how partition improves query performance, see Data Structure in S3. The value of a partition field can be up to a maximum of 700 characters. Documents with values exceeding 700 characters are not archived.

paused Boolean

State of the online archive. This is required for pausing an active or resume a paused online archive. The resume request will fail if the collection has another active online archive.

projectId String

The unique ID for the project

state String

Status of the online archive. Valid values are: Pending, Archiving, Idle, Pausing, Paused, Orphaned and Deleted

syncCreation Boolean

Supporting Types

OnlineArchiveCriteria

Type string
DateField string
DateFormat string
ExpireAfterDays int
Query string
Type string
DateField string
DateFormat string
ExpireAfterDays int
Query string
type String
dateField String
dateFormat String
expireAfterDays Integer
query String
type string
dateField string
dateFormat string
expireAfterDays number
query string
type String
dateField String
dateFormat String
expireAfterDays Number
query String

OnlineArchivePartitionField

FieldName string
Order int
FieldType string
FieldName string
Order int
FieldType string
fieldName String
order Integer
fieldType String
fieldName string
order number
fieldType string
fieldName String
order Number
fieldType String

Package Details

Repository
MongoDB Atlas pulumi/pulumi-mongodbatlas
License
Apache-2.0
Notes

This Pulumi package is based on the mongodbatlas Terraform Provider.