← All packages

MongoDB Atlas

v3.5.1 published on Thursday, Sep 15, 2022 by Pulumi
Source code
  1. Pulumi Registry
  2. MongoDB Atlas
  3. MongoDB Atlas
  4. CloudBackupSchedule

CloudBackupSchedule

Import

Cloud Backup Schedule entries can be imported using project_id and cluster_name, in the format PROJECTID-CLUSTERNAME, e.g.

 $ pulumi import mongodbatlas:index/cloudBackupSchedule:CloudBackupSchedule test 5d0f1f73cf09a29120e173cf-MyClusterTest

For more information seeMongoDB Atlas API Reference.

Create a CloudBackupSchedule Resource

new CloudBackupSchedule(name: string, args: CloudBackupScheduleArgs, opts?: CustomResourceOptions);
@overload
def CloudBackupSchedule(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        auto_export_enabled: Optional[bool] = None,
                        cluster_name: Optional[str] = None,
                        export: Optional[CloudBackupScheduleExportArgs] = None,
                        policy_item_daily: Optional[CloudBackupSchedulePolicyItemDailyArgs] = None,
                        policy_item_hourly: Optional[CloudBackupSchedulePolicyItemHourlyArgs] = None,
                        policy_item_monthlies: Optional[Sequence[CloudBackupSchedulePolicyItemMonthlyArgs]] = None,
                        policy_item_weeklies: Optional[Sequence[CloudBackupSchedulePolicyItemWeeklyArgs]] = None,
                        project_id: Optional[str] = None,
                        reference_hour_of_day: Optional[int] = None,
                        reference_minute_of_hour: Optional[int] = None,
                        restore_window_days: Optional[int] = None,
                        update_snapshots: Optional[bool] = None,
                        use_org_and_group_names_in_export_prefix: Optional[bool] = None)
@overload
def CloudBackupSchedule(resource_name: str,
                        args: CloudBackupScheduleArgs,
                        opts: Optional[ResourceOptions] = None)
func NewCloudBackupSchedule(ctx *Context, name string, args CloudBackupScheduleArgs, opts ...ResourceOption) (*CloudBackupSchedule, error)
public CloudBackupSchedule(string name, CloudBackupScheduleArgs args, CustomResourceOptions? opts = null)
public CloudBackupSchedule(String name, CloudBackupScheduleArgs args)
public CloudBackupSchedule(String name, CloudBackupScheduleArgs args, CustomResourceOptions options)

type: mongodbatlas:CloudBackupSchedule
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
name string
The unique name of the resource.
args CloudBackupScheduleArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args CloudBackupScheduleArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args CloudBackupScheduleArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args CloudBackupScheduleArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args CloudBackupScheduleArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

CloudBackupSchedule Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The CloudBackupSchedule resource accepts the following input properties:

ClusterName string

The name of the Atlas cluster that contains the snapshot backup policy you want to retrieve.

ProjectId string

The unique identifier of the project for the Atlas cluster.

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:

Export CloudBackupScheduleExportArgs
PolicyItemDaily CloudBackupSchedulePolicyItemDailyArgs

Daily policy item

PolicyItemHourly CloudBackupSchedulePolicyItemHourlyArgs

Hourly policy item

PolicyItemMonthlies List<CloudBackupSchedulePolicyItemMonthlyArgs>

Monthly policy item

PolicyItemWeeklies List<CloudBackupSchedulePolicyItemWeeklyArgs>

Weekly policy item

ReferenceHourOfDay int

UTC Hour of day between 0 and 23, inclusive, representing which hour of the day that Atlas takes snapshots for backup policy items.

ReferenceMinuteOfHour int

UTC Minutes after reference_hour_of_day that Atlas takes snapshots for backup policy items. Must be between 0 and 59, inclusive.

RestoreWindowDays int

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

UpdateSnapshots bool

Specify true to apply the retention changes in the updated backup policy to snapshots that Atlas took previously.

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.

ClusterName string

The name of the Atlas cluster that contains the snapshot backup policy you want to retrieve.

ProjectId string

The unique identifier of the project for the Atlas cluster.

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:

Export CloudBackupScheduleExportArgs
PolicyItemDaily CloudBackupSchedulePolicyItemDailyArgs

Daily policy item

PolicyItemHourly CloudBackupSchedulePolicyItemHourlyArgs

Hourly policy item

PolicyItemMonthlies []CloudBackupSchedulePolicyItemMonthlyArgs

Monthly policy item

PolicyItemWeeklies []CloudBackupSchedulePolicyItemWeeklyArgs

Weekly policy item

ReferenceHourOfDay int

UTC Hour of day between 0 and 23, inclusive, representing which hour of the day that Atlas takes snapshots for backup policy items.

ReferenceMinuteOfHour int

UTC Minutes after reference_hour_of_day that Atlas takes snapshots for backup policy items. Must be between 0 and 59, inclusive.

RestoreWindowDays int

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

UpdateSnapshots bool

Specify true to apply the retention changes in the updated backup policy to snapshots that Atlas took previously.

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.

clusterName String

The name of the Atlas cluster that contains the snapshot backup policy you want to retrieve.

projectId String

The unique identifier of the project for the Atlas cluster.

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:

export CloudBackupScheduleExportArgs
policyItemDaily CloudBackupSchedulePolicyItemDailyArgs

Daily policy item

policyItemHourly CloudBackupSchedulePolicyItemHourlyArgs

Hourly policy item

policyItemMonthlies List<CloudBackupSchedulePolicyItemMonthlyArgs>

Monthly policy item

policyItemWeeklies List<CloudBackupSchedulePolicyItemWeeklyArgs>

Weekly policy item

referenceHourOfDay Integer

UTC Hour of day between 0 and 23, inclusive, representing which hour of the day that Atlas takes snapshots for backup policy items.

referenceMinuteOfHour Integer

UTC Minutes after reference_hour_of_day that Atlas takes snapshots for backup policy items. Must be between 0 and 59, inclusive.

restoreWindowDays Integer

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

updateSnapshots Boolean

Specify true to apply the retention changes in the updated backup policy to snapshots that Atlas took previously.

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.

clusterName string

The name of the Atlas cluster that contains the snapshot backup policy you want to retrieve.

projectId string

The unique identifier of the project for the Atlas cluster.

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:

export CloudBackupScheduleExportArgs
policyItemDaily CloudBackupSchedulePolicyItemDailyArgs

Daily policy item

policyItemHourly CloudBackupSchedulePolicyItemHourlyArgs

Hourly policy item

policyItemMonthlies CloudBackupSchedulePolicyItemMonthlyArgs[]

Monthly policy item

policyItemWeeklies CloudBackupSchedulePolicyItemWeeklyArgs[]

Weekly policy item

referenceHourOfDay number

UTC Hour of day between 0 and 23, inclusive, representing which hour of the day that Atlas takes snapshots for backup policy items.

referenceMinuteOfHour number

UTC Minutes after reference_hour_of_day that Atlas takes snapshots for backup policy items. Must be between 0 and 59, inclusive.

restoreWindowDays number

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

updateSnapshots boolean

Specify true to apply the retention changes in the updated backup policy to snapshots that Atlas took previously.

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.

cluster_name str

The name of the Atlas cluster that contains the snapshot backup policy you want to retrieve.

project_id str

The unique identifier of the project for the Atlas cluster.

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:

export CloudBackupScheduleExportArgs
policy_item_daily CloudBackupSchedulePolicyItemDailyArgs

Daily policy item

policy_item_hourly CloudBackupSchedulePolicyItemHourlyArgs

Hourly policy item

policy_item_monthlies Sequence[CloudBackupSchedulePolicyItemMonthlyArgs]

Monthly policy item

policy_item_weeklies Sequence[CloudBackupSchedulePolicyItemWeeklyArgs]

Weekly policy item

reference_hour_of_day int

UTC Hour of day between 0 and 23, inclusive, representing which hour of the day that Atlas takes snapshots for backup policy items.

reference_minute_of_hour int

UTC Minutes after reference_hour_of_day that Atlas takes snapshots for backup policy items. Must be between 0 and 59, inclusive.

restore_window_days int

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

update_snapshots bool

Specify true to apply the retention changes in the updated backup policy to snapshots that Atlas took previously.

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.

clusterName String

The name of the Atlas cluster that contains the snapshot backup policy you want to retrieve.

projectId String

The unique identifier of the project for the Atlas cluster.

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:

export Property Map
policyItemDaily Property Map

Daily policy item

policyItemHourly Property Map

Hourly policy item

policyItemMonthlies List<Property Map>

Monthly policy item

policyItemWeeklies List<Property Map>

Weekly policy item

referenceHourOfDay Number

UTC Hour of day between 0 and 23, inclusive, representing which hour of the day that Atlas takes snapshots for backup policy items.

referenceMinuteOfHour Number

UTC Minutes after reference_hour_of_day that Atlas takes snapshots for backup policy items. Must be between 0 and 59, inclusive.

restoreWindowDays Number

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

updateSnapshots Boolean

Specify true to apply the retention changes in the updated backup policy to snapshots that Atlas took previously.

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.

Outputs

All input properties are implicitly available as output properties. Additionally, the CloudBackupSchedule resource produces the following output properties:

ClusterId string

Unique identifier of the Atlas cluster.

Id string

The provider-assigned unique ID for this managed resource.

IdPolicy string

Unique identifier of the backup policy.

NextSnapshot string

Timestamp in the number of seconds that have elapsed since the UNIX epoch when Atlas takes the next snapshot.

ClusterId string

Unique identifier of the Atlas cluster.

Id string

The provider-assigned unique ID for this managed resource.

IdPolicy string

Unique identifier of the backup policy.

NextSnapshot string

Timestamp in the number of seconds that have elapsed since the UNIX epoch when Atlas takes the next snapshot.

clusterId String

Unique identifier of the Atlas cluster.

id String

The provider-assigned unique ID for this managed resource.

idPolicy String

Unique identifier of the backup policy.

nextSnapshot String

Timestamp in the number of seconds that have elapsed since the UNIX epoch when Atlas takes the next snapshot.

clusterId string

Unique identifier of the Atlas cluster.

id string

The provider-assigned unique ID for this managed resource.

idPolicy string

Unique identifier of the backup policy.

nextSnapshot string

Timestamp in the number of seconds that have elapsed since the UNIX epoch when Atlas takes the next snapshot.

cluster_id str

Unique identifier of the Atlas cluster.

id str

The provider-assigned unique ID for this managed resource.

id_policy str

Unique identifier of the backup policy.

next_snapshot str

Timestamp in the number of seconds that have elapsed since the UNIX epoch when Atlas takes the next snapshot.

clusterId String

Unique identifier of the Atlas cluster.

id String

The provider-assigned unique ID for this managed resource.

idPolicy String

Unique identifier of the backup policy.

nextSnapshot String

Timestamp in the number of seconds that have elapsed since the UNIX epoch when Atlas takes the next snapshot.

Look up an Existing CloudBackupSchedule Resource

Get an existing CloudBackupSchedule resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: CloudBackupScheduleState, opts?: CustomResourceOptions): CloudBackupSchedule
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        auto_export_enabled: Optional[bool] = None,
        cluster_id: Optional[str] = None,
        cluster_name: Optional[str] = None,
        export: Optional[CloudBackupScheduleExportArgs] = None,
        id_policy: Optional[str] = None,
        next_snapshot: Optional[str] = None,
        policy_item_daily: Optional[CloudBackupSchedulePolicyItemDailyArgs] = None,
        policy_item_hourly: Optional[CloudBackupSchedulePolicyItemHourlyArgs] = None,
        policy_item_monthlies: Optional[Sequence[CloudBackupSchedulePolicyItemMonthlyArgs]] = None,
        policy_item_weeklies: Optional[Sequence[CloudBackupSchedulePolicyItemWeeklyArgs]] = None,
        project_id: Optional[str] = None,
        reference_hour_of_day: Optional[int] = None,
        reference_minute_of_hour: Optional[int] = None,
        restore_window_days: Optional[int] = None,
        update_snapshots: Optional[bool] = None,
        use_org_and_group_names_in_export_prefix: Optional[bool] = None) -> CloudBackupSchedule
func GetCloudBackupSchedule(ctx *Context, name string, id IDInput, state *CloudBackupScheduleState, opts ...ResourceOption) (*CloudBackupSchedule, error)
public static CloudBackupSchedule Get(string name, Input<string> id, CloudBackupScheduleState? state, CustomResourceOptions? opts = null)
public static CloudBackupSchedule get(String name, Output<String> id, CloudBackupScheduleState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
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

The name of the Atlas cluster that contains the snapshot backup policy you want to retrieve.

Export CloudBackupScheduleExportArgs
IdPolicy string

Unique identifier of the backup policy.

NextSnapshot string

Timestamp in the number of seconds that have elapsed since the UNIX epoch when Atlas takes the next snapshot.

PolicyItemDaily CloudBackupSchedulePolicyItemDailyArgs

Daily policy item

PolicyItemHourly CloudBackupSchedulePolicyItemHourlyArgs

Hourly policy item

PolicyItemMonthlies List<CloudBackupSchedulePolicyItemMonthlyArgs>

Monthly policy item

PolicyItemWeeklies List<CloudBackupSchedulePolicyItemWeeklyArgs>

Weekly policy item

ProjectId string

The unique identifier of the project for the Atlas cluster.

ReferenceHourOfDay int

UTC Hour of day between 0 and 23, inclusive, representing which hour of the day that Atlas takes snapshots for backup policy items.

ReferenceMinuteOfHour int

UTC Minutes after reference_hour_of_day that Atlas takes snapshots for backup policy items. Must be between 0 and 59, inclusive.

RestoreWindowDays int

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

UpdateSnapshots bool

Specify true to apply the retention changes in the updated backup policy to snapshots that Atlas took previously.

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

The name of the Atlas cluster that contains the snapshot backup policy you want to retrieve.

Export CloudBackupScheduleExportArgs
IdPolicy string

Unique identifier of the backup policy.

NextSnapshot string

Timestamp in the number of seconds that have elapsed since the UNIX epoch when Atlas takes the next snapshot.

PolicyItemDaily CloudBackupSchedulePolicyItemDailyArgs

Daily policy item

PolicyItemHourly CloudBackupSchedulePolicyItemHourlyArgs

Hourly policy item

PolicyItemMonthlies []CloudBackupSchedulePolicyItemMonthlyArgs

Monthly policy item

PolicyItemWeeklies []CloudBackupSchedulePolicyItemWeeklyArgs

Weekly policy item

ProjectId string

The unique identifier of the project for the Atlas cluster.

ReferenceHourOfDay int

UTC Hour of day between 0 and 23, inclusive, representing which hour of the day that Atlas takes snapshots for backup policy items.

ReferenceMinuteOfHour int

UTC Minutes after reference_hour_of_day that Atlas takes snapshots for backup policy items. Must be between 0 and 59, inclusive.

RestoreWindowDays int

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

UpdateSnapshots bool

Specify true to apply the retention changes in the updated backup policy to snapshots that Atlas took previously.

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

The name of the Atlas cluster that contains the snapshot backup policy you want to retrieve.

export CloudBackupScheduleExportArgs
idPolicy String

Unique identifier of the backup policy.

nextSnapshot String

Timestamp in the number of seconds that have elapsed since the UNIX epoch when Atlas takes the next snapshot.

policyItemDaily CloudBackupSchedulePolicyItemDailyArgs

Daily policy item

policyItemHourly CloudBackupSchedulePolicyItemHourlyArgs

Hourly policy item

policyItemMonthlies List<CloudBackupSchedulePolicyItemMonthlyArgs>

Monthly policy item

policyItemWeeklies List<CloudBackupSchedulePolicyItemWeeklyArgs>

Weekly policy item

projectId String

The unique identifier of the project for the Atlas cluster.

referenceHourOfDay Integer

UTC Hour of day between 0 and 23, inclusive, representing which hour of the day that Atlas takes snapshots for backup policy items.

referenceMinuteOfHour Integer

UTC Minutes after reference_hour_of_day that Atlas takes snapshots for backup policy items. Must be between 0 and 59, inclusive.

restoreWindowDays Integer

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

updateSnapshots Boolean

Specify true to apply the retention changes in the updated backup policy to snapshots that Atlas took previously.

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

The name of the Atlas cluster that contains the snapshot backup policy you want to retrieve.

export CloudBackupScheduleExportArgs
idPolicy string

Unique identifier of the backup policy.

nextSnapshot string

Timestamp in the number of seconds that have elapsed since the UNIX epoch when Atlas takes the next snapshot.

policyItemDaily CloudBackupSchedulePolicyItemDailyArgs

Daily policy item

policyItemHourly CloudBackupSchedulePolicyItemHourlyArgs

Hourly policy item

policyItemMonthlies CloudBackupSchedulePolicyItemMonthlyArgs[]

Monthly policy item

policyItemWeeklies CloudBackupSchedulePolicyItemWeeklyArgs[]

Weekly policy item

projectId string

The unique identifier of the project for the Atlas cluster.

referenceHourOfDay number

UTC Hour of day between 0 and 23, inclusive, representing which hour of the day that Atlas takes snapshots for backup policy items.

referenceMinuteOfHour number

UTC Minutes after reference_hour_of_day that Atlas takes snapshots for backup policy items. Must be between 0 and 59, inclusive.

restoreWindowDays number

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

updateSnapshots boolean

Specify true to apply the retention changes in the updated backup policy to snapshots that Atlas took previously.

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

The name of the Atlas cluster that contains the snapshot backup policy you want to retrieve.

export CloudBackupScheduleExportArgs
id_policy str

Unique identifier of the backup policy.

next_snapshot str

Timestamp in the number of seconds that have elapsed since the UNIX epoch when Atlas takes the next snapshot.

policy_item_daily CloudBackupSchedulePolicyItemDailyArgs

Daily policy item

policy_item_hourly CloudBackupSchedulePolicyItemHourlyArgs

Hourly policy item

policy_item_monthlies Sequence[CloudBackupSchedulePolicyItemMonthlyArgs]

Monthly policy item

policy_item_weeklies Sequence[CloudBackupSchedulePolicyItemWeeklyArgs]

Weekly policy item

project_id str

The unique identifier of the project for the Atlas cluster.

reference_hour_of_day int

UTC Hour of day between 0 and 23, inclusive, representing which hour of the day that Atlas takes snapshots for backup policy items.

reference_minute_of_hour int

UTC Minutes after reference_hour_of_day that Atlas takes snapshots for backup policy items. Must be between 0 and 59, inclusive.

restore_window_days int

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

update_snapshots bool

Specify true to apply the retention changes in the updated backup policy to snapshots that Atlas took previously.

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

The name of the Atlas cluster that contains the snapshot backup policy you want to retrieve.

export Property Map
idPolicy String

Unique identifier of the backup policy.

nextSnapshot String

Timestamp in the number of seconds that have elapsed since the UNIX epoch when Atlas takes the next snapshot.

policyItemDaily Property Map

Daily policy item

policyItemHourly Property Map

Hourly policy item

policyItemMonthlies List<Property Map>

Monthly policy item

policyItemWeeklies List<Property Map>

Weekly policy item

projectId String

The unique identifier of the project for the Atlas cluster.

referenceHourOfDay Number

UTC Hour of day between 0 and 23, inclusive, representing which hour of the day that Atlas takes snapshots for backup policy items.

referenceMinuteOfHour Number

UTC Minutes after reference_hour_of_day that Atlas takes snapshots for backup policy items. Must be between 0 and 59, inclusive.

restoreWindowDays Number

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

updateSnapshots Boolean

Specify true to apply the retention changes in the updated backup policy to snapshots that Atlas took previously.

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

CloudBackupScheduleExport

ExportBucketId string

Unique identifier of the mongodbatlas.CloudBackupSnapshotExportBucket export_bucket_id value.

FrequencyType string

Frequency associated with the export snapshot item.

ExportBucketId string

Unique identifier of the mongodbatlas.CloudBackupSnapshotExportBucket export_bucket_id value.

FrequencyType string

Frequency associated with the export snapshot item.

exportBucketId String

Unique identifier of the mongodbatlas.CloudBackupSnapshotExportBucket export_bucket_id value.

frequencyType String

Frequency associated with the export snapshot item.

exportBucketId string

Unique identifier of the mongodbatlas.CloudBackupSnapshotExportBucket export_bucket_id value.

frequencyType string

Frequency associated with the export snapshot item.

export_bucket_id str

Unique identifier of the mongodbatlas.CloudBackupSnapshotExportBucket export_bucket_id value.

frequency_type str

Frequency associated with the export snapshot item.

exportBucketId String

Unique identifier of the mongodbatlas.CloudBackupSnapshotExportBucket export_bucket_id value.

frequencyType String

Frequency associated with the export snapshot item.

CloudBackupSchedulePolicyItemDaily

FrequencyInterval int

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

RetentionUnit string

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

RetentionValue int

Value to associate with retention_unit.

FrequencyType string

Frequency associated with the export snapshot item.

Id string
FrequencyInterval int

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

RetentionUnit string

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

RetentionValue int

Value to associate with retention_unit.

FrequencyType string

Frequency associated with the export snapshot item.

Id string
frequencyInterval Integer

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

retentionUnit String

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

retentionValue Integer

Value to associate with retention_unit.

frequencyType String

Frequency associated with the export snapshot item.

id String
frequencyInterval number

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

retentionUnit string

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

retentionValue number

Value to associate with retention_unit.

frequencyType string

Frequency associated with the export snapshot item.

id string
frequency_interval int

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

retention_unit str

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

retention_value int

Value to associate with retention_unit.

frequency_type str

Frequency associated with the export snapshot item.

id str
frequencyInterval Number

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

retentionUnit String

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

retentionValue Number

Value to associate with retention_unit.

frequencyType String

Frequency associated with the export snapshot item.

id String

CloudBackupSchedulePolicyItemHourly

FrequencyInterval int

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

RetentionUnit string

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

RetentionValue int

Value to associate with retention_unit.

FrequencyType string

Frequency associated with the export snapshot item.

Id string
FrequencyInterval int

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

RetentionUnit string

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

RetentionValue int

Value to associate with retention_unit.

FrequencyType string

Frequency associated with the export snapshot item.

Id string
frequencyInterval Integer

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

retentionUnit String

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

retentionValue Integer

Value to associate with retention_unit.

frequencyType String

Frequency associated with the export snapshot item.

id String
frequencyInterval number

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

retentionUnit string

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

retentionValue number

Value to associate with retention_unit.

frequencyType string

Frequency associated with the export snapshot item.

id string
frequency_interval int

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

retention_unit str

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

retention_value int

Value to associate with retention_unit.

frequency_type str

Frequency associated with the export snapshot item.

id str
frequencyInterval Number

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

retentionUnit String

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

retentionValue Number

Value to associate with retention_unit.

frequencyType String

Frequency associated with the export snapshot item.

id String

CloudBackupSchedulePolicyItemMonthly

FrequencyInterval int

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

RetentionUnit string

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

RetentionValue int

Value to associate with retention_unit.

FrequencyType string

Frequency associated with the export snapshot item.

Id string
FrequencyInterval int

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

RetentionUnit string

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

RetentionValue int

Value to associate with retention_unit.

FrequencyType string

Frequency associated with the export snapshot item.

Id string
frequencyInterval Integer

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

retentionUnit String

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

retentionValue Integer

Value to associate with retention_unit.

frequencyType String

Frequency associated with the export snapshot item.

id String
frequencyInterval number

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

retentionUnit string

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

retentionValue number

Value to associate with retention_unit.

frequencyType string

Frequency associated with the export snapshot item.

id string
frequency_interval int

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

retention_unit str

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

retention_value int

Value to associate with retention_unit.

frequency_type str

Frequency associated with the export snapshot item.

id str
frequencyInterval Number

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

retentionUnit String

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

retentionValue Number

Value to associate with retention_unit.

frequencyType String

Frequency associated with the export snapshot item.

id String

CloudBackupSchedulePolicyItemWeekly

FrequencyInterval int

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

RetentionUnit string

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

RetentionValue int

Value to associate with retention_unit.

FrequencyType string

Frequency associated with the export snapshot item.

Id string
FrequencyInterval int

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

RetentionUnit string

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

RetentionValue int

Value to associate with retention_unit.

FrequencyType string

Frequency associated with the export snapshot item.

Id string
frequencyInterval Integer

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

retentionUnit String

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

retentionValue Integer

Value to associate with retention_unit.

frequencyType String

Frequency associated with the export snapshot item.

id String
frequencyInterval number

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

retentionUnit string

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

retentionValue number

Value to associate with retention_unit.

frequencyType string

Frequency associated with the export snapshot item.

id string
frequency_interval int

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

retention_unit str

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

retention_value int

Value to associate with retention_unit.

frequency_type str

Frequency associated with the export snapshot item.

id str
frequencyInterval Number

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

retentionUnit String

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

retentionValue Number

Value to associate with retention_unit.

frequencyType String

Frequency associated with the export snapshot item.

id String

Package Details

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

This Pulumi package is based on the mongodbatlas Terraform Provider.