mongodbatlas.getBackupCompliancePolicy
Explore with Pulumi AI
Using getBackupCompliancePolicy
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 getBackupCompliancePolicy(args: GetBackupCompliancePolicyArgs, opts?: InvokeOptions): Promise<GetBackupCompliancePolicyResult>
function getBackupCompliancePolicyOutput(args: GetBackupCompliancePolicyOutputArgs, opts?: InvokeOptions): Output<GetBackupCompliancePolicyResult>
def get_backup_compliance_policy(on_demand_policy_item: Optional[GetBackupCompliancePolicyOnDemandPolicyItem] = None,
policy_item_daily: Optional[GetBackupCompliancePolicyPolicyItemDaily] = None,
policy_item_hourly: Optional[GetBackupCompliancePolicyPolicyItemHourly] = None,
policy_item_monthlies: Optional[Sequence[GetBackupCompliancePolicyPolicyItemMonthly]] = None,
policy_item_weeklies: Optional[Sequence[GetBackupCompliancePolicyPolicyItemWeekly]] = None,
project_id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetBackupCompliancePolicyResult
def get_backup_compliance_policy_output(on_demand_policy_item: Optional[pulumi.Input[GetBackupCompliancePolicyOnDemandPolicyItemArgs]] = None,
policy_item_daily: Optional[pulumi.Input[GetBackupCompliancePolicyPolicyItemDailyArgs]] = None,
policy_item_hourly: Optional[pulumi.Input[GetBackupCompliancePolicyPolicyItemHourlyArgs]] = None,
policy_item_monthlies: Optional[pulumi.Input[Sequence[pulumi.Input[GetBackupCompliancePolicyPolicyItemMonthlyArgs]]]] = None,
policy_item_weeklies: Optional[pulumi.Input[Sequence[pulumi.Input[GetBackupCompliancePolicyPolicyItemWeeklyArgs]]]] = None,
project_id: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetBackupCompliancePolicyResult]
func LookupBackupCompliancePolicy(ctx *Context, args *LookupBackupCompliancePolicyArgs, opts ...InvokeOption) (*LookupBackupCompliancePolicyResult, error)
func LookupBackupCompliancePolicyOutput(ctx *Context, args *LookupBackupCompliancePolicyOutputArgs, opts ...InvokeOption) LookupBackupCompliancePolicyResultOutput
> Note: This function is named LookupBackupCompliancePolicy
in the Go SDK.
public static class GetBackupCompliancePolicy
{
public static Task<GetBackupCompliancePolicyResult> InvokeAsync(GetBackupCompliancePolicyArgs args, InvokeOptions? opts = null)
public static Output<GetBackupCompliancePolicyResult> Invoke(GetBackupCompliancePolicyInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetBackupCompliancePolicyResult> getBackupCompliancePolicy(GetBackupCompliancePolicyArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: mongodbatlas:index/getBackupCompliancePolicy:getBackupCompliancePolicy
arguments:
# arguments dictionary
The following arguments are supported:
- Project
Id string Unique 24-hexadecimal digit string that identifies your project
- On
Demand GetPolicy Item Backup Compliance Policy On Demand Policy Item - Policy
Item GetDaily Backup Compliance Policy Policy Item Daily - Policy
Item GetHourly Backup Compliance Policy Policy Item Hourly - Policy
Item List<GetMonthlies Backup Compliance Policy Policy Item Monthly> - Policy
Item List<GetWeeklies Backup Compliance Policy Policy Item Weekly>
- Project
Id string Unique 24-hexadecimal digit string that identifies your project
- On
Demand GetPolicy Item Backup Compliance Policy On Demand Policy Item - Policy
Item GetDaily Backup Compliance Policy Policy Item Daily - Policy
Item GetHourly Backup Compliance Policy Policy Item Hourly - Policy
Item []GetMonthlies Backup Compliance Policy Policy Item Monthly - Policy
Item []GetWeeklies Backup Compliance Policy Policy Item Weekly
- project
Id String Unique 24-hexadecimal digit string that identifies your project
- on
Demand GetPolicy Item Backup Compliance Policy On Demand Policy Item - policy
Item GetDaily Backup Compliance Policy Policy Item Daily - policy
Item GetHourly Backup Compliance Policy Policy Item Hourly - policy
Item List<GetMonthlies Backup Compliance Policy Policy Item Monthly> - policy
Item List<GetWeeklies Backup Compliance Policy Policy Item Weekly>
- project
Id string Unique 24-hexadecimal digit string that identifies your project
- on
Demand GetPolicy Item Backup Compliance Policy On Demand Policy Item - policy
Item GetDaily Backup Compliance Policy Policy Item Daily - policy
Item GetHourly Backup Compliance Policy Policy Item Hourly - policy
Item GetMonthlies Backup Compliance Policy Policy Item Monthly[] - policy
Item GetWeeklies Backup Compliance Policy Policy Item Weekly[]
- project_
id str Unique 24-hexadecimal digit string that identifies your project
- on_
demand_ Getpolicy_ item Backup Compliance Policy On Demand Policy Item - policy_
item_ Getdaily Backup Compliance Policy Policy Item Daily - policy_
item_ Gethourly Backup Compliance Policy Policy Item Hourly - policy_
item_ Sequence[Getmonthlies Backup Compliance Policy Policy Item Monthly] - policy_
item_ Sequence[Getweeklies Backup Compliance Policy Policy Item Weekly]
- project
Id String Unique 24-hexadecimal digit string that identifies your project
- on
Demand Property MapPolicy Item - policy
Item Property MapDaily - policy
Item Property MapHourly - policy
Item List<Property Map>Monthlies - policy
Item List<Property Map>Weeklies
getBackupCompliancePolicy Result
The following output properties are available:
- string
Email address of the user who is authorized to update the Backup Compliance Policy settings.
- Copy
Protection boolEnabled Flag that indicates whether to enable additional backup copies for the cluster. If unspecified, this value defaults to false.
- Encryption
At boolRest Enabled Flag that indicates whether Encryption at Rest using Customer Key Management is required for all clusters with a Backup Compliance Policy. If unspecified, this value defaults to false.
- Id string
The provider-assigned unique ID for this managed resource.
- Pit
Enabled bool Flag that indicates whether the cluster uses Continuous Cloud Backups with a Backup Compliance Policy. If unspecified, this value defaults to false.
- Project
Id string - Restore
Window intDays Number of previous days that you can restore back to with Continuous Cloud Backup with a Backup Compliance Policy. You must specify a positive, non-zero integer, and the maximum retention window can't exceed the hourly retention time. This parameter applies only to Continuous Cloud Backups with a Backup Compliance Policy.
- State string
Label that indicates the state of the Backup Compliance Policy settings. MongoDB Cloud ignores this setting when you enable or update the Backup Compliance Policy settings.
- Updated
Date string ISO 8601 timestamp format in UTC that indicates when the user updated the Data Protection Policy settings. MongoDB Cloud ignores this setting when you enable or update the Backup Compliance Policy settings.
- Updated
User string Email address that identifies the user who updated the Backup Compliance Policy settings. MongoDB Cloud ignores this email setting when you enable or update the Backup Compliance Policy settings.
- On
Demand GetPolicy Item Backup Compliance Policy On Demand Policy Item - Policy
Item GetDaily Backup Compliance Policy Policy Item Daily - Policy
Item GetHourly Backup Compliance Policy Policy Item Hourly - Policy
Item List<GetMonthlies Backup Compliance Policy Policy Item Monthly> - Policy
Item List<GetWeeklies Backup Compliance Policy Policy Item Weekly>
- string
Email address of the user who is authorized to update the Backup Compliance Policy settings.
- Copy
Protection boolEnabled Flag that indicates whether to enable additional backup copies for the cluster. If unspecified, this value defaults to false.
- Encryption
At boolRest Enabled Flag that indicates whether Encryption at Rest using Customer Key Management is required for all clusters with a Backup Compliance Policy. If unspecified, this value defaults to false.
- Id string
The provider-assigned unique ID for this managed resource.
- Pit
Enabled bool Flag that indicates whether the cluster uses Continuous Cloud Backups with a Backup Compliance Policy. If unspecified, this value defaults to false.
- Project
Id string - Restore
Window intDays Number of previous days that you can restore back to with Continuous Cloud Backup with a Backup Compliance Policy. You must specify a positive, non-zero integer, and the maximum retention window can't exceed the hourly retention time. This parameter applies only to Continuous Cloud Backups with a Backup Compliance Policy.
- State string
Label that indicates the state of the Backup Compliance Policy settings. MongoDB Cloud ignores this setting when you enable or update the Backup Compliance Policy settings.
- Updated
Date string ISO 8601 timestamp format in UTC that indicates when the user updated the Data Protection Policy settings. MongoDB Cloud ignores this setting when you enable or update the Backup Compliance Policy settings.
- Updated
User string Email address that identifies the user who updated the Backup Compliance Policy settings. MongoDB Cloud ignores this email setting when you enable or update the Backup Compliance Policy settings.
- On
Demand GetPolicy Item Backup Compliance Policy On Demand Policy Item - Policy
Item GetDaily Backup Compliance Policy Policy Item Daily - Policy
Item GetHourly Backup Compliance Policy Policy Item Hourly - Policy
Item []GetMonthlies Backup Compliance Policy Policy Item Monthly - Policy
Item []GetWeeklies Backup Compliance Policy Policy Item Weekly
- String
Email address of the user who is authorized to update the Backup Compliance Policy settings.
- copy
Protection BooleanEnabled Flag that indicates whether to enable additional backup copies for the cluster. If unspecified, this value defaults to false.
- encryption
At BooleanRest Enabled Flag that indicates whether Encryption at Rest using Customer Key Management is required for all clusters with a Backup Compliance Policy. If unspecified, this value defaults to false.
- id String
The provider-assigned unique ID for this managed resource.
- pit
Enabled Boolean Flag that indicates whether the cluster uses Continuous Cloud Backups with a Backup Compliance Policy. If unspecified, this value defaults to false.
- project
Id String - restore
Window IntegerDays Number of previous days that you can restore back to with Continuous Cloud Backup with a Backup Compliance Policy. You must specify a positive, non-zero integer, and the maximum retention window can't exceed the hourly retention time. This parameter applies only to Continuous Cloud Backups with a Backup Compliance Policy.
- state String
Label that indicates the state of the Backup Compliance Policy settings. MongoDB Cloud ignores this setting when you enable or update the Backup Compliance Policy settings.
- updated
Date String ISO 8601 timestamp format in UTC that indicates when the user updated the Data Protection Policy settings. MongoDB Cloud ignores this setting when you enable or update the Backup Compliance Policy settings.
- updated
User String Email address that identifies the user who updated the Backup Compliance Policy settings. MongoDB Cloud ignores this email setting when you enable or update the Backup Compliance Policy settings.
- on
Demand GetPolicy Item Backup Compliance Policy On Demand Policy Item - policy
Item GetDaily Backup Compliance Policy Policy Item Daily - policy
Item GetHourly Backup Compliance Policy Policy Item Hourly - policy
Item List<GetMonthlies Backup Compliance Policy Policy Item Monthly> - policy
Item List<GetWeeklies Backup Compliance Policy Policy Item Weekly>
- string
Email address of the user who is authorized to update the Backup Compliance Policy settings.
- copy
Protection booleanEnabled Flag that indicates whether to enable additional backup copies for the cluster. If unspecified, this value defaults to false.
- encryption
At booleanRest Enabled Flag that indicates whether Encryption at Rest using Customer Key Management is required for all clusters with a Backup Compliance Policy. If unspecified, this value defaults to false.
- id string
The provider-assigned unique ID for this managed resource.
- pit
Enabled boolean Flag that indicates whether the cluster uses Continuous Cloud Backups with a Backup Compliance Policy. If unspecified, this value defaults to false.
- project
Id string - restore
Window numberDays Number of previous days that you can restore back to with Continuous Cloud Backup with a Backup Compliance Policy. You must specify a positive, non-zero integer, and the maximum retention window can't exceed the hourly retention time. This parameter applies only to Continuous Cloud Backups with a Backup Compliance Policy.
- state string
Label that indicates the state of the Backup Compliance Policy settings. MongoDB Cloud ignores this setting when you enable or update the Backup Compliance Policy settings.
- updated
Date string ISO 8601 timestamp format in UTC that indicates when the user updated the Data Protection Policy settings. MongoDB Cloud ignores this setting when you enable or update the Backup Compliance Policy settings.
- updated
User string Email address that identifies the user who updated the Backup Compliance Policy settings. MongoDB Cloud ignores this email setting when you enable or update the Backup Compliance Policy settings.
- on
Demand GetPolicy Item Backup Compliance Policy On Demand Policy Item - policy
Item GetDaily Backup Compliance Policy Policy Item Daily - policy
Item GetHourly Backup Compliance Policy Policy Item Hourly - policy
Item GetMonthlies Backup Compliance Policy Policy Item Monthly[] - policy
Item GetWeeklies Backup Compliance Policy Policy Item Weekly[]
- str
Email address of the user who is authorized to update the Backup Compliance Policy settings.
- copy_
protection_ boolenabled Flag that indicates whether to enable additional backup copies for the cluster. If unspecified, this value defaults to false.
- encryption_
at_ boolrest_ enabled Flag that indicates whether Encryption at Rest using Customer Key Management is required for all clusters with a Backup Compliance Policy. If unspecified, this value defaults to false.
- id str
The provider-assigned unique ID for this managed resource.
- pit_
enabled bool Flag that indicates whether the cluster uses Continuous Cloud Backups with a Backup Compliance Policy. If unspecified, this value defaults to false.
- project_
id str - restore_
window_ intdays Number of previous days that you can restore back to with Continuous Cloud Backup with a Backup Compliance Policy. You must specify a positive, non-zero integer, and the maximum retention window can't exceed the hourly retention time. This parameter applies only to Continuous Cloud Backups with a Backup Compliance Policy.
- state str
Label that indicates the state of the Backup Compliance Policy settings. MongoDB Cloud ignores this setting when you enable or update the Backup Compliance Policy settings.
- updated_
date str ISO 8601 timestamp format in UTC that indicates when the user updated the Data Protection Policy settings. MongoDB Cloud ignores this setting when you enable or update the Backup Compliance Policy settings.
- updated_
user str Email address that identifies the user who updated the Backup Compliance Policy settings. MongoDB Cloud ignores this email setting when you enable or update the Backup Compliance Policy settings.
- on_
demand_ Getpolicy_ item Backup Compliance Policy On Demand Policy Item - policy_
item_ Getdaily Backup Compliance Policy Policy Item Daily - policy_
item_ Gethourly Backup Compliance Policy Policy Item Hourly - policy_
item_ Sequence[Getmonthlies Backup Compliance Policy Policy Item Monthly] - policy_
item_ Sequence[Getweeklies Backup Compliance Policy Policy Item Weekly]
- String
Email address of the user who is authorized to update the Backup Compliance Policy settings.
- copy
Protection BooleanEnabled Flag that indicates whether to enable additional backup copies for the cluster. If unspecified, this value defaults to false.
- encryption
At BooleanRest Enabled Flag that indicates whether Encryption at Rest using Customer Key Management is required for all clusters with a Backup Compliance Policy. If unspecified, this value defaults to false.
- id String
The provider-assigned unique ID for this managed resource.
- pit
Enabled Boolean Flag that indicates whether the cluster uses Continuous Cloud Backups with a Backup Compliance Policy. If unspecified, this value defaults to false.
- project
Id String - restore
Window NumberDays Number of previous days that you can restore back to with Continuous Cloud Backup with a Backup Compliance Policy. You must specify a positive, non-zero integer, and the maximum retention window can't exceed the hourly retention time. This parameter applies only to Continuous Cloud Backups with a Backup Compliance Policy.
- state String
Label that indicates the state of the Backup Compliance Policy settings. MongoDB Cloud ignores this setting when you enable or update the Backup Compliance Policy settings.
- updated
Date String ISO 8601 timestamp format in UTC that indicates when the user updated the Data Protection Policy settings. MongoDB Cloud ignores this setting when you enable or update the Backup Compliance Policy settings.
- updated
User String Email address that identifies the user who updated the Backup Compliance Policy settings. MongoDB Cloud ignores this email setting when you enable or update the Backup Compliance Policy settings.
- on
Demand Property MapPolicy Item - policy
Item Property MapDaily - policy
Item Property MapHourly - policy
Item List<Property Map>Monthlies - policy
Item List<Property Map>Weeklies
Supporting Types
GetBackupCompliancePolicyOnDemandPolicyItem
- 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.
GetBackupCompliancePolicyPolicyItemDaily
- 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.
GetBackupCompliancePolicyPolicyItemHourly
- 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.
GetBackupCompliancePolicyPolicyItemMonthly
- 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.
GetBackupCompliancePolicyPolicyItemWeekly
- 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.