mongodbatlas.BackupCompliancePolicy
Explore with Pulumi AI
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as mongodbatlas from "@pulumi/mongodbatlas";
const myCluster = new mongodbatlas.Cluster("my_cluster", {
projectId: "<PROJECT-ID>",
name: "clusterTest",
providerName: "AWS",
providerRegionName: "EU_CENTRAL_1",
providerInstanceSizeName: "M10",
cloudBackup: true,
});
const testCloudBackupSchedule = new mongodbatlas.CloudBackupSchedule("test", {
projectId: myCluster.projectId,
clusterName: myCluster.name,
referenceHourOfDay: 3,
referenceMinuteOfHour: 45,
restoreWindowDays: 4,
policyItemHourly: {
frequencyInterval: 1,
retentionUnit: "days",
retentionValue: 7,
},
policyItemDaily: {
frequencyInterval: 1,
retentionUnit: "days",
retentionValue: 7,
},
policyItemWeeklies: [{
frequencyInterval: 1,
retentionUnit: "weeks",
retentionValue: 4,
}],
policyItemMonthlies: [{
frequencyInterval: 1,
retentionUnit: "months",
retentionValue: 12,
}],
policyItemYearlies: [{
frequencyInterval: 1,
retentionUnit: "years",
retentionValue: 1,
}],
});
const test = mongodbatlas.getCloudBackupScheduleOutput({
projectId: testCloudBackupSchedule.projectId,
clusterName: testCloudBackupSchedule.clusterName,
});
const backupPolicy = mongodbatlas.getBackupCompliancePolicyOutput({
projectId: testCloudBackupSchedule.projectId,
});
const backupPolicyBackupCompliancePolicy = new mongodbatlas.BackupCompliancePolicy("backup_policy", {
projectId: "<PROJECT-ID>",
authorizedEmail: "user@email.com",
authorizedUserFirstName: "First",
authorizedUserLastName: "Last",
copyProtectionEnabled: false,
pitEnabled: false,
encryptionAtRestEnabled: false,
restoreWindowDays: 7,
onDemandPolicyItem: {
frequencyInterval: 1,
retentionUnit: "days",
retentionValue: 3,
},
policyItemHourly: {
frequencyInterval: 1,
retentionUnit: "days",
retentionValue: 7,
},
policyItemDaily: {
frequencyInterval: 1,
retentionUnit: "days",
retentionValue: 7,
},
policyItemWeeklies: [{
frequencyInterval: 1,
retentionUnit: "weeks",
retentionValue: 4,
}],
policyItemMonthlies: [{
frequencyInterval: 1,
retentionUnit: "months",
retentionValue: 12,
}],
policyItemYearlies: [{
frequencyInterval: 1,
retentionUnit: "years",
retentionValue: 1,
}],
});
import pulumi
import pulumi_mongodbatlas as mongodbatlas
my_cluster = mongodbatlas.Cluster("my_cluster",
project_id="<PROJECT-ID>",
name="clusterTest",
provider_name="AWS",
provider_region_name="EU_CENTRAL_1",
provider_instance_size_name="M10",
cloud_backup=True)
test_cloud_backup_schedule = mongodbatlas.CloudBackupSchedule("test",
project_id=my_cluster.project_id,
cluster_name=my_cluster.name,
reference_hour_of_day=3,
reference_minute_of_hour=45,
restore_window_days=4,
policy_item_hourly=mongodbatlas.CloudBackupSchedulePolicyItemHourlyArgs(
frequency_interval=1,
retention_unit="days",
retention_value=7,
),
policy_item_daily=mongodbatlas.CloudBackupSchedulePolicyItemDailyArgs(
frequency_interval=1,
retention_unit="days",
retention_value=7,
),
policy_item_weeklies=[mongodbatlas.CloudBackupSchedulePolicyItemWeeklyArgs(
frequency_interval=1,
retention_unit="weeks",
retention_value=4,
)],
policy_item_monthlies=[mongodbatlas.CloudBackupSchedulePolicyItemMonthlyArgs(
frequency_interval=1,
retention_unit="months",
retention_value=12,
)],
policy_item_yearlies=[mongodbatlas.CloudBackupSchedulePolicyItemYearlyArgs(
frequency_interval=1,
retention_unit="years",
retention_value=1,
)])
test = mongodbatlas.get_cloud_backup_schedule_output(project_id=test_cloud_backup_schedule.project_id,
cluster_name=test_cloud_backup_schedule.cluster_name)
backup_policy = mongodbatlas.get_backup_compliance_policy_output(project_id=test_cloud_backup_schedule.project_id)
backup_policy_backup_compliance_policy = mongodbatlas.BackupCompliancePolicy("backup_policy",
project_id="<PROJECT-ID>",
authorized_email="user@email.com",
authorized_user_first_name="First",
authorized_user_last_name="Last",
copy_protection_enabled=False,
pit_enabled=False,
encryption_at_rest_enabled=False,
restore_window_days=7,
on_demand_policy_item=mongodbatlas.BackupCompliancePolicyOnDemandPolicyItemArgs(
frequency_interval=1,
retention_unit="days",
retention_value=3,
),
policy_item_hourly=mongodbatlas.BackupCompliancePolicyPolicyItemHourlyArgs(
frequency_interval=1,
retention_unit="days",
retention_value=7,
),
policy_item_daily=mongodbatlas.BackupCompliancePolicyPolicyItemDailyArgs(
frequency_interval=1,
retention_unit="days",
retention_value=7,
),
policy_item_weeklies=[mongodbatlas.BackupCompliancePolicyPolicyItemWeeklyArgs(
frequency_interval=1,
retention_unit="weeks",
retention_value=4,
)],
policy_item_monthlies=[mongodbatlas.BackupCompliancePolicyPolicyItemMonthlyArgs(
frequency_interval=1,
retention_unit="months",
retention_value=12,
)],
policy_item_yearlies=[mongodbatlas.BackupCompliancePolicyPolicyItemYearlyArgs(
frequency_interval=1,
retention_unit="years",
retention_value=1,
)])
package main
import (
"github.com/pulumi/pulumi-mongodbatlas/sdk/v3/go/mongodbatlas"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
myCluster, err := mongodbatlas.NewCluster(ctx, "my_cluster", &mongodbatlas.ClusterArgs{
ProjectId: pulumi.String("<PROJECT-ID>"),
Name: pulumi.String("clusterTest"),
ProviderName: pulumi.String("AWS"),
ProviderRegionName: pulumi.String("EU_CENTRAL_1"),
ProviderInstanceSizeName: pulumi.String("M10"),
CloudBackup: pulumi.Bool(true),
})
if err != nil {
return err
}
testCloudBackupSchedule, err := mongodbatlas.NewCloudBackupSchedule(ctx, "test", &mongodbatlas.CloudBackupScheduleArgs{
ProjectId: myCluster.ProjectId,
ClusterName: myCluster.Name,
ReferenceHourOfDay: pulumi.Int(3),
ReferenceMinuteOfHour: pulumi.Int(45),
RestoreWindowDays: pulumi.Int(4),
PolicyItemHourly: &mongodbatlas.CloudBackupSchedulePolicyItemHourlyArgs{
FrequencyInterval: pulumi.Int(1),
RetentionUnit: pulumi.String("days"),
RetentionValue: pulumi.Int(7),
},
PolicyItemDaily: &mongodbatlas.CloudBackupSchedulePolicyItemDailyArgs{
FrequencyInterval: pulumi.Int(1),
RetentionUnit: pulumi.String("days"),
RetentionValue: pulumi.Int(7),
},
PolicyItemWeeklies: mongodbatlas.CloudBackupSchedulePolicyItemWeeklyArray{
&mongodbatlas.CloudBackupSchedulePolicyItemWeeklyArgs{
FrequencyInterval: pulumi.Int(1),
RetentionUnit: pulumi.String("weeks"),
RetentionValue: pulumi.Int(4),
},
},
PolicyItemMonthlies: mongodbatlas.CloudBackupSchedulePolicyItemMonthlyArray{
&mongodbatlas.CloudBackupSchedulePolicyItemMonthlyArgs{
FrequencyInterval: pulumi.Int(1),
RetentionUnit: pulumi.String("months"),
RetentionValue: pulumi.Int(12),
},
},
PolicyItemYearlies: mongodbatlas.CloudBackupSchedulePolicyItemYearlyArray{
&mongodbatlas.CloudBackupSchedulePolicyItemYearlyArgs{
FrequencyInterval: pulumi.Int(1),
RetentionUnit: pulumi.String("years"),
RetentionValue: pulumi.Int(1),
},
},
})
if err != nil {
return err
}
_ = mongodbatlas.LookupCloudBackupScheduleOutput(ctx, mongodbatlas.GetCloudBackupScheduleOutputArgs{
ProjectId: testCloudBackupSchedule.ProjectId,
ClusterName: testCloudBackupSchedule.ClusterName,
}, nil)
_ = mongodbatlas.LookupBackupCompliancePolicyOutput(ctx, mongodbatlas.GetBackupCompliancePolicyOutputArgs{
ProjectId: testCloudBackupSchedule.ProjectId,
}, nil)
_, err = mongodbatlas.NewBackupCompliancePolicy(ctx, "backup_policy", &mongodbatlas.BackupCompliancePolicyArgs{
ProjectId: pulumi.String("<PROJECT-ID>"),
AuthorizedEmail: pulumi.String("user@email.com"),
AuthorizedUserFirstName: pulumi.String("First"),
AuthorizedUserLastName: pulumi.String("Last"),
CopyProtectionEnabled: pulumi.Bool(false),
PitEnabled: pulumi.Bool(false),
EncryptionAtRestEnabled: pulumi.Bool(false),
RestoreWindowDays: pulumi.Int(7),
OnDemandPolicyItem: &mongodbatlas.BackupCompliancePolicyOnDemandPolicyItemArgs{
FrequencyInterval: pulumi.Int(1),
RetentionUnit: pulumi.String("days"),
RetentionValue: pulumi.Int(3),
},
PolicyItemHourly: &mongodbatlas.BackupCompliancePolicyPolicyItemHourlyArgs{
FrequencyInterval: pulumi.Int(1),
RetentionUnit: pulumi.String("days"),
RetentionValue: pulumi.Int(7),
},
PolicyItemDaily: &mongodbatlas.BackupCompliancePolicyPolicyItemDailyArgs{
FrequencyInterval: pulumi.Int(1),
RetentionUnit: pulumi.String("days"),
RetentionValue: pulumi.Int(7),
},
PolicyItemWeeklies: mongodbatlas.BackupCompliancePolicyPolicyItemWeeklyArray{
&mongodbatlas.BackupCompliancePolicyPolicyItemWeeklyArgs{
FrequencyInterval: pulumi.Int(1),
RetentionUnit: pulumi.String("weeks"),
RetentionValue: pulumi.Int(4),
},
},
PolicyItemMonthlies: mongodbatlas.BackupCompliancePolicyPolicyItemMonthlyArray{
&mongodbatlas.BackupCompliancePolicyPolicyItemMonthlyArgs{
FrequencyInterval: pulumi.Int(1),
RetentionUnit: pulumi.String("months"),
RetentionValue: pulumi.Int(12),
},
},
PolicyItemYearlies: mongodbatlas.BackupCompliancePolicyPolicyItemYearlyArray{
&mongodbatlas.BackupCompliancePolicyPolicyItemYearlyArgs{
FrequencyInterval: pulumi.Int(1),
RetentionUnit: pulumi.String("years"),
RetentionValue: pulumi.Int(1),
},
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Mongodbatlas = Pulumi.Mongodbatlas;
return await Deployment.RunAsync(() =>
{
var myCluster = new Mongodbatlas.Cluster("my_cluster", new()
{
ProjectId = "<PROJECT-ID>",
Name = "clusterTest",
ProviderName = "AWS",
ProviderRegionName = "EU_CENTRAL_1",
ProviderInstanceSizeName = "M10",
CloudBackup = true,
});
var testCloudBackupSchedule = new Mongodbatlas.CloudBackupSchedule("test", new()
{
ProjectId = myCluster.ProjectId,
ClusterName = myCluster.Name,
ReferenceHourOfDay = 3,
ReferenceMinuteOfHour = 45,
RestoreWindowDays = 4,
PolicyItemHourly = new Mongodbatlas.Inputs.CloudBackupSchedulePolicyItemHourlyArgs
{
FrequencyInterval = 1,
RetentionUnit = "days",
RetentionValue = 7,
},
PolicyItemDaily = new Mongodbatlas.Inputs.CloudBackupSchedulePolicyItemDailyArgs
{
FrequencyInterval = 1,
RetentionUnit = "days",
RetentionValue = 7,
},
PolicyItemWeeklies = new[]
{
new Mongodbatlas.Inputs.CloudBackupSchedulePolicyItemWeeklyArgs
{
FrequencyInterval = 1,
RetentionUnit = "weeks",
RetentionValue = 4,
},
},
PolicyItemMonthlies = new[]
{
new Mongodbatlas.Inputs.CloudBackupSchedulePolicyItemMonthlyArgs
{
FrequencyInterval = 1,
RetentionUnit = "months",
RetentionValue = 12,
},
},
PolicyItemYearlies = new[]
{
new Mongodbatlas.Inputs.CloudBackupSchedulePolicyItemYearlyArgs
{
FrequencyInterval = 1,
RetentionUnit = "years",
RetentionValue = 1,
},
},
});
var test = Mongodbatlas.GetCloudBackupSchedule.Invoke(new()
{
ProjectId = testCloudBackupSchedule.ProjectId,
ClusterName = testCloudBackupSchedule.ClusterName,
});
var backupPolicy = Mongodbatlas.GetBackupCompliancePolicy.Invoke(new()
{
ProjectId = testCloudBackupSchedule.ProjectId,
});
var backupPolicyBackupCompliancePolicy = new Mongodbatlas.BackupCompliancePolicy("backup_policy", new()
{
ProjectId = "<PROJECT-ID>",
AuthorizedEmail = "user@email.com",
AuthorizedUserFirstName = "First",
AuthorizedUserLastName = "Last",
CopyProtectionEnabled = false,
PitEnabled = false,
EncryptionAtRestEnabled = false,
RestoreWindowDays = 7,
OnDemandPolicyItem = new Mongodbatlas.Inputs.BackupCompliancePolicyOnDemandPolicyItemArgs
{
FrequencyInterval = 1,
RetentionUnit = "days",
RetentionValue = 3,
},
PolicyItemHourly = new Mongodbatlas.Inputs.BackupCompliancePolicyPolicyItemHourlyArgs
{
FrequencyInterval = 1,
RetentionUnit = "days",
RetentionValue = 7,
},
PolicyItemDaily = new Mongodbatlas.Inputs.BackupCompliancePolicyPolicyItemDailyArgs
{
FrequencyInterval = 1,
RetentionUnit = "days",
RetentionValue = 7,
},
PolicyItemWeeklies = new[]
{
new Mongodbatlas.Inputs.BackupCompliancePolicyPolicyItemWeeklyArgs
{
FrequencyInterval = 1,
RetentionUnit = "weeks",
RetentionValue = 4,
},
},
PolicyItemMonthlies = new[]
{
new Mongodbatlas.Inputs.BackupCompliancePolicyPolicyItemMonthlyArgs
{
FrequencyInterval = 1,
RetentionUnit = "months",
RetentionValue = 12,
},
},
PolicyItemYearlies = new[]
{
new Mongodbatlas.Inputs.BackupCompliancePolicyPolicyItemYearlyArgs
{
FrequencyInterval = 1,
RetentionUnit = "years",
RetentionValue = 1,
},
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.mongodbatlas.Cluster;
import com.pulumi.mongodbatlas.ClusterArgs;
import com.pulumi.mongodbatlas.CloudBackupSchedule;
import com.pulumi.mongodbatlas.CloudBackupScheduleArgs;
import com.pulumi.mongodbatlas.inputs.CloudBackupSchedulePolicyItemHourlyArgs;
import com.pulumi.mongodbatlas.inputs.CloudBackupSchedulePolicyItemDailyArgs;
import com.pulumi.mongodbatlas.inputs.CloudBackupSchedulePolicyItemWeeklyArgs;
import com.pulumi.mongodbatlas.inputs.CloudBackupSchedulePolicyItemMonthlyArgs;
import com.pulumi.mongodbatlas.inputs.CloudBackupSchedulePolicyItemYearlyArgs;
import com.pulumi.mongodbatlas.MongodbatlasFunctions;
import com.pulumi.mongodbatlas.inputs.GetCloudBackupScheduleArgs;
import com.pulumi.mongodbatlas.inputs.GetBackupCompliancePolicyArgs;
import com.pulumi.mongodbatlas.BackupCompliancePolicy;
import com.pulumi.mongodbatlas.BackupCompliancePolicyArgs;
import com.pulumi.mongodbatlas.inputs.BackupCompliancePolicyOnDemandPolicyItemArgs;
import com.pulumi.mongodbatlas.inputs.BackupCompliancePolicyPolicyItemHourlyArgs;
import com.pulumi.mongodbatlas.inputs.BackupCompliancePolicyPolicyItemDailyArgs;
import com.pulumi.mongodbatlas.inputs.BackupCompliancePolicyPolicyItemWeeklyArgs;
import com.pulumi.mongodbatlas.inputs.BackupCompliancePolicyPolicyItemMonthlyArgs;
import com.pulumi.mongodbatlas.inputs.BackupCompliancePolicyPolicyItemYearlyArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var myCluster = new Cluster("myCluster", ClusterArgs.builder()
.projectId("<PROJECT-ID>")
.name("clusterTest")
.providerName("AWS")
.providerRegionName("EU_CENTRAL_1")
.providerInstanceSizeName("M10")
.cloudBackup(true)
.build());
var testCloudBackupSchedule = new CloudBackupSchedule("testCloudBackupSchedule", CloudBackupScheduleArgs.builder()
.projectId(myCluster.projectId())
.clusterName(myCluster.name())
.referenceHourOfDay(3)
.referenceMinuteOfHour(45)
.restoreWindowDays(4)
.policyItemHourly(CloudBackupSchedulePolicyItemHourlyArgs.builder()
.frequencyInterval(1)
.retentionUnit("days")
.retentionValue(7)
.build())
.policyItemDaily(CloudBackupSchedulePolicyItemDailyArgs.builder()
.frequencyInterval(1)
.retentionUnit("days")
.retentionValue(7)
.build())
.policyItemWeeklies(CloudBackupSchedulePolicyItemWeeklyArgs.builder()
.frequencyInterval(1)
.retentionUnit("weeks")
.retentionValue(4)
.build())
.policyItemMonthlies(CloudBackupSchedulePolicyItemMonthlyArgs.builder()
.frequencyInterval(1)
.retentionUnit("months")
.retentionValue(12)
.build())
.policyItemYearlies(CloudBackupSchedulePolicyItemYearlyArgs.builder()
.frequencyInterval(1)
.retentionUnit("years")
.retentionValue(1)
.build())
.build());
final var test = MongodbatlasFunctions.getCloudBackupSchedule(GetCloudBackupScheduleArgs.builder()
.projectId(testCloudBackupSchedule.projectId())
.clusterName(testCloudBackupSchedule.clusterName())
.build());
final var backupPolicy = MongodbatlasFunctions.getBackupCompliancePolicy(GetBackupCompliancePolicyArgs.builder()
.projectId(testCloudBackupSchedule.projectId())
.build());
var backupPolicyBackupCompliancePolicy = new BackupCompliancePolicy("backupPolicyBackupCompliancePolicy", BackupCompliancePolicyArgs.builder()
.projectId("<PROJECT-ID>")
.authorizedEmail("user@email.com")
.authorizedUserFirstName("First")
.authorizedUserLastName("Last")
.copyProtectionEnabled(false)
.pitEnabled(false)
.encryptionAtRestEnabled(false)
.restoreWindowDays(7)
.onDemandPolicyItem(BackupCompliancePolicyOnDemandPolicyItemArgs.builder()
.frequencyInterval(1)
.retentionUnit("days")
.retentionValue(3)
.build())
.policyItemHourly(BackupCompliancePolicyPolicyItemHourlyArgs.builder()
.frequencyInterval(1)
.retentionUnit("days")
.retentionValue(7)
.build())
.policyItemDaily(BackupCompliancePolicyPolicyItemDailyArgs.builder()
.frequencyInterval(1)
.retentionUnit("days")
.retentionValue(7)
.build())
.policyItemWeeklies(BackupCompliancePolicyPolicyItemWeeklyArgs.builder()
.frequencyInterval(1)
.retentionUnit("weeks")
.retentionValue(4)
.build())
.policyItemMonthlies(BackupCompliancePolicyPolicyItemMonthlyArgs.builder()
.frequencyInterval(1)
.retentionUnit("months")
.retentionValue(12)
.build())
.policyItemYearlies(BackupCompliancePolicyPolicyItemYearlyArgs.builder()
.frequencyInterval(1)
.retentionUnit("years")
.retentionValue(1)
.build())
.build());
}
}
resources:
myCluster:
type: mongodbatlas:Cluster
name: my_cluster
properties:
projectId: <PROJECT-ID>
name: clusterTest
providerName: AWS
providerRegionName: EU_CENTRAL_1
providerInstanceSizeName: M10
cloudBackup: true # enable cloud backup snapshots
testCloudBackupSchedule:
type: mongodbatlas:CloudBackupSchedule
name: test
properties:
projectId: ${myCluster.projectId}
clusterName: ${myCluster.name}
referenceHourOfDay: 3
referenceMinuteOfHour: 45
restoreWindowDays: 4 # This will now add the desired policy items to the existing mongodbatlas_cloud_backup_schedule resource
policyItemHourly:
frequencyInterval: 1
retentionUnit: days
retentionValue: 7
policyItemDaily:
frequencyInterval: 1
retentionUnit: days
retentionValue: 7
policyItemWeeklies:
- frequencyInterval: 1
retentionUnit: weeks
retentionValue: 4
policyItemMonthlies:
- frequencyInterval: 1
retentionUnit: months
retentionValue: 12
policyItemYearlies:
- frequencyInterval: 1
retentionUnit: years
retentionValue: 1
backupPolicyBackupCompliancePolicy:
type: mongodbatlas:BackupCompliancePolicy
name: backup_policy
properties:
projectId: <PROJECT-ID>
authorizedEmail: user@email.com
authorizedUserFirstName: First
authorizedUserLastName: Last
copyProtectionEnabled: false
pitEnabled: false
encryptionAtRestEnabled: false
restoreWindowDays: 7
onDemandPolicyItem:
frequencyInterval: 1
retentionUnit: days
retentionValue: 3
policyItemHourly:
frequencyInterval: 1
retentionUnit: days
retentionValue: 7
policyItemDaily:
frequencyInterval: 1
retentionUnit: days
retentionValue: 7
policyItemWeeklies:
- frequencyInterval: 1
retentionUnit: weeks
retentionValue: 4
policyItemMonthlies:
- frequencyInterval: 1
retentionUnit: months
retentionValue: 12
policyItemYearlies:
- frequencyInterval: 1
retentionUnit: years
retentionValue: 1
variables:
test:
fn::invoke:
Function: mongodbatlas:getCloudBackupSchedule
Arguments:
projectId: ${testCloudBackupSchedule.projectId}
clusterName: ${testCloudBackupSchedule.clusterName}
backupPolicy:
fn::invoke:
Function: mongodbatlas:getBackupCompliancePolicy
Arguments:
projectId: ${testCloudBackupSchedule.projectId}
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,
policy_item_yearlies: Optional[Sequence[BackupCompliancePolicyPolicyItemYearlyArgs]] = 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.
Constructor 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",
},
},
PolicyItemYearlies = new[]
{
new Mongodbatlas.Inputs.BackupCompliancePolicyPolicyItemYearlyArgs
{
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"),
},
},
PolicyItemYearlies: mongodbatlas.BackupCompliancePolicyPolicyItemYearlyArray{
&mongodbatlas.BackupCompliancePolicyPolicyItemYearlyArgs{
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())
.policyItemYearlies(BackupCompliancePolicyPolicyItemYearlyArgs.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",
)],
policy_item_yearlies=[mongodbatlas.BackupCompliancePolicyPolicyItemYearlyArgs(
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",
}],
policyItemYearlies: [{
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
policyItemYearlies:
- 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:
- string
- Email address of a security or legal representative for the Backup Compliance Policy who is authorized to update the Backup Compliance Policy settings.
- string
- First name of the user who authorized to update the Backup Compliance Policy settings.
- string
- Last name of the user who authorized to update the Backup Compliance Policy settings.
- On
Demand BackupPolicy Item Compliance Policy On Demand Policy Item - Project
Id string - Unique 24-hexadecimal digit string that identifies your project.
- Copy
Protection boolEnabled - Flag that indicates whether to enable additional backup copies for the cluster. If unspecified, this value defaults to false.
- Encryption
At boolRest Enabled - Flag that indicates whether Encryption at Rest using Customer Key Management is required for all clusters with a Backup Compliance Policy. If unspecified, this value defaults to false.
- 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 BackupDaily Compliance Policy Policy Item Daily - Policy
Item BackupHourly Compliance Policy Policy Item Hourly - Policy
Item List<BackupMonthlies Compliance Policy Policy Item Monthly> - Policy
Item List<BackupWeeklies Compliance Policy Policy Item Weekly> - Policy
Item List<BackupYearlies Compliance Policy Policy Item Yearly> - Restore
Window intDays - Number of previous days that you can restore back to with Continuous Cloud Backup with a Backup Compliance Policy. You must specify a positive, non-zero integer, and the maximum retention window can't exceed the hourly retention time. This parameter applies only to Continuous Cloud Backups with a Backup Compliance Policy.
- string
- Email address of a security or legal representative for the Backup Compliance Policy who is authorized to update the Backup Compliance Policy settings.
- string
- First name of the user who authorized to update the Backup Compliance Policy settings.
- string
- Last name of the user who authorized to update the Backup Compliance Policy settings.
- On
Demand BackupPolicy Item Compliance Policy On Demand Policy Item Args - Project
Id string - Unique 24-hexadecimal digit string that identifies your project.
- Copy
Protection boolEnabled - Flag that indicates whether to enable additional backup copies for the cluster. If unspecified, this value defaults to false.
- Encryption
At boolRest Enabled - Flag that indicates whether Encryption at Rest using Customer Key Management is required for all clusters with a Backup Compliance Policy. If unspecified, this value defaults to false.
- 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 BackupDaily Compliance Policy Policy Item Daily Args - Policy
Item BackupHourly Compliance Policy Policy Item Hourly Args - Policy
Item []BackupMonthlies Compliance Policy Policy Item Monthly Args - Policy
Item []BackupWeeklies Compliance Policy Policy Item Weekly Args - Policy
Item []BackupYearlies Compliance Policy Policy Item Yearly Args - Restore
Window intDays - Number of previous days that you can restore back to with Continuous Cloud Backup with a Backup Compliance Policy. You must specify a positive, non-zero integer, and the maximum retention window can't exceed the hourly retention time. This parameter applies only to Continuous Cloud Backups with a Backup Compliance Policy.
- String
- Email address of a security or legal representative for the Backup Compliance Policy who is authorized to update the Backup Compliance Policy settings.
- String
- First name of the user who authorized to update the Backup Compliance Policy settings.
- String
- Last name of the user who authorized to update the Backup Compliance Policy settings.
- on
Demand BackupPolicy Item Compliance Policy On Demand Policy Item - project
Id String - Unique 24-hexadecimal digit string that identifies your project.
- copy
Protection BooleanEnabled - Flag that indicates whether to enable additional backup copies for the cluster. If unspecified, this value defaults to false.
- encryption
At BooleanRest Enabled - Flag that indicates whether Encryption at Rest using Customer Key Management is required for all clusters with a Backup Compliance Policy. If unspecified, this value defaults to false.
- pit
Enabled Boolean - Flag that indicates whether the cluster uses Continuous Cloud Backups with a Backup Compliance Policy. If unspecified, this value defaults to false.
- policy
Item BackupDaily Compliance Policy Policy Item Daily - policy
Item BackupHourly Compliance Policy Policy Item Hourly - policy
Item List<BackupMonthlies Compliance Policy Policy Item Monthly> - policy
Item List<BackupWeeklies Compliance Policy Policy Item Weekly> - policy
Item List<BackupYearlies Compliance Policy Policy Item Yearly> - restore
Window IntegerDays - Number of previous days that you can restore back to with Continuous Cloud Backup with a Backup Compliance Policy. You must specify a positive, non-zero integer, and the maximum retention window can't exceed the hourly retention time. This parameter applies only to Continuous Cloud Backups with a Backup Compliance Policy.
- string
- Email address of a security or legal representative for the Backup Compliance Policy who is authorized to update the Backup Compliance Policy settings.
- string
- First name of the user who authorized to update the Backup Compliance Policy settings.
- string
- Last name of the user who authorized to update the Backup Compliance Policy settings.
- on
Demand BackupPolicy Item Compliance Policy On Demand Policy Item - project
Id string - Unique 24-hexadecimal digit string that identifies your project.
- copy
Protection booleanEnabled - Flag that indicates whether to enable additional backup copies for the cluster. If unspecified, this value defaults to false.
- encryption
At booleanRest Enabled - Flag that indicates whether Encryption at Rest using Customer Key Management is required for all clusters with a Backup Compliance Policy. If unspecified, this value defaults to false.
- pit
Enabled boolean - Flag that indicates whether the cluster uses Continuous Cloud Backups with a Backup Compliance Policy. If unspecified, this value defaults to false.
- policy
Item BackupDaily Compliance Policy Policy Item Daily - policy
Item BackupHourly Compliance Policy Policy Item Hourly - policy
Item BackupMonthlies Compliance Policy Policy Item Monthly[] - policy
Item BackupWeeklies Compliance Policy Policy Item Weekly[] - policy
Item BackupYearlies Compliance Policy Policy Item Yearly[] - restore
Window numberDays - Number of previous days that you can restore back to with Continuous Cloud Backup with a Backup Compliance Policy. You must specify a positive, non-zero integer, and the maximum retention window can't exceed the hourly retention time. This parameter applies only to Continuous Cloud Backups with a Backup Compliance Policy.
- str
- Email address of a security or legal representative for the Backup Compliance Policy who is authorized to update the Backup Compliance Policy settings.
- str
- First name of the user who authorized to update the Backup Compliance Policy settings.
- str
- Last name of the user who authorized to update the Backup Compliance Policy settings.
- on_
demand_ Backuppolicy_ item Compliance Policy On Demand Policy Item Args - project_
id str - Unique 24-hexadecimal digit string that identifies your project.
- copy_
protection_ boolenabled - Flag that indicates whether to enable additional backup copies for the cluster. If unspecified, this value defaults to false.
- encryption_
at_ boolrest_ enabled - Flag that indicates whether Encryption at Rest using Customer Key Management is required for all clusters with a Backup Compliance Policy. If unspecified, this value defaults to false.
- 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_ Backupdaily Compliance Policy Policy Item Daily Args - policy_
item_ Backuphourly Compliance Policy Policy Item Hourly Args - policy_
item_ Sequence[Backupmonthlies Compliance Policy Policy Item Monthly Args] - policy_
item_ Sequence[Backupweeklies Compliance Policy Policy Item Weekly Args] - policy_
item_ Sequence[Backupyearlies Compliance Policy Policy Item Yearly Args] - restore_
window_ intdays - Number of previous days that you can restore back to with Continuous Cloud Backup with a Backup Compliance Policy. You must specify a positive, non-zero integer, and the maximum retention window can't exceed the hourly retention time. This parameter applies only to Continuous Cloud Backups with a Backup Compliance Policy.
- String
- Email address of a security or legal representative for the Backup Compliance Policy who is authorized to update the Backup Compliance Policy settings.
- String
- First name of the user who authorized to update the Backup Compliance Policy settings.
- String
- Last name of the user who authorized to update the Backup Compliance Policy settings.
- on
Demand Property MapPolicy Item - project
Id String - Unique 24-hexadecimal digit string that identifies your project.
- copy
Protection BooleanEnabled - Flag that indicates whether to enable additional backup copies for the cluster. If unspecified, this value defaults to false.
- encryption
At BooleanRest Enabled - Flag that indicates whether Encryption at Rest using Customer Key Management is required for all clusters with a Backup Compliance Policy. If unspecified, this value defaults to false.
- pit
Enabled Boolean - Flag that indicates whether the cluster uses Continuous Cloud Backups with a Backup Compliance Policy. If unspecified, this value defaults to false.
- policy
Item Property MapDaily - policy
Item Property MapHourly - policy
Item List<Property Map>Monthlies - policy
Item List<Property Map>Weeklies - policy
Item List<Property Map>Yearlies - restore
Window NumberDays - Number of previous days that you can restore back to with Continuous Cloud Backup with a Backup Compliance Policy. You must specify a positive, non-zero integer, and the maximum retention window can't exceed the hourly retention time. This parameter applies only to Continuous Cloud Backups with a Backup Compliance Policy.
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.
- Updated
Date string - ISO 8601 timestamp format in UTC that indicates when the user updated the Data Protection Policy settings. MongoDB Cloud ignores this setting when you enable or update the Backup Compliance Policy settings.
- Updated
User string - Email address that identifies the user who updated the Backup Compliance Policy settings. MongoDB Cloud ignores this email setting when you enable or update the Backup Compliance Policy settings.
- 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.
- Updated
Date string - ISO 8601 timestamp format in UTC that indicates when the user updated the Data Protection Policy settings. MongoDB Cloud ignores this setting when you enable or update the Backup Compliance Policy settings.
- Updated
User string - Email address that identifies the user who updated the Backup Compliance Policy settings. MongoDB Cloud ignores this email setting when you enable or update the Backup Compliance Policy settings.
- 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.
- updated
Date String - ISO 8601 timestamp format in UTC that indicates when the user updated the Data Protection Policy settings. MongoDB Cloud ignores this setting when you enable or update the Backup Compliance Policy settings.
- updated
User String - Email address that identifies the user who updated the Backup Compliance Policy settings. MongoDB Cloud ignores this email setting when you enable or update the Backup Compliance Policy settings.
- 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.
- updated
Date string - ISO 8601 timestamp format in UTC that indicates when the user updated the Data Protection Policy settings. MongoDB Cloud ignores this setting when you enable or update the Backup Compliance Policy settings.
- updated
User string - Email address that identifies the user who updated the Backup Compliance Policy settings. MongoDB Cloud ignores this email setting when you enable or update the Backup Compliance Policy settings.
- 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.
- updated
Date String - ISO 8601 timestamp format in UTC that indicates when the user updated the Data Protection Policy settings. MongoDB Cloud ignores this setting when you enable or update the Backup Compliance Policy settings.
- updated
User String - Email address that identifies the user who updated the Backup Compliance Policy settings. MongoDB Cloud ignores this email setting when you enable or update the Backup Compliance Policy settings.
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,
policy_item_yearlies: Optional[Sequence[BackupCompliancePolicyPolicyItemYearlyArgs]] = 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.
- string
- Email address of a security or legal representative for the Backup Compliance Policy who is authorized to update the Backup Compliance Policy settings.
- string
- First name of the user who authorized to update the Backup Compliance Policy settings.
- string
- Last name of the user who authorized to update the Backup Compliance Policy settings.
- Copy
Protection boolEnabled - Flag that indicates whether to enable additional backup copies for the cluster. If unspecified, this value defaults to false.
- Encryption
At boolRest Enabled - Flag that indicates whether Encryption at Rest using Customer Key Management is required for all clusters with a Backup Compliance Policy. If unspecified, this value defaults to false.
- On
Demand BackupPolicy Item Compliance Policy On Demand Policy Item - 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 BackupDaily Compliance Policy Policy Item Daily - Policy
Item BackupHourly Compliance Policy Policy Item Hourly - Policy
Item List<BackupMonthlies Compliance Policy Policy Item Monthly> - Policy
Item List<BackupWeeklies Compliance Policy Policy Item Weekly> - Policy
Item List<BackupYearlies Compliance Policy Policy Item Yearly> - Project
Id string - Unique 24-hexadecimal digit string that identifies your project.
- Restore
Window intDays - Number of previous days that you can restore back to with Continuous Cloud Backup with a Backup Compliance Policy. You must specify a positive, non-zero integer, and the maximum retention window can't exceed the hourly retention time. This parameter applies only to Continuous Cloud Backups with a Backup Compliance Policy.
- State string
- Label that indicates the state of the Backup Compliance Policy settings. MongoDB Cloud ignores this setting when you enable or update the Backup Compliance Policy settings.
- Updated
Date string - ISO 8601 timestamp format in UTC that indicates when the user updated the Data Protection Policy settings. MongoDB Cloud ignores this setting when you enable or update the Backup Compliance Policy settings.
- Updated
User string - Email address that identifies the user who updated the Backup Compliance Policy settings. MongoDB Cloud ignores this email setting when you enable or update the Backup Compliance Policy settings.
- string
- Email address of a security or legal representative for the Backup Compliance Policy who is authorized to update the Backup Compliance Policy settings.
- string
- First name of the user who authorized to update the Backup Compliance Policy settings.
- string
- Last name of the user who authorized to update the Backup Compliance Policy settings.
- Copy
Protection boolEnabled - Flag that indicates whether to enable additional backup copies for the cluster. If unspecified, this value defaults to false.
- Encryption
At boolRest Enabled - Flag that indicates whether Encryption at Rest using Customer Key Management is required for all clusters with a Backup Compliance Policy. If unspecified, this value defaults to false.
- On
Demand BackupPolicy Item Compliance Policy On Demand Policy Item Args - 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 BackupDaily Compliance Policy Policy Item Daily Args - Policy
Item BackupHourly Compliance Policy Policy Item Hourly Args - Policy
Item []BackupMonthlies Compliance Policy Policy Item Monthly Args - Policy
Item []BackupWeeklies Compliance Policy Policy Item Weekly Args - Policy
Item []BackupYearlies Compliance Policy Policy Item Yearly Args - Project
Id string - Unique 24-hexadecimal digit string that identifies your project.
- Restore
Window intDays - Number of previous days that you can restore back to with Continuous Cloud Backup with a Backup Compliance Policy. You must specify a positive, non-zero integer, and the maximum retention window can't exceed the hourly retention time. This parameter applies only to Continuous Cloud Backups with a Backup Compliance Policy.
- State string
- Label that indicates the state of the Backup Compliance Policy settings. MongoDB Cloud ignores this setting when you enable or update the Backup Compliance Policy settings.
- Updated
Date string - ISO 8601 timestamp format in UTC that indicates when the user updated the Data Protection Policy settings. MongoDB Cloud ignores this setting when you enable or update the Backup Compliance Policy settings.
- Updated
User string - Email address that identifies the user who updated the Backup Compliance Policy settings. MongoDB Cloud ignores this email setting when you enable or update the Backup Compliance Policy settings.
- String
- Email address of a security or legal representative for the Backup Compliance Policy who is authorized to update the Backup Compliance Policy settings.
- String
- First name of the user who authorized to update the Backup Compliance Policy settings.
- String
- Last name of the user who authorized to update the Backup Compliance Policy settings.
- copy
Protection BooleanEnabled - Flag that indicates whether to enable additional backup copies for the cluster. If unspecified, this value defaults to false.
- encryption
At BooleanRest Enabled - Flag that indicates whether Encryption at Rest using Customer Key Management is required for all clusters with a Backup Compliance Policy. If unspecified, this value defaults to false.
- on
Demand BackupPolicy Item Compliance Policy On Demand Policy Item - pit
Enabled Boolean - Flag that indicates whether the cluster uses Continuous Cloud Backups with a Backup Compliance Policy. If unspecified, this value defaults to false.
- policy
Item BackupDaily Compliance Policy Policy Item Daily - policy
Item BackupHourly Compliance Policy Policy Item Hourly - policy
Item List<BackupMonthlies Compliance Policy Policy Item Monthly> - policy
Item List<BackupWeeklies Compliance Policy Policy Item Weekly> - policy
Item List<BackupYearlies Compliance Policy Policy Item Yearly> - project
Id String - Unique 24-hexadecimal digit string that identifies your project.
- restore
Window IntegerDays - Number of previous days that you can restore back to with Continuous Cloud Backup with a Backup Compliance Policy. You must specify a positive, non-zero integer, and the maximum retention window can't exceed the hourly retention time. This parameter applies only to Continuous Cloud Backups with a Backup Compliance Policy.
- state String
- Label that indicates the state of the Backup Compliance Policy settings. MongoDB Cloud ignores this setting when you enable or update the Backup Compliance Policy settings.
- updated
Date String - ISO 8601 timestamp format in UTC that indicates when the user updated the Data Protection Policy settings. MongoDB Cloud ignores this setting when you enable or update the Backup Compliance Policy settings.
- updated
User String - Email address that identifies the user who updated the Backup Compliance Policy settings. MongoDB Cloud ignores this email setting when you enable or update the Backup Compliance Policy settings.
- string
- Email address of a security or legal representative for the Backup Compliance Policy who is authorized to update the Backup Compliance Policy settings.
- string
- First name of the user who authorized to update the Backup Compliance Policy settings.
- string
- Last name of the user who authorized to update the Backup Compliance Policy settings.
- copy
Protection booleanEnabled - Flag that indicates whether to enable additional backup copies for the cluster. If unspecified, this value defaults to false.
- encryption
At booleanRest Enabled - Flag that indicates whether Encryption at Rest using Customer Key Management is required for all clusters with a Backup Compliance Policy. If unspecified, this value defaults to false.
- on
Demand BackupPolicy Item Compliance Policy On Demand Policy Item - pit
Enabled boolean - Flag that indicates whether the cluster uses Continuous Cloud Backups with a Backup Compliance Policy. If unspecified, this value defaults to false.
- policy
Item BackupDaily Compliance Policy Policy Item Daily - policy
Item BackupHourly Compliance Policy Policy Item Hourly - policy
Item BackupMonthlies Compliance Policy Policy Item Monthly[] - policy
Item BackupWeeklies Compliance Policy Policy Item Weekly[] - policy
Item BackupYearlies Compliance Policy Policy Item Yearly[] - project
Id string - Unique 24-hexadecimal digit string that identifies your project.
- restore
Window numberDays - Number of previous days that you can restore back to with Continuous Cloud Backup with a Backup Compliance Policy. You must specify a positive, non-zero integer, and the maximum retention window can't exceed the hourly retention time. This parameter applies only to Continuous Cloud Backups with a Backup Compliance Policy.
- state string
- Label that indicates the state of the Backup Compliance Policy settings. MongoDB Cloud ignores this setting when you enable or update the Backup Compliance Policy settings.
- updated
Date string - ISO 8601 timestamp format in UTC that indicates when the user updated the Data Protection Policy settings. MongoDB Cloud ignores this setting when you enable or update the Backup Compliance Policy settings.
- updated
User string - Email address that identifies the user who updated the Backup Compliance Policy settings. MongoDB Cloud ignores this email setting when you enable or update the Backup Compliance Policy settings.
- str
- Email address of a security or legal representative for the Backup Compliance Policy who is authorized to update the Backup Compliance Policy settings.
- str
- First name of the user who authorized to update the Backup Compliance Policy settings.
- str
- Last name of the user who authorized to update the Backup Compliance Policy settings.
- copy_
protection_ boolenabled - Flag that indicates whether to enable additional backup copies for the cluster. If unspecified, this value defaults to false.
- encryption_
at_ boolrest_ enabled - Flag that indicates whether Encryption at Rest using Customer Key Management is required for all clusters with a Backup Compliance Policy. If unspecified, this value defaults to false.
- on_
demand_ Backuppolicy_ item Compliance Policy On Demand Policy Item Args - 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_ Backupdaily Compliance Policy Policy Item Daily Args - policy_
item_ Backuphourly Compliance Policy Policy Item Hourly Args - policy_
item_ Sequence[Backupmonthlies Compliance Policy Policy Item Monthly Args] - policy_
item_ Sequence[Backupweeklies Compliance Policy Policy Item Weekly Args] - policy_
item_ Sequence[Backupyearlies Compliance Policy Policy Item Yearly Args] - project_
id str - Unique 24-hexadecimal digit string that identifies your project.
- restore_
window_ intdays - Number of previous days that you can restore back to with Continuous Cloud Backup with a Backup Compliance Policy. You must specify a positive, non-zero integer, and the maximum retention window can't exceed the hourly retention time. This parameter applies only to Continuous Cloud Backups with a Backup Compliance Policy.
- state str
- Label that indicates the state of the Backup Compliance Policy settings. MongoDB Cloud ignores this setting when you enable or update the Backup Compliance Policy settings.
- updated_
date str - ISO 8601 timestamp format in UTC that indicates when the user updated the Data Protection Policy settings. MongoDB Cloud ignores this setting when you enable or update the Backup Compliance Policy settings.
- updated_
user str - Email address that identifies the user who updated the Backup Compliance Policy settings. MongoDB Cloud ignores this email setting when you enable or update the Backup Compliance Policy settings.
- String
- Email address of a security or legal representative for the Backup Compliance Policy who is authorized to update the Backup Compliance Policy settings.
- String
- First name of the user who authorized to update the Backup Compliance Policy settings.
- String
- Last name of the user who authorized to update the Backup Compliance Policy settings.
- copy
Protection BooleanEnabled - Flag that indicates whether to enable additional backup copies for the cluster. If unspecified, this value defaults to false.
- encryption
At BooleanRest Enabled - Flag that indicates whether Encryption at Rest using Customer Key Management is required for all clusters with a Backup Compliance Policy. If unspecified, this value defaults to false.
- on
Demand Property MapPolicy Item - pit
Enabled Boolean - Flag that indicates whether the cluster uses Continuous Cloud Backups with a Backup Compliance Policy. If unspecified, this value defaults to false.
- policy
Item Property MapDaily - policy
Item Property MapHourly - policy
Item List<Property Map>Monthlies - policy
Item List<Property Map>Weeklies - policy
Item List<Property Map>Yearlies - project
Id String - Unique 24-hexadecimal digit string that identifies your project.
- restore
Window NumberDays - Number of previous days that you can restore back to with Continuous Cloud Backup with a Backup Compliance Policy. You must specify a positive, non-zero integer, and the maximum retention window can't exceed the hourly retention time. This parameter applies only to Continuous Cloud Backups with a Backup Compliance Policy.
- state String
- Label that indicates the state of the Backup Compliance Policy settings. MongoDB Cloud ignores this setting when you enable or update the Backup Compliance Policy settings.
- updated
Date String - ISO 8601 timestamp format in UTC that indicates when the user updated the Data Protection Policy settings. MongoDB Cloud ignores this setting when you enable or update the Backup Compliance Policy settings.
- updated
User String - Email address that identifies the user who updated the Backup Compliance Policy settings. MongoDB Cloud ignores this email setting when you enable or update the Backup Compliance Policy settings.
Supporting Types
BackupCompliancePolicyOnDemandPolicyItem, BackupCompliancePolicyOnDemandPolicyItemArgs
- Frequency
Interval int - Desired frequency of the new backup policy item specified by
frequency_type
(yearly in this case). The supported values for yearly policies are - Retention
Unit string - Scope of the backup policy item:
days
,weeks
,months
, oryears
. - Retention
Value int - Value to associate with
retention_unit
. Yearly policy must have retention of at least 1 year. - Frequency
Type string - Frequency associated with the backup policy item. For yearly policies, the frequency type is defined as
yearly
. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type. - Id string
- Unique identifier of the backup policy item.
- Frequency
Interval int - Desired frequency of the new backup policy item specified by
frequency_type
(yearly in this case). The supported values for yearly policies are - Retention
Unit string - Scope of the backup policy item:
days
,weeks
,months
, oryears
. - Retention
Value int - Value to associate with
retention_unit
. Yearly policy must have retention of at least 1 year. - Frequency
Type string - Frequency associated with the backup policy item. For yearly policies, the frequency type is defined as
yearly
. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type. - Id string
- Unique identifier of the backup policy item.
- frequency
Interval Integer - Desired frequency of the new backup policy item specified by
frequency_type
(yearly in this case). The supported values for yearly policies are - retention
Unit String - Scope of the backup policy item:
days
,weeks
,months
, oryears
. - retention
Value Integer - Value to associate with
retention_unit
. Yearly policy must have retention of at least 1 year. - frequency
Type String - Frequency associated with the backup policy item. For yearly policies, the frequency type is defined as
yearly
. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type. - id String
- Unique identifier of the backup policy item.
- frequency
Interval number - Desired frequency of the new backup policy item specified by
frequency_type
(yearly in this case). The supported values for yearly policies are - retention
Unit string - Scope of the backup policy item:
days
,weeks
,months
, oryears
. - retention
Value number - Value to associate with
retention_unit
. Yearly policy must have retention of at least 1 year. - frequency
Type string - Frequency associated with the backup policy item. For yearly policies, the frequency type is defined as
yearly
. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type. - id string
- Unique identifier of the backup policy item.
- frequency_
interval int - Desired frequency of the new backup policy item specified by
frequency_type
(yearly in this case). The supported values for yearly policies are - retention_
unit str - Scope of the backup policy item:
days
,weeks
,months
, oryears
. - retention_
value int - Value to associate with
retention_unit
. Yearly policy must have retention of at least 1 year. - frequency_
type str - Frequency associated with the backup policy item. For yearly policies, the frequency type is defined as
yearly
. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type. - id str
- Unique identifier of the backup policy item.
- frequency
Interval Number - Desired frequency of the new backup policy item specified by
frequency_type
(yearly in this case). The supported values for yearly policies are - retention
Unit String - Scope of the backup policy item:
days
,weeks
,months
, oryears
. - retention
Value Number - Value to associate with
retention_unit
. Yearly policy must have retention of at least 1 year. - frequency
Type String - Frequency associated with the backup policy item. For yearly policies, the frequency type is defined as
yearly
. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type. - id String
- Unique identifier of the backup policy item.
BackupCompliancePolicyPolicyItemDaily, BackupCompliancePolicyPolicyItemDailyArgs
- Frequency
Interval int - Desired frequency of the new backup policy item specified by
frequency_type
(yearly in this case). The supported values for yearly policies are - Retention
Unit string - Scope of the backup policy item:
days
,weeks
,months
, oryears
. - Retention
Value int - Value to associate with
retention_unit
. Yearly policy must have retention of at least 1 year. - Frequency
Type string - Frequency associated with the backup policy item. For yearly policies, the frequency type is defined as
yearly
. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type. - Id string
- Unique identifier of the backup policy item.
- Frequency
Interval int - Desired frequency of the new backup policy item specified by
frequency_type
(yearly in this case). The supported values for yearly policies are - Retention
Unit string - Scope of the backup policy item:
days
,weeks
,months
, oryears
. - Retention
Value int - Value to associate with
retention_unit
. Yearly policy must have retention of at least 1 year. - Frequency
Type string - Frequency associated with the backup policy item. For yearly policies, the frequency type is defined as
yearly
. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type. - Id string
- Unique identifier of the backup policy item.
- frequency
Interval Integer - Desired frequency of the new backup policy item specified by
frequency_type
(yearly in this case). The supported values for yearly policies are - retention
Unit String - Scope of the backup policy item:
days
,weeks
,months
, oryears
. - retention
Value Integer - Value to associate with
retention_unit
. Yearly policy must have retention of at least 1 year. - frequency
Type String - Frequency associated with the backup policy item. For yearly policies, the frequency type is defined as
yearly
. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type. - id String
- Unique identifier of the backup policy item.
- frequency
Interval number - Desired frequency of the new backup policy item specified by
frequency_type
(yearly in this case). The supported values for yearly policies are - retention
Unit string - Scope of the backup policy item:
days
,weeks
,months
, oryears
. - retention
Value number - Value to associate with
retention_unit
. Yearly policy must have retention of at least 1 year. - frequency
Type string - Frequency associated with the backup policy item. For yearly policies, the frequency type is defined as
yearly
. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type. - id string
- Unique identifier of the backup policy item.
- frequency_
interval int - Desired frequency of the new backup policy item specified by
frequency_type
(yearly in this case). The supported values for yearly policies are - retention_
unit str - Scope of the backup policy item:
days
,weeks
,months
, oryears
. - retention_
value int - Value to associate with
retention_unit
. Yearly policy must have retention of at least 1 year. - frequency_
type str - Frequency associated with the backup policy item. For yearly policies, the frequency type is defined as
yearly
. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type. - id str
- Unique identifier of the backup policy item.
- frequency
Interval Number - Desired frequency of the new backup policy item specified by
frequency_type
(yearly in this case). The supported values for yearly policies are - retention
Unit String - Scope of the backup policy item:
days
,weeks
,months
, oryears
. - retention
Value Number - Value to associate with
retention_unit
. Yearly policy must have retention of at least 1 year. - frequency
Type String - Frequency associated with the backup policy item. For yearly policies, the frequency type is defined as
yearly
. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type. - id String
- Unique identifier of the backup policy item.
BackupCompliancePolicyPolicyItemHourly, BackupCompliancePolicyPolicyItemHourlyArgs
- Frequency
Interval int - Desired frequency of the new backup policy item specified by
frequency_type
(yearly in this case). The supported values for yearly policies are - Retention
Unit string - Scope of the backup policy item:
days
,weeks
,months
, oryears
. - Retention
Value int - Value to associate with
retention_unit
. Yearly policy must have retention of at least 1 year. - Frequency
Type string - Frequency associated with the backup policy item. For yearly policies, the frequency type is defined as
yearly
. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type. - Id string
- Unique identifier of the backup policy item.
- Frequency
Interval int - Desired frequency of the new backup policy item specified by
frequency_type
(yearly in this case). The supported values for yearly policies are - Retention
Unit string - Scope of the backup policy item:
days
,weeks
,months
, oryears
. - Retention
Value int - Value to associate with
retention_unit
. Yearly policy must have retention of at least 1 year. - Frequency
Type string - Frequency associated with the backup policy item. For yearly policies, the frequency type is defined as
yearly
. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type. - Id string
- Unique identifier of the backup policy item.
- frequency
Interval Integer - Desired frequency of the new backup policy item specified by
frequency_type
(yearly in this case). The supported values for yearly policies are - retention
Unit String - Scope of the backup policy item:
days
,weeks
,months
, oryears
. - retention
Value Integer - Value to associate with
retention_unit
. Yearly policy must have retention of at least 1 year. - frequency
Type String - Frequency associated with the backup policy item. For yearly policies, the frequency type is defined as
yearly
. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type. - id String
- Unique identifier of the backup policy item.
- frequency
Interval number - Desired frequency of the new backup policy item specified by
frequency_type
(yearly in this case). The supported values for yearly policies are - retention
Unit string - Scope of the backup policy item:
days
,weeks
,months
, oryears
. - retention
Value number - Value to associate with
retention_unit
. Yearly policy must have retention of at least 1 year. - frequency
Type string - Frequency associated with the backup policy item. For yearly policies, the frequency type is defined as
yearly
. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type. - id string
- Unique identifier of the backup policy item.
- frequency_
interval int - Desired frequency of the new backup policy item specified by
frequency_type
(yearly in this case). The supported values for yearly policies are - retention_
unit str - Scope of the backup policy item:
days
,weeks
,months
, oryears
. - retention_
value int - Value to associate with
retention_unit
. Yearly policy must have retention of at least 1 year. - frequency_
type str - Frequency associated with the backup policy item. For yearly policies, the frequency type is defined as
yearly
. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type. - id str
- Unique identifier of the backup policy item.
- frequency
Interval Number - Desired frequency of the new backup policy item specified by
frequency_type
(yearly in this case). The supported values for yearly policies are - retention
Unit String - Scope of the backup policy item:
days
,weeks
,months
, oryears
. - retention
Value Number - Value to associate with
retention_unit
. Yearly policy must have retention of at least 1 year. - frequency
Type String - Frequency associated with the backup policy item. For yearly policies, the frequency type is defined as
yearly
. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type. - id String
- Unique identifier of the backup policy item.
BackupCompliancePolicyPolicyItemMonthly, BackupCompliancePolicyPolicyItemMonthlyArgs
- Frequency
Interval int - Desired frequency of the new backup policy item specified by
frequency_type
(yearly in this case). The supported values for yearly policies are - Retention
Unit string - Scope of the backup policy item:
days
,weeks
,months
, oryears
. - Retention
Value int - Value to associate with
retention_unit
. Yearly policy must have retention of at least 1 year. - Frequency
Type string - Frequency associated with the backup policy item. For yearly policies, the frequency type is defined as
yearly
. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type. - Id string
- Unique identifier of the backup policy item.
- Frequency
Interval int - Desired frequency of the new backup policy item specified by
frequency_type
(yearly in this case). The supported values for yearly policies are - Retention
Unit string - Scope of the backup policy item:
days
,weeks
,months
, oryears
. - Retention
Value int - Value to associate with
retention_unit
. Yearly policy must have retention of at least 1 year. - Frequency
Type string - Frequency associated with the backup policy item. For yearly policies, the frequency type is defined as
yearly
. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type. - Id string
- Unique identifier of the backup policy item.
- frequency
Interval Integer - Desired frequency of the new backup policy item specified by
frequency_type
(yearly in this case). The supported values for yearly policies are - retention
Unit String - Scope of the backup policy item:
days
,weeks
,months
, oryears
. - retention
Value Integer - Value to associate with
retention_unit
. Yearly policy must have retention of at least 1 year. - frequency
Type String - Frequency associated with the backup policy item. For yearly policies, the frequency type is defined as
yearly
. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type. - id String
- Unique identifier of the backup policy item.
- frequency
Interval number - Desired frequency of the new backup policy item specified by
frequency_type
(yearly in this case). The supported values for yearly policies are - retention
Unit string - Scope of the backup policy item:
days
,weeks
,months
, oryears
. - retention
Value number - Value to associate with
retention_unit
. Yearly policy must have retention of at least 1 year. - frequency
Type string - Frequency associated with the backup policy item. For yearly policies, the frequency type is defined as
yearly
. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type. - id string
- Unique identifier of the backup policy item.
- frequency_
interval int - Desired frequency of the new backup policy item specified by
frequency_type
(yearly in this case). The supported values for yearly policies are - retention_
unit str - Scope of the backup policy item:
days
,weeks
,months
, oryears
. - retention_
value int - Value to associate with
retention_unit
. Yearly policy must have retention of at least 1 year. - frequency_
type str - Frequency associated with the backup policy item. For yearly policies, the frequency type is defined as
yearly
. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type. - id str
- Unique identifier of the backup policy item.
- frequency
Interval Number - Desired frequency of the new backup policy item specified by
frequency_type
(yearly in this case). The supported values for yearly policies are - retention
Unit String - Scope of the backup policy item:
days
,weeks
,months
, oryears
. - retention
Value Number - Value to associate with
retention_unit
. Yearly policy must have retention of at least 1 year. - frequency
Type String - Frequency associated with the backup policy item. For yearly policies, the frequency type is defined as
yearly
. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type. - id String
- Unique identifier of the backup policy item.
BackupCompliancePolicyPolicyItemWeekly, BackupCompliancePolicyPolicyItemWeeklyArgs
- Frequency
Interval int - Desired frequency of the new backup policy item specified by
frequency_type
(yearly in this case). The supported values for yearly policies are - Retention
Unit string - Scope of the backup policy item:
days
,weeks
,months
, oryears
. - Retention
Value int - Value to associate with
retention_unit
. Yearly policy must have retention of at least 1 year. - Frequency
Type string - Frequency associated with the backup policy item. For yearly policies, the frequency type is defined as
yearly
. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type. - Id string
- Unique identifier of the backup policy item.
- Frequency
Interval int - Desired frequency of the new backup policy item specified by
frequency_type
(yearly in this case). The supported values for yearly policies are - Retention
Unit string - Scope of the backup policy item:
days
,weeks
,months
, oryears
. - Retention
Value int - Value to associate with
retention_unit
. Yearly policy must have retention of at least 1 year. - Frequency
Type string - Frequency associated with the backup policy item. For yearly policies, the frequency type is defined as
yearly
. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type. - Id string
- Unique identifier of the backup policy item.
- frequency
Interval Integer - Desired frequency of the new backup policy item specified by
frequency_type
(yearly in this case). The supported values for yearly policies are - retention
Unit String - Scope of the backup policy item:
days
,weeks
,months
, oryears
. - retention
Value Integer - Value to associate with
retention_unit
. Yearly policy must have retention of at least 1 year. - frequency
Type String - Frequency associated with the backup policy item. For yearly policies, the frequency type is defined as
yearly
. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type. - id String
- Unique identifier of the backup policy item.
- frequency
Interval number - Desired frequency of the new backup policy item specified by
frequency_type
(yearly in this case). The supported values for yearly policies are - retention
Unit string - Scope of the backup policy item:
days
,weeks
,months
, oryears
. - retention
Value number - Value to associate with
retention_unit
. Yearly policy must have retention of at least 1 year. - frequency
Type string - Frequency associated with the backup policy item. For yearly policies, the frequency type is defined as
yearly
. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type. - id string
- Unique identifier of the backup policy item.
- frequency_
interval int - Desired frequency of the new backup policy item specified by
frequency_type
(yearly in this case). The supported values for yearly policies are - retention_
unit str - Scope of the backup policy item:
days
,weeks
,months
, oryears
. - retention_
value int - Value to associate with
retention_unit
. Yearly policy must have retention of at least 1 year. - frequency_
type str - Frequency associated with the backup policy item. For yearly policies, the frequency type is defined as
yearly
. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type. - id str
- Unique identifier of the backup policy item.
- frequency
Interval Number - Desired frequency of the new backup policy item specified by
frequency_type
(yearly in this case). The supported values for yearly policies are - retention
Unit String - Scope of the backup policy item:
days
,weeks
,months
, oryears
. - retention
Value Number - Value to associate with
retention_unit
. Yearly policy must have retention of at least 1 year. - frequency
Type String - Frequency associated with the backup policy item. For yearly policies, the frequency type is defined as
yearly
. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type. - id String
- Unique identifier of the backup policy item.
BackupCompliancePolicyPolicyItemYearly, BackupCompliancePolicyPolicyItemYearlyArgs
- Frequency
Interval int - Desired frequency of the new backup policy item specified by
frequency_type
(yearly in this case). The supported values for yearly policies are - Retention
Unit string - Scope of the backup policy item:
days
,weeks
,months
, oryears
. - Retention
Value int - Value to associate with
retention_unit
. Yearly policy must have retention of at least 1 year. - Frequency
Type string - Frequency associated with the backup policy item. For yearly policies, the frequency type is defined as
yearly
. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type. - Id string
- Unique identifier of the backup policy item.
- Frequency
Interval int - Desired frequency of the new backup policy item specified by
frequency_type
(yearly in this case). The supported values for yearly policies are - Retention
Unit string - Scope of the backup policy item:
days
,weeks
,months
, oryears
. - Retention
Value int - Value to associate with
retention_unit
. Yearly policy must have retention of at least 1 year. - Frequency
Type string - Frequency associated with the backup policy item. For yearly policies, the frequency type is defined as
yearly
. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type. - Id string
- Unique identifier of the backup policy item.
- frequency
Interval Integer - Desired frequency of the new backup policy item specified by
frequency_type
(yearly in this case). The supported values for yearly policies are - retention
Unit String - Scope of the backup policy item:
days
,weeks
,months
, oryears
. - retention
Value Integer - Value to associate with
retention_unit
. Yearly policy must have retention of at least 1 year. - frequency
Type String - Frequency associated with the backup policy item. For yearly policies, the frequency type is defined as
yearly
. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type. - id String
- Unique identifier of the backup policy item.
- frequency
Interval number - Desired frequency of the new backup policy item specified by
frequency_type
(yearly in this case). The supported values for yearly policies are - retention
Unit string - Scope of the backup policy item:
days
,weeks
,months
, oryears
. - retention
Value number - Value to associate with
retention_unit
. Yearly policy must have retention of at least 1 year. - frequency
Type string - Frequency associated with the backup policy item. For yearly policies, the frequency type is defined as
yearly
. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type. - id string
- Unique identifier of the backup policy item.
- frequency_
interval int - Desired frequency of the new backup policy item specified by
frequency_type
(yearly in this case). The supported values for yearly policies are - retention_
unit str - Scope of the backup policy item:
days
,weeks
,months
, oryears
. - retention_
value int - Value to associate with
retention_unit
. Yearly policy must have retention of at least 1 year. - frequency_
type str - Frequency associated with the backup policy item. For yearly policies, the frequency type is defined as
yearly
. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type. - id str
- Unique identifier of the backup policy item.
- frequency
Interval Number - Desired frequency of the new backup policy item specified by
frequency_type
(yearly in this case). The supported values for yearly policies are - retention
Unit String - Scope of the backup policy item:
days
,weeks
,months
, oryears
. - retention
Value Number - Value to associate with
retention_unit
. Yearly policy must have retention of at least 1 year. - frequency
Type String - Frequency associated with the backup policy item. For yearly policies, the frequency type is defined as
yearly
. Note that this is a read-only value and not required in plan files - its value is implied from the policy resource type. - id String
- Unique identifier of the backup policy item.
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.