MongoDB Atlas v3.7.2, Mar 31 23

mongodbatlas.getCloudBackupSchedule

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,
                              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,
                              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)
// Output-based functions aren't available in Java yet

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.

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.

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.

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.

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.

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.

getCloudBackupSchedule Result

The following output properties are available:

AutoExportEnabled bool: Flag that indicates whether automatic export of cloud backup snapshots to the AWS bucket is enabled. Value can be one of the following:
ClusterId string: Unique identifier of the Atlas cluster.
ClusterName string
CopySettings List<GetCloudBackupScheduleCopySetting>
Exports List<GetCloudBackupScheduleExport>
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>: Daily policy item
PolicyItemHourlies List<GetCloudBackupSchedulePolicyItemHourly>: Hourly policy item
PolicyItemMonthlies List<GetCloudBackupSchedulePolicyItemMonthly>: Monthly policy item
PolicyItemWeeklies List<GetCloudBackupSchedulePolicyItemWeekly>: Weekly policy item
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 S3 bucket after it finishes exporting the snapshots. To learn more about the metadata files that Atlas uploads, see Export Cloud Backup Snapshot.

AutoExportEnabled bool: Flag that indicates whether automatic export of cloud backup snapshots to the AWS bucket is enabled. Value can be one of the following:
ClusterId string: Unique identifier of the Atlas cluster.
ClusterName string
CopySettings []GetCloudBackupScheduleCopySetting
Exports []GetCloudBackupScheduleExport
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: Daily policy item
PolicyItemHourlies []GetCloudBackupSchedulePolicyItemHourly: Hourly policy item
PolicyItemMonthlies []GetCloudBackupSchedulePolicyItemMonthly: Monthly policy item
PolicyItemWeeklies []GetCloudBackupSchedulePolicyItemWeekly: Weekly policy item
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 S3 bucket after it finishes exporting the snapshots. To learn more about the metadata files that Atlas uploads, see Export Cloud Backup Snapshot.

autoExportEnabled Boolean: Flag that indicates whether automatic export of cloud backup snapshots to the AWS bucket is enabled. Value can be one of the following:
clusterId String: Unique identifier of the Atlas cluster.
clusterName String
copySettings List<GetCloudBackupScheduleCopySetting>
exports List<GetCloudBackupScheduleExport>
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>: Daily policy item
policyItemHourlies List<GetCloudBackupSchedulePolicyItemHourly>: Hourly policy item
policyItemMonthlies List<GetCloudBackupSchedulePolicyItemMonthly>: Monthly policy item
policyItemWeeklies List<GetCloudBackupSchedulePolicyItemWeekly>: Weekly policy item
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 S3 bucket after it finishes exporting the snapshots. To learn more about the metadata files that Atlas uploads, see Export Cloud Backup Snapshot.

autoExportEnabled boolean: Flag that indicates whether automatic export of cloud backup snapshots to the AWS bucket is enabled. Value can be one of the following:
clusterId string: Unique identifier of the Atlas cluster.
clusterName string
copySettings GetCloudBackupScheduleCopySetting[]
exports GetCloudBackupScheduleExport[]
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[]: Daily policy item
policyItemHourlies GetCloudBackupSchedulePolicyItemHourly[]: Hourly policy item
policyItemMonthlies GetCloudBackupSchedulePolicyItemMonthly[]: Monthly policy item
policyItemWeeklies GetCloudBackupSchedulePolicyItemWeekly[]: Weekly policy item
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 S3 bucket after it finishes exporting the snapshots. To learn more about the metadata files that Atlas uploads, see Export Cloud Backup Snapshot.

auto_export_enabled bool: Flag that indicates whether automatic export of cloud backup snapshots to the AWS bucket is enabled. Value can be one of the following:
cluster_id str: Unique identifier of the Atlas cluster.
cluster_name str
copy_settings Sequence[GetCloudBackupScheduleCopySetting]
exports Sequence[GetCloudBackupScheduleExport]
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]: Daily policy item
policy_item_hourlies Sequence[GetCloudBackupSchedulePolicyItemHourly]: Hourly policy item
policy_item_monthlies Sequence[GetCloudBackupSchedulePolicyItemMonthly]: Monthly policy item
policy_item_weeklies Sequence[GetCloudBackupSchedulePolicyItemWeekly]: Weekly policy item
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 S3 bucket after it finishes exporting the snapshots. To learn more about the metadata files that Atlas uploads, see Export Cloud Backup Snapshot.

autoExportEnabled Boolean: Flag that indicates whether automatic export of cloud backup snapshots to the AWS bucket is enabled. Value can be one of the following:
clusterId String: Unique identifier of the Atlas cluster.
clusterName String
copySettings List<Property Map>
exports List<Property Map>
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>: Daily policy item
policyItemHourlies List<Property Map>: Hourly policy item
policyItemMonthlies List<Property Map>: Monthly policy item
policyItemWeeklies List<Property Map>: Weekly policy item
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 S3 bucket after it finishes exporting the snapshots. To learn more about the metadata files that Atlas uploads, see Export Cloud Backup Snapshot.

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" "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, do a GET request to Return One Cluster in One Project and consult the replicationSpecs array https://www.mongodb.com/docs/atlas/reference/api-resources-spec/#operation/returnOneCluster
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.

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" "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, do a GET request to Return One Cluster in One Project and consult the replicationSpecs array https://www.mongodb.com/docs/atlas/reference/api-resources-spec/#operation/returnOneCluster
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.

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" "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, do a GET request to Return One Cluster in One Project and consult the replicationSpecs array https://www.mongodb.com/docs/atlas/reference/api-resources-spec/#operation/returnOneCluster
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.

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" "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, do a GET request to Return One Cluster in One Project and consult the replicationSpecs array https://www.mongodb.com/docs/atlas/reference/api-resources-spec/#operation/returnOneCluster
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.

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" "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, do a GET request to Return One Cluster in One Project and consult the replicationSpecs array https://www.mongodb.com/docs/atlas/reference/api-resources-spec/#operation/returnOneCluster
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.

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" "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, do a GET request to Return One Cluster in One Project and consult the replicationSpecs array https://www.mongodb.com/docs/atlas/reference/api-resources-spec/#operation/returnOneCluster
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.

GetCloudBackupScheduleExport

ExportBucketId string: Unique identifier of the mongodbatlas.CloudBackupSnapshotExportBucket export_bucket_id value.
FrequencyType string: Frequency associated with the backup policy item. For monthly policies, the frequency type is defined as monthly. 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 monthly policies, the frequency type is defined as monthly. 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 monthly policies, the frequency type is defined as monthly. 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 monthly policies, the frequency type is defined as monthly. 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 monthly policies, the frequency type is defined as monthly. 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 monthly policies, the frequency type is defined as monthly. 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 (monthly in this case). The supported values for weekly policies are
FrequencyType string: Frequency associated with the backup policy item. For monthly policies, the frequency type is defined as monthly. 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, or months.
RetentionValue int: Value to associate with retention_unit. Monthly policy must have retention days of at least 31 days or 5 weeks or 1 month. Note that for less frequent policy items, Atlas requires that you specify a retention period greater than or equal to the retention period specified for more frequent policy items. For example: If the weekly policy item specifies a retention of two weeks, the montly retention policy must specify two weeks or greater.

FrequencyInterval int: Desired frequency of the new backup policy item specified by frequency_type (monthly in this case). The supported values for weekly policies are
FrequencyType string: Frequency associated with the backup policy item. For monthly policies, the frequency type is defined as monthly. 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, or months.
RetentionValue int: Value to associate with retention_unit. Monthly policy must have retention days of at least 31 days or 5 weeks or 1 month. Note that for less frequent policy items, Atlas requires that you specify a retention period greater than or equal to the retention period specified for more frequent policy items. For example: If the weekly policy item specifies a retention of two weeks, the montly retention policy must specify two weeks or greater.

frequencyInterval Integer: Desired frequency of the new backup policy item specified by frequency_type (monthly in this case). The supported values for weekly policies are
frequencyType String: Frequency associated with the backup policy item. For monthly policies, the frequency type is defined as monthly. 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, or months.
retentionValue Integer: Value to associate with retention_unit. Monthly policy must have retention days of at least 31 days or 5 weeks or 1 month. Note that for less frequent policy items, Atlas requires that you specify a retention period greater than or equal to the retention period specified for more frequent policy items. For example: If the weekly policy item specifies a retention of two weeks, the montly retention policy must specify two weeks or greater.

frequencyInterval number: Desired frequency of the new backup policy item specified by frequency_type (monthly in this case). The supported values for weekly policies are
frequencyType string: Frequency associated with the backup policy item. For monthly policies, the frequency type is defined as monthly. 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, or months.
retentionValue number: Value to associate with retention_unit. Monthly policy must have retention days of at least 31 days or 5 weeks or 1 month. Note that for less frequent policy items, Atlas requires that you specify a retention period greater than or equal to the retention period specified for more frequent policy items. For example: If the weekly policy item specifies a retention of two weeks, the montly retention policy must specify two weeks or greater.

frequency_interval int: Desired frequency of the new backup policy item specified by frequency_type (monthly in this case). The supported values for weekly policies are
frequency_type str: Frequency associated with the backup policy item. For monthly policies, the frequency type is defined as monthly. 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, or months.
retention_value int: Value to associate with retention_unit. Monthly policy must have retention days of at least 31 days or 5 weeks or 1 month. Note that for less frequent policy items, Atlas requires that you specify a retention period greater than or equal to the retention period specified for more frequent policy items. For example: If the weekly policy item specifies a retention of two weeks, the montly retention policy must specify two weeks or greater.

frequencyInterval Number: Desired frequency of the new backup policy item specified by frequency_type (monthly in this case). The supported values for weekly policies are
frequencyType String: Frequency associated with the backup policy item. For monthly policies, the frequency type is defined as monthly. 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, or months.
retentionValue Number: Value to associate with retention_unit. Monthly policy must have retention days of at least 31 days or 5 weeks or 1 month. Note that for less frequent policy items, Atlas requires that you specify a retention period greater than or equal to the retention period specified for more frequent policy items. For example: If the weekly policy item specifies a retention of two weeks, the montly retention policy must specify two weeks or greater.

GetCloudBackupSchedulePolicyItemHourly

FrequencyInterval int: Desired frequency of the new backup policy item specified by frequency_type (monthly in this case). The supported values for weekly policies are
FrequencyType string: Frequency associated with the backup policy item. For monthly policies, the frequency type is defined as monthly. 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, or months.
RetentionValue int: Value to associate with retention_unit. Monthly policy must have retention days of at least 31 days or 5 weeks or 1 month. Note that for less frequent policy items, Atlas requires that you specify a retention period greater than or equal to the retention period specified for more frequent policy items. For example: If the weekly policy item specifies a retention of two weeks, the montly retention policy must specify two weeks or greater.

FrequencyInterval int: Desired frequency of the new backup policy item specified by frequency_type (monthly in this case). The supported values for weekly policies are
FrequencyType string: Frequency associated with the backup policy item. For monthly policies, the frequency type is defined as monthly. 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, or months.
RetentionValue int: Value to associate with retention_unit. Monthly policy must have retention days of at least 31 days or 5 weeks or 1 month. Note that for less frequent policy items, Atlas requires that you specify a retention period greater than or equal to the retention period specified for more frequent policy items. For example: If the weekly policy item specifies a retention of two weeks, the montly retention policy must specify two weeks or greater.

frequencyInterval Integer: Desired frequency of the new backup policy item specified by frequency_type (monthly in this case). The supported values for weekly policies are
frequencyType String: Frequency associated with the backup policy item. For monthly policies, the frequency type is defined as monthly. 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, or months.
retentionValue Integer: Value to associate with retention_unit. Monthly policy must have retention days of at least 31 days or 5 weeks or 1 month. Note that for less frequent policy items, Atlas requires that you specify a retention period greater than or equal to the retention period specified for more frequent policy items. For example: If the weekly policy item specifies a retention of two weeks, the montly retention policy must specify two weeks or greater.

frequencyInterval number: Desired frequency of the new backup policy item specified by frequency_type (monthly in this case). The supported values for weekly policies are
frequencyType string: Frequency associated with the backup policy item. For monthly policies, the frequency type is defined as monthly. 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, or months.
retentionValue number: Value to associate with retention_unit. Monthly policy must have retention days of at least 31 days or 5 weeks or 1 month. Note that for less frequent policy items, Atlas requires that you specify a retention period greater than or equal to the retention period specified for more frequent policy items. For example: If the weekly policy item specifies a retention of two weeks, the montly retention policy must specify two weeks or greater.

frequency_interval int: Desired frequency of the new backup policy item specified by frequency_type (monthly in this case). The supported values for weekly policies are
frequency_type str: Frequency associated with the backup policy item. For monthly policies, the frequency type is defined as monthly. 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, or months.
retention_value int: Value to associate with retention_unit. Monthly policy must have retention days of at least 31 days or 5 weeks or 1 month. Note that for less frequent policy items, Atlas requires that you specify a retention period greater than or equal to the retention period specified for more frequent policy items. For example: If the weekly policy item specifies a retention of two weeks, the montly retention policy must specify two weeks or greater.

frequencyInterval Number: Desired frequency of the new backup policy item specified by frequency_type (monthly in this case). The supported values for weekly policies are
frequencyType String: Frequency associated with the backup policy item. For monthly policies, the frequency type is defined as monthly. 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, or months.
retentionValue Number: Value to associate with retention_unit. Monthly policy must have retention days of at least 31 days or 5 weeks or 1 month. Note that for less frequent policy items, Atlas requires that you specify a retention period greater than or equal to the retention period specified for more frequent policy items. For example: If the weekly policy item specifies a retention of two weeks, the montly retention policy must specify two weeks or greater.

GetCloudBackupSchedulePolicyItemMonthly

FrequencyInterval int: Desired frequency of the new backup policy item specified by frequency_type (monthly in this case). The supported values for weekly policies are
FrequencyType string: Frequency associated with the backup policy item. For monthly policies, the frequency type is defined as monthly. 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, or months.
RetentionValue int: Value to associate with retention_unit. Monthly policy must have retention days of at least 31 days or 5 weeks or 1 month. Note that for less frequent policy items, Atlas requires that you specify a retention period greater than or equal to the retention period specified for more frequent policy items. For example: If the weekly policy item specifies a retention of two weeks, the montly retention policy must specify two weeks or greater.

FrequencyInterval int: Desired frequency of the new backup policy item specified by frequency_type (monthly in this case). The supported values for weekly policies are
FrequencyType string: Frequency associated with the backup policy item. For monthly policies, the frequency type is defined as monthly. 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, or months.
RetentionValue int: Value to associate with retention_unit. Monthly policy must have retention days of at least 31 days or 5 weeks or 1 month. Note that for less frequent policy items, Atlas requires that you specify a retention period greater than or equal to the retention period specified for more frequent policy items. For example: If the weekly policy item specifies a retention of two weeks, the montly retention policy must specify two weeks or greater.

frequencyInterval Integer: Desired frequency of the new backup policy item specified by frequency_type (monthly in this case). The supported values for weekly policies are
frequencyType String: Frequency associated with the backup policy item. For monthly policies, the frequency type is defined as monthly. 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, or months.
retentionValue Integer: Value to associate with retention_unit. Monthly policy must have retention days of at least 31 days or 5 weeks or 1 month. Note that for less frequent policy items, Atlas requires that you specify a retention period greater than or equal to the retention period specified for more frequent policy items. For example: If the weekly policy item specifies a retention of two weeks, the montly retention policy must specify two weeks or greater.

frequencyInterval number: Desired frequency of the new backup policy item specified by frequency_type (monthly in this case). The supported values for weekly policies are
frequencyType string: Frequency associated with the backup policy item. For monthly policies, the frequency type is defined as monthly. 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, or months.
retentionValue number: Value to associate with retention_unit. Monthly policy must have retention days of at least 31 days or 5 weeks or 1 month. Note that for less frequent policy items, Atlas requires that you specify a retention period greater than or equal to the retention period specified for more frequent policy items. For example: If the weekly policy item specifies a retention of two weeks, the montly retention policy must specify two weeks or greater.

frequency_interval int: Desired frequency of the new backup policy item specified by frequency_type (monthly in this case). The supported values for weekly policies are
frequency_type str: Frequency associated with the backup policy item. For monthly policies, the frequency type is defined as monthly. 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, or months.
retention_value int: Value to associate with retention_unit. Monthly policy must have retention days of at least 31 days or 5 weeks or 1 month. Note that for less frequent policy items, Atlas requires that you specify a retention period greater than or equal to the retention period specified for more frequent policy items. For example: If the weekly policy item specifies a retention of two weeks, the montly retention policy must specify two weeks or greater.

frequencyInterval Number: Desired frequency of the new backup policy item specified by frequency_type (monthly in this case). The supported values for weekly policies are
frequencyType String: Frequency associated with the backup policy item. For monthly policies, the frequency type is defined as monthly. 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, or months.
retentionValue Number: Value to associate with retention_unit. Monthly policy must have retention days of at least 31 days or 5 weeks or 1 month. Note that for less frequent policy items, Atlas requires that you specify a retention period greater than or equal to the retention period specified for more frequent policy items. For example: If the weekly policy item specifies a retention of two weeks, the montly retention policy must specify two weeks or greater.

GetCloudBackupSchedulePolicyItemWeekly

FrequencyInterval int: Desired frequency of the new backup policy item specified by frequency_type (monthly in this case). The supported values for weekly policies are
FrequencyType string: Frequency associated with the backup policy item. For monthly policies, the frequency type is defined as monthly. 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, or months.
RetentionValue int: Value to associate with retention_unit. Monthly policy must have retention days of at least 31 days or 5 weeks or 1 month. Note that for less frequent policy items, Atlas requires that you specify a retention period greater than or equal to the retention period specified for more frequent policy items. For example: If the weekly policy item specifies a retention of two weeks, the montly retention policy must specify two weeks or greater.

FrequencyInterval int: Desired frequency of the new backup policy item specified by frequency_type (monthly in this case). The supported values for weekly policies are
FrequencyType string: Frequency associated with the backup policy item. For monthly policies, the frequency type is defined as monthly. 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, or months.
RetentionValue int: Value to associate with retention_unit. Monthly policy must have retention days of at least 31 days or 5 weeks or 1 month. Note that for less frequent policy items, Atlas requires that you specify a retention period greater than or equal to the retention period specified for more frequent policy items. For example: If the weekly policy item specifies a retention of two weeks, the montly retention policy must specify two weeks or greater.

frequencyInterval Integer: Desired frequency of the new backup policy item specified by frequency_type (monthly in this case). The supported values for weekly policies are
frequencyType String: Frequency associated with the backup policy item. For monthly policies, the frequency type is defined as monthly. 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, or months.
retentionValue Integer: Value to associate with retention_unit. Monthly policy must have retention days of at least 31 days or 5 weeks or 1 month. Note that for less frequent policy items, Atlas requires that you specify a retention period greater than or equal to the retention period specified for more frequent policy items. For example: If the weekly policy item specifies a retention of two weeks, the montly retention policy must specify two weeks or greater.

frequencyInterval number: Desired frequency of the new backup policy item specified by frequency_type (monthly in this case). The supported values for weekly policies are
frequencyType string: Frequency associated with the backup policy item. For monthly policies, the frequency type is defined as monthly. 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, or months.
retentionValue number: Value to associate with retention_unit. Monthly policy must have retention days of at least 31 days or 5 weeks or 1 month. Note that for less frequent policy items, Atlas requires that you specify a retention period greater than or equal to the retention period specified for more frequent policy items. For example: If the weekly policy item specifies a retention of two weeks, the montly retention policy must specify two weeks or greater.

frequency_interval int: Desired frequency of the new backup policy item specified by frequency_type (monthly in this case). The supported values for weekly policies are
frequency_type str: Frequency associated with the backup policy item. For monthly policies, the frequency type is defined as monthly. 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, or months.
retention_value int: Value to associate with retention_unit. Monthly policy must have retention days of at least 31 days or 5 weeks or 1 month. Note that for less frequent policy items, Atlas requires that you specify a retention period greater than or equal to the retention period specified for more frequent policy items. For example: If the weekly policy item specifies a retention of two weeks, the montly retention policy must specify two weeks or greater.

frequencyInterval Number: Desired frequency of the new backup policy item specified by frequency_type (monthly in this case). The supported values for weekly policies are
frequencyType String: Frequency associated with the backup policy item. For monthly policies, the frequency type is defined as monthly. 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, or months.
retentionValue Number: Value to associate with retention_unit. Monthly policy must have retention days of at least 31 days or 5 weeks or 1 month. Note that for less frequent policy items, Atlas requires that you specify a retention period greater than or equal to the retention period specified for more frequent policy items. For example: If the weekly policy item specifies a retention of two weeks, the montly retention policy must specify two weeks or greater.

Package Details

Repository: MongoDB Atlas pulumi/pulumi-mongodbatlas
License: Apache-2.0
Notes: This Pulumi package is based on the mongodbatlas Terraform Provider.