latest--mongodb-atlas-onlinearchive
sharedReturns, adds, edits, or removes an online archive.. Source:- https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git
Properties
Human-readable label that identifies the cluster that contains the collection from which you want to remove an online archive.
5 nested properties
Means by which MongoDB Cloud selects data to archive. Data can be chosen using the age of the data or a MongoDB query.
DATE selects documents to archive based on a date.
CUSTOM selects documents to archive based on a custom JSON query. MongoDB Cloud doesn't support CUSTOM when "collectionType": "TIMESERIES".
Indexed database parameter that stores the date that determines when data moves to the online archive. MongoDB Cloud archives the data when the current date exceeds the date in this database parameter plus the number of days specified through the expireAfterDays parameter. Set this parameter when you set "criteria.type" : "DATE".
Syntax used to write the date after which data moves to the online archive. Date can be expressed as ISO 8601 or Epoch timestamps. The Epoch timestamp can be expressed as nanoseconds, milliseconds, or seconds. Set this parameter when "criteria.type" : "DATE". You must set "criteria.type" : "DATE" if "collectionType": "TIMESERIES".
Number of days after the value in the criteria.dateField when MongoDB Cloud archives data in the specified cluster. Set this parameter when you set "criteria.type" : "DATE".
MongoDB find query that selects documents to archive. The specified query follows the syntax of the db.collection.find(query) command. This query can't use the empty document ({}) to return all documents. Set this parameter when "criteria.type" : "CUSTOM".
The profile is defined in AWS Secret manager. See Secret Manager Profile setup.
Human-readable label that identifies the collection for which you created the online archive.
Classification of MongoDB database collection that you want to return.
If you set this parameter to TIMESERIES, set "criteria.type" : "date" and "criteria.dateFormat" : "ISODATE".
Human-readable label of the database that contains the collection that contains the online archive.
Unique 24-hexadecimal digit string that identifies your project.
Flag that indicates whether the response returns the total number of items (totalCount) in the response.
Number of items that the response returns per page.
Number of the page that displays the current set of the total objects that the response returns.
List that contains document parameters to use to logically divide data within a collection. Partitions provide a coarse level of filtering of the underlying collection data. To divide your data, specify up to two parameters that you frequently query. Any queries that don't use these parameters result in a full collection scan of all archived documents. This takes more time and increase your costs.
7 nested properties
Hour of the day when the scheduled window to run one online archive ends.
Minute of the hour when the scheduled window to run one online archive ends.
Hour of the day when the when the scheduled window to run one online archive starts.
Minute of the hour when the scheduled window to run one online archive starts.
Day of the month when the scheduled archive starts.
Day of the month when the scheduled archive starts.
Definitions
Hour of the day when the scheduled window to run one online archive ends.
Minute of the hour when the scheduled window to run one online archive ends.
Hour of the day when the when the scheduled window to run one online archive starts.
Minute of the hour when the scheduled window to run one online archive starts.
Day of the month when the scheduled archive starts.
Day of the month when the scheduled archive starts.
Means by which MongoDB Cloud selects data to archive. Data can be chosen using the age of the data or a MongoDB query.
DATE selects documents to archive based on a date.
CUSTOM selects documents to archive based on a custom JSON query. MongoDB Cloud doesn't support CUSTOM when "collectionType": "TIMESERIES".
Indexed database parameter that stores the date that determines when data moves to the online archive. MongoDB Cloud archives the data when the current date exceeds the date in this database parameter plus the number of days specified through the expireAfterDays parameter. Set this parameter when you set "criteria.type" : "DATE".
Syntax used to write the date after which data moves to the online archive. Date can be expressed as ISO 8601 or Epoch timestamps. The Epoch timestamp can be expressed as nanoseconds, milliseconds, or seconds. Set this parameter when "criteria.type" : "DATE". You must set "criteria.type" : "DATE" if "collectionType": "TIMESERIES".
Number of days after the value in the criteria.dateField when MongoDB Cloud archives data in the specified cluster. Set this parameter when you set "criteria.type" : "DATE".
MongoDB find query that selects documents to archive. The specified query follows the syntax of the db.collection.find(query) command. This query can't use the empty document ({}) to return all documents. Set this parameter when "criteria.type" : "CUSTOM".
Human-readable label that identifies the parameter that MongoDB Cloud uses to partition data. To specify a nested parameter, use the dot notation.
Data type of the parameter that that MongoDB Cloud uses to partition data. Partition parameters of type UUID must be of binary subtype 4. MongoDB Cloud skips partition parameters of type UUID with subtype 3.
Sequence in which MongoDB Cloud slices the collection data to create partitions. The resource expresses this sequence starting with zero. The value of the criteria.dateField parameter defaults as the first item in the partition sequence.