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

mongodbatlas.BackupCompliancePolicy

Explore with Pulumi AI

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

    Example Usage

    Create BackupCompliancePolicy Resource

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

    Constructor syntax

    new BackupCompliancePolicy(name: string, args: BackupCompliancePolicyArgs, opts?: CustomResourceOptions);
    @overload
def BackupCompliancePolicy(resource_name: str,
                           args: BackupCompliancePolicyArgs,
                           opts: Optional[ResourceOptions] = None)

@overload
def BackupCompliancePolicy(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           on_demand_policy_item: Optional[BackupCompliancePolicyOnDemandPolicyItemArgs] = None,
                           authorized_user_first_name: Optional[str] = None,
                           authorized_user_last_name: Optional[str] = None,
                           project_id: Optional[str] = None,
                           authorized_email: Optional[str] = None,
                           pit_enabled: Optional[bool] = None,
                           encryption_at_rest_enabled: Optional[bool] = None,
                           policy_item_daily: Optional[BackupCompliancePolicyPolicyItemDailyArgs] = None,
                           policy_item_hourly: Optional[BackupCompliancePolicyPolicyItemHourlyArgs] = None,
                           policy_item_monthlies: Optional[Sequence[BackupCompliancePolicyPolicyItemMonthlyArgs]] = None,
                           policy_item_weeklies: Optional[Sequence[BackupCompliancePolicyPolicyItemWeeklyArgs]] = None,
                           copy_protection_enabled: Optional[bool] = None,
                           restore_window_days: Optional[int] = None)
    func NewBackupCompliancePolicy(ctx *Context, name string, args BackupCompliancePolicyArgs, opts ...ResourceOption) (*BackupCompliancePolicy, error)
    public BackupCompliancePolicy(string name, BackupCompliancePolicyArgs args, CustomResourceOptions? opts = null)
    public BackupCompliancePolicy(String name, BackupCompliancePolicyArgs args)
public BackupCompliancePolicy(String name, BackupCompliancePolicyArgs args, CustomResourceOptions options)

    type: mongodbatlas:BackupCompliancePolicy
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

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

    Example

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

    var backupCompliancePolicyResource = new Mongodbatlas.BackupCompliancePolicy("backupCompliancePolicyResource", new()
{
    OnDemandPolicyItem = new Mongodbatlas.Inputs.BackupCompliancePolicyOnDemandPolicyItemArgs
    {
        FrequencyInterval = 0,
        RetentionUnit = "string",
        RetentionValue = 0,
        FrequencyType = "string",
        Id = "string",
    },
    AuthorizedUserFirstName = "string",
    AuthorizedUserLastName = "string",
    ProjectId = "string",
    AuthorizedEmail = "string",
    PitEnabled = false,
    EncryptionAtRestEnabled = false,
    PolicyItemDaily = new Mongodbatlas.Inputs.BackupCompliancePolicyPolicyItemDailyArgs
    {
        FrequencyInterval = 0,
        RetentionUnit = "string",
        RetentionValue = 0,
        FrequencyType = "string",
        Id = "string",
    },
    PolicyItemHourly = new Mongodbatlas.Inputs.BackupCompliancePolicyPolicyItemHourlyArgs
    {
        FrequencyInterval = 0,
        RetentionUnit = "string",
        RetentionValue = 0,
        FrequencyType = "string",
        Id = "string",
    },
    PolicyItemMonthlies = new[]
    {
        new Mongodbatlas.Inputs.BackupCompliancePolicyPolicyItemMonthlyArgs
        {
            FrequencyInterval = 0,
            RetentionUnit = "string",
            RetentionValue = 0,
            FrequencyType = "string",
            Id = "string",
        },
    },
    PolicyItemWeeklies = new[]
    {
        new Mongodbatlas.Inputs.BackupCompliancePolicyPolicyItemWeeklyArgs
        {
            FrequencyInterval = 0,
            RetentionUnit = "string",
            RetentionValue = 0,
            FrequencyType = "string",
            Id = "string",
        },
    },
    CopyProtectionEnabled = false,
    RestoreWindowDays = 0,
});

    example, err := mongodbatlas.NewBackupCompliancePolicy(ctx, "backupCompliancePolicyResource", &mongodbatlas.BackupCompliancePolicyArgs{
	OnDemandPolicyItem: &mongodbatlas.BackupCompliancePolicyOnDemandPolicyItemArgs{
		FrequencyInterval: pulumi.Int(0),
		RetentionUnit:     pulumi.String("string"),
		RetentionValue:    pulumi.Int(0),
		FrequencyType:     pulumi.String("string"),
		Id:                pulumi.String("string"),
	},
	AuthorizedUserFirstName: pulumi.String("string"),
	AuthorizedUserLastName:  pulumi.String("string"),
	ProjectId:               pulumi.String("string"),
	AuthorizedEmail:         pulumi.String("string"),
	PitEnabled:              pulumi.Bool(false),
	EncryptionAtRestEnabled: pulumi.Bool(false),
	PolicyItemDaily: &mongodbatlas.BackupCompliancePolicyPolicyItemDailyArgs{
		FrequencyInterval: pulumi.Int(0),
		RetentionUnit:     pulumi.String("string"),
		RetentionValue:    pulumi.Int(0),
		FrequencyType:     pulumi.String("string"),
		Id:                pulumi.String("string"),
	},
	PolicyItemHourly: &mongodbatlas.BackupCompliancePolicyPolicyItemHourlyArgs{
		FrequencyInterval: pulumi.Int(0),
		RetentionUnit:     pulumi.String("string"),
		RetentionValue:    pulumi.Int(0),
		FrequencyType:     pulumi.String("string"),
		Id:                pulumi.String("string"),
	},
	PolicyItemMonthlies: mongodbatlas.BackupCompliancePolicyPolicyItemMonthlyArray{
		&mongodbatlas.BackupCompliancePolicyPolicyItemMonthlyArgs{
			FrequencyInterval: pulumi.Int(0),
			RetentionUnit:     pulumi.String("string"),
			RetentionValue:    pulumi.Int(0),
			FrequencyType:     pulumi.String("string"),
			Id:                pulumi.String("string"),
		},
	},
	PolicyItemWeeklies: mongodbatlas.BackupCompliancePolicyPolicyItemWeeklyArray{
		&mongodbatlas.BackupCompliancePolicyPolicyItemWeeklyArgs{
			FrequencyInterval: pulumi.Int(0),
			RetentionUnit:     pulumi.String("string"),
			RetentionValue:    pulumi.Int(0),
			FrequencyType:     pulumi.String("string"),
			Id:                pulumi.String("string"),
		},
	},
	CopyProtectionEnabled: pulumi.Bool(false),
	RestoreWindowDays:     pulumi.Int(0),
})

    var backupCompliancePolicyResource = new BackupCompliancePolicy("backupCompliancePolicyResource", BackupCompliancePolicyArgs.builder()        
    .onDemandPolicyItem(BackupCompliancePolicyOnDemandPolicyItemArgs.builder()
        .frequencyInterval(0)
        .retentionUnit("string")
        .retentionValue(0)
        .frequencyType("string")
        .id("string")
        .build())
    .authorizedUserFirstName("string")
    .authorizedUserLastName("string")
    .projectId("string")
    .authorizedEmail("string")
    .pitEnabled(false)
    .encryptionAtRestEnabled(false)
    .policyItemDaily(BackupCompliancePolicyPolicyItemDailyArgs.builder()
        .frequencyInterval(0)
        .retentionUnit("string")
        .retentionValue(0)
        .frequencyType("string")
        .id("string")
        .build())
    .policyItemHourly(BackupCompliancePolicyPolicyItemHourlyArgs.builder()
        .frequencyInterval(0)
        .retentionUnit("string")
        .retentionValue(0)
        .frequencyType("string")
        .id("string")
        .build())
    .policyItemMonthlies(BackupCompliancePolicyPolicyItemMonthlyArgs.builder()
        .frequencyInterval(0)
        .retentionUnit("string")
        .retentionValue(0)
        .frequencyType("string")
        .id("string")
        .build())
    .policyItemWeeklies(BackupCompliancePolicyPolicyItemWeeklyArgs.builder()
        .frequencyInterval(0)
        .retentionUnit("string")
        .retentionValue(0)
        .frequencyType("string")
        .id("string")
        .build())
    .copyProtectionEnabled(false)
    .restoreWindowDays(0)
    .build());

    backup_compliance_policy_resource = mongodbatlas.BackupCompliancePolicy("backupCompliancePolicyResource",
    on_demand_policy_item=mongodbatlas.BackupCompliancePolicyOnDemandPolicyItemArgs(
        frequency_interval=0,
        retention_unit="string",
        retention_value=0,
        frequency_type="string",
        id="string",
    ),
    authorized_user_first_name="string",
    authorized_user_last_name="string",
    project_id="string",
    authorized_email="string",
    pit_enabled=False,
    encryption_at_rest_enabled=False,
    policy_item_daily=mongodbatlas.BackupCompliancePolicyPolicyItemDailyArgs(
        frequency_interval=0,
        retention_unit="string",
        retention_value=0,
        frequency_type="string",
        id="string",
    ),
    policy_item_hourly=mongodbatlas.BackupCompliancePolicyPolicyItemHourlyArgs(
        frequency_interval=0,
        retention_unit="string",
        retention_value=0,
        frequency_type="string",
        id="string",
    ),
    policy_item_monthlies=[mongodbatlas.BackupCompliancePolicyPolicyItemMonthlyArgs(
        frequency_interval=0,
        retention_unit="string",
        retention_value=0,
        frequency_type="string",
        id="string",
    )],
    policy_item_weeklies=[mongodbatlas.BackupCompliancePolicyPolicyItemWeeklyArgs(
        frequency_interval=0,
        retention_unit="string",
        retention_value=0,
        frequency_type="string",
        id="string",
    )],
    copy_protection_enabled=False,
    restore_window_days=0)

    const backupCompliancePolicyResource = new mongodbatlas.BackupCompliancePolicy("backupCompliancePolicyResource", {
    onDemandPolicyItem: {
        frequencyInterval: 0,
        retentionUnit: "string",
        retentionValue: 0,
        frequencyType: "string",
        id: "string",
    },
    authorizedUserFirstName: "string",
    authorizedUserLastName: "string",
    projectId: "string",
    authorizedEmail: "string",
    pitEnabled: false,
    encryptionAtRestEnabled: false,
    policyItemDaily: {
        frequencyInterval: 0,
        retentionUnit: "string",
        retentionValue: 0,
        frequencyType: "string",
        id: "string",
    },
    policyItemHourly: {
        frequencyInterval: 0,
        retentionUnit: "string",
        retentionValue: 0,
        frequencyType: "string",
        id: "string",
    },
    policyItemMonthlies: [{
        frequencyInterval: 0,
        retentionUnit: "string",
        retentionValue: 0,
        frequencyType: "string",
        id: "string",
    }],
    policyItemWeeklies: [{
        frequencyInterval: 0,
        retentionUnit: "string",
        retentionValue: 0,
        frequencyType: "string",
        id: "string",
    }],
    copyProtectionEnabled: false,
    restoreWindowDays: 0,
});

    type: mongodbatlas:BackupCompliancePolicy
properties:
    authorizedEmail: string
    authorizedUserFirstName: string
    authorizedUserLastName: string
    copyProtectionEnabled: false
    encryptionAtRestEnabled: false
    onDemandPolicyItem:
        frequencyInterval: 0
        frequencyType: string
        id: string
        retentionUnit: string
        retentionValue: 0
    pitEnabled: false
    policyItemDaily:
        frequencyInterval: 0
        frequencyType: string
        id: string
        retentionUnit: string
        retentionValue: 0
    policyItemHourly:
        frequencyInterval: 0
        frequencyType: string
        id: string
        retentionUnit: string
        retentionValue: 0
    policyItemMonthlies:
        - frequencyInterval: 0
          frequencyType: string
          id: string
          retentionUnit: string
          retentionValue: 0
    policyItemWeeklies:
        - frequencyInterval: 0
          frequencyType: string
          id: string
          retentionUnit: string
          retentionValue: 0
    projectId: string
    restoreWindowDays: 0

    BackupCompliancePolicy Resource Properties

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

    Inputs

    The BackupCompliancePolicy resource accepts the following input properties:

    AuthorizedEmail string
    Email address of a security or legal representative for the Backup Compliance Policy 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.
    OnDemandPolicyItem BackupCompliancePolicyOnDemandPolicyItem
    ProjectId string
    Unique 24-hexadecimal digit string that identifies your project.
    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.
    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 BackupCompliancePolicyPolicyItemDaily
    PolicyItemHourly BackupCompliancePolicyPolicyItemHourly
    PolicyItemMonthlies List<BackupCompliancePolicyPolicyItemMonthly>
    PolicyItemWeeklies List<BackupCompliancePolicyPolicyItemWeekly>
    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.
    AuthorizedEmail string
    Email address of a security or legal representative for the Backup Compliance Policy 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.
    OnDemandPolicyItem BackupCompliancePolicyOnDemandPolicyItemArgs
    ProjectId string
    Unique 24-hexadecimal digit string that identifies your project.
    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.
    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 BackupCompliancePolicyPolicyItemDailyArgs
    PolicyItemHourly BackupCompliancePolicyPolicyItemHourlyArgs
    PolicyItemMonthlies []BackupCompliancePolicyPolicyItemMonthlyArgs
    PolicyItemWeeklies []BackupCompliancePolicyPolicyItemWeeklyArgs
    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.
    authorizedEmail String
    Email address of a security or legal representative for the Backup Compliance Policy 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.
    onDemandPolicyItem BackupCompliancePolicyOnDemandPolicyItem
    projectId String
    Unique 24-hexadecimal digit string that identifies your project.
    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.
    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 BackupCompliancePolicyPolicyItemDaily
    policyItemHourly BackupCompliancePolicyPolicyItemHourly
    policyItemMonthlies List<BackupCompliancePolicyPolicyItemMonthly>
    policyItemWeeklies List<BackupCompliancePolicyPolicyItemWeekly>
    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.
    authorizedEmail string
    Email address of a security or legal representative for the Backup Compliance Policy 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.
    onDemandPolicyItem BackupCompliancePolicyOnDemandPolicyItem
    projectId string
    Unique 24-hexadecimal digit string that identifies your project.
    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.
    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 BackupCompliancePolicyPolicyItemDaily
    policyItemHourly BackupCompliancePolicyPolicyItemHourly
    policyItemMonthlies BackupCompliancePolicyPolicyItemMonthly[]
    policyItemWeeklies BackupCompliancePolicyPolicyItemWeekly[]
    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.
    authorized_email str
    Email address of a security or legal representative for the Backup Compliance Policy 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.
    on_demand_policy_item BackupCompliancePolicyOnDemandPolicyItemArgs
    project_id str
    Unique 24-hexadecimal digit string that identifies your project.
    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.
    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 BackupCompliancePolicyPolicyItemDailyArgs
    policy_item_hourly BackupCompliancePolicyPolicyItemHourlyArgs
    policy_item_monthlies Sequence[BackupCompliancePolicyPolicyItemMonthlyArgs]
    policy_item_weeklies Sequence[BackupCompliancePolicyPolicyItemWeeklyArgs]
    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.
    authorizedEmail String
    Email address of a security or legal representative for the Backup Compliance Policy 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.
    onDemandPolicyItem Property Map
    projectId String
    Unique 24-hexadecimal digit string that identifies your project.
    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.
    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>
    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.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    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.
    Id string
    The provider-assigned unique ID for this managed resource.
    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.
    id String
    The provider-assigned unique ID for this managed resource.
    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.
    id string
    The provider-assigned unique ID for this managed resource.
    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.
    id str
    The provider-assigned unique ID for this managed resource.
    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.
    id String
    The provider-assigned unique ID for this managed resource.
    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.

    Look up Existing BackupCompliancePolicy Resource

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

    public static get(name: string, id: Input<ID>, state?: BackupCompliancePolicyState, opts?: CustomResourceOptions): BackupCompliancePolicy
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        authorized_email: Optional[str] = None,
        authorized_user_first_name: Optional[str] = None,
        authorized_user_last_name: Optional[str] = None,
        copy_protection_enabled: Optional[bool] = None,
        encryption_at_rest_enabled: Optional[bool] = None,
        on_demand_policy_item: Optional[BackupCompliancePolicyOnDemandPolicyItemArgs] = None,
        pit_enabled: Optional[bool] = None,
        policy_item_daily: Optional[BackupCompliancePolicyPolicyItemDailyArgs] = None,
        policy_item_hourly: Optional[BackupCompliancePolicyPolicyItemHourlyArgs] = None,
        policy_item_monthlies: Optional[Sequence[BackupCompliancePolicyPolicyItemMonthlyArgs]] = None,
        policy_item_weeklies: Optional[Sequence[BackupCompliancePolicyPolicyItemWeeklyArgs]] = None,
        project_id: Optional[str] = None,
        restore_window_days: Optional[int] = None,
        state: Optional[str] = None,
        updated_date: Optional[str] = None,
        updated_user: Optional[str] = None) -> BackupCompliancePolicy
    func GetBackupCompliancePolicy(ctx *Context, name string, id IDInput, state *BackupCompliancePolicyState, opts ...ResourceOption) (*BackupCompliancePolicy, error)
    public static BackupCompliancePolicy Get(string name, Input<string> id, BackupCompliancePolicyState? state, CustomResourceOptions? opts = null)
    public static BackupCompliancePolicy get(String name, Output<String> id, BackupCompliancePolicyState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AuthorizedEmail string
    Email address of a security or legal representative for the Backup Compliance Policy 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.
    OnDemandPolicyItem BackupCompliancePolicyOnDemandPolicyItem
    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 BackupCompliancePolicyPolicyItemDaily
    PolicyItemHourly BackupCompliancePolicyPolicyItemHourly
    PolicyItemMonthlies List<BackupCompliancePolicyPolicyItemMonthly>
    PolicyItemWeeklies List<BackupCompliancePolicyPolicyItemWeekly>
    ProjectId string
    Unique 24-hexadecimal digit string that identifies your project.
    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 a security or legal representative for the Backup Compliance Policy 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.
    OnDemandPolicyItem BackupCompliancePolicyOnDemandPolicyItemArgs
    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 BackupCompliancePolicyPolicyItemDailyArgs
    PolicyItemHourly BackupCompliancePolicyPolicyItemHourlyArgs
    PolicyItemMonthlies []BackupCompliancePolicyPolicyItemMonthlyArgs
    PolicyItemWeeklies []BackupCompliancePolicyPolicyItemWeeklyArgs
    ProjectId string
    Unique 24-hexadecimal digit string that identifies your project.
    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 a security or legal representative for the Backup Compliance Policy 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.
    onDemandPolicyItem BackupCompliancePolicyOnDemandPolicyItem
    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 BackupCompliancePolicyPolicyItemDaily
    policyItemHourly BackupCompliancePolicyPolicyItemHourly
    policyItemMonthlies List<BackupCompliancePolicyPolicyItemMonthly>
    policyItemWeeklies List<BackupCompliancePolicyPolicyItemWeekly>
    projectId String
    Unique 24-hexadecimal digit string that identifies your project.
    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 a security or legal representative for the Backup Compliance Policy 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.
    onDemandPolicyItem BackupCompliancePolicyOnDemandPolicyItem
    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 BackupCompliancePolicyPolicyItemDaily
    policyItemHourly BackupCompliancePolicyPolicyItemHourly
    policyItemMonthlies BackupCompliancePolicyPolicyItemMonthly[]
    policyItemWeeklies BackupCompliancePolicyPolicyItemWeekly[]
    projectId string
    Unique 24-hexadecimal digit string that identifies your project.
    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 a security or legal representative for the Backup Compliance Policy 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.
    on_demand_policy_item BackupCompliancePolicyOnDemandPolicyItemArgs
    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 BackupCompliancePolicyPolicyItemDailyArgs
    policy_item_hourly BackupCompliancePolicyPolicyItemHourlyArgs
    policy_item_monthlies Sequence[BackupCompliancePolicyPolicyItemMonthlyArgs]
    policy_item_weeklies Sequence[BackupCompliancePolicyPolicyItemWeeklyArgs]
    project_id str
    Unique 24-hexadecimal digit string that identifies your project.
    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 a security or legal representative for the Backup Compliance Policy 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.
    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
    Unique 24-hexadecimal digit string that identifies your project.
    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

    BackupCompliancePolicyOnDemandPolicyItem, BackupCompliancePolicyOnDemandPolicyItemArgs

    FrequencyInterval int
    Desired frequency of the new backup policy item specified by frequency_type (monthly in this case). The supported values for weekly policies are
    RetentionUnit string
    Scope of the backup policy item: days, weeks, 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.
    FrequencyType string
    Frequency associated with the backup policy item. For monthly policies, the frequency type is defined as monthly. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.
    Id string
    Unique identifier of the backup policy item.
    FrequencyInterval int
    Desired frequency of the new backup policy item specified by frequency_type (monthly in this case). The supported values for weekly policies are
    RetentionUnit string
    Scope of the backup policy item: days, weeks, 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.
    FrequencyType string
    Frequency associated with the backup policy item. For monthly policies, the frequency type is defined as monthly. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.
    Id string
    Unique identifier of the backup policy item.
    frequencyInterval Integer
    Desired frequency of the new backup policy item specified by frequency_type (monthly in this case). The supported values for weekly policies are
    retentionUnit String
    Scope of the backup policy item: days, weeks, 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.
    frequencyType String
    Frequency associated with the backup policy item. For monthly policies, the frequency type is defined as monthly. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.
    id String
    Unique identifier of the backup policy item.
    frequencyInterval number
    Desired frequency of the new backup policy item specified by frequency_type (monthly in this case). The supported values for weekly policies are
    retentionUnit string
    Scope of the backup policy item: days, weeks, 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.
    frequencyType string
    Frequency associated with the backup policy item. For monthly policies, the frequency type is defined as monthly. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.
    id string
    Unique identifier of the backup policy item.
    frequency_interval int
    Desired frequency of the new backup policy item specified by frequency_type (monthly in this case). The supported values for weekly policies are
    retention_unit str
    Scope of the backup policy item: days, weeks, 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.
    frequency_type str
    Frequency associated with the backup policy item. For monthly policies, the frequency type is defined as monthly. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.
    id str
    Unique identifier of the backup policy item.
    frequencyInterval Number
    Desired frequency of the new backup policy item specified by frequency_type (monthly in this case). The supported values for weekly policies are
    retentionUnit String
    Scope of the backup policy item: days, weeks, 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.
    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.

    BackupCompliancePolicyPolicyItemDaily, BackupCompliancePolicyPolicyItemDailyArgs

    FrequencyInterval int
    Desired frequency of the new backup policy item specified by frequency_type (monthly in this case). The supported values for weekly policies are
    RetentionUnit string
    Scope of the backup policy item: days, weeks, 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.
    FrequencyType string
    Frequency associated with the backup policy item. For monthly policies, the frequency type is defined as monthly. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.
    Id string
    Unique identifier of the backup policy item.
    FrequencyInterval int
    Desired frequency of the new backup policy item specified by frequency_type (monthly in this case). The supported values for weekly policies are
    RetentionUnit string
    Scope of the backup policy item: days, weeks, 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.
    FrequencyType string
    Frequency associated with the backup policy item. For monthly policies, the frequency type is defined as monthly. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.
    Id string
    Unique identifier of the backup policy item.
    frequencyInterval Integer
    Desired frequency of the new backup policy item specified by frequency_type (monthly in this case). The supported values for weekly policies are
    retentionUnit String
    Scope of the backup policy item: days, weeks, 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.
    frequencyType String
    Frequency associated with the backup policy item. For monthly policies, the frequency type is defined as monthly. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.
    id String
    Unique identifier of the backup policy item.
    frequencyInterval number
    Desired frequency of the new backup policy item specified by frequency_type (monthly in this case). The supported values for weekly policies are
    retentionUnit string
    Scope of the backup policy item: days, weeks, 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.
    frequencyType string
    Frequency associated with the backup policy item. For monthly policies, the frequency type is defined as monthly. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.
    id string
    Unique identifier of the backup policy item.
    frequency_interval int
    Desired frequency of the new backup policy item specified by frequency_type (monthly in this case). The supported values for weekly policies are
    retention_unit str
    Scope of the backup policy item: days, weeks, 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.
    frequency_type str
    Frequency associated with the backup policy item. For monthly policies, the frequency type is defined as monthly. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.
    id str
    Unique identifier of the backup policy item.
    frequencyInterval Number
    Desired frequency of the new backup policy item specified by frequency_type (monthly in this case). The supported values for weekly policies are
    retentionUnit String
    Scope of the backup policy item: days, weeks, 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.
    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.

    BackupCompliancePolicyPolicyItemHourly, BackupCompliancePolicyPolicyItemHourlyArgs

    FrequencyInterval int
    Desired frequency of the new backup policy item specified by frequency_type (monthly in this case). The supported values for weekly policies are
    RetentionUnit string
    Scope of the backup policy item: days, weeks, 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.
    FrequencyType string
    Frequency associated with the backup policy item. For monthly policies, the frequency type is defined as monthly. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.
    Id string
    Unique identifier of the backup policy item.
    FrequencyInterval int
    Desired frequency of the new backup policy item specified by frequency_type (monthly in this case). The supported values for weekly policies are
    RetentionUnit string
    Scope of the backup policy item: days, weeks, 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.
    FrequencyType string
    Frequency associated with the backup policy item. For monthly policies, the frequency type is defined as monthly. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.
    Id string
    Unique identifier of the backup policy item.
    frequencyInterval Integer
    Desired frequency of the new backup policy item specified by frequency_type (monthly in this case). The supported values for weekly policies are
    retentionUnit String
    Scope of the backup policy item: days, weeks, 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.
    frequencyType String
    Frequency associated with the backup policy item. For monthly policies, the frequency type is defined as monthly. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.
    id String
    Unique identifier of the backup policy item.
    frequencyInterval number
    Desired frequency of the new backup policy item specified by frequency_type (monthly in this case). The supported values for weekly policies are
    retentionUnit string
    Scope of the backup policy item: days, weeks, 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.
    frequencyType string
    Frequency associated with the backup policy item. For monthly policies, the frequency type is defined as monthly. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.
    id string
    Unique identifier of the backup policy item.
    frequency_interval int
    Desired frequency of the new backup policy item specified by frequency_type (monthly in this case). The supported values for weekly policies are
    retention_unit str
    Scope of the backup policy item: days, weeks, 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.
    frequency_type str
    Frequency associated with the backup policy item. For monthly policies, the frequency type is defined as monthly. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.
    id str
    Unique identifier of the backup policy item.
    frequencyInterval Number
    Desired frequency of the new backup policy item specified by frequency_type (monthly in this case). The supported values for weekly policies are
    retentionUnit String
    Scope of the backup policy item: days, weeks, 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.
    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.

    BackupCompliancePolicyPolicyItemMonthly, BackupCompliancePolicyPolicyItemMonthlyArgs

    FrequencyInterval int
    Desired frequency of the new backup policy item specified by frequency_type (monthly in this case). The supported values for weekly policies are
    RetentionUnit string
    Scope of the backup policy item: days, weeks, 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.
    FrequencyType string
    Frequency associated with the backup policy item. For monthly policies, the frequency type is defined as monthly. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.
    Id string
    Unique identifier of the backup policy item.
    FrequencyInterval int
    Desired frequency of the new backup policy item specified by frequency_type (monthly in this case). The supported values for weekly policies are
    RetentionUnit string
    Scope of the backup policy item: days, weeks, 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.
    FrequencyType string
    Frequency associated with the backup policy item. For monthly policies, the frequency type is defined as monthly. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.
    Id string
    Unique identifier of the backup policy item.
    frequencyInterval Integer
    Desired frequency of the new backup policy item specified by frequency_type (monthly in this case). The supported values for weekly policies are
    retentionUnit String
    Scope of the backup policy item: days, weeks, 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.
    frequencyType String
    Frequency associated with the backup policy item. For monthly policies, the frequency type is defined as monthly. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.
    id String
    Unique identifier of the backup policy item.
    frequencyInterval number
    Desired frequency of the new backup policy item specified by frequency_type (monthly in this case). The supported values for weekly policies are
    retentionUnit string
    Scope of the backup policy item: days, weeks, 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.
    frequencyType string
    Frequency associated with the backup policy item. For monthly policies, the frequency type is defined as monthly. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.
    id string
    Unique identifier of the backup policy item.
    frequency_interval int
    Desired frequency of the new backup policy item specified by frequency_type (monthly in this case). The supported values for weekly policies are
    retention_unit str
    Scope of the backup policy item: days, weeks, 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.
    frequency_type str
    Frequency associated with the backup policy item. For monthly policies, the frequency type is defined as monthly. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.
    id str
    Unique identifier of the backup policy item.
    frequencyInterval Number
    Desired frequency of the new backup policy item specified by frequency_type (monthly in this case). The supported values for weekly policies are
    retentionUnit String
    Scope of the backup policy item: days, weeks, 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.
    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.

    BackupCompliancePolicyPolicyItemWeekly, BackupCompliancePolicyPolicyItemWeeklyArgs

    FrequencyInterval int
    Desired frequency of the new backup policy item specified by frequency_type (monthly in this case). The supported values for weekly policies are
    RetentionUnit string
    Scope of the backup policy item: days, weeks, 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.
    FrequencyType string
    Frequency associated with the backup policy item. For monthly policies, the frequency type is defined as monthly. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.
    Id string
    Unique identifier of the backup policy item.
    FrequencyInterval int
    Desired frequency of the new backup policy item specified by frequency_type (monthly in this case). The supported values for weekly policies are
    RetentionUnit string
    Scope of the backup policy item: days, weeks, 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.
    FrequencyType string
    Frequency associated with the backup policy item. For monthly policies, the frequency type is defined as monthly. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.
    Id string
    Unique identifier of the backup policy item.
    frequencyInterval Integer
    Desired frequency of the new backup policy item specified by frequency_type (monthly in this case). The supported values for weekly policies are
    retentionUnit String
    Scope of the backup policy item: days, weeks, 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.
    frequencyType String
    Frequency associated with the backup policy item. For monthly policies, the frequency type is defined as monthly. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.
    id String
    Unique identifier of the backup policy item.
    frequencyInterval number
    Desired frequency of the new backup policy item specified by frequency_type (monthly in this case). The supported values for weekly policies are
    retentionUnit string
    Scope of the backup policy item: days, weeks, 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.
    frequencyType string
    Frequency associated with the backup policy item. For monthly policies, the frequency type is defined as monthly. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.
    id string
    Unique identifier of the backup policy item.
    frequency_interval int
    Desired frequency of the new backup policy item specified by frequency_type (monthly in this case). The supported values for weekly policies are
    retention_unit str
    Scope of the backup policy item: days, weeks, 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.
    frequency_type str
    Frequency associated with the backup policy item. For monthly policies, the frequency type is defined as monthly. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type.
    id str
    Unique identifier of the backup policy item.
    frequencyInterval Number
    Desired frequency of the new backup policy item specified by frequency_type (monthly in this case). The supported values for weekly policies are
    retentionUnit String
    Scope of the backup policy item: days, weeks, 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.
    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.

    Import

    Backup Compliance Policy entries can be imported using project project_id in the format project_id, e.g.

    $ pulumi import mongodbatlas:index/backupCompliancePolicy:BackupCompliancePolicy backup_policy 5d0f1f73cf09a29120e173cf

    For more information see: MongoDB Atlas API Reference and Backup Compliance Policy Prohibited Actions.

    To learn more about importing existing cloud resources, see Importing resources.

    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