OnlineArchiveOnlineArchive is the Schema for the OnlineArchives API.
TypeMR
Providerprovider-mongodbatlas
Groupmongodbatlas.m.crossplane.io
Scopenamespaced
Versionv1alpha1

1apiVersion: mongodbatlas.m.crossplane.io/v1alpha1

2kind: OnlineArchive

kind
string
metadata
object
spec
object

OnlineArchiveSpec defines the desired state of OnlineArchive

forProvider
required
object

(No description available)

collName
string
array

Criteria to use for archiving data. See criteria.

dateField
string
query
string
type
string
array

Rule for specifying when data should be deleted from the archive. See data expiration rule.

array

Settings to configure the region where you wish to store your archived data. See data process region. This field is immutable hence cannot be updated.

dbName
string
array

(Recommended) Fields to use to partition data. You can specify up to two frequently queried fields (or up to three fields when one of them is date_field) to use for partitioning data. Queries that don’t contain the specified fields require a full collection scan of all archived documents, which takes longer and increases 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. See partition fields.

fieldName
string
order
number
paused
boolean
projectId
string
object

Reference to a Project in mongodbatlas to populate projectId.

name
required
string
namespace
string
policy
object

Policies for referencing.

resolve
string
object

Selector for a Project in mongodbatlas to populate projectId.

namespace
string
policy
object

Policies for selection.

resolve
string
array

Regular frequency and duration when archiving process occurs. See schedule.

dayOfWeek
number
endHour
number
endMinute
number
startHour
number
type
string
object

THIS IS A BETA FIELD. It will be honored unless the Management Policies feature flag is disabled. InitProvider holds the same fields as ForProvider, with the exception of Identifier and other resource reference fields. The fields that are in InitProvider are merged into ForProvider when the resource is created. The same fields are also added to the terraform ignore_changes hook, to avoid updating them after creation. This is useful for fields that are required on creation, but we do not desire to update them after creation, for example because of an external controller is managing them, like an autoscaler.

collName
string
array

Criteria to use for archiving data. See criteria.

dateField
string
query
string
type
string
array

Rule for specifying when data should be deleted from the archive. See data expiration rule.

array

Settings to configure the region where you wish to store your archived data. See data process region. This field is immutable hence cannot be updated.

dbName
string
array

(Recommended) Fields to use to partition data. You can specify up to two frequently queried fields (or up to three fields when one of them is date_field) to use for partitioning data. Queries that don’t contain the specified fields require a full collection scan of all archived documents, which takes longer and increases 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. See partition fields.

fieldName
string
order
number
paused
boolean
projectId
string
object

Reference to a Project in mongodbatlas to populate projectId.

name
required
string
namespace
string
policy
object

Policies for referencing.

resolve
string
object

Selector for a Project in mongodbatlas to populate projectId.

namespace
string
policy
object

Policies for selection.

resolve
string
array

Regular frequency and duration when archiving process occurs. See schedule.

dayOfWeek
number
endHour
number
endMinute
number
startHour
number
type
string
array

THIS IS A BETA FIELD. It is on by default but can be opted out through a Crossplane feature flag. ManagementPolicies specify the array of actions Crossplane is allowed to take on the managed and external resources. See the design doc for more information: https://github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223 and this one: https://github.com/crossplane/crossplane/blob/444267e84783136daa93568b364a5f01228cacbe/design/one-pager-ignore-changes.md

object

ProviderConfigReference specifies how the provider that will be used to create, observe, update, and delete this managed resource should be configured.

kind
required
string
name
required
string
object

WriteConnectionSecretToReference specifies the namespace and name of a Secret to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource.

name
required
string
status
object

OnlineArchiveStatus defines the observed state of OnlineArchive.

object

(No description available)

archiveId
string
collName
string
array

Criteria to use for archiving data. See criteria.

dateField
string
query
string
type
string
array

Rule for specifying when data should be deleted from the archive. See data expiration rule.

array

Settings to configure the region where you wish to store your archived data. See data process region. This field is immutable hence cannot be updated.

dbName
string
id
string
array

(Recommended) Fields to use to partition data. You can specify up to two frequently queried fields (or up to three fields when one of them is date_field) to use for partitioning data. Queries that don’t contain the specified fields require a full collection scan of all archived documents, which takes longer and increases 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. See partition fields.

fieldName
string
fieldType
string
order
number
paused
boolean
projectId
string
array

Regular frequency and duration when archiving process occurs. See schedule.

dayOfWeek
number
endHour
number
endMinute
number
startHour
number
type
string
state
string
array

Conditions of the resource.

lastTransitionTime
required
string
message
string
reason
required
string
status
required
string
type
required
string