Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Mongodbatlas Provider
  3. API Docs
  4. getCloudBackupSchedule
MongoDB Atlas v3.31.0 published on Tuesday, May 6, 2025 by Pulumi
pulumi/pulumi-mongodbatlas

mongodbatlas.getCloudBackupSchedule

Explore with Pulumi AI

mongodbatlas logo
MongoDB Atlas v3.31.0 published on Tuesday, May 6, 2025 by Pulumi
pulumi/pulumi-mongodbatlas

    # Data Source: mongodbatlas.CloudBackupSchedule

    mongodbatlas.CloudBackupSchedule provides a Cloud Backup Schedule datasource. An Atlas Cloud Backup Schedule provides the current cloud backup schedule for the cluster.

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

    Using getCloudBackupSchedule

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getCloudBackupSchedule(args: GetCloudBackupScheduleArgs, opts?: InvokeOptions): Promise<GetCloudBackupScheduleResult>
function getCloudBackupScheduleOutput(args: GetCloudBackupScheduleOutputArgs, opts?: InvokeOptions): Output<GetCloudBackupScheduleResult>
    def get_cloud_backup_schedule(cluster_name: Optional[str] = None,
                              project_id: Optional[str] = None,
                              use_zone_id_for_copy_settings: Optional[bool] = None,
                              opts: Optional[InvokeOptions] = None) -> GetCloudBackupScheduleResult
def get_cloud_backup_schedule_output(cluster_name: Optional[pulumi.Input[str]] = None,
                              project_id: Optional[pulumi.Input[str]] = None,
                              use_zone_id_for_copy_settings: Optional[pulumi.Input[bool]] = None,
                              opts: Optional[InvokeOptions] = None) -> Output[GetCloudBackupScheduleResult]
    func LookupCloudBackupSchedule(ctx *Context, args *LookupCloudBackupScheduleArgs, opts ...InvokeOption) (*LookupCloudBackupScheduleResult, error)
func LookupCloudBackupScheduleOutput(ctx *Context, args *LookupCloudBackupScheduleOutputArgs, opts ...InvokeOption) LookupCloudBackupScheduleResultOutput

    > Note: This function is named LookupCloudBackupSchedule in the Go SDK.

    public static class GetCloudBackupSchedule 
{
    public static Task<GetCloudBackupScheduleResult> InvokeAsync(GetCloudBackupScheduleArgs args, InvokeOptions? opts = null)
    public static Output<GetCloudBackupScheduleResult> Invoke(GetCloudBackupScheduleInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetCloudBackupScheduleResult> getCloudBackupSchedule(GetCloudBackupScheduleArgs args, InvokeOptions options)
public static Output<GetCloudBackupScheduleResult> getCloudBackupSchedule(GetCloudBackupScheduleArgs args, InvokeOptions options)

    fn::invoke:
  function: mongodbatlas:index/getCloudBackupSchedule:getCloudBackupSchedule
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ClusterName string
    The name of the Atlas cluster that contains the snapshots backup policy you want to retrieve.
    ProjectId string
    The unique identifier of the project for the Atlas cluster.
    UseZoneIdForCopySettings bool
    Set this field to true to allow the data source to use the latest schema that populates copy_settings.#.zone_id instead of the deprecated copy_settings.#.replication_spec_id. These fields also enable you to reference cluster zones using independent shard scaling, which no longer supports replication_spec.*.id. To learn more, see the 1.18.0 upgrade guide.
    ClusterName string
    The name of the Atlas cluster that contains the snapshots backup policy you want to retrieve.
    ProjectId string
    The unique identifier of the project for the Atlas cluster.
    UseZoneIdForCopySettings bool
    Set this field to true to allow the data source to use the latest schema that populates copy_settings.#.zone_id instead of the deprecated copy_settings.#.replication_spec_id. These fields also enable you to reference cluster zones using independent shard scaling, which no longer supports replication_spec.*.id. To learn more, see the 1.18.0 upgrade guide.
    clusterName String
    The name of the Atlas cluster that contains the snapshots backup policy you want to retrieve.
    projectId String
    The unique identifier of the project for the Atlas cluster.
    useZoneIdForCopySettings Boolean
    Set this field to true to allow the data source to use the latest schema that populates copy_settings.#.zone_id instead of the deprecated copy_settings.#.replication_spec_id. These fields also enable you to reference cluster zones using independent shard scaling, which no longer supports replication_spec.*.id. To learn more, see the 1.18.0 upgrade guide.
    clusterName string
    The name of the Atlas cluster that contains the snapshots backup policy you want to retrieve.
    projectId string
    The unique identifier of the project for the Atlas cluster.
    useZoneIdForCopySettings boolean
    Set this field to true to allow the data source to use the latest schema that populates copy_settings.#.zone_id instead of the deprecated copy_settings.#.replication_spec_id. These fields also enable you to reference cluster zones using independent shard scaling, which no longer supports replication_spec.*.id. To learn more, see the 1.18.0 upgrade guide.
    cluster_name str
    The name of the Atlas cluster that contains the snapshots backup policy you want to retrieve.
    project_id str
    The unique identifier of the project for the Atlas cluster.
    use_zone_id_for_copy_settings bool
    Set this field to true to allow the data source to use the latest schema that populates copy_settings.#.zone_id instead of the deprecated copy_settings.#.replication_spec_id. These fields also enable you to reference cluster zones using independent shard scaling, which no longer supports replication_spec.*.id. To learn more, see the 1.18.0 upgrade guide.
    clusterName String
    The name of the Atlas cluster that contains the snapshots backup policy you want to retrieve.
    projectId String
    The unique identifier of the project for the Atlas cluster.
    useZoneIdForCopySettings Boolean
    Set this field to true to allow the data source to use the latest schema that populates copy_settings.#.zone_id instead of the deprecated copy_settings.#.replication_spec_id. These fields also enable you to reference cluster zones using independent shard scaling, which no longer supports replication_spec.*.id. To learn more, see the 1.18.0 upgrade guide.

    getCloudBackupSchedule Result

    The following output properties are available:

    AutoExportEnabled bool
    Flag that indicates whether MongoDB Cloud automatically exports Cloud Backup Snapshots to the Export Bucket. Value can be one of the following:

    • true - Enables automatic export of cloud backup snapshots to the Export Bucket.
    • false - Disables automatic export of cloud backup snapshots to the Export Bucket. (default)
    ClusterId string
    Unique identifier of the Atlas cluster.
    ClusterName string
    CopySettings List<GetCloudBackupScheduleCopySetting>
    List that contains a document for each copy setting item in the desired backup policy. See below
    Exports List<GetCloudBackupScheduleExport>
    Policy for automatically exporting Cloud Backup Snapshots. See below
    Id string
    The provider-assigned unique ID for this managed resource.
    IdPolicy string
    Unique identifier of the backup policy.
    NextSnapshot string
    UTC ISO 8601 formatted point in time when Atlas will take the next snapshot.
    PolicyItemDailies List<GetCloudBackupSchedulePolicyItemDaily>
    (Optional) Daily policy item. See below
    PolicyItemHourlies List<GetCloudBackupSchedulePolicyItemHourly>
    (Optional) Hourly policy item. See below
    PolicyItemMonthlies List<GetCloudBackupSchedulePolicyItemMonthly>
    (Optional) Monthly policy item. See below
    PolicyItemWeeklies List<GetCloudBackupSchedulePolicyItemWeekly>
    (Optional) Weekly policy item. See below
    PolicyItemYearlies List<GetCloudBackupSchedulePolicyItemYearly>
    (Optional) Yearly policy item. See below
    ProjectId string
    ReferenceHourOfDay int
    UTC Hour of day between 0 and 23 representing which hour of the day that Atlas takes a snapshot.
    ReferenceMinuteOfHour int
    UTC Minute of day between 0 and 59 representing which minute of the reference_hour_of_day that Atlas takes the snapshot.
    RestoreWindowDays int
    Specifies a restore window in days for cloud backup to maintain.
    UseOrgAndGroupNamesInExportPrefix bool
    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 bucket after it finishes exporting the snapshots. To learn more about the metadata files that Atlas uploads, see Export Cloud Backup Snapshot.
    UseZoneIdForCopySettings bool
    AutoExportEnabled bool
    Flag that indicates whether MongoDB Cloud automatically exports Cloud Backup Snapshots to the Export Bucket. Value can be one of the following:

    • true - Enables automatic export of cloud backup snapshots to the Export Bucket.
    • false - Disables automatic export of cloud backup snapshots to the Export Bucket. (default)
    ClusterId string
    Unique identifier of the Atlas cluster.
    ClusterName string
    CopySettings []GetCloudBackupScheduleCopySetting
    List that contains a document for each copy setting item in the desired backup policy. See below
    Exports []GetCloudBackupScheduleExport
    Policy for automatically exporting Cloud Backup Snapshots. See below
    Id string
    The provider-assigned unique ID for this managed resource.
    IdPolicy string
    Unique identifier of the backup policy.
    NextSnapshot string
    UTC ISO 8601 formatted point in time when Atlas will take the next snapshot.
    PolicyItemDailies []GetCloudBackupSchedulePolicyItemDaily
    (Optional) Daily policy item. See below
    PolicyItemHourlies []GetCloudBackupSchedulePolicyItemHourly
    (Optional) Hourly policy item. See below
    PolicyItemMonthlies []GetCloudBackupSchedulePolicyItemMonthly
    (Optional) Monthly policy item. See below
    PolicyItemWeeklies []GetCloudBackupSchedulePolicyItemWeekly
    (Optional) Weekly policy item. See below
    PolicyItemYearlies []GetCloudBackupSchedulePolicyItemYearly
    (Optional) Yearly policy item. See below
    ProjectId string
    ReferenceHourOfDay int
    UTC Hour of day between 0 and 23 representing which hour of the day that Atlas takes a snapshot.
    ReferenceMinuteOfHour int
    UTC Minute of day between 0 and 59 representing which minute of the reference_hour_of_day that Atlas takes the snapshot.
    RestoreWindowDays int
    Specifies a restore window in days for cloud backup to maintain.
    UseOrgAndGroupNamesInExportPrefix bool
    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 bucket after it finishes exporting the snapshots. To learn more about the metadata files that Atlas uploads, see Export Cloud Backup Snapshot.
    UseZoneIdForCopySettings bool
    autoExportEnabled Boolean
    Flag that indicates whether MongoDB Cloud automatically exports Cloud Backup Snapshots to the Export Bucket. Value can be one of the following:

    • true - Enables automatic export of cloud backup snapshots to the Export Bucket.
    • false - Disables automatic export of cloud backup snapshots to the Export Bucket. (default)
    clusterId String
    Unique identifier of the Atlas cluster.
    clusterName String
    copySettings List<GetCloudBackupScheduleCopySetting>
    List that contains a document for each copy setting item in the desired backup policy. See below
    exports List<GetCloudBackupScheduleExport>
    Policy for automatically exporting Cloud Backup Snapshots. See below
    id String
    The provider-assigned unique ID for this managed resource.
    idPolicy String
    Unique identifier of the backup policy.
    nextSnapshot String
    UTC ISO 8601 formatted point in time when Atlas will take the next snapshot.
    policyItemDailies List<GetCloudBackupSchedulePolicyItemDaily>
    (Optional) Daily policy item. See below
    policyItemHourlies List<GetCloudBackupSchedulePolicyItemHourly>
    (Optional) Hourly policy item. See below
    policyItemMonthlies List<GetCloudBackupSchedulePolicyItemMonthly>
    (Optional) Monthly policy item. See below
    policyItemWeeklies List<GetCloudBackupSchedulePolicyItemWeekly>
    (Optional) Weekly policy item. See below
    policyItemYearlies List<GetCloudBackupSchedulePolicyItemYearly>
    (Optional) Yearly policy item. See below
    projectId String
    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 reference_hour_of_day that Atlas takes the snapshot.
    restoreWindowDays Integer
    Specifies a restore window in days for cloud backup to maintain.
    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 bucket after it finishes exporting the snapshots. To learn more about the metadata files that Atlas uploads, see Export Cloud Backup Snapshot.
    useZoneIdForCopySettings Boolean
    autoExportEnabled boolean
    Flag that indicates whether MongoDB Cloud automatically exports Cloud Backup Snapshots to the Export Bucket. Value can be one of the following:

    • true - Enables automatic export of cloud backup snapshots to the Export Bucket.
    • false - Disables automatic export of cloud backup snapshots to the Export Bucket. (default)
    clusterId string
    Unique identifier of the Atlas cluster.
    clusterName string
    copySettings GetCloudBackupScheduleCopySetting[]
    List that contains a document for each copy setting item in the desired backup policy. See below
    exports GetCloudBackupScheduleExport[]
    Policy for automatically exporting Cloud Backup Snapshots. See below
    id string
    The provider-assigned unique ID for this managed resource.
    idPolicy string
    Unique identifier of the backup policy.
    nextSnapshot string
    UTC ISO 8601 formatted point in time when Atlas will take the next snapshot.
    policyItemDailies GetCloudBackupSchedulePolicyItemDaily[]
    (Optional) Daily policy item. See below
    policyItemHourlies GetCloudBackupSchedulePolicyItemHourly[]
    (Optional) Hourly policy item. See below
    policyItemMonthlies GetCloudBackupSchedulePolicyItemMonthly[]
    (Optional) Monthly policy item. See below
    policyItemWeeklies GetCloudBackupSchedulePolicyItemWeekly[]
    (Optional) Weekly policy item. See below
    policyItemYearlies GetCloudBackupSchedulePolicyItemYearly[]
    (Optional) Yearly policy item. See below
    projectId string
    referenceHourOfDay number
    UTC Hour of day between 0 and 23 representing which hour of the day that Atlas takes a snapshot.
    referenceMinuteOfHour number
    UTC Minute of day between 0 and 59 representing which minute of the reference_hour_of_day that Atlas takes the snapshot.
    restoreWindowDays number
    Specifies a restore window in days for cloud backup to maintain.
    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 bucket after it finishes exporting the snapshots. To learn more about the metadata files that Atlas uploads, see Export Cloud Backup Snapshot.
    useZoneIdForCopySettings boolean
    auto_export_enabled bool
    Flag that indicates whether MongoDB Cloud automatically exports Cloud Backup Snapshots to the Export Bucket. Value can be one of the following:

    • true - Enables automatic export of cloud backup snapshots to the Export Bucket.
    • false - Disables automatic export of cloud backup snapshots to the Export Bucket. (default)
    cluster_id str
    Unique identifier of the Atlas cluster.
    cluster_name str
    copy_settings Sequence[GetCloudBackupScheduleCopySetting]
    List that contains a document for each copy setting item in the desired backup policy. See below
    exports Sequence[GetCloudBackupScheduleExport]
    Policy for automatically exporting Cloud Backup Snapshots. See below
    id str
    The provider-assigned unique ID for this managed resource.
    id_policy str
    Unique identifier of the backup policy.
    next_snapshot str
    UTC ISO 8601 formatted point in time when Atlas will take the next snapshot.
    policy_item_dailies Sequence[GetCloudBackupSchedulePolicyItemDaily]
    (Optional) Daily policy item. See below
    policy_item_hourlies Sequence[GetCloudBackupSchedulePolicyItemHourly]
    (Optional) Hourly policy item. See below
    policy_item_monthlies Sequence[GetCloudBackupSchedulePolicyItemMonthly]
    (Optional) Monthly policy item. See below
    policy_item_weeklies Sequence[GetCloudBackupSchedulePolicyItemWeekly]
    (Optional) Weekly policy item. See below
    policy_item_yearlies Sequence[GetCloudBackupSchedulePolicyItemYearly]
    (Optional) Yearly policy item. See below
    project_id str
    reference_hour_of_day int
    UTC Hour of day between 0 and 23 representing which hour of the day that Atlas takes a snapshot.
    reference_minute_of_hour int
    UTC Minute of day between 0 and 59 representing which minute of the reference_hour_of_day that Atlas takes the snapshot.
    restore_window_days int
    Specifies a restore window in days for cloud backup to maintain.
    use_org_and_group_names_in_export_prefix bool
    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 bucket after it finishes exporting the snapshots. To learn more about the metadata files that Atlas uploads, see Export Cloud Backup Snapshot.
    use_zone_id_for_copy_settings bool
    autoExportEnabled Boolean
    Flag that indicates whether MongoDB Cloud automatically exports Cloud Backup Snapshots to the Export Bucket. Value can be one of the following:

    • true - Enables automatic export of cloud backup snapshots to the Export Bucket.
    • false - Disables automatic export of cloud backup snapshots to the Export Bucket. (default)
    clusterId String
    Unique identifier of the Atlas cluster.
    clusterName String
    copySettings List<Property Map>
    List that contains a document for each copy setting item in the desired backup policy. See below
    exports List<Property Map>
    Policy for automatically exporting Cloud Backup Snapshots. See below
    id String
    The provider-assigned unique ID for this managed resource.
    idPolicy String
    Unique identifier of the backup policy.
    nextSnapshot String
    UTC ISO 8601 formatted point in time when Atlas will take the next snapshot.
    policyItemDailies List<Property Map>
    (Optional) Daily policy item. See below
    policyItemHourlies List<Property Map>
    (Optional) Hourly policy item. See below
    policyItemMonthlies List<Property Map>
    (Optional) Monthly policy item. See below
    policyItemWeeklies List<Property Map>
    (Optional) Weekly policy item. See below
    policyItemYearlies List<Property Map>
    (Optional) Yearly policy item. See below
    projectId String
    referenceHourOfDay Number
    UTC Hour of day between 0 and 23 representing which hour of the day that Atlas takes a snapshot.
    referenceMinuteOfHour Number
    UTC Minute of day between 0 and 59 representing which minute of the reference_hour_of_day that Atlas takes the snapshot.
    restoreWindowDays Number
    Specifies a restore window in days for cloud backup to maintain.
    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 bucket after it finishes exporting the snapshots. To learn more about the metadata files that Atlas uploads, see Export Cloud Backup Snapshot.
    useZoneIdForCopySettings Boolean

    Supporting Types

    GetCloudBackupScheduleCopySetting

    CloudProvider string
    Human-readable label that identifies the cloud provider that stores the snapshot copy. i.e. "AWS" "AZURE" "GCP"
    Frequencies List<string>
    List that describes which types of snapshots to copy. i.e. "HOURLY" "DAILY" "WEEKLY" "MONTHLY" "YEARLY" "ON_DEMAND"
    RegionName string
    Target region to copy snapshots belonging to replicationSpecId to. Please supply the 'Atlas Region' which can be found under https://www.mongodb.com/docs/atlas/reference/cloud-providers/ 'regions' link
    ReplicationSpecId string
    Unique 24-hexadecimal digit string that identifies the replication object for a zone in a cluster. For global clusters, there can be multiple zones to choose from. For sharded clusters and replica set clusters, there is only one zone in the cluster. To find the Replication Spec Id, consult the replicationSpecs array returned from Return One Multi-Cloud Cluster in One Project. (DEPRECATED) Use zone_id instead. To learn more, see the 1.18.0 upgrade guide.

    Deprecated: This parameter is deprecated. Please transition to copy_settings.#.zone_id. To learn more, see our examples, documentation, and 1.18.0 migration guide for more details at https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs/guides/1.18.0-upgrade-guide

    ShouldCopyOplogs bool
    Flag that indicates whether to copy the oplogs to the target region. You can use the oplogs to perform point-in-time restores.
    ZoneId string
    Unique 24-hexadecimal digit string that identifies the zone in a cluster. For global clusters, there can be multiple zones to choose from. For sharded clusters and replica set clusters, there is only one zone in the cluster.
    CloudProvider string
    Human-readable label that identifies the cloud provider that stores the snapshot copy. i.e. "AWS" "AZURE" "GCP"
    Frequencies []string
    List that describes which types of snapshots to copy. i.e. "HOURLY" "DAILY" "WEEKLY" "MONTHLY" "YEARLY" "ON_DEMAND"
    RegionName string
    Target region to copy snapshots belonging to replicationSpecId to. Please supply the 'Atlas Region' which can be found under https://www.mongodb.com/docs/atlas/reference/cloud-providers/ 'regions' link
    ReplicationSpecId string
    Unique 24-hexadecimal digit string that identifies the replication object for a zone in a cluster. For global clusters, there can be multiple zones to choose from. For sharded clusters and replica set clusters, there is only one zone in the cluster. To find the Replication Spec Id, consult the replicationSpecs array returned from Return One Multi-Cloud Cluster in One Project. (DEPRECATED) Use zone_id instead. To learn more, see the 1.18.0 upgrade guide.

    Deprecated: This parameter is deprecated. Please transition to copy_settings.#.zone_id. To learn more, see our examples, documentation, and 1.18.0 migration guide for more details at https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs/guides/1.18.0-upgrade-guide

    ShouldCopyOplogs bool
    Flag that indicates whether to copy the oplogs to the target region. You can use the oplogs to perform point-in-time restores.
    ZoneId string
    Unique 24-hexadecimal digit string that identifies the zone in a cluster. For global clusters, there can be multiple zones to choose from. For sharded clusters and replica set clusters, there is only one zone in the cluster.
    cloudProvider String
    Human-readable label that identifies the cloud provider that stores the snapshot copy. i.e. "AWS" "AZURE" "GCP"
    frequencies List<String>
    List that describes which types of snapshots to copy. i.e. "HOURLY" "DAILY" "WEEKLY" "MONTHLY" "YEARLY" "ON_DEMAND"
    regionName String
    Target region to copy snapshots belonging to replicationSpecId to. Please supply the 'Atlas Region' which can be found under https://www.mongodb.com/docs/atlas/reference/cloud-providers/ 'regions' link
    replicationSpecId String
    Unique 24-hexadecimal digit string that identifies the replication object for a zone in a cluster. For global clusters, there can be multiple zones to choose from. For sharded clusters and replica set clusters, there is only one zone in the cluster. To find the Replication Spec Id, consult the replicationSpecs array returned from Return One Multi-Cloud Cluster in One Project. (DEPRECATED) Use zone_id instead. To learn more, see the 1.18.0 upgrade guide.

    Deprecated: This parameter is deprecated. Please transition to copy_settings.#.zone_id. To learn more, see our examples, documentation, and 1.18.0 migration guide for more details at https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs/guides/1.18.0-upgrade-guide

    shouldCopyOplogs Boolean
    Flag that indicates whether to copy the oplogs to the target region. You can use the oplogs to perform point-in-time restores.
    zoneId String
    Unique 24-hexadecimal digit string that identifies the zone in a cluster. For global clusters, there can be multiple zones to choose from. For sharded clusters and replica set clusters, there is only one zone in the cluster.
    cloudProvider string
    Human-readable label that identifies the cloud provider that stores the snapshot copy. i.e. "AWS" "AZURE" "GCP"
    frequencies string[]
    List that describes which types of snapshots to copy. i.e. "HOURLY" "DAILY" "WEEKLY" "MONTHLY" "YEARLY" "ON_DEMAND"
    regionName string
    Target region to copy snapshots belonging to replicationSpecId to. Please supply the 'Atlas Region' which can be found under https://www.mongodb.com/docs/atlas/reference/cloud-providers/ 'regions' link
    replicationSpecId string
    Unique 24-hexadecimal digit string that identifies the replication object for a zone in a cluster. For global clusters, there can be multiple zones to choose from. For sharded clusters and replica set clusters, there is only one zone in the cluster. To find the Replication Spec Id, consult the replicationSpecs array returned from Return One Multi-Cloud Cluster in One Project. (DEPRECATED) Use zone_id instead. To learn more, see the 1.18.0 upgrade guide.

    Deprecated: This parameter is deprecated. Please transition to copy_settings.#.zone_id. To learn more, see our examples, documentation, and 1.18.0 migration guide for more details at https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs/guides/1.18.0-upgrade-guide

    shouldCopyOplogs boolean
    Flag that indicates whether to copy the oplogs to the target region. You can use the oplogs to perform point-in-time restores.
    zoneId string
    Unique 24-hexadecimal digit string that identifies the zone in a cluster. For global clusters, there can be multiple zones to choose from. For sharded clusters and replica set clusters, there is only one zone in the cluster.
    cloud_provider str
    Human-readable label that identifies the cloud provider that stores the snapshot copy. i.e. "AWS" "AZURE" "GCP"
    frequencies Sequence[str]
    List that describes which types of snapshots to copy. i.e. "HOURLY" "DAILY" "WEEKLY" "MONTHLY" "YEARLY" "ON_DEMAND"
    region_name str
    Target region to copy snapshots belonging to replicationSpecId to. Please supply the 'Atlas Region' which can be found under https://www.mongodb.com/docs/atlas/reference/cloud-providers/ 'regions' link
    replication_spec_id str
    Unique 24-hexadecimal digit string that identifies the replication object for a zone in a cluster. For global clusters, there can be multiple zones to choose from. For sharded clusters and replica set clusters, there is only one zone in the cluster. To find the Replication Spec Id, consult the replicationSpecs array returned from Return One Multi-Cloud Cluster in One Project. (DEPRECATED) Use zone_id instead. To learn more, see the 1.18.0 upgrade guide.

    Deprecated: This parameter is deprecated. Please transition to copy_settings.#.zone_id. To learn more, see our examples, documentation, and 1.18.0 migration guide for more details at https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs/guides/1.18.0-upgrade-guide

    should_copy_oplogs bool
    Flag that indicates whether to copy the oplogs to the target region. You can use the oplogs to perform point-in-time restores.
    zone_id str
    Unique 24-hexadecimal digit string that identifies the zone in a cluster. For global clusters, there can be multiple zones to choose from. For sharded clusters and replica set clusters, there is only one zone in the cluster.
    cloudProvider String
    Human-readable label that identifies the cloud provider that stores the snapshot copy. i.e. "AWS" "AZURE" "GCP"
    frequencies List<String>
    List that describes which types of snapshots to copy. i.e. "HOURLY" "DAILY" "WEEKLY" "MONTHLY" "YEARLY" "ON_DEMAND"
    regionName String
    Target region to copy snapshots belonging to replicationSpecId to. Please supply the 'Atlas Region' which can be found under https://www.mongodb.com/docs/atlas/reference/cloud-providers/ 'regions' link
    replicationSpecId String
    Unique 24-hexadecimal digit string that identifies the replication object for a zone in a cluster. For global clusters, there can be multiple zones to choose from. For sharded clusters and replica set clusters, there is only one zone in the cluster. To find the Replication Spec Id, consult the replicationSpecs array returned from Return One Multi-Cloud Cluster in One Project. (DEPRECATED) Use zone_id instead. To learn more, see the 1.18.0 upgrade guide.

    Deprecated: This parameter is deprecated. Please transition to copy_settings.#.zone_id. To learn more, see our examples, documentation, and 1.18.0 migration guide for more details at https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs/guides/1.18.0-upgrade-guide

    shouldCopyOplogs Boolean
    Flag that indicates whether to copy the oplogs to the target region. You can use the oplogs to perform point-in-time restores.
    zoneId String
    Unique 24-hexadecimal digit string that identifies the zone in a cluster. For global clusters, there can be multiple zones to choose from. For sharded clusters and replica set clusters, there is only one zone in the cluster.

    GetCloudBackupScheduleExport

    ExportBucketId string
    Unique identifier of the mongodbatlas.CloudBackupSnapshotExportBucket export_bucket_id value.
    FrequencyType string
    Frequency associated with the backup policy item. For yearly policies, the frequency type is defined as yearly. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.
    ExportBucketId string
    Unique identifier of the mongodbatlas.CloudBackupSnapshotExportBucket export_bucket_id value.
    FrequencyType string
    Frequency associated with the backup policy item. For yearly policies, the frequency type is defined as yearly. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.
    exportBucketId String
    Unique identifier of the mongodbatlas.CloudBackupSnapshotExportBucket export_bucket_id value.
    frequencyType String
    Frequency associated with the backup policy item. For yearly policies, the frequency type is defined as yearly. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.
    exportBucketId string
    Unique identifier of the mongodbatlas.CloudBackupSnapshotExportBucket export_bucket_id value.
    frequencyType string
    Frequency associated with the backup policy item. For yearly policies, the frequency type is defined as yearly. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.
    export_bucket_id str
    Unique identifier of the mongodbatlas.CloudBackupSnapshotExportBucket export_bucket_id value.
    frequency_type str
    Frequency associated with the backup policy item. For yearly policies, the frequency type is defined as yearly. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.
    exportBucketId String
    Unique identifier of the mongodbatlas.CloudBackupSnapshotExportBucket export_bucket_id value.
    frequencyType String
    Frequency associated with the backup policy item. For yearly policies, the frequency type is defined as yearly. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.

    GetCloudBackupSchedulePolicyItemDaily

    FrequencyInterval int
    Desired frequency of the new backup policy item specified by frequency_type (yearly in this case). The supported values for yearly policies are
    FrequencyType string
    Frequency associated with the backup policy item. For yearly policies, the frequency type is defined as yearly. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.
    Id string
    Unique identifier of the backup policy item.
    RetentionUnit string
    Scope of the backup policy item: days, weeks, months, or years.
    RetentionValue int
    Value to associate with retention_unit. Yearly policy must have retention of at least 1 year.
    FrequencyInterval int
    Desired frequency of the new backup policy item specified by frequency_type (yearly in this case). The supported values for yearly policies are
    FrequencyType string
    Frequency associated with the backup policy item. For yearly policies, the frequency type is defined as yearly. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.
    Id string
    Unique identifier of the backup policy item.
    RetentionUnit string
    Scope of the backup policy item: days, weeks, months, or years.
    RetentionValue int
    Value to associate with retention_unit. Yearly policy must have retention of at least 1 year.
    frequencyInterval Integer
    Desired frequency of the new backup policy item specified by frequency_type (yearly in this case). The supported values for yearly policies are
    frequencyType String
    Frequency associated with the backup policy item. For yearly policies, the frequency type is defined as yearly. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.
    id String
    Unique identifier of the backup policy item.
    retentionUnit String
    Scope of the backup policy item: days, weeks, months, or years.
    retentionValue Integer
    Value to associate with retention_unit. Yearly policy must have retention of at least 1 year.
    frequencyInterval number
    Desired frequency of the new backup policy item specified by frequency_type (yearly in this case). The supported values for yearly policies are
    frequencyType string
    Frequency associated with the backup policy item. For yearly policies, the frequency type is defined as yearly. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.
    id string
    Unique identifier of the backup policy item.
    retentionUnit string
    Scope of the backup policy item: days, weeks, months, or years.
    retentionValue number
    Value to associate with retention_unit. Yearly policy must have retention of at least 1 year.
    frequency_interval int
    Desired frequency of the new backup policy item specified by frequency_type (yearly in this case). The supported values for yearly policies are
    frequency_type str
    Frequency associated with the backup policy item. For yearly policies, the frequency type is defined as yearly. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.
    id str
    Unique identifier of the backup policy item.
    retention_unit str
    Scope of the backup policy item: days, weeks, months, or years.
    retention_value int
    Value to associate with retention_unit. Yearly policy must have retention of at least 1 year.
    frequencyInterval Number
    Desired frequency of the new backup policy item specified by frequency_type (yearly in this case). The supported values for yearly policies are
    frequencyType String
    Frequency associated with the backup policy item. For yearly policies, the frequency type is defined as yearly. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.
    id String
    Unique identifier of the backup policy item.
    retentionUnit String
    Scope of the backup policy item: days, weeks, months, or years.
    retentionValue Number
    Value to associate with retention_unit. Yearly policy must have retention of at least 1 year.

    GetCloudBackupSchedulePolicyItemHourly

    FrequencyInterval int
    Desired frequency of the new backup policy item specified by frequency_type (yearly in this case). The supported values for yearly policies are
    FrequencyType string
    Frequency associated with the backup policy item. For yearly policies, the frequency type is defined as yearly. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.
    Id string
    Unique identifier of the backup policy item.
    RetentionUnit string
    Scope of the backup policy item: days, weeks, months, or years.
    RetentionValue int
    Value to associate with retention_unit. Yearly policy must have retention of at least 1 year.
    FrequencyInterval int
    Desired frequency of the new backup policy item specified by frequency_type (yearly in this case). The supported values for yearly policies are
    FrequencyType string
    Frequency associated with the backup policy item. For yearly policies, the frequency type is defined as yearly. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.
    Id string
    Unique identifier of the backup policy item.
    RetentionUnit string
    Scope of the backup policy item: days, weeks, months, or years.
    RetentionValue int
    Value to associate with retention_unit. Yearly policy must have retention of at least 1 year.
    frequencyInterval Integer
    Desired frequency of the new backup policy item specified by frequency_type (yearly in this case). The supported values for yearly policies are
    frequencyType String
    Frequency associated with the backup policy item. For yearly policies, the frequency type is defined as yearly. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.
    id String
    Unique identifier of the backup policy item.
    retentionUnit String
    Scope of the backup policy item: days, weeks, months, or years.
    retentionValue Integer
    Value to associate with retention_unit. Yearly policy must have retention of at least 1 year.
    frequencyInterval number
    Desired frequency of the new backup policy item specified by frequency_type (yearly in this case). The supported values for yearly policies are
    frequencyType string
    Frequency associated with the backup policy item. For yearly policies, the frequency type is defined as yearly. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.
    id string
    Unique identifier of the backup policy item.
    retentionUnit string
    Scope of the backup policy item: days, weeks, months, or years.
    retentionValue number
    Value to associate with retention_unit. Yearly policy must have retention of at least 1 year.
    frequency_interval int
    Desired frequency of the new backup policy item specified by frequency_type (yearly in this case). The supported values for yearly policies are
    frequency_type str
    Frequency associated with the backup policy item. For yearly policies, the frequency type is defined as yearly. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.
    id str
    Unique identifier of the backup policy item.
    retention_unit str
    Scope of the backup policy item: days, weeks, months, or years.
    retention_value int
    Value to associate with retention_unit. Yearly policy must have retention of at least 1 year.
    frequencyInterval Number
    Desired frequency of the new backup policy item specified by frequency_type (yearly in this case). The supported values for yearly policies are
    frequencyType String
    Frequency associated with the backup policy item. For yearly policies, the frequency type is defined as yearly. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.
    id String
    Unique identifier of the backup policy item.
    retentionUnit String
    Scope of the backup policy item: days, weeks, months, or years.
    retentionValue Number
    Value to associate with retention_unit. Yearly policy must have retention of at least 1 year.

    GetCloudBackupSchedulePolicyItemMonthly

    FrequencyInterval int
    Desired frequency of the new backup policy item specified by frequency_type (yearly in this case). The supported values for yearly policies are
    FrequencyType string
    Frequency associated with the backup policy item. For yearly policies, the frequency type is defined as yearly. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.
    Id string
    Unique identifier of the backup policy item.
    RetentionUnit string
    Scope of the backup policy item: days, weeks, months, or years.
    RetentionValue int
    Value to associate with retention_unit. Yearly policy must have retention of at least 1 year.
    FrequencyInterval int
    Desired frequency of the new backup policy item specified by frequency_type (yearly in this case). The supported values for yearly policies are
    FrequencyType string
    Frequency associated with the backup policy item. For yearly policies, the frequency type is defined as yearly. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.
    Id string
    Unique identifier of the backup policy item.
    RetentionUnit string
    Scope of the backup policy item: days, weeks, months, or years.
    RetentionValue int
    Value to associate with retention_unit. Yearly policy must have retention of at least 1 year.
    frequencyInterval Integer
    Desired frequency of the new backup policy item specified by frequency_type (yearly in this case). The supported values for yearly policies are
    frequencyType String
    Frequency associated with the backup policy item. For yearly policies, the frequency type is defined as yearly. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.
    id String
    Unique identifier of the backup policy item.
    retentionUnit String
    Scope of the backup policy item: days, weeks, months, or years.
    retentionValue Integer
    Value to associate with retention_unit. Yearly policy must have retention of at least 1 year.
    frequencyInterval number
    Desired frequency of the new backup policy item specified by frequency_type (yearly in this case). The supported values for yearly policies are
    frequencyType string
    Frequency associated with the backup policy item. For yearly policies, the frequency type is defined as yearly. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.
    id string
    Unique identifier of the backup policy item.
    retentionUnit string
    Scope of the backup policy item: days, weeks, months, or years.
    retentionValue number
    Value to associate with retention_unit. Yearly policy must have retention of at least 1 year.
    frequency_interval int
    Desired frequency of the new backup policy item specified by frequency_type (yearly in this case). The supported values for yearly policies are
    frequency_type str
    Frequency associated with the backup policy item. For yearly policies, the frequency type is defined as yearly. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.
    id str
    Unique identifier of the backup policy item.
    retention_unit str
    Scope of the backup policy item: days, weeks, months, or years.
    retention_value int
    Value to associate with retention_unit. Yearly policy must have retention of at least 1 year.
    frequencyInterval Number
    Desired frequency of the new backup policy item specified by frequency_type (yearly in this case). The supported values for yearly policies are
    frequencyType String
    Frequency associated with the backup policy item. For yearly policies, the frequency type is defined as yearly. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.
    id String
    Unique identifier of the backup policy item.
    retentionUnit String
    Scope of the backup policy item: days, weeks, months, or years.
    retentionValue Number
    Value to associate with retention_unit. Yearly policy must have retention of at least 1 year.

    GetCloudBackupSchedulePolicyItemWeekly

    FrequencyInterval int
    Desired frequency of the new backup policy item specified by frequency_type (yearly in this case). The supported values for yearly policies are
    FrequencyType string
    Frequency associated with the backup policy item. For yearly policies, the frequency type is defined as yearly. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.
    Id string
    Unique identifier of the backup policy item.
    RetentionUnit string
    Scope of the backup policy item: days, weeks, months, or years.
    RetentionValue int
    Value to associate with retention_unit. Yearly policy must have retention of at least 1 year.
    FrequencyInterval int
    Desired frequency of the new backup policy item specified by frequency_type (yearly in this case). The supported values for yearly policies are
    FrequencyType string
    Frequency associated with the backup policy item. For yearly policies, the frequency type is defined as yearly. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.
    Id string
    Unique identifier of the backup policy item.
    RetentionUnit string
    Scope of the backup policy item: days, weeks, months, or years.
    RetentionValue int
    Value to associate with retention_unit. Yearly policy must have retention of at least 1 year.
    frequencyInterval Integer
    Desired frequency of the new backup policy item specified by frequency_type (yearly in this case). The supported values for yearly policies are
    frequencyType String
    Frequency associated with the backup policy item. For yearly policies, the frequency type is defined as yearly. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.
    id String
    Unique identifier of the backup policy item.
    retentionUnit String
    Scope of the backup policy item: days, weeks, months, or years.
    retentionValue Integer
    Value to associate with retention_unit. Yearly policy must have retention of at least 1 year.
    frequencyInterval number
    Desired frequency of the new backup policy item specified by frequency_type (yearly in this case). The supported values for yearly policies are
    frequencyType string
    Frequency associated with the backup policy item. For yearly policies, the frequency type is defined as yearly. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.
    id string
    Unique identifier of the backup policy item.
    retentionUnit string
    Scope of the backup policy item: days, weeks, months, or years.
    retentionValue number
    Value to associate with retention_unit. Yearly policy must have retention of at least 1 year.
    frequency_interval int
    Desired frequency of the new backup policy item specified by frequency_type (yearly in this case). The supported values for yearly policies are
    frequency_type str
    Frequency associated with the backup policy item. For yearly policies, the frequency type is defined as yearly. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.
    id str
    Unique identifier of the backup policy item.
    retention_unit str
    Scope of the backup policy item: days, weeks, months, or years.
    retention_value int
    Value to associate with retention_unit. Yearly policy must have retention of at least 1 year.
    frequencyInterval Number
    Desired frequency of the new backup policy item specified by frequency_type (yearly in this case). The supported values for yearly policies are
    frequencyType String
    Frequency associated with the backup policy item. For yearly policies, the frequency type is defined as yearly. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.
    id String
    Unique identifier of the backup policy item.
    retentionUnit String
    Scope of the backup policy item: days, weeks, months, or years.
    retentionValue Number
    Value to associate with retention_unit. Yearly policy must have retention of at least 1 year.

    GetCloudBackupSchedulePolicyItemYearly

    FrequencyInterval int
    Desired frequency of the new backup policy item specified by frequency_type (yearly in this case). The supported values for yearly policies are
    FrequencyType string
    Frequency associated with the backup policy item. For yearly policies, the frequency type is defined as yearly. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.
    Id string
    Unique identifier of the backup policy item.
    RetentionUnit string
    Scope of the backup policy item: days, weeks, months, or years.
    RetentionValue int
    Value to associate with retention_unit. Yearly policy must have retention of at least 1 year.
    FrequencyInterval int
    Desired frequency of the new backup policy item specified by frequency_type (yearly in this case). The supported values for yearly policies are
    FrequencyType string
    Frequency associated with the backup policy item. For yearly policies, the frequency type is defined as yearly. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.
    Id string
    Unique identifier of the backup policy item.
    RetentionUnit string
    Scope of the backup policy item: days, weeks, months, or years.
    RetentionValue int
    Value to associate with retention_unit. Yearly policy must have retention of at least 1 year.
    frequencyInterval Integer
    Desired frequency of the new backup policy item specified by frequency_type (yearly in this case). The supported values for yearly policies are
    frequencyType String
    Frequency associated with the backup policy item. For yearly policies, the frequency type is defined as yearly. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.
    id String
    Unique identifier of the backup policy item.
    retentionUnit String
    Scope of the backup policy item: days, weeks, months, or years.
    retentionValue Integer
    Value to associate with retention_unit. Yearly policy must have retention of at least 1 year.
    frequencyInterval number
    Desired frequency of the new backup policy item specified by frequency_type (yearly in this case). The supported values for yearly policies are
    frequencyType string
    Frequency associated with the backup policy item. For yearly policies, the frequency type is defined as yearly. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.
    id string
    Unique identifier of the backup policy item.
    retentionUnit string
    Scope of the backup policy item: days, weeks, months, or years.
    retentionValue number
    Value to associate with retention_unit. Yearly policy must have retention of at least 1 year.
    frequency_interval int
    Desired frequency of the new backup policy item specified by frequency_type (yearly in this case). The supported values for yearly policies are
    frequency_type str
    Frequency associated with the backup policy item. For yearly policies, the frequency type is defined as yearly. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.
    id str
    Unique identifier of the backup policy item.
    retention_unit str
    Scope of the backup policy item: days, weeks, months, or years.
    retention_value int
    Value to associate with retention_unit. Yearly policy must have retention of at least 1 year.
    frequencyInterval Number
    Desired frequency of the new backup policy item specified by frequency_type (yearly in this case). The supported values for yearly policies are
    frequencyType String
    Frequency associated with the backup policy item. For yearly policies, the frequency type is defined as yearly. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.
    id String
    Unique identifier of the backup policy item.
    retentionUnit String
    Scope of the backup policy item: days, weeks, months, or years.
    retentionValue Number
    Value to associate with retention_unit. Yearly policy must have retention of at least 1 year.

    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
    MongoDB Atlas v3.31.0 published on Tuesday, May 6, 2025 by Pulumi
    pulumi/pulumi-mongodbatlas