1. Packages
  2. MongoDB Atlas
  3. API Docs
  4. CloudBackupSchedule
MongoDB Atlas v3.16.1 published on Saturday, Jun 15, 2024 by Pulumi

mongodbatlas.CloudBackupSchedule

Explore with Pulumi AI

mongodbatlas logo
MongoDB Atlas v3.16.1 published on Saturday, Jun 15, 2024 by Pulumi

    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 see: MongoDB Atlas API Reference.

    Create CloudBackupSchedule Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new CloudBackupSchedule(name: string, args: CloudBackupScheduleArgs, opts?: CustomResourceOptions);
    @overload
    def CloudBackupSchedule(resource_name: str,
                            args: CloudBackupScheduleArgs,
                            opts: Optional[ResourceOptions] = None)
    
    @overload
    def CloudBackupSchedule(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            project_id: Optional[str] = None,
                            cluster_name: Optional[str] = None,
                            export: Optional[CloudBackupScheduleExportArgs] = None,
                            auto_export_enabled: Optional[bool] = 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,
                            policy_item_yearlies: Optional[Sequence[CloudBackupSchedulePolicyItemYearlyArgs]] = None,
                            copy_settings: Optional[Sequence[CloudBackupScheduleCopySettingArgs]] = 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)
    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.
    
    

    Parameters

    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.

    Example

    The following reference example uses placeholder values for all input properties.

    var cloudBackupScheduleResource = new Mongodbatlas.CloudBackupSchedule("cloudBackupScheduleResource", new()
    {
        ProjectId = "string",
        ClusterName = "string",
        Export = new Mongodbatlas.Inputs.CloudBackupScheduleExportArgs
        {
            ExportBucketId = "string",
            FrequencyType = "string",
        },
        AutoExportEnabled = false,
        PolicyItemDaily = new Mongodbatlas.Inputs.CloudBackupSchedulePolicyItemDailyArgs
        {
            FrequencyInterval = 0,
            RetentionUnit = "string",
            RetentionValue = 0,
            FrequencyType = "string",
            Id = "string",
        },
        PolicyItemHourly = new Mongodbatlas.Inputs.CloudBackupSchedulePolicyItemHourlyArgs
        {
            FrequencyInterval = 0,
            RetentionUnit = "string",
            RetentionValue = 0,
            FrequencyType = "string",
            Id = "string",
        },
        PolicyItemMonthlies = new[]
        {
            new Mongodbatlas.Inputs.CloudBackupSchedulePolicyItemMonthlyArgs
            {
                FrequencyInterval = 0,
                RetentionUnit = "string",
                RetentionValue = 0,
                FrequencyType = "string",
                Id = "string",
            },
        },
        PolicyItemWeeklies = new[]
        {
            new Mongodbatlas.Inputs.CloudBackupSchedulePolicyItemWeeklyArgs
            {
                FrequencyInterval = 0,
                RetentionUnit = "string",
                RetentionValue = 0,
                FrequencyType = "string",
                Id = "string",
            },
        },
        PolicyItemYearlies = new[]
        {
            new Mongodbatlas.Inputs.CloudBackupSchedulePolicyItemYearlyArgs
            {
                FrequencyInterval = 0,
                RetentionUnit = "string",
                RetentionValue = 0,
                FrequencyType = "string",
                Id = "string",
            },
        },
        CopySettings = new[]
        {
            new Mongodbatlas.Inputs.CloudBackupScheduleCopySettingArgs
            {
                CloudProvider = "string",
                Frequencies = new[]
                {
                    "string",
                },
                RegionName = "string",
                ReplicationSpecId = "string",
                ShouldCopyOplogs = false,
            },
        },
        ReferenceHourOfDay = 0,
        ReferenceMinuteOfHour = 0,
        RestoreWindowDays = 0,
        UpdateSnapshots = false,
        UseOrgAndGroupNamesInExportPrefix = false,
    });
    
    example, err := mongodbatlas.NewCloudBackupSchedule(ctx, "cloudBackupScheduleResource", &mongodbatlas.CloudBackupScheduleArgs{
    	ProjectId:   pulumi.String("string"),
    	ClusterName: pulumi.String("string"),
    	Export: &mongodbatlas.CloudBackupScheduleExportArgs{
    		ExportBucketId: pulumi.String("string"),
    		FrequencyType:  pulumi.String("string"),
    	},
    	AutoExportEnabled: pulumi.Bool(false),
    	PolicyItemDaily: &mongodbatlas.CloudBackupSchedulePolicyItemDailyArgs{
    		FrequencyInterval: pulumi.Int(0),
    		RetentionUnit:     pulumi.String("string"),
    		RetentionValue:    pulumi.Int(0),
    		FrequencyType:     pulumi.String("string"),
    		Id:                pulumi.String("string"),
    	},
    	PolicyItemHourly: &mongodbatlas.CloudBackupSchedulePolicyItemHourlyArgs{
    		FrequencyInterval: pulumi.Int(0),
    		RetentionUnit:     pulumi.String("string"),
    		RetentionValue:    pulumi.Int(0),
    		FrequencyType:     pulumi.String("string"),
    		Id:                pulumi.String("string"),
    	},
    	PolicyItemMonthlies: mongodbatlas.CloudBackupSchedulePolicyItemMonthlyArray{
    		&mongodbatlas.CloudBackupSchedulePolicyItemMonthlyArgs{
    			FrequencyInterval: pulumi.Int(0),
    			RetentionUnit:     pulumi.String("string"),
    			RetentionValue:    pulumi.Int(0),
    			FrequencyType:     pulumi.String("string"),
    			Id:                pulumi.String("string"),
    		},
    	},
    	PolicyItemWeeklies: mongodbatlas.CloudBackupSchedulePolicyItemWeeklyArray{
    		&mongodbatlas.CloudBackupSchedulePolicyItemWeeklyArgs{
    			FrequencyInterval: pulumi.Int(0),
    			RetentionUnit:     pulumi.String("string"),
    			RetentionValue:    pulumi.Int(0),
    			FrequencyType:     pulumi.String("string"),
    			Id:                pulumi.String("string"),
    		},
    	},
    	PolicyItemYearlies: mongodbatlas.CloudBackupSchedulePolicyItemYearlyArray{
    		&mongodbatlas.CloudBackupSchedulePolicyItemYearlyArgs{
    			FrequencyInterval: pulumi.Int(0),
    			RetentionUnit:     pulumi.String("string"),
    			RetentionValue:    pulumi.Int(0),
    			FrequencyType:     pulumi.String("string"),
    			Id:                pulumi.String("string"),
    		},
    	},
    	CopySettings: mongodbatlas.CloudBackupScheduleCopySettingArray{
    		&mongodbatlas.CloudBackupScheduleCopySettingArgs{
    			CloudProvider: pulumi.String("string"),
    			Frequencies: pulumi.StringArray{
    				pulumi.String("string"),
    			},
    			RegionName:        pulumi.String("string"),
    			ReplicationSpecId: pulumi.String("string"),
    			ShouldCopyOplogs:  pulumi.Bool(false),
    		},
    	},
    	ReferenceHourOfDay:                pulumi.Int(0),
    	ReferenceMinuteOfHour:             pulumi.Int(0),
    	RestoreWindowDays:                 pulumi.Int(0),
    	UpdateSnapshots:                   pulumi.Bool(false),
    	UseOrgAndGroupNamesInExportPrefix: pulumi.Bool(false),
    })
    
    var cloudBackupScheduleResource = new CloudBackupSchedule("cloudBackupScheduleResource", CloudBackupScheduleArgs.builder()
        .projectId("string")
        .clusterName("string")
        .export(CloudBackupScheduleExportArgs.builder()
            .exportBucketId("string")
            .frequencyType("string")
            .build())
        .autoExportEnabled(false)
        .policyItemDaily(CloudBackupSchedulePolicyItemDailyArgs.builder()
            .frequencyInterval(0)
            .retentionUnit("string")
            .retentionValue(0)
            .frequencyType("string")
            .id("string")
            .build())
        .policyItemHourly(CloudBackupSchedulePolicyItemHourlyArgs.builder()
            .frequencyInterval(0)
            .retentionUnit("string")
            .retentionValue(0)
            .frequencyType("string")
            .id("string")
            .build())
        .policyItemMonthlies(CloudBackupSchedulePolicyItemMonthlyArgs.builder()
            .frequencyInterval(0)
            .retentionUnit("string")
            .retentionValue(0)
            .frequencyType("string")
            .id("string")
            .build())
        .policyItemWeeklies(CloudBackupSchedulePolicyItemWeeklyArgs.builder()
            .frequencyInterval(0)
            .retentionUnit("string")
            .retentionValue(0)
            .frequencyType("string")
            .id("string")
            .build())
        .policyItemYearlies(CloudBackupSchedulePolicyItemYearlyArgs.builder()
            .frequencyInterval(0)
            .retentionUnit("string")
            .retentionValue(0)
            .frequencyType("string")
            .id("string")
            .build())
        .copySettings(CloudBackupScheduleCopySettingArgs.builder()
            .cloudProvider("string")
            .frequencies("string")
            .regionName("string")
            .replicationSpecId("string")
            .shouldCopyOplogs(false)
            .build())
        .referenceHourOfDay(0)
        .referenceMinuteOfHour(0)
        .restoreWindowDays(0)
        .updateSnapshots(false)
        .useOrgAndGroupNamesInExportPrefix(false)
        .build());
    
    cloud_backup_schedule_resource = mongodbatlas.CloudBackupSchedule("cloudBackupScheduleResource",
        project_id="string",
        cluster_name="string",
        export=mongodbatlas.CloudBackupScheduleExportArgs(
            export_bucket_id="string",
            frequency_type="string",
        ),
        auto_export_enabled=False,
        policy_item_daily=mongodbatlas.CloudBackupSchedulePolicyItemDailyArgs(
            frequency_interval=0,
            retention_unit="string",
            retention_value=0,
            frequency_type="string",
            id="string",
        ),
        policy_item_hourly=mongodbatlas.CloudBackupSchedulePolicyItemHourlyArgs(
            frequency_interval=0,
            retention_unit="string",
            retention_value=0,
            frequency_type="string",
            id="string",
        ),
        policy_item_monthlies=[mongodbatlas.CloudBackupSchedulePolicyItemMonthlyArgs(
            frequency_interval=0,
            retention_unit="string",
            retention_value=0,
            frequency_type="string",
            id="string",
        )],
        policy_item_weeklies=[mongodbatlas.CloudBackupSchedulePolicyItemWeeklyArgs(
            frequency_interval=0,
            retention_unit="string",
            retention_value=0,
            frequency_type="string",
            id="string",
        )],
        policy_item_yearlies=[mongodbatlas.CloudBackupSchedulePolicyItemYearlyArgs(
            frequency_interval=0,
            retention_unit="string",
            retention_value=0,
            frequency_type="string",
            id="string",
        )],
        copy_settings=[mongodbatlas.CloudBackupScheduleCopySettingArgs(
            cloud_provider="string",
            frequencies=["string"],
            region_name="string",
            replication_spec_id="string",
            should_copy_oplogs=False,
        )],
        reference_hour_of_day=0,
        reference_minute_of_hour=0,
        restore_window_days=0,
        update_snapshots=False,
        use_org_and_group_names_in_export_prefix=False)
    
    const cloudBackupScheduleResource = new mongodbatlas.CloudBackupSchedule("cloudBackupScheduleResource", {
        projectId: "string",
        clusterName: "string",
        "export": {
            exportBucketId: "string",
            frequencyType: "string",
        },
        autoExportEnabled: false,
        policyItemDaily: {
            frequencyInterval: 0,
            retentionUnit: "string",
            retentionValue: 0,
            frequencyType: "string",
            id: "string",
        },
        policyItemHourly: {
            frequencyInterval: 0,
            retentionUnit: "string",
            retentionValue: 0,
            frequencyType: "string",
            id: "string",
        },
        policyItemMonthlies: [{
            frequencyInterval: 0,
            retentionUnit: "string",
            retentionValue: 0,
            frequencyType: "string",
            id: "string",
        }],
        policyItemWeeklies: [{
            frequencyInterval: 0,
            retentionUnit: "string",
            retentionValue: 0,
            frequencyType: "string",
            id: "string",
        }],
        policyItemYearlies: [{
            frequencyInterval: 0,
            retentionUnit: "string",
            retentionValue: 0,
            frequencyType: "string",
            id: "string",
        }],
        copySettings: [{
            cloudProvider: "string",
            frequencies: ["string"],
            regionName: "string",
            replicationSpecId: "string",
            shouldCopyOplogs: false,
        }],
        referenceHourOfDay: 0,
        referenceMinuteOfHour: 0,
        restoreWindowDays: 0,
        updateSnapshots: false,
        useOrgAndGroupNamesInExportPrefix: false,
    });
    
    type: mongodbatlas:CloudBackupSchedule
    properties:
        autoExportEnabled: false
        clusterName: string
        copySettings:
            - cloudProvider: string
              frequencies:
                - string
              regionName: string
              replicationSpecId: string
              shouldCopyOplogs: false
        export:
            exportBucketId: string
            frequencyType: string
        policyItemDaily:
            frequencyInterval: 0
            frequencyType: string
            id: string
            retentionUnit: string
            retentionValue: 0
        policyItemHourly:
            frequencyInterval: 0
            frequencyType: string
            id: string
            retentionUnit: string
            retentionValue: 0
        policyItemMonthlies:
            - frequencyInterval: 0
              frequencyType: string
              id: string
              retentionUnit: string
              retentionValue: 0
        policyItemWeeklies:
            - frequencyInterval: 0
              frequencyType: string
              id: string
              retentionUnit: string
              retentionValue: 0
        policyItemYearlies:
            - frequencyInterval: 0
              frequencyType: string
              id: string
              retentionUnit: string
              retentionValue: 0
        projectId: string
        referenceHourOfDay: 0
        referenceMinuteOfHour: 0
        restoreWindowDays: 0
        updateSnapshots: false
        useOrgAndGroupNamesInExportPrefix: false
    

    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:

    • true - enables automatic export of cloud backup snapshots to the AWS bucket
    • false - disables automatic export of cloud backup snapshots to the AWS bucket (default)
    CopySettings List<CloudBackupScheduleCopySetting>
    Export CloudBackupScheduleExport
    PolicyItemDaily CloudBackupSchedulePolicyItemDaily
    Daily policy item
    PolicyItemHourly CloudBackupSchedulePolicyItemHourly
    Hourly policy item
    PolicyItemMonthlies List<CloudBackupSchedulePolicyItemMonthly>
    Monthly policy item
    PolicyItemWeeklies List<CloudBackupSchedulePolicyItemWeekly>
    Weekly policy item
    PolicyItemYearlies List<CloudBackupSchedulePolicyItemYearly>
    Yearly 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
    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:

    • true - enables automatic export of cloud backup snapshots to the AWS bucket
    • false - disables automatic export of cloud backup snapshots to the AWS bucket (default)
    CopySettings []CloudBackupScheduleCopySettingArgs
    Export CloudBackupScheduleExportArgs
    PolicyItemDaily CloudBackupSchedulePolicyItemDailyArgs
    Daily policy item
    PolicyItemHourly CloudBackupSchedulePolicyItemHourlyArgs
    Hourly policy item
    PolicyItemMonthlies []CloudBackupSchedulePolicyItemMonthlyArgs
    Monthly policy item
    PolicyItemWeeklies []CloudBackupSchedulePolicyItemWeeklyArgs
    Weekly policy item
    PolicyItemYearlies []CloudBackupSchedulePolicyItemYearlyArgs
    Yearly 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
    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:

    • true - enables automatic export of cloud backup snapshots to the AWS bucket
    • false - disables automatic export of cloud backup snapshots to the AWS bucket (default)
    copySettings List<CloudBackupScheduleCopySetting>
    export CloudBackupScheduleExport
    policyItemDaily CloudBackupSchedulePolicyItemDaily
    Daily policy item
    policyItemHourly CloudBackupSchedulePolicyItemHourly
    Hourly policy item
    policyItemMonthlies List<CloudBackupSchedulePolicyItemMonthly>
    Monthly policy item
    policyItemWeeklies List<CloudBackupSchedulePolicyItemWeekly>
    Weekly policy item
    policyItemYearlies List<CloudBackupSchedulePolicyItemYearly>
    Yearly 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
    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:

    • true - enables automatic export of cloud backup snapshots to the AWS bucket
    • false - disables automatic export of cloud backup snapshots to the AWS bucket (default)
    copySettings CloudBackupScheduleCopySetting[]
    export CloudBackupScheduleExport
    policyItemDaily CloudBackupSchedulePolicyItemDaily
    Daily policy item
    policyItemHourly CloudBackupSchedulePolicyItemHourly
    Hourly policy item
    policyItemMonthlies CloudBackupSchedulePolicyItemMonthly[]
    Monthly policy item
    policyItemWeeklies CloudBackupSchedulePolicyItemWeekly[]
    Weekly policy item
    policyItemYearlies CloudBackupSchedulePolicyItemYearly[]
    Yearly 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
    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:

    • true - enables automatic export of cloud backup snapshots to the AWS bucket
    • false - disables automatic export of cloud backup snapshots to the AWS bucket (default)
    copy_settings Sequence[CloudBackupScheduleCopySettingArgs]
    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
    policy_item_yearlies Sequence[CloudBackupSchedulePolicyItemYearlyArgs]
    Yearly 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
    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:

    • true - enables automatic export of cloud backup snapshots to the AWS bucket
    • false - disables automatic export of cloud backup snapshots to the AWS bucket (default)
    copySettings List<Property Map>
    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
    policyItemYearlies List<Property Map>
    Yearly 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
    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 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,
            copy_settings: Optional[Sequence[CloudBackupScheduleCopySettingArgs]] = 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,
            policy_item_yearlies: Optional[Sequence[CloudBackupSchedulePolicyItemYearlyArgs]] = 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:

    • true - enables automatic export of cloud backup snapshots to the AWS bucket
    • false - disables automatic export of cloud backup snapshots to the AWS bucket (default)
    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.
    CopySettings List<CloudBackupScheduleCopySetting>
    Export CloudBackupScheduleExport
    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 CloudBackupSchedulePolicyItemDaily
    Daily policy item
    PolicyItemHourly CloudBackupSchedulePolicyItemHourly
    Hourly policy item
    PolicyItemMonthlies List<CloudBackupSchedulePolicyItemMonthly>
    Monthly policy item
    PolicyItemWeeklies List<CloudBackupSchedulePolicyItemWeekly>
    Weekly policy item
    PolicyItemYearlies List<CloudBackupSchedulePolicyItemYearly>
    Yearly 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
    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:

    • true - enables automatic export of cloud backup snapshots to the AWS bucket
    • false - disables automatic export of cloud backup snapshots to the AWS bucket (default)
    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.
    CopySettings []CloudBackupScheduleCopySettingArgs
    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
    PolicyItemYearlies []CloudBackupSchedulePolicyItemYearlyArgs
    Yearly 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
    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:

    • true - enables automatic export of cloud backup snapshots to the AWS bucket
    • false - disables automatic export of cloud backup snapshots to the AWS bucket (default)
    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.
    copySettings List<CloudBackupScheduleCopySetting>
    export CloudBackupScheduleExport
    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 CloudBackupSchedulePolicyItemDaily
    Daily policy item
    policyItemHourly CloudBackupSchedulePolicyItemHourly
    Hourly policy item
    policyItemMonthlies List<CloudBackupSchedulePolicyItemMonthly>
    Monthly policy item
    policyItemWeeklies List<CloudBackupSchedulePolicyItemWeekly>
    Weekly policy item
    policyItemYearlies List<CloudBackupSchedulePolicyItemYearly>
    Yearly 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
    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:

    • true - enables automatic export of cloud backup snapshots to the AWS bucket
    • false - disables automatic export of cloud backup snapshots to the AWS bucket (default)
    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.
    copySettings CloudBackupScheduleCopySetting[]
    export CloudBackupScheduleExport
    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 CloudBackupSchedulePolicyItemDaily
    Daily policy item
    policyItemHourly CloudBackupSchedulePolicyItemHourly
    Hourly policy item
    policyItemMonthlies CloudBackupSchedulePolicyItemMonthly[]
    Monthly policy item
    policyItemWeeklies CloudBackupSchedulePolicyItemWeekly[]
    Weekly policy item
    policyItemYearlies CloudBackupSchedulePolicyItemYearly[]
    Yearly 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
    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:

    • true - enables automatic export of cloud backup snapshots to the AWS bucket
    • false - disables automatic export of cloud backup snapshots to the AWS bucket (default)
    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.
    copy_settings Sequence[CloudBackupScheduleCopySettingArgs]
    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
    policy_item_yearlies Sequence[CloudBackupSchedulePolicyItemYearlyArgs]
    Yearly 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
    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:

    • true - enables automatic export of cloud backup snapshots to the AWS bucket
    • false - disables automatic export of cloud backup snapshots to the AWS bucket (default)
    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.
    copySettings List<Property Map>
    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
    policyItemYearlies List<Property Map>
    Yearly 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
    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

    CloudBackupScheduleCopySetting, CloudBackupScheduleCopySettingArgs

    CloudBackupScheduleExport, CloudBackupScheduleExportArgs

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

    FrequencyInterval int
    Desired frequency of the new backup policy item specified by frequency_type (daily in this case). The only supported value for daily policies is 1 day.
    RetentionUnit string
    Scope of the backup policy item: days, weeks, months, or years.
    RetentionValue int
    Value to associate with retention_unit. 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 hourly policy item specifies a retention of two days, the daily retention policy must specify two days or greater.
    FrequencyType string
    Frequency associated with the backup policy item. For daily policies, the frequency type is defined as daily. 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.
    FrequencyInterval int
    Desired frequency of the new backup policy item specified by frequency_type (daily in this case). The only supported value for daily policies is 1 day.
    RetentionUnit string
    Scope of the backup policy item: days, weeks, months, or years.
    RetentionValue int
    Value to associate with retention_unit. 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 hourly policy item specifies a retention of two days, the daily retention policy must specify two days or greater.
    FrequencyType string
    Frequency associated with the backup policy item. For daily policies, the frequency type is defined as daily. 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.
    frequencyInterval Integer
    Desired frequency of the new backup policy item specified by frequency_type (daily in this case). The only supported value for daily policies is 1 day.
    retentionUnit String
    Scope of the backup policy item: days, weeks, months, or years.
    retentionValue Integer
    Value to associate with retention_unit. 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 hourly policy item specifies a retention of two days, the daily retention policy must specify two days or greater.
    frequencyType String
    Frequency associated with the backup policy item. For daily policies, the frequency type is defined as daily. 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.
    frequencyInterval number
    Desired frequency of the new backup policy item specified by frequency_type (daily in this case). The only supported value for daily policies is 1 day.
    retentionUnit string
    Scope of the backup policy item: days, weeks, months, or years.
    retentionValue number
    Value to associate with retention_unit. 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 hourly policy item specifies a retention of two days, the daily retention policy must specify two days or greater.
    frequencyType string
    Frequency associated with the backup policy item. For daily policies, the frequency type is defined as daily. 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.
    frequency_interval int
    Desired frequency of the new backup policy item specified by frequency_type (daily in this case). The only supported value for daily policies is 1 day.
    retention_unit str
    Scope of the backup policy item: days, weeks, months, or years.
    retention_value int
    Value to associate with retention_unit. 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 hourly policy item specifies a retention of two days, the daily retention policy must specify two days or greater.
    frequency_type str
    Frequency associated with the backup policy item. For daily policies, the frequency type is defined as daily. 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.
    frequencyInterval Number
    Desired frequency of the new backup policy item specified by frequency_type (daily in this case). The only supported value for daily policies is 1 day.
    retentionUnit String
    Scope of the backup policy item: days, weeks, months, or years.
    retentionValue Number
    Value to associate with retention_unit. 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 hourly policy item specifies a retention of two days, the daily retention policy must specify two days or greater.
    frequencyType String
    Frequency associated with the backup policy item. For daily policies, the frequency type is defined as daily. 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.

    CloudBackupSchedulePolicyItemHourly, CloudBackupSchedulePolicyItemHourlyArgs

    FrequencyInterval int
    Desired frequency of the new backup policy item specified by frequency_type (hourly in this case). The supported values for hourly policies are 1, 2, 4, 6, 8 or 12 hours. Note that 12 hours is the only accepted value for NVMe clusters.
    RetentionUnit string
    Scope of the backup policy item: days, weeks, months, or years.
    RetentionValue int
    Value to associate with retention_unit.
    FrequencyType string
    Frequency associated with the backup policy item. For hourly policies, the frequency type is defined as hourly. 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.
    FrequencyInterval int
    Desired frequency of the new backup policy item specified by frequency_type (hourly in this case). The supported values for hourly policies are 1, 2, 4, 6, 8 or 12 hours. Note that 12 hours is the only accepted value for NVMe clusters.
    RetentionUnit string
    Scope of the backup policy item: days, weeks, months, or years.
    RetentionValue int
    Value to associate with retention_unit.
    FrequencyType string
    Frequency associated with the backup policy item. For hourly policies, the frequency type is defined as hourly. 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.
    frequencyInterval Integer
    Desired frequency of the new backup policy item specified by frequency_type (hourly in this case). The supported values for hourly policies are 1, 2, 4, 6, 8 or 12 hours. Note that 12 hours is the only accepted value for NVMe clusters.
    retentionUnit String
    Scope of the backup policy item: days, weeks, months, or years.
    retentionValue Integer
    Value to associate with retention_unit.
    frequencyType String
    Frequency associated with the backup policy item. For hourly policies, the frequency type is defined as hourly. 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.
    frequencyInterval number
    Desired frequency of the new backup policy item specified by frequency_type (hourly in this case). The supported values for hourly policies are 1, 2, 4, 6, 8 or 12 hours. Note that 12 hours is the only accepted value for NVMe clusters.
    retentionUnit string
    Scope of the backup policy item: days, weeks, months, or years.
    retentionValue number
    Value to associate with retention_unit.
    frequencyType string
    Frequency associated with the backup policy item. For hourly policies, the frequency type is defined as hourly. 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.
    frequency_interval int
    Desired frequency of the new backup policy item specified by frequency_type (hourly in this case). The supported values for hourly policies are 1, 2, 4, 6, 8 or 12 hours. Note that 12 hours is the only accepted value for NVMe clusters.
    retention_unit str
    Scope of the backup policy item: days, weeks, months, or years.
    retention_value int
    Value to associate with retention_unit.
    frequency_type str
    Frequency associated with the backup policy item. For hourly policies, the frequency type is defined as hourly. 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.
    frequencyInterval Number
    Desired frequency of the new backup policy item specified by frequency_type (hourly in this case). The supported values for hourly policies are 1, 2, 4, 6, 8 or 12 hours. Note that 12 hours is the only accepted value for NVMe clusters.
    retentionUnit String
    Scope of the backup policy item: days, weeks, months, or years.
    retentionValue Number
    Value to associate with retention_unit.
    frequencyType String
    Frequency associated with the backup policy item. For hourly policies, the frequency type is defined as hourly. 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.

    CloudBackupSchedulePolicyItemMonthly, CloudBackupSchedulePolicyItemMonthlyArgs

    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
    RetentionUnit string
    Scope of the backup policy item: days, weeks, months, or years.
    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.
    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.
    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
    RetentionUnit string
    Scope of the backup policy item: days, weeks, months, or years.
    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.
    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.
    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
    retentionUnit String
    Scope of the backup policy item: days, weeks, months, or years.
    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.
    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.
    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
    retentionUnit string
    Scope of the backup policy item: days, weeks, months, or years.
    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.
    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.
    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
    retention_unit str
    Scope of the backup policy item: days, weeks, months, or years.
    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.
    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.
    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
    retentionUnit String
    Scope of the backup policy item: days, weeks, months, or years.
    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.
    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.

    CloudBackupSchedulePolicyItemWeekly, CloudBackupSchedulePolicyItemWeeklyArgs

    FrequencyInterval int
    Desired frequency of the new backup policy item specified by frequency_type (weekly in this case). The supported values for weekly policies are 1 through 7, where 1 represents Monday and 7 represents Sunday.
    RetentionUnit string
    Scope of the backup policy item: days, weeks, months, or years.
    RetentionValue int
    Value to associate with retention_unit. Weekly policy must have retention of at least 7 days or 1 week. 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 daily policy item specifies a retention of two weeks, the weekly retention policy must specify two weeks or greater.
    FrequencyType string
    Frequency associated with the backup policy item. For weekly policies, the frequency type is defined as weekly. 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.
    FrequencyInterval int
    Desired frequency of the new backup policy item specified by frequency_type (weekly in this case). The supported values for weekly policies are 1 through 7, where 1 represents Monday and 7 represents Sunday.
    RetentionUnit string
    Scope of the backup policy item: days, weeks, months, or years.
    RetentionValue int
    Value to associate with retention_unit. Weekly policy must have retention of at least 7 days or 1 week. 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 daily policy item specifies a retention of two weeks, the weekly retention policy must specify two weeks or greater.
    FrequencyType string
    Frequency associated with the backup policy item. For weekly policies, the frequency type is defined as weekly. 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.
    frequencyInterval Integer
    Desired frequency of the new backup policy item specified by frequency_type (weekly in this case). The supported values for weekly policies are 1 through 7, where 1 represents Monday and 7 represents Sunday.
    retentionUnit String
    Scope of the backup policy item: days, weeks, months, or years.
    retentionValue Integer
    Value to associate with retention_unit. Weekly policy must have retention of at least 7 days or 1 week. 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 daily policy item specifies a retention of two weeks, the weekly retention policy must specify two weeks or greater.
    frequencyType String
    Frequency associated with the backup policy item. For weekly policies, the frequency type is defined as weekly. 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.
    frequencyInterval number
    Desired frequency of the new backup policy item specified by frequency_type (weekly in this case). The supported values for weekly policies are 1 through 7, where 1 represents Monday and 7 represents Sunday.
    retentionUnit string
    Scope of the backup policy item: days, weeks, months, or years.
    retentionValue number
    Value to associate with retention_unit. Weekly policy must have retention of at least 7 days or 1 week. 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 daily policy item specifies a retention of two weeks, the weekly retention policy must specify two weeks or greater.
    frequencyType string
    Frequency associated with the backup policy item. For weekly policies, the frequency type is defined as weekly. 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.
    frequency_interval int
    Desired frequency of the new backup policy item specified by frequency_type (weekly in this case). The supported values for weekly policies are 1 through 7, where 1 represents Monday and 7 represents Sunday.
    retention_unit str
    Scope of the backup policy item: days, weeks, months, or years.
    retention_value int
    Value to associate with retention_unit. Weekly policy must have retention of at least 7 days or 1 week. 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 daily policy item specifies a retention of two weeks, the weekly retention policy must specify two weeks or greater.
    frequency_type str
    Frequency associated with the backup policy item. For weekly policies, the frequency type is defined as weekly. 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.
    frequencyInterval Number
    Desired frequency of the new backup policy item specified by frequency_type (weekly in this case). The supported values for weekly policies are 1 through 7, where 1 represents Monday and 7 represents Sunday.
    retentionUnit String
    Scope of the backup policy item: days, weeks, months, or years.
    retentionValue Number
    Value to associate with retention_unit. Weekly policy must have retention of at least 7 days or 1 week. 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 daily policy item specifies a retention of two weeks, the weekly retention policy must specify two weeks or greater.
    frequencyType String
    Frequency associated with the backup policy item. For weekly policies, the frequency type is defined as weekly. 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.

    CloudBackupSchedulePolicyItemYearly, CloudBackupSchedulePolicyItemYearlyArgs

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

    Package Details

    Repository
    MongoDB Atlas pulumi/pulumi-mongodbatlas
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the mongodbatlas Terraform Provider.
    mongodbatlas logo
    MongoDB Atlas v3.16.1 published on Saturday, Jun 15, 2024 by Pulumi