Docs Packages
  1. Packages
  2. MongoDB Atlas
  3. API Docs
  4. getBackupCompliancePolicy
MongoDB Atlas v3.14.3 published on Monday, Apr 1, 2024 by Pulumi
pulumi/pulumi-mongodbatlas

mongodbatlas.getBackupCompliancePolicy

Explore with Pulumi AI

mongodbatlas logo
MongoDB Atlas v3.14.3 published on Monday, Apr 1, 2024 by Pulumi
pulumi/pulumi-mongodbatlas

    Example Usage

    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(project_id: Optional[str] = None,
                                 opts: Optional[InvokeOptions] = None) -> GetBackupCompliancePolicyResult
def get_backup_compliance_policy_output(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:

    ProjectId string
    Unique 24-hexadecimal digit string that identifies your project
    ProjectId string
    Unique 24-hexadecimal digit string that identifies your project
    projectId String
    Unique 24-hexadecimal digit string that identifies your project
    projectId string
    Unique 24-hexadecimal digit string that identifies your project
    project_id str
    Unique 24-hexadecimal digit string that identifies your project
    projectId String
    Unique 24-hexadecimal digit string that identifies your project

    getBackupCompliancePolicy Result

    The following output properties are available:

    AuthorizedEmail string
    Email address of the user who is authorized to update the Backup Compliance Policy settings.
    AuthorizedUserFirstName string
    First name of the user who authorized to update the Backup Compliance Policy settings.
    AuthorizedUserLastName string
    Last name of the user who authorized to update the Backup Compliance Policy settings.
    CopyProtectionEnabled bool
    Flag that indicates whether to enable additional backup copies for the cluster. If unspecified, this value defaults to false.
    EncryptionAtRestEnabled bool
    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.
    OnDemandPolicyItem GetBackupCompliancePolicyOnDemandPolicyItem
    PitEnabled bool
    Flag that indicates whether the cluster uses Continuous Cloud Backups with a Backup Compliance Policy. If unspecified, this value defaults to false.
    PolicyItemDaily GetBackupCompliancePolicyPolicyItemDaily
    PolicyItemHourly GetBackupCompliancePolicyPolicyItemHourly
    PolicyItemMonthlies List<GetBackupCompliancePolicyPolicyItemMonthly>
    PolicyItemWeeklies List<GetBackupCompliancePolicyPolicyItemWeekly>
    ProjectId string
    RestoreWindowDays int
    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.
    UpdatedDate 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.
    UpdatedUser 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.
    AuthorizedEmail string
    Email address of the user who is authorized to update the Backup Compliance Policy settings.
    AuthorizedUserFirstName string
    First name of the user who authorized to update the Backup Compliance Policy settings.
    AuthorizedUserLastName string
    Last name of the user who authorized to update the Backup Compliance Policy settings.
    CopyProtectionEnabled bool
    Flag that indicates whether to enable additional backup copies for the cluster. If unspecified, this value defaults to false.
    EncryptionAtRestEnabled bool
    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.
    OnDemandPolicyItem GetBackupCompliancePolicyOnDemandPolicyItem
    PitEnabled bool
    Flag that indicates whether the cluster uses Continuous Cloud Backups with a Backup Compliance Policy. If unspecified, this value defaults to false.
    PolicyItemDaily GetBackupCompliancePolicyPolicyItemDaily
    PolicyItemHourly GetBackupCompliancePolicyPolicyItemHourly
    PolicyItemMonthlies []GetBackupCompliancePolicyPolicyItemMonthly
    PolicyItemWeeklies []GetBackupCompliancePolicyPolicyItemWeekly
    ProjectId string
    RestoreWindowDays int
    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.
    UpdatedDate 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.
    UpdatedUser 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.
    authorizedEmail String
    Email address of the user who is authorized to update the Backup Compliance Policy settings.
    authorizedUserFirstName String
    First name of the user who authorized to update the Backup Compliance Policy settings.
    authorizedUserLastName String
    Last name of the user who authorized to update the Backup Compliance Policy settings.
    copyProtectionEnabled Boolean
    Flag that indicates whether to enable additional backup copies for the cluster. If unspecified, this value defaults to false.
    encryptionAtRestEnabled Boolean
    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.
    onDemandPolicyItem GetBackupCompliancePolicyOnDemandPolicyItem
    pitEnabled Boolean
    Flag that indicates whether the cluster uses Continuous Cloud Backups with a Backup Compliance Policy. If unspecified, this value defaults to false.
    policyItemDaily GetBackupCompliancePolicyPolicyItemDaily
    policyItemHourly GetBackupCompliancePolicyPolicyItemHourly
    policyItemMonthlies List<GetBackupCompliancePolicyPolicyItemMonthly>
    policyItemWeeklies List<GetBackupCompliancePolicyPolicyItemWeekly>
    projectId String
    restoreWindowDays Integer
    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.
    updatedDate 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.
    updatedUser 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.
    authorizedEmail string
    Email address of the user who is authorized to update the Backup Compliance Policy settings.
    authorizedUserFirstName string
    First name of the user who authorized to update the Backup Compliance Policy settings.
    authorizedUserLastName string
    Last name of the user who authorized to update the Backup Compliance Policy settings.
    copyProtectionEnabled boolean
    Flag that indicates whether to enable additional backup copies for the cluster. If unspecified, this value defaults to false.
    encryptionAtRestEnabled boolean
    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.
    onDemandPolicyItem GetBackupCompliancePolicyOnDemandPolicyItem
    pitEnabled boolean
    Flag that indicates whether the cluster uses Continuous Cloud Backups with a Backup Compliance Policy. If unspecified, this value defaults to false.
    policyItemDaily GetBackupCompliancePolicyPolicyItemDaily
    policyItemHourly GetBackupCompliancePolicyPolicyItemHourly
    policyItemMonthlies GetBackupCompliancePolicyPolicyItemMonthly[]
    policyItemWeeklies GetBackupCompliancePolicyPolicyItemWeekly[]
    projectId string
    restoreWindowDays number
    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.
    updatedDate 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.
    updatedUser 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.
    authorized_email str
    Email address of the user who is authorized to update the Backup Compliance Policy settings.
    authorized_user_first_name str
    First name of the user who authorized to update the Backup Compliance Policy settings.
    authorized_user_last_name str
    Last name of the user who authorized to update the Backup Compliance Policy settings.
    copy_protection_enabled bool
    Flag that indicates whether to enable additional backup copies for the cluster. If unspecified, this value defaults to false.
    encryption_at_rest_enabled bool
    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.
    on_demand_policy_item GetBackupCompliancePolicyOnDemandPolicyItem
    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.
    policy_item_daily GetBackupCompliancePolicyPolicyItemDaily
    policy_item_hourly GetBackupCompliancePolicyPolicyItemHourly
    policy_item_monthlies Sequence[GetBackupCompliancePolicyPolicyItemMonthly]
    policy_item_weeklies Sequence[GetBackupCompliancePolicyPolicyItemWeekly]
    project_id str
    restore_window_days int
    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.
    authorizedEmail String
    Email address of the user who is authorized to update the Backup Compliance Policy settings.
    authorizedUserFirstName String
    First name of the user who authorized to update the Backup Compliance Policy settings.
    authorizedUserLastName String
    Last name of the user who authorized to update the Backup Compliance Policy settings.
    copyProtectionEnabled Boolean
    Flag that indicates whether to enable additional backup copies for the cluster. If unspecified, this value defaults to false.
    encryptionAtRestEnabled Boolean
    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.
    onDemandPolicyItem Property Map
    pitEnabled Boolean
    Flag that indicates whether the cluster uses Continuous Cloud Backups with a Backup Compliance Policy. If unspecified, this value defaults to false.
    policyItemDaily Property Map
    policyItemHourly Property Map
    policyItemMonthlies List<Property Map>
    policyItemWeeklies List<Property Map>
    projectId String
    restoreWindowDays Number
    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.
    updatedDate 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.
    updatedUser 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.

    Supporting Types

    GetBackupCompliancePolicyOnDemandPolicyItem

    FrequencyInterval int
    Desired frequency of the new backup policy item specified by frequency_type (monthly in this case). The supported values for weekly policies are
    FrequencyType string
    Frequency associated with the backup policy item. For monthly policies, the frequency type is defined as monthly. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.
    Id string
    Unique identifier of the backup policy item.
    RetentionUnit string
    Scope of the backup policy item: days, weeks, or months.
    RetentionValue int
    Value to associate with retention_unit. Monthly policy must have retention days of at least 31 days or 5 weeks or 1 month. Note that for less frequent policy items, Atlas requires that you specify a retention period greater than or equal to the retention period specified for more frequent policy items. For example: If the weekly policy item specifies a retention of two weeks, the montly retention policy must specify two weeks or greater.
    FrequencyInterval int
    Desired frequency of the new backup policy item specified by frequency_type (monthly in this case). The supported values for weekly policies are
    FrequencyType string
    Frequency associated with the backup policy item. For monthly policies, the frequency type is defined as monthly. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.
    Id string
    Unique identifier of the backup policy item.
    RetentionUnit string
    Scope of the backup policy item: days, weeks, or months.
    RetentionValue int
    Value to associate with retention_unit. Monthly policy must have retention days of at least 31 days or 5 weeks or 1 month. Note that for less frequent policy items, Atlas requires that you specify a retention period greater than or equal to the retention period specified for more frequent policy items. For example: If the weekly policy item specifies a retention of two weeks, the montly retention policy must specify two weeks or greater.
    frequencyInterval Integer
    Desired frequency of the new backup policy item specified by frequency_type (monthly in this case). The supported values for weekly policies are
    frequencyType String
    Frequency associated with the backup policy item. For monthly policies, the frequency type is defined as monthly. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.
    id String
    Unique identifier of the backup policy item.
    retentionUnit String
    Scope of the backup policy item: days, weeks, or months.
    retentionValue Integer
    Value to associate with retention_unit. Monthly policy must have retention days of at least 31 days or 5 weeks or 1 month. Note that for less frequent policy items, Atlas requires that you specify a retention period greater than or equal to the retention period specified for more frequent policy items. For example: If the weekly policy item specifies a retention of two weeks, the montly retention policy must specify two weeks or greater.
    frequencyInterval number
    Desired frequency of the new backup policy item specified by frequency_type (monthly in this case). The supported values for weekly policies are
    frequencyType string
    Frequency associated with the backup policy item. For monthly policies, the frequency type is defined as monthly. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.
    id string
    Unique identifier of the backup policy item.
    retentionUnit string
    Scope of the backup policy item: days, weeks, or months.
    retentionValue number
    Value to associate with retention_unit. Monthly policy must have retention days of at least 31 days or 5 weeks or 1 month. Note that for less frequent policy items, Atlas requires that you specify a retention period greater than or equal to the retention period specified for more frequent policy items. For example: If the weekly policy item specifies a retention of two weeks, the montly retention policy must specify two weeks or greater.
    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, or months.
    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.
    frequencyInterval Number
    Desired frequency of the new backup policy item specified by frequency_type (monthly in this case). The supported values for weekly policies are
    frequencyType String
    Frequency associated with the backup policy item. For monthly policies, the frequency type is defined as monthly. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.
    id String
    Unique identifier of the backup policy item.
    retentionUnit String
    Scope of the backup policy item: days, weeks, or months.
    retentionValue Number
    Value to associate with retention_unit. Monthly policy must have retention days of at least 31 days or 5 weeks or 1 month. Note that for less frequent policy items, Atlas requires that you specify a retention period greater than or equal to the retention period specified for more frequent policy items. For example: If the weekly policy item specifies a retention of two weeks, the montly retention policy must specify two weeks or greater.

    GetBackupCompliancePolicyPolicyItemDaily

    FrequencyInterval int
    Desired frequency of the new backup policy item specified by frequency_type (monthly in this case). The supported values for weekly policies are
    FrequencyType string
    Frequency associated with the backup policy item. For monthly policies, the frequency type is defined as monthly. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.
    Id string
    Unique identifier of the backup policy item.
    RetentionUnit string
    Scope of the backup policy item: days, weeks, or months.
    RetentionValue int
    Value to associate with retention_unit. Monthly policy must have retention days of at least 31 days or 5 weeks or 1 month. Note that for less frequent policy items, Atlas requires that you specify a retention period greater than or equal to the retention period specified for more frequent policy items. For example: If the weekly policy item specifies a retention of two weeks, the montly retention policy must specify two weeks or greater.
    FrequencyInterval int
    Desired frequency of the new backup policy item specified by frequency_type (monthly in this case). The supported values for weekly policies are
    FrequencyType string
    Frequency associated with the backup policy item. For monthly policies, the frequency type is defined as monthly. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.
    Id string
    Unique identifier of the backup policy item.
    RetentionUnit string
    Scope of the backup policy item: days, weeks, or months.
    RetentionValue int
    Value to associate with retention_unit. Monthly policy must have retention days of at least 31 days or 5 weeks or 1 month. Note that for less frequent policy items, Atlas requires that you specify a retention period greater than or equal to the retention period specified for more frequent policy items. For example: If the weekly policy item specifies a retention of two weeks, the montly retention policy must specify two weeks or greater.
    frequencyInterval Integer
    Desired frequency of the new backup policy item specified by frequency_type (monthly in this case). The supported values for weekly policies are
    frequencyType String
    Frequency associated with the backup policy item. For monthly policies, the frequency type is defined as monthly. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.
    id String
    Unique identifier of the backup policy item.
    retentionUnit String
    Scope of the backup policy item: days, weeks, or months.
    retentionValue Integer
    Value to associate with retention_unit. Monthly policy must have retention days of at least 31 days or 5 weeks or 1 month. Note that for less frequent policy items, Atlas requires that you specify a retention period greater than or equal to the retention period specified for more frequent policy items. For example: If the weekly policy item specifies a retention of two weeks, the montly retention policy must specify two weeks or greater.
    frequencyInterval number
    Desired frequency of the new backup policy item specified by frequency_type (monthly in this case). The supported values for weekly policies are
    frequencyType string
    Frequency associated with the backup policy item. For monthly policies, the frequency type is defined as monthly. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.
    id string
    Unique identifier of the backup policy item.
    retentionUnit string
    Scope of the backup policy item: days, weeks, or months.
    retentionValue number
    Value to associate with retention_unit. Monthly policy must have retention days of at least 31 days or 5 weeks or 1 month. Note that for less frequent policy items, Atlas requires that you specify a retention period greater than or equal to the retention period specified for more frequent policy items. For example: If the weekly policy item specifies a retention of two weeks, the montly retention policy must specify two weeks or greater.
    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, or months.
    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.
    frequencyInterval Number
    Desired frequency of the new backup policy item specified by frequency_type (monthly in this case). The supported values for weekly policies are
    frequencyType String
    Frequency associated with the backup policy item. For monthly policies, the frequency type is defined as monthly. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.
    id String
    Unique identifier of the backup policy item.
    retentionUnit String
    Scope of the backup policy item: days, weeks, or months.
    retentionValue Number
    Value to associate with retention_unit. Monthly policy must have retention days of at least 31 days or 5 weeks or 1 month. Note that for less frequent policy items, Atlas requires that you specify a retention period greater than or equal to the retention period specified for more frequent policy items. For example: If the weekly policy item specifies a retention of two weeks, the montly retention policy must specify two weeks or greater.

    GetBackupCompliancePolicyPolicyItemHourly

    FrequencyInterval int
    Desired frequency of the new backup policy item specified by frequency_type (monthly in this case). The supported values for weekly policies are
    FrequencyType string
    Frequency associated with the backup policy item. For monthly policies, the frequency type is defined as monthly. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.
    Id string
    Unique identifier of the backup policy item.
    RetentionUnit string
    Scope of the backup policy item: days, weeks, or months.
    RetentionValue int
    Value to associate with retention_unit. Monthly policy must have retention days of at least 31 days or 5 weeks or 1 month. Note that for less frequent policy items, Atlas requires that you specify a retention period greater than or equal to the retention period specified for more frequent policy items. For example: If the weekly policy item specifies a retention of two weeks, the montly retention policy must specify two weeks or greater.
    FrequencyInterval int
    Desired frequency of the new backup policy item specified by frequency_type (monthly in this case). The supported values for weekly policies are
    FrequencyType string
    Frequency associated with the backup policy item. For monthly policies, the frequency type is defined as monthly. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.
    Id string
    Unique identifier of the backup policy item.
    RetentionUnit string
    Scope of the backup policy item: days, weeks, or months.
    RetentionValue int
    Value to associate with retention_unit. Monthly policy must have retention days of at least 31 days or 5 weeks or 1 month. Note that for less frequent policy items, Atlas requires that you specify a retention period greater than or equal to the retention period specified for more frequent policy items. For example: If the weekly policy item specifies a retention of two weeks, the montly retention policy must specify two weeks or greater.
    frequencyInterval Integer
    Desired frequency of the new backup policy item specified by frequency_type (monthly in this case). The supported values for weekly policies are
    frequencyType String
    Frequency associated with the backup policy item. For monthly policies, the frequency type is defined as monthly. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.
    id String
    Unique identifier of the backup policy item.
    retentionUnit String
    Scope of the backup policy item: days, weeks, or months.
    retentionValue Integer
    Value to associate with retention_unit. Monthly policy must have retention days of at least 31 days or 5 weeks or 1 month. Note that for less frequent policy items, Atlas requires that you specify a retention period greater than or equal to the retention period specified for more frequent policy items. For example: If the weekly policy item specifies a retention of two weeks, the montly retention policy must specify two weeks or greater.
    frequencyInterval number
    Desired frequency of the new backup policy item specified by frequency_type (monthly in this case). The supported values for weekly policies are
    frequencyType string
    Frequency associated with the backup policy item. For monthly policies, the frequency type is defined as monthly. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.
    id string
    Unique identifier of the backup policy item.
    retentionUnit string
    Scope of the backup policy item: days, weeks, or months.
    retentionValue number
    Value to associate with retention_unit. Monthly policy must have retention days of at least 31 days or 5 weeks or 1 month. Note that for less frequent policy items, Atlas requires that you specify a retention period greater than or equal to the retention period specified for more frequent policy items. For example: If the weekly policy item specifies a retention of two weeks, the montly retention policy must specify two weeks or greater.
    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, or months.
    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.
    frequencyInterval Number
    Desired frequency of the new backup policy item specified by frequency_type (monthly in this case). The supported values for weekly policies are
    frequencyType String
    Frequency associated with the backup policy item. For monthly policies, the frequency type is defined as monthly. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.
    id String
    Unique identifier of the backup policy item.
    retentionUnit String
    Scope of the backup policy item: days, weeks, or months.
    retentionValue Number
    Value to associate with retention_unit. Monthly policy must have retention days of at least 31 days or 5 weeks or 1 month. Note that for less frequent policy items, Atlas requires that you specify a retention period greater than or equal to the retention period specified for more frequent policy items. For example: If the weekly policy item specifies a retention of two weeks, the montly retention policy must specify two weeks or greater.

    GetBackupCompliancePolicyPolicyItemMonthly

    FrequencyInterval int
    Desired frequency of the new backup policy item specified by frequency_type (monthly in this case). The supported values for weekly policies are
    FrequencyType string
    Frequency associated with the backup policy item. For monthly policies, the frequency type is defined as monthly. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.
    Id string
    Unique identifier of the backup policy item.
    RetentionUnit string
    Scope of the backup policy item: days, weeks, or months.
    RetentionValue int
    Value to associate with retention_unit. Monthly policy must have retention days of at least 31 days or 5 weeks or 1 month. Note that for less frequent policy items, Atlas requires that you specify a retention period greater than or equal to the retention period specified for more frequent policy items. For example: If the weekly policy item specifies a retention of two weeks, the montly retention policy must specify two weeks or greater.
    FrequencyInterval int
    Desired frequency of the new backup policy item specified by frequency_type (monthly in this case). The supported values for weekly policies are
    FrequencyType string
    Frequency associated with the backup policy item. For monthly policies, the frequency type is defined as monthly. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.
    Id string
    Unique identifier of the backup policy item.
    RetentionUnit string
    Scope of the backup policy item: days, weeks, or months.
    RetentionValue int
    Value to associate with retention_unit. Monthly policy must have retention days of at least 31 days or 5 weeks or 1 month. Note that for less frequent policy items, Atlas requires that you specify a retention period greater than or equal to the retention period specified for more frequent policy items. For example: If the weekly policy item specifies a retention of two weeks, the montly retention policy must specify two weeks or greater.
    frequencyInterval Integer
    Desired frequency of the new backup policy item specified by frequency_type (monthly in this case). The supported values for weekly policies are
    frequencyType String
    Frequency associated with the backup policy item. For monthly policies, the frequency type is defined as monthly. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.
    id String
    Unique identifier of the backup policy item.
    retentionUnit String
    Scope of the backup policy item: days, weeks, or months.
    retentionValue Integer
    Value to associate with retention_unit. Monthly policy must have retention days of at least 31 days or 5 weeks or 1 month. Note that for less frequent policy items, Atlas requires that you specify a retention period greater than or equal to the retention period specified for more frequent policy items. For example: If the weekly policy item specifies a retention of two weeks, the montly retention policy must specify two weeks or greater.
    frequencyInterval number
    Desired frequency of the new backup policy item specified by frequency_type (monthly in this case). The supported values for weekly policies are
    frequencyType string
    Frequency associated with the backup policy item. For monthly policies, the frequency type is defined as monthly. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.
    id string
    Unique identifier of the backup policy item.
    retentionUnit string
    Scope of the backup policy item: days, weeks, or months.
    retentionValue number
    Value to associate with retention_unit. Monthly policy must have retention days of at least 31 days or 5 weeks or 1 month. Note that for less frequent policy items, Atlas requires that you specify a retention period greater than or equal to the retention period specified for more frequent policy items. For example: If the weekly policy item specifies a retention of two weeks, the montly retention policy must specify two weeks or greater.
    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, or months.
    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.
    frequencyInterval Number
    Desired frequency of the new backup policy item specified by frequency_type (monthly in this case). The supported values for weekly policies are
    frequencyType String
    Frequency associated with the backup policy item. For monthly policies, the frequency type is defined as monthly. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.
    id String
    Unique identifier of the backup policy item.
    retentionUnit String
    Scope of the backup policy item: days, weeks, or months.
    retentionValue Number
    Value to associate with retention_unit. Monthly policy must have retention days of at least 31 days or 5 weeks or 1 month. Note that for less frequent policy items, Atlas requires that you specify a retention period greater than or equal to the retention period specified for more frequent policy items. For example: If the weekly policy item specifies a retention of two weeks, the montly retention policy must specify two weeks or greater.

    GetBackupCompliancePolicyPolicyItemWeekly

    FrequencyInterval int
    Desired frequency of the new backup policy item specified by frequency_type (monthly in this case). The supported values for weekly policies are
    FrequencyType string
    Frequency associated with the backup policy item. For monthly policies, the frequency type is defined as monthly. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.
    Id string
    Unique identifier of the backup policy item.
    RetentionUnit string
    Scope of the backup policy item: days, weeks, or months.
    RetentionValue int
    Value to associate with retention_unit. Monthly policy must have retention days of at least 31 days or 5 weeks or 1 month. Note that for less frequent policy items, Atlas requires that you specify a retention period greater than or equal to the retention period specified for more frequent policy items. For example: If the weekly policy item specifies a retention of two weeks, the montly retention policy must specify two weeks or greater.
    FrequencyInterval int
    Desired frequency of the new backup policy item specified by frequency_type (monthly in this case). The supported values for weekly policies are
    FrequencyType string
    Frequency associated with the backup policy item. For monthly policies, the frequency type is defined as monthly. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.
    Id string
    Unique identifier of the backup policy item.
    RetentionUnit string
    Scope of the backup policy item: days, weeks, or months.
    RetentionValue int
    Value to associate with retention_unit. Monthly policy must have retention days of at least 31 days or 5 weeks or 1 month. Note that for less frequent policy items, Atlas requires that you specify a retention period greater than or equal to the retention period specified for more frequent policy items. For example: If the weekly policy item specifies a retention of two weeks, the montly retention policy must specify two weeks or greater.
    frequencyInterval Integer
    Desired frequency of the new backup policy item specified by frequency_type (monthly in this case). The supported values for weekly policies are
    frequencyType String
    Frequency associated with the backup policy item. For monthly policies, the frequency type is defined as monthly. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.
    id String
    Unique identifier of the backup policy item.
    retentionUnit String
    Scope of the backup policy item: days, weeks, or months.
    retentionValue Integer
    Value to associate with retention_unit. Monthly policy must have retention days of at least 31 days or 5 weeks or 1 month. Note that for less frequent policy items, Atlas requires that you specify a retention period greater than or equal to the retention period specified for more frequent policy items. For example: If the weekly policy item specifies a retention of two weeks, the montly retention policy must specify two weeks or greater.
    frequencyInterval number
    Desired frequency of the new backup policy item specified by frequency_type (monthly in this case). The supported values for weekly policies are
    frequencyType string
    Frequency associated with the backup policy item. For monthly policies, the frequency type is defined as monthly. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.
    id string
    Unique identifier of the backup policy item.
    retentionUnit string
    Scope of the backup policy item: days, weeks, or months.
    retentionValue number
    Value to associate with retention_unit. Monthly policy must have retention days of at least 31 days or 5 weeks or 1 month. Note that for less frequent policy items, Atlas requires that you specify a retention period greater than or equal to the retention period specified for more frequent policy items. For example: If the weekly policy item specifies a retention of two weeks, the montly retention policy must specify two weeks or greater.
    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, or months.
    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.
    frequencyInterval Number
    Desired frequency of the new backup policy item specified by frequency_type (monthly in this case). The supported values for weekly policies are
    frequencyType String
    Frequency associated with the backup policy item. For monthly policies, the frequency type is defined as monthly. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.
    id String
    Unique identifier of the backup policy item.
    retentionUnit String
    Scope of the backup policy item: days, weeks, or months.
    retentionValue Number
    Value to associate with retention_unit. Monthly policy must have retention days of at least 31 days or 5 weeks or 1 month. Note that for less frequent policy items, Atlas requires that you specify a retention period greater than or equal to the retention period specified for more frequent policy items. For example: If the weekly policy item specifies a retention of two weeks, the montly retention policy must specify two weeks or greater.

    Package Details

    Repository
    MongoDB Atlas pulumi/pulumi-mongodbatlas
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the mongodbatlas Terraform Provider.
    mongodbatlas logo
    MongoDB Atlas v3.14.3 published on Monday, Apr 1, 2024 by Pulumi
    pulumi/pulumi-mongodbatlas