mongodbatlas.getCloudBackupSchedule
Explore with Pulumi AI
mongodbatlas.CloudBackupSchedule
provides a Cloud Backup Schedule datasource. An Atlas Cloud Backup Schedule provides the current cloud backup schedule for the cluster.
NOTE: Groups and projects are synonymous terms. You may find
groupId
in the official documentation.
Using getCloudBackupSchedule
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getCloudBackupSchedule(args: GetCloudBackupScheduleArgs, opts?: InvokeOptions): Promise<GetCloudBackupScheduleResult>
function getCloudBackupScheduleOutput(args: GetCloudBackupScheduleOutputArgs, opts?: InvokeOptions): Output<GetCloudBackupScheduleResult>
def get_cloud_backup_schedule(cluster_name: Optional[str] = None,
project_id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetCloudBackupScheduleResult
def get_cloud_backup_schedule_output(cluster_name: Optional[pulumi.Input[str]] = None,
project_id: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetCloudBackupScheduleResult]
func LookupCloudBackupSchedule(ctx *Context, args *LookupCloudBackupScheduleArgs, opts ...InvokeOption) (*LookupCloudBackupScheduleResult, error)
func LookupCloudBackupScheduleOutput(ctx *Context, args *LookupCloudBackupScheduleOutputArgs, opts ...InvokeOption) LookupCloudBackupScheduleResultOutput
> Note: This function is named LookupCloudBackupSchedule
in the Go SDK.
public static class GetCloudBackupSchedule
{
public static Task<GetCloudBackupScheduleResult> InvokeAsync(GetCloudBackupScheduleArgs args, InvokeOptions? opts = null)
public static Output<GetCloudBackupScheduleResult> Invoke(GetCloudBackupScheduleInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetCloudBackupScheduleResult> getCloudBackupSchedule(GetCloudBackupScheduleArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: mongodbatlas:index/getCloudBackupSchedule:getCloudBackupSchedule
arguments:
# arguments dictionary
The following arguments are supported:
- Cluster
Name string The name of the Atlas cluster that contains the snapshots backup policy you want to retrieve.
- Project
Id string The unique identifier of the project for the Atlas cluster.
- Cluster
Name string The name of the Atlas cluster that contains the snapshots backup policy you want to retrieve.
- Project
Id string The unique identifier of the project for the Atlas cluster.
- cluster
Name String The name of the Atlas cluster that contains the snapshots backup policy you want to retrieve.
- project
Id String The unique identifier of the project for the Atlas cluster.
- cluster
Name string The name of the Atlas cluster that contains the snapshots backup policy you want to retrieve.
- project
Id string The unique identifier of the project for the Atlas cluster.
- cluster_
name str The name of the Atlas cluster that contains the snapshots backup policy you want to retrieve.
- project_
id str The unique identifier of the project for the Atlas cluster.
- cluster
Name String The name of the Atlas cluster that contains the snapshots backup policy you want to retrieve.
- project
Id String The unique identifier of the project for the Atlas cluster.
getCloudBackupSchedule Result
The following output properties are available:
- Auto
Export boolEnabled 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 string Unique identifier of the Atlas cluster.
- Cluster
Name string - Copy
Settings List<GetCloud Backup Schedule Copy Setting> - Exports
List<Get
Cloud Backup Schedule Export> - Id string
The provider-assigned unique ID for this managed resource.
- Id
Policy string Unique identifier of the backup policy.
- Next
Snapshot string UTC ISO 8601 formatted point in time when Atlas will take the next snapshot.
- Policy
Item List<GetDailies Cloud Backup Schedule Policy Item Daily> Daily policy item
- Policy
Item List<GetHourlies Cloud Backup Schedule Policy Item Hourly> Hourly policy item
- Policy
Item List<GetMonthlies Cloud Backup Schedule Policy Item Monthly> Monthly policy item
- Policy
Item List<GetWeeklies Cloud Backup Schedule Policy Item Weekly> Weekly policy item
- Project
Id string - Reference
Hour intOf Day UTC Hour of day between 0 and 23 representing which hour of the day that Atlas takes a snapshot.
- Reference
Minute intOf Hour UTC Minute of day between 0 and 59 representing which minute of the
reference_hour_of_day
that Atlas takes the snapshot.- Restore
Window intDays Specifies a restore window in days for cloud backup to maintain.
- Use
Org boolAnd Group Names In Export Prefix 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 boolEnabled 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 string Unique identifier of the Atlas cluster.
- Cluster
Name string - Copy
Settings []GetCloud Backup Schedule Copy Setting - Exports
[]Get
Cloud Backup Schedule Export - Id string
The provider-assigned unique ID for this managed resource.
- Id
Policy string Unique identifier of the backup policy.
- Next
Snapshot string UTC ISO 8601 formatted point in time when Atlas will take the next snapshot.
- Policy
Item []GetDailies Cloud Backup Schedule Policy Item Daily Daily policy item
- Policy
Item []GetHourlies Cloud Backup Schedule Policy Item Hourly Hourly policy item
- Policy
Item []GetMonthlies Cloud Backup Schedule Policy Item Monthly Monthly policy item
- Policy
Item []GetWeeklies Cloud Backup Schedule Policy Item Weekly Weekly policy item
- Project
Id string - Reference
Hour intOf Day UTC Hour of day between 0 and 23 representing which hour of the day that Atlas takes a snapshot.
- Reference
Minute intOf Hour UTC Minute of day between 0 and 59 representing which minute of the
reference_hour_of_day
that Atlas takes the snapshot.- Restore
Window intDays Specifies a restore window in days for cloud backup to maintain.
- Use
Org boolAnd Group Names In Export Prefix 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 BooleanEnabled 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 String Unique identifier of the Atlas cluster.
- cluster
Name String - copy
Settings List<GetCloud Backup Schedule Copy Setting> - exports
List<Get
Cloud Backup Schedule Export> - id String
The provider-assigned unique ID for this managed resource.
- id
Policy String Unique identifier of the backup policy.
- next
Snapshot String UTC ISO 8601 formatted point in time when Atlas will take the next snapshot.
- policy
Item List<GetDailies Cloud Backup Schedule Policy Item Daily> Daily policy item
- policy
Item List<GetHourlies Cloud Backup Schedule Policy Item Hourly> Hourly policy item
- policy
Item List<GetMonthlies Cloud Backup Schedule Policy Item Monthly> Monthly policy item
- policy
Item List<GetWeeklies Cloud Backup Schedule Policy Item Weekly> Weekly policy item
- project
Id String - reference
Hour IntegerOf Day UTC Hour of day between 0 and 23 representing which hour of the day that Atlas takes a snapshot.
- reference
Minute IntegerOf Hour UTC Minute of day between 0 and 59 representing which minute of the
reference_hour_of_day
that Atlas takes the snapshot.- restore
Window IntegerDays Specifies a restore window in days for cloud backup to maintain.
- use
Org BooleanAnd Group Names In Export Prefix 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 booleanEnabled 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 string Unique identifier of the Atlas cluster.
- cluster
Name string - copy
Settings GetCloud Backup Schedule Copy Setting[] - exports
Get
Cloud Backup Schedule Export[] - id string
The provider-assigned unique ID for this managed resource.
- id
Policy string Unique identifier of the backup policy.
- next
Snapshot string UTC ISO 8601 formatted point in time when Atlas will take the next snapshot.
- policy
Item GetDailies Cloud Backup Schedule Policy Item Daily[] Daily policy item
- policy
Item GetHourlies Cloud Backup Schedule Policy Item Hourly[] Hourly policy item
- policy
Item GetMonthlies Cloud Backup Schedule Policy Item Monthly[] Monthly policy item
- policy
Item GetWeeklies Cloud Backup Schedule Policy Item Weekly[] Weekly policy item
- project
Id string - reference
Hour numberOf Day UTC Hour of day between 0 and 23 representing which hour of the day that Atlas takes a snapshot.
- reference
Minute numberOf Hour UTC Minute of day between 0 and 59 representing which minute of the
reference_hour_of_day
that Atlas takes the snapshot.- restore
Window numberDays Specifies a restore window in days for cloud backup to maintain.
- use
Org booleanAnd Group Names In Export Prefix 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_ boolenabled Flag that indicates whether automatic export of cloud backup snapshots to the AWS bucket is enabled. Value can be one of the following:
- cluster_
id str Unique identifier of the Atlas cluster.
- cluster_
name str - copy_
settings Sequence[GetCloud Backup Schedule Copy Setting] - exports
Sequence[Get
Cloud Backup Schedule Export] - id str
The provider-assigned unique ID for this managed resource.
- id_
policy str Unique identifier of the backup policy.
- next_
snapshot str UTC ISO 8601 formatted point in time when Atlas will take the next snapshot.
- policy_
item_ Sequence[Getdailies Cloud Backup Schedule Policy Item Daily] Daily policy item
- policy_
item_ Sequence[Gethourlies Cloud Backup Schedule Policy Item Hourly] Hourly policy item
- policy_
item_ Sequence[Getmonthlies Cloud Backup Schedule Policy Item Monthly] Monthly policy item
- policy_
item_ Sequence[Getweeklies Cloud Backup Schedule Policy Item Weekly] Weekly policy item
- project_
id str - reference_
hour_ intof_ day UTC Hour of day between 0 and 23 representing which hour of the day that Atlas takes a snapshot.
- reference_
minute_ intof_ hour UTC Minute of day between 0 and 59 representing which minute of the
reference_hour_of_day
that Atlas takes the snapshot.- restore_
window_ intdays Specifies a restore window in days for cloud backup to maintain.
- use_
org_ booland_ group_ names_ in_ export_ prefix 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 BooleanEnabled 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 String Unique identifier of the Atlas cluster.
- cluster
Name String - copy
Settings List<Property Map> - exports List<Property Map>
- id String
The provider-assigned unique ID for this managed resource.
- id
Policy String Unique identifier of the backup policy.
- next
Snapshot String UTC ISO 8601 formatted point in time when Atlas will take the next snapshot.
- policy
Item List<Property Map>Dailies Daily policy item
- policy
Item List<Property Map>Hourlies Hourly policy item
- policy
Item List<Property Map>Monthlies Monthly policy item
- policy
Item List<Property Map>Weeklies Weekly policy item
- project
Id String - reference
Hour NumberOf Day UTC Hour of day between 0 and 23 representing which hour of the day that Atlas takes a snapshot.
- reference
Minute NumberOf Hour UTC Minute of day between 0 and 59 representing which minute of the
reference_hour_of_day
that Atlas takes the snapshot.- restore
Window NumberDays Specifies a restore window in days for cloud backup to maintain.
- use
Org BooleanAnd Group Names In Export Prefix Specify true to use organization and project names instead of organization and project UUIDs in the path for the metadata files that Atlas uploads to your S3 bucket after it finishes exporting the snapshots. To learn more about the metadata files that Atlas uploads, see Export Cloud Backup Snapshot.
Supporting Types
GetCloudBackupScheduleCopySetting
- Cloud
Provider string Human-readable label that identifies the cloud provider that stores the snapshot copy. i.e. "AWS" "AZURE" "GCP"
- Frequencies List<string>
List that describes which types of snapshots to copy. i.e. "HOURLY" "DAILY" "WEEKLY" "MONTHLY" "ON_DEMAND"
- Region
Name string Target region to copy snapshots belonging to replicationSpecId to. Please supply the 'Atlas Region' which can be found under https://www.mongodb.com/docs/atlas/reference/cloud-providers/ 'regions' link
- Replication
Spec stringId Unique 24-hexadecimal digit string that identifies the replication object for a zone in a cluster. For global clusters, there can be multiple zones to choose from. For sharded clusters and replica set clusters, there is only one zone in the cluster. To find the Replication Spec Id, consult the replicationSpecs array returned from Return One Multi-Cloud Cluster in One Project.
- Should
Copy boolOplogs Flag that indicates whether to copy the oplogs to the target region. You can use the oplogs to perform point-in-time restores.
- Cloud
Provider string Human-readable label that identifies the cloud provider that stores the snapshot copy. i.e. "AWS" "AZURE" "GCP"
- Frequencies []string
List that describes which types of snapshots to copy. i.e. "HOURLY" "DAILY" "WEEKLY" "MONTHLY" "ON_DEMAND"
- Region
Name string Target region to copy snapshots belonging to replicationSpecId to. Please supply the 'Atlas Region' which can be found under https://www.mongodb.com/docs/atlas/reference/cloud-providers/ 'regions' link
- Replication
Spec stringId Unique 24-hexadecimal digit string that identifies the replication object for a zone in a cluster. For global clusters, there can be multiple zones to choose from. For sharded clusters and replica set clusters, there is only one zone in the cluster. To find the Replication Spec Id, consult the replicationSpecs array returned from Return One Multi-Cloud Cluster in One Project.
- Should
Copy boolOplogs Flag that indicates whether to copy the oplogs to the target region. You can use the oplogs to perform point-in-time restores.
- cloud
Provider String Human-readable label that identifies the cloud provider that stores the snapshot copy. i.e. "AWS" "AZURE" "GCP"
- frequencies List<String>
List that describes which types of snapshots to copy. i.e. "HOURLY" "DAILY" "WEEKLY" "MONTHLY" "ON_DEMAND"
- region
Name String Target region to copy snapshots belonging to replicationSpecId to. Please supply the 'Atlas Region' which can be found under https://www.mongodb.com/docs/atlas/reference/cloud-providers/ 'regions' link
- replication
Spec StringId Unique 24-hexadecimal digit string that identifies the replication object for a zone in a cluster. For global clusters, there can be multiple zones to choose from. For sharded clusters and replica set clusters, there is only one zone in the cluster. To find the Replication Spec Id, consult the replicationSpecs array returned from Return One Multi-Cloud Cluster in One Project.
- should
Copy BooleanOplogs Flag that indicates whether to copy the oplogs to the target region. You can use the oplogs to perform point-in-time restores.
- cloud
Provider string Human-readable label that identifies the cloud provider that stores the snapshot copy. i.e. "AWS" "AZURE" "GCP"
- frequencies string[]
List that describes which types of snapshots to copy. i.e. "HOURLY" "DAILY" "WEEKLY" "MONTHLY" "ON_DEMAND"
- region
Name string Target region to copy snapshots belonging to replicationSpecId to. Please supply the 'Atlas Region' which can be found under https://www.mongodb.com/docs/atlas/reference/cloud-providers/ 'regions' link
- replication
Spec stringId Unique 24-hexadecimal digit string that identifies the replication object for a zone in a cluster. For global clusters, there can be multiple zones to choose from. For sharded clusters and replica set clusters, there is only one zone in the cluster. To find the Replication Spec Id, consult the replicationSpecs array returned from Return One Multi-Cloud Cluster in One Project.
- should
Copy booleanOplogs Flag that indicates whether to copy the oplogs to the target region. You can use the oplogs to perform point-in-time restores.
- cloud_
provider str Human-readable label that identifies the cloud provider that stores the snapshot copy. i.e. "AWS" "AZURE" "GCP"
- frequencies Sequence[str]
List that describes which types of snapshots to copy. i.e. "HOURLY" "DAILY" "WEEKLY" "MONTHLY" "ON_DEMAND"
- region_
name str Target region to copy snapshots belonging to replicationSpecId to. Please supply the 'Atlas Region' which can be found under https://www.mongodb.com/docs/atlas/reference/cloud-providers/ 'regions' link
- replication_
spec_ strid Unique 24-hexadecimal digit string that identifies the replication object for a zone in a cluster. For global clusters, there can be multiple zones to choose from. For sharded clusters and replica set clusters, there is only one zone in the cluster. To find the Replication Spec Id, consult the replicationSpecs array returned from Return One Multi-Cloud Cluster in One Project.
- should_
copy_ booloplogs Flag that indicates whether to copy the oplogs to the target region. You can use the oplogs to perform point-in-time restores.
- cloud
Provider String Human-readable label that identifies the cloud provider that stores the snapshot copy. i.e. "AWS" "AZURE" "GCP"
- frequencies List<String>
List that describes which types of snapshots to copy. i.e. "HOURLY" "DAILY" "WEEKLY" "MONTHLY" "ON_DEMAND"
- region
Name String Target region to copy snapshots belonging to replicationSpecId to. Please supply the 'Atlas Region' which can be found under https://www.mongodb.com/docs/atlas/reference/cloud-providers/ 'regions' link
- replication
Spec StringId Unique 24-hexadecimal digit string that identifies the replication object for a zone in a cluster. For global clusters, there can be multiple zones to choose from. For sharded clusters and replica set clusters, there is only one zone in the cluster. To find the Replication Spec Id, consult the replicationSpecs array returned from Return One Multi-Cloud Cluster in One Project.
- should
Copy BooleanOplogs Flag that indicates whether to copy the oplogs to the target region. You can use the oplogs to perform point-in-time restores.
GetCloudBackupScheduleExport
- Export
Bucket stringId Unique identifier of the mongodbatlas.CloudBackupSnapshotExportBucket export_bucket_id value.
- Frequency
Type string Frequency associated with the backup policy item. For monthly policies, the frequency type is defined as
monthly
. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.
- Export
Bucket stringId Unique identifier of the mongodbatlas.CloudBackupSnapshotExportBucket export_bucket_id value.
- Frequency
Type string Frequency associated with the backup policy item. For monthly policies, the frequency type is defined as
monthly
. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.
- export
Bucket StringId Unique identifier of the mongodbatlas.CloudBackupSnapshotExportBucket export_bucket_id value.
- frequency
Type String Frequency associated with the backup policy item. For monthly policies, the frequency type is defined as
monthly
. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.
- export
Bucket stringId Unique identifier of the mongodbatlas.CloudBackupSnapshotExportBucket export_bucket_id value.
- frequency
Type string Frequency associated with the backup policy item. For monthly policies, the frequency type is defined as
monthly
. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.
- export_
bucket_ strid Unique identifier of the mongodbatlas.CloudBackupSnapshotExportBucket export_bucket_id value.
- frequency_
type str Frequency associated with the backup policy item. For monthly policies, the frequency type is defined as
monthly
. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.
- export
Bucket StringId Unique identifier of the mongodbatlas.CloudBackupSnapshotExportBucket export_bucket_id value.
- frequency
Type String Frequency associated with the backup policy item. For monthly policies, the frequency type is defined as
monthly
. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.
GetCloudBackupSchedulePolicyItemDaily
- Frequency
Interval int Desired frequency of the new backup policy item specified by
frequency_type
(monthly in this case). The supported values for weekly policies are- Frequency
Type 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.
- Retention
Unit string Scope of the backup policy item:
days
,weeks
, ormonths
.- 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
Interval int Desired frequency of the new backup policy item specified by
frequency_type
(monthly in this case). The supported values for weekly policies are- Frequency
Type 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.
- Retention
Unit string Scope of the backup policy item:
days
,weeks
, ormonths
.- 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
Interval Integer Desired frequency of the new backup policy item specified by
frequency_type
(monthly in this case). The supported values for weekly policies are- frequency
Type 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.
- retention
Unit String Scope of the backup policy item:
days
,weeks
, ormonths
.- retention
Value 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.
- frequency
Interval number Desired frequency of the new backup policy item specified by
frequency_type
(monthly in this case). The supported values for weekly policies are- frequency
Type 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.
- retention
Unit string Scope of the backup policy item:
days
,weeks
, ormonths
.- retention
Value number Value to associate with
retention_unit
. Monthly policy must have retention days of at least 31 days or 5 weeks or 1 month. Note that for less frequent policy items, Atlas requires that you specify a retention period greater than or equal to the retention period specified for more frequent policy items. For example: If the weekly policy item specifies a retention of two weeks, the montly retention policy must specify two weeks or greater.
- frequency_
interval int Desired frequency of the new backup policy item specified by
frequency_type
(monthly in this case). The supported values for weekly policies are- frequency_
type str Frequency associated with the backup policy item. For monthly policies, the frequency type is defined as
monthly
. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.- id str
Unique identifier of the backup policy item.
- retention_
unit str Scope of the backup policy item:
days
,weeks
, ormonths
.- 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
Interval Number Desired frequency of the new backup policy item specified by
frequency_type
(monthly in this case). The supported values for weekly policies are- frequency
Type 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.
- retention
Unit String Scope of the backup policy item:
days
,weeks
, ormonths
.- retention
Value Number Value to associate with
retention_unit
. Monthly policy must have retention days of at least 31 days or 5 weeks or 1 month. Note that for less frequent policy items, Atlas requires that you specify a retention period greater than or equal to the retention period specified for more frequent policy items. For example: If the weekly policy item specifies a retention of two weeks, the montly retention policy must specify two weeks or greater.
GetCloudBackupSchedulePolicyItemHourly
- Frequency
Interval int Desired frequency of the new backup policy item specified by
frequency_type
(monthly in this case). The supported values for weekly policies are- Frequency
Type 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.
- Retention
Unit string Scope of the backup policy item:
days
,weeks
, ormonths
.- 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
Interval int Desired frequency of the new backup policy item specified by
frequency_type
(monthly in this case). The supported values for weekly policies are- Frequency
Type 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.
- Retention
Unit string Scope of the backup policy item:
days
,weeks
, ormonths
.- 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
Interval Integer Desired frequency of the new backup policy item specified by
frequency_type
(monthly in this case). The supported values for weekly policies are- frequency
Type 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.
- retention
Unit String Scope of the backup policy item:
days
,weeks
, ormonths
.- retention
Value 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.
- frequency
Interval number Desired frequency of the new backup policy item specified by
frequency_type
(monthly in this case). The supported values for weekly policies are- frequency
Type 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.
- retention
Unit string Scope of the backup policy item:
days
,weeks
, ormonths
.- retention
Value number Value to associate with
retention_unit
. Monthly policy must have retention days of at least 31 days or 5 weeks or 1 month. Note that for less frequent policy items, Atlas requires that you specify a retention period greater than or equal to the retention period specified for more frequent policy items. For example: If the weekly policy item specifies a retention of two weeks, the montly retention policy must specify two weeks or greater.
- frequency_
interval int Desired frequency of the new backup policy item specified by
frequency_type
(monthly in this case). The supported values for weekly policies are- frequency_
type str Frequency associated with the backup policy item. For monthly policies, the frequency type is defined as
monthly
. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.- id str
Unique identifier of the backup policy item.
- retention_
unit str Scope of the backup policy item:
days
,weeks
, ormonths
.- 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
Interval Number Desired frequency of the new backup policy item specified by
frequency_type
(monthly in this case). The supported values for weekly policies are- frequency
Type 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.
- retention
Unit String Scope of the backup policy item:
days
,weeks
, ormonths
.- retention
Value Number Value to associate with
retention_unit
. Monthly policy must have retention days of at least 31 days or 5 weeks or 1 month. Note that for less frequent policy items, Atlas requires that you specify a retention period greater than or equal to the retention period specified for more frequent policy items. For example: If the weekly policy item specifies a retention of two weeks, the montly retention policy must specify two weeks or greater.
GetCloudBackupSchedulePolicyItemMonthly
- Frequency
Interval int Desired frequency of the new backup policy item specified by
frequency_type
(monthly in this case). The supported values for weekly policies are- Frequency
Type 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.
- Retention
Unit string Scope of the backup policy item:
days
,weeks
, ormonths
.- 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
Interval int Desired frequency of the new backup policy item specified by
frequency_type
(monthly in this case). The supported values for weekly policies are- Frequency
Type 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.
- Retention
Unit string Scope of the backup policy item:
days
,weeks
, ormonths
.- 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
Interval Integer Desired frequency of the new backup policy item specified by
frequency_type
(monthly in this case). The supported values for weekly policies are- frequency
Type 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.
- retention
Unit String Scope of the backup policy item:
days
,weeks
, ormonths
.- retention
Value 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.
- frequency
Interval number Desired frequency of the new backup policy item specified by
frequency_type
(monthly in this case). The supported values for weekly policies are- frequency
Type 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.
- retention
Unit string Scope of the backup policy item:
days
,weeks
, ormonths
.- retention
Value number Value to associate with
retention_unit
. Monthly policy must have retention days of at least 31 days or 5 weeks or 1 month. Note that for less frequent policy items, Atlas requires that you specify a retention period greater than or equal to the retention period specified for more frequent policy items. For example: If the weekly policy item specifies a retention of two weeks, the montly retention policy must specify two weeks or greater.
- frequency_
interval int Desired frequency of the new backup policy item specified by
frequency_type
(monthly in this case). The supported values for weekly policies are- frequency_
type str Frequency associated with the backup policy item. For monthly policies, the frequency type is defined as
monthly
. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.- id str
Unique identifier of the backup policy item.
- retention_
unit str Scope of the backup policy item:
days
,weeks
, ormonths
.- 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
Interval Number Desired frequency of the new backup policy item specified by
frequency_type
(monthly in this case). The supported values for weekly policies are- frequency
Type 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.
- retention
Unit String Scope of the backup policy item:
days
,weeks
, ormonths
.- retention
Value Number Value to associate with
retention_unit
. Monthly policy must have retention days of at least 31 days or 5 weeks or 1 month. Note that for less frequent policy items, Atlas requires that you specify a retention period greater than or equal to the retention period specified for more frequent policy items. For example: If the weekly policy item specifies a retention of two weeks, the montly retention policy must specify two weeks or greater.
GetCloudBackupSchedulePolicyItemWeekly
- Frequency
Interval int Desired frequency of the new backup policy item specified by
frequency_type
(monthly in this case). The supported values for weekly policies are- Frequency
Type 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.
- Retention
Unit string Scope of the backup policy item:
days
,weeks
, ormonths
.- 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
Interval int Desired frequency of the new backup policy item specified by
frequency_type
(monthly in this case). The supported values for weekly policies are- Frequency
Type 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.
- Retention
Unit string Scope of the backup policy item:
days
,weeks
, ormonths
.- 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
Interval Integer Desired frequency of the new backup policy item specified by
frequency_type
(monthly in this case). The supported values for weekly policies are- frequency
Type 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.
- retention
Unit String Scope of the backup policy item:
days
,weeks
, ormonths
.- retention
Value 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.
- frequency
Interval number Desired frequency of the new backup policy item specified by
frequency_type
(monthly in this case). The supported values for weekly policies are- frequency
Type 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.
- retention
Unit string Scope of the backup policy item:
days
,weeks
, ormonths
.- retention
Value number Value to associate with
retention_unit
. Monthly policy must have retention days of at least 31 days or 5 weeks or 1 month. Note that for less frequent policy items, Atlas requires that you specify a retention period greater than or equal to the retention period specified for more frequent policy items. For example: If the weekly policy item specifies a retention of two weeks, the montly retention policy must specify two weeks or greater.
- frequency_
interval int Desired frequency of the new backup policy item specified by
frequency_type
(monthly in this case). The supported values for weekly policies are- frequency_
type str Frequency associated with the backup policy item. For monthly policies, the frequency type is defined as
monthly
. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.- id str
Unique identifier of the backup policy item.
- retention_
unit str Scope of the backup policy item:
days
,weeks
, ormonths
.- 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
Interval Number Desired frequency of the new backup policy item specified by
frequency_type
(monthly in this case). The supported values for weekly policies are- frequency
Type 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.
- retention
Unit String Scope of the backup policy item:
days
,weeks
, ormonths
.- retention
Value Number Value to associate with
retention_unit
. Monthly policy must have retention days of at least 31 days or 5 weeks or 1 month. Note that for less frequent policy items, Atlas requires that you specify a retention period greater than or equal to the retention period specified for more frequent policy items. For example: If the weekly policy item specifies a retention of two weeks, the montly retention policy must specify two weeks or greater.
Package Details
- Repository
- MongoDB Atlas pulumi/pulumi-mongodbatlas
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
mongodbatlas
Terraform Provider.