Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/serverless-framework-configuration/_shared/latest--mongodb-atlas-cloudbackupschedule.json
Parent schema serverless-framework-configuration
Type: object

An example resource schema demonstrating some basic constructs and validation rules.. Source:- https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git

Properties

AutoExportEnabled boolean required

Flag that indicates whether automatic export of cloud backup snapshots to the AWS bucket is enabled.

ProjectId string | Aws_CF_FunctionString

The unique identifier of the project for the Atlas cluster.

Id string | Aws_CF_FunctionString

Unique identifier of the snapshot.

UseOrgAndGroupNamesInExportPrefix boolean

Specify true to use organization and project names instead of organization and project UUIDs in the path for the metadata files that Atlas uploads to your S3 bucket after it finishes exporting the snapshots.

Export object
2 nested properties
ExportBucketId string | Aws_CF_FunctionString

Unique identifier of the AWS bucket to export the cloud backup snapshot to

FrequencyType string | Aws_CF_FunctionString

Frequency associated with the export policy. Value can be daily, weekly, or monthly.

CopySettings object[]

List that contains a document for each copy setting item in the desired backup policy.

DeleteCopiedBackups object[]

List that contains a document for each deleted copy setting whose backup copies you want to delete.

Policies array[]

Rules set for this backup schedule.

ReferenceHourOfDay integer

UTC Hour of day between 0 and 23 representing which hour of the day that Atlas takes a snapshot

ReferenceMinuteOfHour integer

UTC Minute of day between 0 and 59 representing which minute of the referenceHourOfDay that Atlas takes the snapshot.

RestoreWindowDays integer

Number of days back in time you can restore to with Continuous Cloud Backup accuracy. Must be a positive, non-zero integer.

UpdateSnapshots boolean

Flag indicating if updates to retention in the backup policy were applied to snapshots that Atlas took earlier.

Profile string | Aws_CF_FunctionString

Profile used to provide credentials information, (a secret with the cfn/atlas/profile/{Profile}, is required), if not provided default is used

Definitions

Export object
ExportBucketId string | Aws_CF_FunctionString

Unique identifier of the AWS bucket to export the cloud backup snapshot to

FrequencyType string | Aws_CF_FunctionString

Frequency associated with the export policy. Value can be daily, weekly, or monthly.

ApiPolicyItemView object
ID string | Aws_CF_FunctionString

Unique identifier of the backup policy item.

FrequencyType string | Aws_CF_FunctionString

Frequency associated with the backup policy item. One of the following values: hourly, daily, weekly or monthly.

FrequencyInterval integer

Desired frequency of the new backup policy item specified by frequencyType.

RetentionValue integer

Duration for which the backup is kept. Associated with retentionUnit.

RetentionUnit string | Aws_CF_FunctionString

Metric of duration of the backup policy item: days, weeks, or months.

ApiAtlasDiskBackupCopySettingView object
CloudProvider string | Aws_CF_FunctionString

A label that identifies the cloud provider that stores the snapshot copy.

RegionName string | Aws_CF_FunctionString

Target region to copy snapshots belonging to replicationSpecId to.

ReplicationSpecId string | Aws_CF_FunctionString

Unique 24-hexadecimal digit string that identifies the replication object for a zone in a cluster.

ShouldCopyOplogs boolean

Flag that indicates whether to copy the oplogs to the target region.

Frequencies string[]

List that describes which types of snapshots to copy.

ApiDeleteCopiedBackupsView object
CloudProvider string | Aws_CF_FunctionString

A label that identifies the cloud provider for the deleted copy setting whose backup copies you want to delete

RegionName string | Aws_CF_FunctionString

Target region for the deleted copy setting whose backup copies you want to delete.

ReplicationSpecId string | Aws_CF_FunctionString

Unique 24-hexadecimal digit string that identifies the replication object for a zone in a cluster.

ApiPolicyView object
ID string | Aws_CF_FunctionString

Unique 24-hexadecimal digit string that identifies this backup policy. The policy id can be retrieved by running: atlas backups schedule describe "${clusterName}" --projectId "${projectId}" | jq -r '.policies[0].id'

PolicyItems ApiPolicyItemView[]