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
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
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
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
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
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
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

GetCloudBackupScheduleExport

ExportBucketId string

Unique identifier of the mongodbatlas.CloudBackupSnapshotExportBucket export_bucket_id value.

FrequencyType string

Frequency associated with the backup policy item.

ExportBucketId string

Unique identifier of the mongodbatlas.CloudBackupSnapshotExportBucket export_bucket_id value.

FrequencyType string

Frequency associated with the backup policy item.

exportBucketId String

Unique identifier of the mongodbatlas.CloudBackupSnapshotExportBucket export_bucket_id value.

frequencyType String

Frequency associated with the backup policy item.

exportBucketId string

Unique identifier of the mongodbatlas.CloudBackupSnapshotExportBucket export_bucket_id value.

frequencyType string

Frequency associated with the backup policy item.

export_bucket_id str

Unique identifier of the mongodbatlas.CloudBackupSnapshotExportBucket export_bucket_id value.

frequency_type str

Frequency associated with the backup policy item.

exportBucketId String

Unique identifier of the mongodbatlas.CloudBackupSnapshotExportBucket export_bucket_id value.

frequencyType String

Frequency associated with the backup policy item.

GetCloudBackupSchedulePolicyItemDaily

FrequencyInterval int

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

FrequencyType string

Frequency associated with the backup policy item.

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.

FrequencyInterval int

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

FrequencyType string

Frequency associated with the backup policy item.

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.

frequencyInterval Integer

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

frequencyType String

Frequency associated with the backup policy item.

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.

frequencyInterval number

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

frequencyType string

Frequency associated with the backup policy item.

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.

frequency_interval int

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

frequency_type str

Frequency associated with the backup policy item.

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.

frequencyInterval Number

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

frequencyType String

Frequency associated with the backup policy item.

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.

GetCloudBackupSchedulePolicyItemHourly

FrequencyInterval int

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

FrequencyType string

Frequency associated with the backup policy item.

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.

FrequencyInterval int

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

FrequencyType string

Frequency associated with the backup policy item.

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.

frequencyInterval Integer

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

frequencyType String

Frequency associated with the backup policy item.

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.

frequencyInterval number

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

frequencyType string

Frequency associated with the backup policy item.

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.

frequency_interval int

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

frequency_type str

Frequency associated with the backup policy item.

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.

frequencyInterval Number

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

frequencyType String

Frequency associated with the backup policy item.

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.

GetCloudBackupSchedulePolicyItemMonthly

FrequencyInterval int

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

FrequencyType string

Frequency associated with the backup policy item.

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.

FrequencyInterval int

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

FrequencyType string

Frequency associated with the backup policy item.

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.

frequencyInterval Integer

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

frequencyType String

Frequency associated with the backup policy item.

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.

frequencyInterval number

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

frequencyType string

Frequency associated with the backup policy item.

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.

frequency_interval int

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

frequency_type str

Frequency associated with the backup policy item.

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.

frequencyInterval Number

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

frequencyType String

Frequency associated with the backup policy item.

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.

GetCloudBackupSchedulePolicyItemWeekly

FrequencyInterval int

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

FrequencyType string

Frequency associated with the backup policy item.

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.

FrequencyInterval int

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

FrequencyType string

Frequency associated with the backup policy item.

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.

frequencyInterval Integer

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

frequencyType String

Frequency associated with the backup policy item.

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.

frequencyInterval number

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

frequencyType string

Frequency associated with the backup policy item.

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.

frequency_interval int

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

frequency_type str

Frequency associated with the backup policy item.

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.

frequencyInterval Number

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

frequencyType String

Frequency associated with the backup policy item.

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.

Package Details

Repository
https://github.com/pulumi/pulumi-mongodbatlas
License
Apache-2.0
Notes

This Pulumi package is based on the mongodbatlas Terraform Provider.